import { Attributes } from "./attribute";
import { fetchConfig } from "../shared";
export interface OTPsSmsLoginOrCreateRequest {
    /**
     * The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e.
     * +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see
     * [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
     */
    phone_number: string;
    /**
     * Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the
     * maximum is 10 minutes. The default expiration is 2 minutes.
     */
    expiration_minutes?: number;
    /**
     * Provided attributes to help with fraud detection. These values are pulled and passed into Stytch
     * endpoints by your application.
     */
    attributes?: Attributes;
    /**
     * Flag for whether or not to save a user as pending vs active in Stytch. Defaults to false.
     *         If true, users will be saved with status pending in Stytch's backend until authenticated.
     *         If false, users will be created as active. An example usage of
     *         a true flag would be to require users to verify their phone by entering the OTP code before
     * creating
     *         an account for them.
     */
    create_user_as_pending?: boolean;
    /**
     * Used to determine which language to use when sending the user this delivery method. Parameter is an
     * [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
     *
     * Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian
     * Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
     *
     * Request support for additional languages
     * [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
     *
     */
    locale?: "en" | "es" | "pt-br" | "fr" | "it" | "de-DE" | "zh-Hans" | "ca-ES" | string;
}
export interface OTPsSmsLoginOrCreateResponse {
    /**
     * Globally unique UUID that is returned with every API call. This value is important to log for debugging
     * purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
     */
    request_id: string;
    user_id: string;
    phone_id: string;
    user_created: boolean;
    /**
     * The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g.
     * 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
     */
    status_code: number;
}
export interface OTPsSmsSendRequest {
    /**
     * The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e.
     * +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see
     * [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
     */
    phone_number: string;
    /**
     * Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the
     * maximum is 10 minutes. The default expiration is 2 minutes.
     */
    expiration_minutes?: number;
    /**
     * Provided attributes to help with fraud detection. These values are pulled and passed into Stytch
     * endpoints by your application.
     */
    attributes?: Attributes;
    /**
     * Used to determine which language to use when sending the user this delivery method. Parameter is an
     * [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
     *
     * Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian
     * Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
     *
     * Request support for additional languages
     * [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
     *
     */
    locale?: "en" | "es" | "pt-br" | "fr" | "it" | "de-DE" | "zh-Hans" | "ca-ES" | string;
    user_id?: string;
    session_token?: string;
    session_jwt?: string;
}
export interface OTPsSmsSendResponse {
    /**
     * Globally unique UUID that is returned with every API call. This value is important to log for debugging
     * purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
     */
    request_id: string;
    user_id: string;
    phone_id: string;
    /**
     * The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g.
     * 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
     */
    status_code: number;
}
export declare class Sms {
    private fetchConfig;
    constructor(fetchConfig: fetchConfig);
    /**
     * Send a one-time passcode (OTP) to a user's phone number. If you'd like to create a user and send them a
     * passcode with one request, use our
     * [log in or create](https://stytch.com/docs/api/log-in-or-create-user-by-sms) endpoint.
     *
     * Note that sending another OTP code before the first has expired will invalidate the first code.
     *
     * ### Cost to send SMS OTP
     * Before configuring SMS or WhatsApp OTPs, please review how Stytch
     * [bills the costs of international OTPs](https://stytch.com/pricing) and understand how to protect your
     * app against [toll fraud](https://stytch.com/docs/guides/passcodes/toll-fraud/overview).
     *
     * __Note:__ SMS to phone numbers outside of the US and Canada is disabled by default for customers who did
     * not use SMS prior to October 2023. If you're interested in sending international SMS, please add those
     * countries to your Project's allowlist via the
     * [Dashboard](https://stytch.com/dashboard/country-code-allowlists) or
     * [Programmatic Workspace Actions](https://stytch.com/docs/workspace-management/pwa/set-allowed-country-codes), and [add credit card details](https://stytch.com/dashboard/settings/billing) to your account.
     *
     * Even when international SMS is enabled, we do not support sending SMS to countries on our
     * [Unsupported countries list](https://stytch.com/docs/guides/passcodes/unsupported-countries).
     *
     * ### Add a phone number to an existing user
     *
     * This endpoint also allows you to add a new phone number to an existing Stytch User. Including a
     * `user_id`, `session_token`, or `session_jwt` in your Send one-time passcode by SMS request will add the
     * new, unverified phone number to the existing Stytch User. If the user successfully authenticates within
     * 5 minutes, the new phone number will be marked as verified and remain permanently on the existing Stytch
     * User. Otherwise, it will be removed from the User object, and any subsequent login requests using that
     * phone number will create a new User.
     *
     * ### Next steps
     *
     * Collect the OTP which was delivered to the user. Call
     * [Authenticate OTP](https://stytch.com/docs/api/authenticate-otp) using the OTP `code` along with the
     * `phone_id` found in the response as the `method_id`.
     * @param data {@link OTPsSmsSendRequest}
     * @returns {@link OTPsSmsSendResponse}
     * @async
     * @throws A {@link StytchError} on a non-2xx response from the Stytch API
     * @throws A {@link RequestError} when the Stytch API cannot be reached
     */
    send(data: OTPsSmsSendRequest): Promise<OTPsSmsSendResponse>;
    /**
     * Send a One-Time Passcode (OTP) to a User using their phone number. If the phone number is not associated
     * with a user already, a user will be created.
     *
     * ### Cost to send SMS OTP
     * Before configuring SMS or WhatsApp OTPs, please review how Stytch
     * [bills the costs of international OTPs](https://stytch.com/pricing) and understand how to protect your
     * app against [toll fraud](https://stytch.com/docs/guides/passcodes/toll-fraud/overview).
     *
     * __Note:__ SMS to phone numbers outside of the US and Canada is disabled by default for customers who did
     * not use SMS prior to October 2023. If you're interested in sending international SMS, please add those
     * countries to your Project's allowlist via the
     * [Dashboard](https://stytch.com/dashboard/country-code-allowlists) or
     * [Programmatic Workspace Actions](https://stytch.com/docs/workspace-management/pwa/set-allowed-country-codes), and [add credit card details](https://stytch.com/dashboard/settings/billing) to your account.
     *
     * Even when international SMS is enabled, we do not support sending SMS to countries on our
     * [Unsupported countries list](https://stytch.com/docs/guides/passcodes/unsupported-countries).
     *
     * ### Next steps
     *
     * Collect the OTP which was delivered to the User. Call
     * [Authenticate OTP](https://stytch.com/docs/api/authenticate-otp) using the OTP `code` along with the
     * `phone_id` found in the response as the `method_id`.
     * @param data {@link OTPsSmsLoginOrCreateRequest}
     * @returns {@link OTPsSmsLoginOrCreateResponse}
     * @async
     * @throws A {@link StytchError} on a non-2xx response from the Stytch API
     * @throws A {@link RequestError} when the Stytch API cannot be reached
     */
    loginOrCreate(data: OTPsSmsLoginOrCreateRequest): Promise<OTPsSmsLoginOrCreateResponse>;
}