import { VerifyLanguages } from '../enums/VerifyLanguages.js';
import { VerifyWorkflows } from '../enums/Workflows.js';

/**
 * Represents parameters for a verification request.
 */
type VerificationParameters = {
    /**
     * The mobile or landline phone number to verify. Unless you are setting
     * country explicitly, this number must be in E.164 format.
     */
    number: string;
    /**
     * An 18-character alphanumeric string you can use to personalize the
     * verification request SMS body, to help users identify your company or
     * application name. For example: "Your Acme Inc PIN is ..."
     */
    brand: string;
    /**
     * (Optional) The two-character country code if the number is not provided in
     * international format or if you are not sure if the number is correctly
     * formatted. Verify will then format the number for you.
     */
    country?: string;
    /**
     * (Optional) An 11-character alphanumeric string that represents the identity
     * of the sender of the verification request. Depending on the destination of
     * the phone number you are sending the verification SMS to, restrictions
     * might apply.
     */
    senderId?: string;
    /**
     * (Optional) The length of the verification code.
     */
    codeLength?: number;
    /**
     * (Optional) The language used for the Verify request.
     */
    lg?: VerifyLanguages;
    /**
     * (Optional) How long the generated verification code is valid for,
     * in seconds.
     */
    pinExpiry?: number;
    /**
     * (Optional) The wait time in seconds between attempts to deliver the
     * verification code.
     */
    nextEventWait?: number;
    /**
     * (Optional) Selects the predefined sequence of SMS and TTS (Text To Speech)
     * actions to use in order to convey the PIN to your user.
     */
    workflowId?: VerifyWorkflows;
    /**
     * (Optional) A custom PIN to send to the user. If a PIN is not provided,
     * Verify will generate a random PIN for you. This feature is not enabled by
     * default - please discuss with your Account Manager if you would like it
     * enabled. If this feature is not enabled on your account, error status 20
     * will be returned.
     */
    pinCode?: string;
};

export type { VerificationParameters };