import { DeviceInfo } from "./device_history";
import { fetchConfig } from "../shared";
import { Session } from "./sessions";
import { User } from "./users";
export interface TOTPWithRecoveryCodes {
    totp_id: string;
    /**
     * The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc.,
     * has been successfully authenticated by the User.
     */
    verified: boolean;
    recovery_codes: string[];
}
export interface TOTPsAuthenticateRequest {
    /**
     * The `user_id` of an active user the TOTP registration should be tied to. You may use an `external_id`
     * here if one is set for the user.
     */
    user_id: string;
    totp_code: string;
    session_token?: string;
    /**
     * Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't
     * already exist,
     *   returning both an opaque `session_token` and `session_jwt` for this session. Remember that the
     * `session_jwt` will have a fixed lifetime of
     *   five minutes regardless of the underlying session duration, and will need to be refreshed over time.
     *
     *   This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).
     *
     *   If a `session_token` or `session_jwt` is provided then a successful authentication will continue to
     * extend the session this many minutes.
     *
     *   If the `session_duration_minutes` parameter is not specified, a Stytch session will not be created.
     */
    session_duration_minutes?: number;
    session_jwt?: string;
    /**
     * Add a custom claims map to the Session being authenticated. Claims are only created if a Session is
     * initialized by providing a value in `session_duration_minutes`. Claims will be included on the Session
     * object and in the JWT. To update a key in an existing Session, supply a new value. To delete a key,
     * supply a null value.
     *
     *   Custom claims made with reserved claims ("iss", "sub", "aud", "exp", "nbf", "iat", "jti") will be
     * ignored. Total custom claims size cannot exceed four kilobytes.
     */
    session_custom_claims?: Record<string, any>;
    /**
     * If the `telemetry_id` is passed, as part of this request, Stytch will call the
     * [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated
     * fingerprints and IPGEO information for the User. Your workspace must be enabled for Device
     * Fingerprinting to use this feature.
     */
    telemetry_id?: string;
}
export interface TOTPsAuthenticateResponse {
    /**
     * 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;
    session_token: string;
    totp_id: string;
    session_jwt: string;
    /**
     * The `user` object affected by this API call. See the
     * [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
     */
    user: User;
    /**
     * 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;
    /**
     * If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll
     * receive a full Session object in the response.
     *
     *   See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.
     *
     */
    session?: Session;
    /**
     * If a valid `telemetry_id` was passed in the request and the
     * [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the
     * `user_device` response field will contain information about the user's device attributes.
     */
    user_device?: DeviceInfo;
}
export interface TOTPsCreateRequest {
    /**
     * The `user_id` of an active user the TOTP registration should be tied to. You may use an `external_id`
     * here if one is set for the user.
     */
    user_id: string;
    /**
     * The expiration for the TOTP instance. If the newly created TOTP is not authenticated within this time
     * frame the TOTP will be unusable. Defaults to 1440 (1 day) with a minimum of 5 and a maximum of 1440.
     */
    expiration_minutes?: number;
}
export interface TOTPsCreateResponse {
    /**
     * 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;
    totp_id: string;
    secret: string;
    qr_code: string;
    recovery_codes: string[];
    /**
     * The `user` object affected by this API call. See the
     * [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
     */
    user: User;
    user_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 interface TOTPsRecoverRequest {
    /**
     * The `user_id` of an active user the TOTP registration should be tied to. You may use an `external_id`
     * here if one is set for the user.
     */
    user_id: string;
    recovery_code: string;
    session_token?: string;
    /**
     * Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't
     * already exist,
     *   returning both an opaque `session_token` and `session_jwt` for this session. Remember that the
     * `session_jwt` will have a fixed lifetime of
     *   five minutes regardless of the underlying session duration, and will need to be refreshed over time.
     *
     *   This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).
     *
     *   If a `session_token` or `session_jwt` is provided then a successful authentication will continue to
     * extend the session this many minutes.
     *
     *   If the `session_duration_minutes` parameter is not specified, a Stytch session will not be created.
     */
    session_duration_minutes?: number;
    session_jwt?: string;
    /**
     * Add a custom claims map to the Session being authenticated. Claims are only created if a Session is
     * initialized by providing a value in `session_duration_minutes`. Claims will be included on the Session
     * object and in the JWT. To update a key in an existing Session, supply a new value. To delete a key,
     * supply a null value.
     *
     *   Custom claims made with reserved claims ("iss", "sub", "aud", "exp", "nbf", "iat", "jti") will be
     * ignored. Total custom claims size cannot exceed four kilobytes.
     */
    session_custom_claims?: Record<string, any>;
    /**
     * If the `telemetry_id` is passed, as part of this request, Stytch will call the
     * [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated
     * fingerprints and IPGEO information for the User. Your workspace must be enabled for Device
     * Fingerprinting to use this feature.
     */
    telemetry_id?: string;
}
export interface TOTPsRecoverResponse {
    /**
     * 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;
    totp_id: string;
    user_id: string;
    session_token: string;
    session_jwt: string;
    /**
     * The `user` object affected by this API call. See the
     * [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
     */
    user: User;
    /**
     * 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;
    /**
     * If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll
     * receive a full Session object in the response.
     *
     *   See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.
     *
     */
    session?: Session;
    /**
     * If a valid `telemetry_id` was passed in the request and the
     * [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the
     * `user_device` response field will contain information about the user's device attributes.
     */
    user_device?: DeviceInfo;
}
export interface TOTPsRecoveryCodesRequest {
    /**
     * The `user_id` of an active user the TOTP registration should be tied to. You may use an `external_id`
     * here if one is set for the user.
     */
    user_id: string;
}
export interface TOTPsRecoveryCodesResponse {
    /**
     * 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;
    /**
     * An array containing a list of all TOTP instances (along with their recovery codes) for a given User in
     * the Stytch API.
     */
    totps: TOTPWithRecoveryCodes[];
    /**
     * 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 TOTPs {
    private fetchConfig;
    constructor(fetchConfig: fetchConfig);
    /**
     * Create a new TOTP instance for a user. The user can use the authenticator application of their choice to
     * scan the QR code or enter the secret.
     * @param data {@link TOTPsCreateRequest}
     * @returns {@link TOTPsCreateResponse}
     * @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
     */
    create(data: TOTPsCreateRequest): Promise<TOTPsCreateResponse>;
    /**
     * Authenticate a TOTP code entered by a user.
     * @param data {@link TOTPsAuthenticateRequest}
     * @returns {@link TOTPsAuthenticateResponse}
     * @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
     */
    authenticate(data: TOTPsAuthenticateRequest): Promise<TOTPsAuthenticateResponse>;
    /**
     * Retrieve the recovery codes for a TOTP instance tied to a User.
     * @param data {@link TOTPsRecoveryCodesRequest}
     * @returns {@link TOTPsRecoveryCodesResponse}
     * @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
     */
    recoveryCodes(data: TOTPsRecoveryCodesRequest): Promise<TOTPsRecoveryCodesResponse>;
    /**
     * Authenticate a recovery code for a TOTP instance.
     * @param data {@link TOTPsRecoverRequest}
     * @returns {@link TOTPsRecoverResponse}
     * @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
     */
    recover(data: TOTPsRecoverRequest): Promise<TOTPsRecoverResponse>;
}