@nhost/nhost-js 3.3.0 → 4.0.0

package/dist/src/auth/client.d.ts

@@ -0,0 +1,1763 @@
+/**
+ * This file is auto-generated. Do not edit manually.
+ */
+import type { ChainFunction, FetchResponse } from "../fetch";
+/**
+ * The attestation statement format
+ */
+export type AttestationFormat = "packed" | "tpm" | "android-key" | "android-safetynet" | "fido-u2f" | "apple" | "none";
+/**
+ * Map of extension outputs from the client
+ @property appid? (`boolean`) - Application identifier extension output
+ @property credProps? (`CredentialPropertiesOutput`) - Credential properties extension output
+ @property hmacCreateSecret? (`boolean`) - HMAC secret extension output*/
+export interface AuthenticationExtensionsClientOutputs {
+    /**
+     * Application identifier extension output
+     */
+    appid?: boolean;
+    /**
+     * Credential properties extension output
+     */
+    credProps?: CredentialPropertiesOutput;
+    /**
+     * HMAC secret extension output
+     */
+    hmacCreateSecret?: boolean;
+}
+/**
+ *
+ @property clientDataJSON (`string`) - Base64url encoded client data JSON
+ @property authenticatorData (`string`) - Base64url encoded authenticator data
+ @property signature (`string`) - Base64url encoded assertion signature
+ @property userHandle? (`string`) - Base64url encoded user handle*/
+export interface AuthenticatorAssertionResponse {
+    /**
+     * Base64url encoded client data JSON
+     */
+    clientDataJSON: string;
+    /**
+     * Base64url encoded authenticator data
+     */
+    authenticatorData: string;
+    /**
+     * Base64url encoded assertion signature
+     */
+    signature: string;
+    /**
+     * Base64url encoded user handle
+     */
+    userHandle?: string;
+}
+/**
+ * The authenticator attachment modality
+ */
+export type AuthenticatorAttachment = "platform" | "cross-platform";
+/**
+ *
+ @property clientDataJSON (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property transports? (`string[]`) - The authenticator transports
+ @property authenticatorData? (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property publicKey? (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property publicKeyAlgorithm? (`number`) - The public key algorithm identifier
+    *    Format - int64
+ @property attestationObject (`string`) - Base64url-encoded binary data
+    *    Format - byte*/
+export interface AuthenticatorAttestationResponse {
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    clientDataJSON: string;
+    /**
+     * The authenticator transports
+     */
+    transports?: string[];
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    authenticatorData?: string;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    publicKey?: string;
+    /**
+     * The public key algorithm identifier
+     *    Format - int64
+     */
+    publicKeyAlgorithm?: number;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    attestationObject: string;
+}
+/**
+ *
+ @property authenticatorAttachment? (`AuthenticatorAttachment`) - The authenticator attachment modality
+ @property requireResidentKey? (`boolean`) - Whether the authenticator must create a client-side-resident public key credential source
+ @property residentKey? (`ResidentKeyRequirement`) - The resident key requirement
+ @property userVerification? (`UserVerificationRequirement`) - A requirement for user verification for the operation*/
+export interface AuthenticatorSelection {
+    /**
+     * The authenticator attachment modality
+     */
+    authenticatorAttachment?: AuthenticatorAttachment;
+    /**
+     * Whether the authenticator must create a client-side-resident public key credential source
+     */
+    requireResidentKey?: boolean;
+    /**
+     * The resident key requirement
+     */
+    residentKey?: ResidentKeyRequirement;
+    /**
+     * A requirement for user verification for the operation
+     */
+    userVerification?: UserVerificationRequirement;
+}
+/**
+ * The authenticator transports that can be used
+ */
+export type AuthenticatorTransport = "usb" | "nfc" | "ble" | "smart-card" | "hybrid" | "internal";
+/**
+ * The attestation conveyance preference
+ */
+export type ConveyancePreference = "none" | "indirect" | "direct" | "enterprise";
+/**
+ *
+ @property expiresAt (`string`) - Expiration date of the PAT
+    *    Format - date-time
+ @property metadata? (`Record<string, unknown>`) -
+    *    Example - `{"name":"my-pat","used-by":"my-app-cli"}`*/
+export interface CreatePATRequest {
+    /**
+     * Expiration date of the PAT
+     *    Format - date-time
+     */
+    expiresAt: string;
+    /**
+     *
+     *    Example - `{"name":"my-pat","used-by":"my-app-cli"}`
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ *
+ @property id (`string`) - ID of the PAT
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+ @property personalAccessToken (`string`) - PAT
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b*/
+export interface CreatePATResponse {
+    /**
+     * ID of the PAT
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    id: string;
+    /**
+     * PAT
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    personalAccessToken: string;
+}
+/**
+ *
+ @property id (`string`) - The credential's identifier
+ @property type (`string`) - The credential type represented by this object
+ @property rawId (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property clientExtensionResults? (`AuthenticationExtensionsClientOutputs`) - Map of extension outputs from the client
+ @property authenticatorAttachment? (`string`) - The authenticator attachment
+ @property response (`AuthenticatorAssertionResponse`) - */
+export interface CredentialAssertionResponse {
+    /**
+     * The credential's identifier
+     */
+    id: string;
+    /**
+     * The credential type represented by this object
+     */
+    type: string;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    rawId: string;
+    /**
+     * Map of extension outputs from the client
+     */
+    clientExtensionResults?: AuthenticationExtensionsClientOutputs;
+    /**
+     * The authenticator attachment
+     */
+    authenticatorAttachment?: string;
+    /**
+     *
+     */
+    response: AuthenticatorAssertionResponse;
+}
+/**
+ *
+ @property id (`string`) - The credential's identifier
+ @property type (`string`) - The credential type represented by this object
+ @property rawId (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property clientExtensionResults? (`AuthenticationExtensionsClientOutputs`) - Map of extension outputs from the client
+ @property authenticatorAttachment? (`string`) - The authenticator attachment
+ @property response (`AuthenticatorAttestationResponse`) - */
+export interface CredentialCreationResponse {
+    /**
+     * The credential's identifier
+     */
+    id: string;
+    /**
+     * The credential type represented by this object
+     */
+    type: string;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    rawId: string;
+    /**
+     * Map of extension outputs from the client
+     */
+    clientExtensionResults?: AuthenticationExtensionsClientOutputs;
+    /**
+     * The authenticator attachment
+     */
+    authenticatorAttachment?: string;
+    /**
+     *
+     */
+    response: AuthenticatorAttestationResponse;
+}
+/**
+ *
+ @property type (`CredentialType`) - The valid credential types
+ @property alg (`number`) - The cryptographic algorithm identifier*/
+export interface CredentialParameter {
+    /**
+     * The valid credential types
+     */
+    type: CredentialType;
+    /**
+     * The cryptographic algorithm identifier
+     */
+    alg: number;
+}
+/**
+ * Credential properties extension output
+ @property rk? (`boolean`) - Indicates if the credential is a resident key*/
+export interface CredentialPropertiesOutput {
+    /**
+     * Indicates if the credential is a resident key
+     */
+    rk?: boolean;
+}
+/**
+ * The valid credential types
+ */
+export type CredentialType = "public-key";
+/**
+ * Error code identifying the specific application error
+ */
+export type ErrorResponseError = "default-role-must-be-in-allowed-roles" | "disabled-endpoint" | "disabled-user" | "email-already-in-use" | "email-already-verified" | "forbidden-anonymous" | "internal-server-error" | "invalid-email-password" | "invalid-request" | "locale-not-allowed" | "password-too-short" | "password-in-hibp-database" | "redirectTo-not-allowed" | "role-not-allowed" | "signup-disabled" | "unverified-user" | "user-not-anonymous" | "invalid-pat" | "invalid-refresh-token" | "invalid-ticket" | "disabled-mfa-totp" | "no-totp-secret" | "invalid-totp" | "mfa-type-not-found" | "totp-already-active" | "invalid-state" | "oauth-token-echange-failed" | "oauth-profile-fetch-failed" | "oauth-provider-error" | "invalid-otp" | "cannot-send-sms";
+/**
+ * Standardized error response
+ @property status (`number`) - HTTP status error code
+    *    Example - `400`
+ @property message (`string`) - Human-friendly error message
+    *    Example - `"Invalid email format"`
+ @property error (`ErrorResponseError`) - Error code identifying the specific application error*/
+export interface ErrorResponse {
+    /**
+     * HTTP status error code
+     *    Example - `400`
+     */
+    status: number;
+    /**
+     * Human-friendly error message
+     *    Example - `"Invalid email format"`
+     */
+    message: string;
+    /**
+     * Error code identifying the specific application error
+     */
+    error: ErrorResponseError;
+}
+/**
+ *
+ */
+export type IdTokenProvider = "apple" | "google";
+/**
+ * JSON Web Key for JWT verification
+ @property alg (`string`) - Algorithm used with this key
+    *    Example - `"RS256"`
+ @property e (`string`) - RSA public exponent
+    *    Example - `"AQAB"`
+ @property kid (`string`) - Key ID
+    *    Example - `"key-id-1"`
+ @property kty (`string`) - Key type
+    *    Example - `"RSA"`
+ @property n (`string`) - RSA modulus
+    *    Example - `"abcd1234..."`
+ @property use (`string`) - Key usage
+    *    Example - `"sig"`*/
+export interface JWK {
+    /**
+     * Algorithm used with this key
+     *    Example - `"RS256"`
+     */
+    alg: string;
+    /**
+     * RSA public exponent
+     *    Example - `"AQAB"`
+     */
+    e: string;
+    /**
+     * Key ID
+     *    Example - `"key-id-1"`
+     */
+    kid: string;
+    /**
+     * Key type
+     *    Example - `"RSA"`
+     */
+    kty: string;
+    /**
+     * RSA modulus
+     *    Example - `"abcd1234..."`
+     */
+    n: string;
+    /**
+     * Key usage
+     *    Example - `"sig"`
+     */
+    use: string;
+}
+/**
+ * JSON Web Key Set for verifying JWT signatures
+ @property keys (`JWK[]`) - Array of public keys*/
+export interface JWKSet {
+    /**
+     * Array of public keys
+     */
+    keys: JWK[];
+}
+/**
+ *
+ @property provider (`IdTokenProvider`) -
+ @property idToken (`string`) - Apple ID token
+ @property nonce? (`string`) - Nonce used during sign in process*/
+export interface LinkIdTokenRequest {
+    /**
+     *
+     */
+    provider: IdTokenProvider;
+    /**
+     * Apple ID token
+     */
+    idToken: string;
+    /**
+     * Nonce used during sign in process
+     */
+    nonce?: string;
+}
+/**
+ * Challenge payload for multi-factor authentication
+ @property ticket (`string`) - Ticket to use when completing the MFA challenge
+    *    Example - `"mfaTotp:abc123def456"`*/
+export interface MFAChallengePayload {
+    /**
+     * Ticket to use when completing the MFA challenge
+     *    Example - `"mfaTotp:abc123def456"`
+     */
+    ticket: string;
+}
+/**
+ *
+ */
+export type OKResponse = "OK";
+/**
+ *
+ @property redirectTo? (`string`) -
+    *    Example - `"https://my-app.com/catch-redirection"`
+    *    Format - uri*/
+export interface OptionsRedirectTo {
+    /**
+     *
+     *    Example - `"https://my-app.com/catch-redirection"`
+     *    Format - uri
+     */
+    redirectTo?: string;
+}
+/**
+ *
+ @property rp (`RelyingPartyEntity`) -
+ @property user (`UserEntity`) -
+ @property challenge (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property pubKeyCredParams (`CredentialParameter[]`) - The desired credential types and their respective cryptographic parameters
+ @property timeout? (`number`) - A time, in milliseconds, that the caller is willing to wait for the call to complete
+ @property excludeCredentials? (`PublicKeyCredentialDescriptor[]`) - A list of PublicKeyCredentialDescriptor objects representing public key credentials that are not acceptable to the caller
+ @property authenticatorSelection? (`AuthenticatorSelection`) -
+ @property hints? (`PublicKeyCredentialHints[]`) - Hints to help guide the user through the experience
+ @property attestation? (`ConveyancePreference`) - The attestation conveyance preference
+ @property attestationFormats? (`AttestationFormat[]`) - The preferred attestation statement formats
+ @property extensions? (`Record<string, unknown>`) - Additional parameters requesting additional processing by the client and authenticator*/
+export interface PublicKeyCredentialCreationOptions {
+    /**
+     *
+     */
+    rp: RelyingPartyEntity;
+    /**
+     *
+     */
+    user: UserEntity;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    challenge: string;
+    /**
+     * The desired credential types and their respective cryptographic parameters
+     */
+    pubKeyCredParams: CredentialParameter[];
+    /**
+     * A time, in milliseconds, that the caller is willing to wait for the call to complete
+     */
+    timeout?: number;
+    /**
+     * A list of PublicKeyCredentialDescriptor objects representing public key credentials that are not acceptable to the caller
+     */
+    excludeCredentials?: PublicKeyCredentialDescriptor[];
+    /**
+     *
+     */
+    authenticatorSelection?: AuthenticatorSelection;
+    /**
+     * Hints to help guide the user through the experience
+     */
+    hints?: PublicKeyCredentialHints[];
+    /**
+     * The attestation conveyance preference
+     */
+    attestation?: ConveyancePreference;
+    /**
+     * The preferred attestation statement formats
+     */
+    attestationFormats?: AttestationFormat[];
+    /**
+     * Additional parameters requesting additional processing by the client and authenticator
+     */
+    extensions?: Record<string, unknown>;
+}
+/**
+ *
+ @property type (`CredentialType`) - The valid credential types
+ @property id (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property transports? (`AuthenticatorTransport[]`) - The authenticator transports that can be used*/
+export interface PublicKeyCredentialDescriptor {
+    /**
+     * The valid credential types
+     */
+    type: CredentialType;
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    id: string;
+    /**
+     * The authenticator transports that can be used
+     */
+    transports?: AuthenticatorTransport[];
+}
+/**
+ * Hints to help guide the user through the experience
+ */
+export type PublicKeyCredentialHints = "security-key" | "client-device" | "hybrid";
+/**
+ *
+ @property challenge (`string`) - Base64url-encoded binary data
+    *    Format - byte
+ @property timeout? (`number`) - A time, in milliseconds, that the caller is willing to wait for the call to complete
+ @property rpId? (`string`) - The RP ID the credential should be scoped to
+ @property allowCredentials? (`PublicKeyCredentialDescriptor[]`) - A list of CredentialDescriptor objects representing public key credentials acceptable to the caller
+ @property userVerification? (`UserVerificationRequirement`) - A requirement for user verification for the operation
+ @property hints? (`PublicKeyCredentialHints[]`) - Hints to help guide the user through the experience
+ @property extensions? (`Record<string, unknown>`) - Additional parameters requesting additional processing by the client and authenticator*/
+export interface PublicKeyCredentialRequestOptions {
+    /**
+     * Base64url-encoded binary data
+     *    Format - byte
+     */
+    challenge: string;
+    /**
+     * A time, in milliseconds, that the caller is willing to wait for the call to complete
+     */
+    timeout?: number;
+    /**
+     * The RP ID the credential should be scoped to
+     */
+    rpId?: string;
+    /**
+     * A list of CredentialDescriptor objects representing public key credentials acceptable to the caller
+     */
+    allowCredentials?: PublicKeyCredentialDescriptor[];
+    /**
+     * A requirement for user verification for the operation
+     */
+    userVerification?: UserVerificationRequirement;
+    /**
+     * Hints to help guide the user through the experience
+     */
+    hints?: PublicKeyCredentialHints[];
+    /**
+     * Additional parameters requesting additional processing by the client and authenticator
+     */
+    extensions?: Record<string, unknown>;
+}
+/**
+ * Request to refresh an access token
+ @property refreshToken (`string`) - Refresh token used to generate a new access token
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b*/
+export interface RefreshTokenRequest {
+    /**
+     * Refresh token used to generate a new access token
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    refreshToken: string;
+}
+/**
+ *
+ @property name (`string`) - A human-palatable name for the entity
+ @property id (`string`) - A unique identifier for the Relying Party entity, which sets the RP ID*/
+export interface RelyingPartyEntity {
+    /**
+     * A human-palatable name for the entity
+     */
+    name: string;
+    /**
+     * A unique identifier for the Relying Party entity, which sets the RP ID
+     */
+    id: string;
+}
+/**
+ * The resident key requirement
+ */
+export type ResidentKeyRequirement = "discouraged" | "preferred" | "required";
+/**
+ * User authentication session containing tokens and user information
+ @property accessToken (`string`) - JWT token for authenticating API requests
+    *    Example - `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."`
+ @property accessTokenExpiresIn (`number`) - Expiration time of the access token in seconds
+    *    Example - `900`
+    *    Format - int64
+ @property refreshTokenId (`string`) - Identifier for the refresh token
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+ @property refreshToken (`string`) - Token used to refresh the access token
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+ @property user? (`User`) - User profile and account information*/
+export interface Session {
+    /**
+     * JWT token for authenticating API requests
+     *    Example - `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."`
+     */
+    accessToken: string;
+    /**
+     * Expiration time of the access token in seconds
+     *    Example - `900`
+     *    Format - int64
+     */
+    accessTokenExpiresIn: number;
+    /**
+     * Identifier for the refresh token
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    refreshTokenId: string;
+    /**
+     * Token used to refresh the access token
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    refreshToken: string;
+    /**
+     * User profile and account information
+     */
+    user?: User;
+}
+/**
+ * Container for session information
+ @property session? (`Session`) - User authentication session containing tokens and user information*/
+export interface SessionPayload {
+    /**
+     * User authentication session containing tokens and user information
+     */
+    session?: Session;
+}
+/**
+ *
+ @property displayName? (`string`) -
+    *    Example - `"John Smith"`
+ @property locale? (`string`) - A two-characters locale
+    *    Example - `"en"`
+    *    MinLength - 2
+    *    MaxLength - 2
+ @property metadata? (`Record<string, unknown>`) -
+    *    Example - `{"firstName":"John","lastName":"Smith"}`*/
+export interface SignInAnonymousRequest {
+    /**
+     *
+     *    Example - `"John Smith"`
+     */
+    displayName?: string;
+    /**
+     * A two-characters locale
+     *    Example - `"en"`
+     *    MinLength - 2
+     *    MaxLength - 2
+     */
+    locale?: string;
+    /**
+     *
+     *    Example - `{"firstName":"John","lastName":"Smith"}`
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Request to authenticate using email and password
+ @property email (`string`) - User's email address
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property password (`string`) - User's password
+    *    Example - `"Str0ngPassw#ord-94|%"`
+    *    MinLength - 3
+    *    MaxLength - 50*/
+export interface SignInEmailPasswordRequest {
+    /**
+     * User's email address
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     * User's password
+     *    Example - `"Str0ngPassw#ord-94|%"`
+     *    MinLength - 3
+     *    MaxLength - 50
+     */
+    password: string;
+}
+/**
+ * Response for email-password authentication that may include a session or MFA challenge
+ @property session? (`Session`) - User authentication session containing tokens and user information
+ @property mfa? (`MFAChallengePayload`) - Challenge payload for multi-factor authentication*/
+export interface SignInEmailPasswordResponse {
+    /**
+     * User authentication session containing tokens and user information
+     */
+    session?: Session;
+    /**
+     * Challenge payload for multi-factor authentication
+     */
+    mfa?: MFAChallengePayload;
+}
+/**
+ *
+ @property provider (`IdTokenProvider`) -
+ @property idToken (`string`) - Apple ID token
+ @property nonce? (`string`) - Nonce used during sign in process
+ @property options? (`SignUpOptions`) - */
+export interface SignInIdTokenRequest {
+    /**
+     *
+     */
+    provider: IdTokenProvider;
+    /**
+     * Apple ID token
+     */
+    idToken: string;
+    /**
+     * Nonce used during sign in process
+     */
+    nonce?: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property ticket (`string`) - Ticket
+    *    Pattern - ^mfaTotp:.*$
+ @property otp (`string`) - One time password*/
+export interface SignInMfaTotpRequest {
+    /**
+     * Ticket
+     *    Pattern - ^mfaTotp:.*$
+     */
+    ticket: string;
+    /**
+     * One time password
+     */
+    otp: string;
+}
+/**
+ *
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`SignUpOptions`) - */
+export interface SignInOTPEmailRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property otp (`string`) - One time password
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email*/
+export interface SignInOTPEmailVerifyRequest {
+    /**
+     * One time password
+     */
+    otp: string;
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+}
+/**
+ *
+ @property session? (`Session`) - User authentication session containing tokens and user information*/
+export interface SignInOTPEmailVerifyResponse {
+    /**
+     * User authentication session containing tokens and user information
+     */
+    session?: Session;
+}
+/**
+ *
+ @property personalAccessToken (`string`) - PAT
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b*/
+export interface SignInPATRequest {
+    /**
+     * PAT
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    personalAccessToken: string;
+}
+/**
+ *
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`SignUpOptions`) - */
+export interface SignInPasswordlessEmailRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property phoneNumber (`string`) - Phone number of the user
+    *    Example - `"+123456789"`
+ @property otp (`string`) - One-time password received by SMS*/
+export interface SignInPasswordlessSmsOtpRequest {
+    /**
+     * Phone number of the user
+     *    Example - `"+123456789"`
+     */
+    phoneNumber: string;
+    /**
+     * One-time password received by SMS
+     */
+    otp: string;
+}
+/**
+ *
+ @property session? (`Session`) - User authentication session containing tokens and user information
+ @property mfa? (`MFAChallengePayload`) - Challenge payload for multi-factor authentication*/
+export interface SignInPasswordlessSmsOtpResponse {
+    /**
+     * User authentication session containing tokens and user information
+     */
+    session?: Session;
+    /**
+     * Challenge payload for multi-factor authentication
+     */
+    mfa?: MFAChallengePayload;
+}
+/**
+ *
+ @property phoneNumber (`string`) - Phone number of the user
+    *    Example - `"+123456789"`
+ @property options? (`SignUpOptions`) - */
+export interface SignInPasswordlessSmsRequest {
+    /**
+     * Phone number of the user
+     *    Example - `"+123456789"`
+     */
+    phoneNumber: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property email? (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email*/
+export interface SignInWebauthnRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email?: string;
+}
+/**
+ *
+ @property email? (`string`) - A valid email. Deprecated, no longer used
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property credential (`CredentialAssertionResponse`) - */
+export interface SignInWebauthnVerifyRequest {
+    /**
+     * A valid email. Deprecated, no longer used
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email?: string;
+    /**
+     *
+     */
+    credential: CredentialAssertionResponse;
+}
+/**
+ *
+ @property refreshToken? (`string`) - Refresh token for the current session
+ @property all? (`boolean`) - Sign out from all connected devices*/
+export interface SignOutRequest {
+    /**
+     * Refresh token for the current session
+     */
+    refreshToken?: string;
+    /**
+     * Sign out from all connected devices
+     */
+    all?: boolean;
+}
+/**
+ * Request to register a new user with email and password
+ @property email (`string`) - Email address for the new user account
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property password (`string`) - Password for the new user account
+    *    Example - `"Str0ngPassw#ord-94|%"`
+    *    MinLength - 3
+    *    MaxLength - 50
+ @property options? (`SignUpOptions`) - */
+export interface SignUpEmailPasswordRequest {
+    /**
+     * Email address for the new user account
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     * Password for the new user account
+     *    Example - `"Str0ngPassw#ord-94|%"`
+     *    MinLength - 3
+     *    MaxLength - 50
+     */
+    password: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property allowedRoles? (`string[]`) -
+    *    Example - `["me","user"]`
+ @property defaultRole? (`string`) -
+    *    Example - `"user"`
+ @property displayName? (`string`) -
+    *    Example - `"John Smith"`
+    *    Pattern - ^[\p{L}\p{N}\p{S} ,.'-]+$
+    *    MaxLength - 32
+ @property locale? (`string`) - A two-characters locale
+    *    Example - `"en"`
+    *    MinLength - 2
+    *    MaxLength - 2
+ @property metadata? (`Record<string, unknown>`) -
+    *    Example - `{"firstName":"John","lastName":"Smith"}`
+ @property redirectTo? (`string`) -
+    *    Example - `"https://my-app.com/catch-redirection"`
+    *    Format - uri*/
+export interface SignUpOptions {
+    /**
+     *
+     *    Example - `["me","user"]`
+     */
+    allowedRoles?: string[];
+    /**
+     *
+     *    Example - `"user"`
+     */
+    defaultRole?: string;
+    /**
+     *
+     *    Example - `"John Smith"`
+     *    Pattern - ^[\p{L}\p{N}\p{S} ,.'-]+$
+     *    MaxLength - 32
+     */
+    displayName?: string;
+    /**
+     * A two-characters locale
+     *    Example - `"en"`
+     *    MinLength - 2
+     *    MaxLength - 2
+     */
+    locale?: string;
+    /**
+     *
+     *    Example - `{"firstName":"John","lastName":"Smith"}`
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     *
+     *    Example - `"https://my-app.com/catch-redirection"`
+     *    Format - uri
+     */
+    redirectTo?: string;
+}
+/**
+ *
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`SignUpOptions`) - */
+export interface SignUpWebauthnRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property credential (`CredentialCreationResponse`) -
+ @property options? (`SignUpOptions`) -
+ @property nickname? (`string`) - Nickname for the security key*/
+export interface SignUpWebauthnVerifyRequest {
+    /**
+     *
+     */
+    credential: CredentialCreationResponse;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+    /**
+     * Nickname for the security key
+     */
+    nickname?: string;
+}
+/**
+ * Response containing TOTP setup information for MFA
+ @property imageUrl (`string`) - URL to QR code image for scanning with an authenticator app
+    *    Example - `"data:image/png;base64,iVBORw0KGg..."`
+ @property totpSecret (`string`) - TOTP secret key for manual setup with an authenticator app
+    *    Example - `"ABCDEFGHIJK23456"`*/
+export interface TotpGenerateResponse {
+    /**
+     * URL to QR code image for scanning with an authenticator app
+     *    Example - `"data:image/png;base64,iVBORw0KGg..."`
+     */
+    imageUrl: string;
+    /**
+     * TOTP secret key for manual setup with an authenticator app
+     *    Example - `"ABCDEFGHIJK23456"`
+     */
+    totpSecret: string;
+}
+/**
+ * Base64url-encoded binary data
+ */
+export type URLEncodedBase64 = string;
+/**
+ * User profile and account information
+ @property avatarUrl (`string`) - URL to the user's profile picture
+    *    Example - `"https://myapp.com/avatars/user123.jpg"`
+ @property createdAt (`string`) - Timestamp when the user account was created
+    *    Example - `"2023-01-15T12:34:56Z"`
+    *    Format - date-time
+ @property defaultRole (`string`) - Default authorization role for the user
+    *    Example - `"user"`
+ @property displayName (`string`) - User's display name
+    *    Example - `"John Smith"`
+ @property email? (`string`) - User's email address
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property emailVerified (`boolean`) - Whether the user's email has been verified
+    *    Example - `true`
+ @property id (`string`) - Unique identifier for the user
+    *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+    *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+ @property isAnonymous (`boolean`) - Whether this is an anonymous user account
+    *    Example - `false`
+ @property locale (`string`) - User's preferred locale (language code)
+    *    Example - `"en"`
+    *    MinLength - 2
+    *    MaxLength - 2
+ @property metadata (`Record<string, unknown>`) - Custom metadata associated with the user
+    *    Example - `{"firstName":"John","lastName":"Smith"}`
+ @property phoneNumber? (`string`) - User's phone number
+    *    Example - `"+12025550123"`
+ @property phoneNumberVerified (`boolean`) - Whether the user's phone number has been verified
+    *    Example - `false`
+ @property roles (`string[]`) - List of roles assigned to the user
+    *    Example - `["user","customer"]`
+ @property activeMfaType? (`string`) - Active MFA type for the user*/
+export interface User {
+    /**
+     * URL to the user's profile picture
+     *    Example - `"https://myapp.com/avatars/user123.jpg"`
+     */
+    avatarUrl: string;
+    /**
+     * Timestamp when the user account was created
+     *    Example - `"2023-01-15T12:34:56Z"`
+     *    Format - date-time
+     */
+    createdAt: string;
+    /**
+     * Default authorization role for the user
+     *    Example - `"user"`
+     */
+    defaultRole: string;
+    /**
+     * User's display name
+     *    Example - `"John Smith"`
+     */
+    displayName: string;
+    /**
+     * User's email address
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email?: string;
+    /**
+     * Whether the user's email has been verified
+     *    Example - `true`
+     */
+    emailVerified: boolean;
+    /**
+     * Unique identifier for the user
+     *    Example - `"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"`
+     *    Pattern - \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
+     */
+    id: string;
+    /**
+     * Whether this is an anonymous user account
+     *    Example - `false`
+     */
+    isAnonymous: boolean;
+    /**
+     * User's preferred locale (language code)
+     *    Example - `"en"`
+     *    MinLength - 2
+     *    MaxLength - 2
+     */
+    locale: string;
+    /**
+     * Custom metadata associated with the user
+     *    Example - `{"firstName":"John","lastName":"Smith"}`
+     */
+    metadata: Record<string, unknown>;
+    /**
+     * User's phone number
+     *    Example - `"+12025550123"`
+     */
+    phoneNumber?: string;
+    /**
+     * Whether the user's phone number has been verified
+     *    Example - `false`
+     */
+    phoneNumberVerified: boolean;
+    /**
+     * List of roles assigned to the user
+     *    Example - `["user","customer"]`
+     */
+    roles: string[];
+    /**
+     * Active MFA type for the user
+     */
+    activeMfaType?: string;
+}
+/**
+ * Which sign-in method to use
+ */
+export type UserDeanonymizeRequestSignInMethod = "email-password" | "passwordless";
+/**
+ *
+ @property signInMethod (`UserDeanonymizeRequestSignInMethod`) - Which sign-in method to use
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property password? (`string`) - A password of minimum 3 characters
+    *    Example - `"Str0ngPassw#ord-94|%"`
+    *    MinLength - 3
+    *    MaxLength - 50
+ @property connection? (`string`) - Deprecated, will be ignored
+ @property options? (`SignUpOptions`) - */
+export interface UserDeanonymizeRequest {
+    /**
+     * Which sign-in method to use
+     */
+    signInMethod: UserDeanonymizeRequestSignInMethod;
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     * A password of minimum 3 characters
+     *    Example - `"Str0ngPassw#ord-94|%"`
+     *    MinLength - 3
+     *    MaxLength - 50
+     */
+    password?: string;
+    /**
+     * Deprecated, will be ignored
+     */
+    connection?: string;
+    /**
+     *
+     */
+    options?: SignUpOptions;
+}
+/**
+ *
+ @property newEmail (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`OptionsRedirectTo`) - */
+export interface UserEmailChangeRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    newEmail: string;
+    /**
+     *
+     */
+    options?: OptionsRedirectTo;
+}
+/**
+ *
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`OptionsRedirectTo`) - */
+export interface UserEmailSendVerificationEmailRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     *
+     */
+    options?: OptionsRedirectTo;
+}
+/**
+ *
+ @property name (`string`) - A human-palatable name for the entity
+ @property displayName (`string`) - A human-palatable name for the user account, intended only for display
+ @property id (`string`) - The user handle of the user account entity*/
+export interface UserEntity {
+    /**
+     * A human-palatable name for the entity
+     */
+    name: string;
+    /**
+     * A human-palatable name for the user account, intended only for display
+     */
+    displayName: string;
+    /**
+     * The user handle of the user account entity
+     */
+    id: string;
+}
+/**
+ * Type of MFA to activate. Use empty string to disable MFA.
+ */
+export type UserMfaRequestActiveMfaType = "totp" | "";
+/**
+ * Request to activate or deactivate multi-factor authentication
+ @property code (`string`) - Verification code from the authenticator app when activating MFA
+    *    Example - `"123456"`
+ @property activeMfaType? (`UserMfaRequestActiveMfaType`) - Type of MFA to activate. Use empty string to disable MFA.
+    *    Example - `"totp"`*/
+export interface UserMfaRequest {
+    /**
+     * Verification code from the authenticator app when activating MFA
+     *    Example - `"123456"`
+     */
+    code: string;
+    /**
+     * Type of MFA to activate. Use empty string to disable MFA.
+     *    Example - `"totp"`
+     */
+    activeMfaType?: UserMfaRequestActiveMfaType;
+}
+/**
+ *
+ @property newPassword (`string`) - A password of minimum 3 characters
+    *    Example - `"Str0ngPassw#ord-94|%"`
+    *    MinLength - 3
+    *    MaxLength - 50
+ @property ticket? (`string`) - Ticket to reset the password, required if the user is not authenticated
+    *    Pattern - ^passwordReset\:.*$*/
+export interface UserPasswordRequest {
+    /**
+     * A password of minimum 3 characters
+     *    Example - `"Str0ngPassw#ord-94|%"`
+     *    MinLength - 3
+     *    MaxLength - 50
+     */
+    newPassword: string;
+    /**
+     * Ticket to reset the password, required if the user is not authenticated
+     *    Pattern - ^passwordReset\:.*$
+     */
+    ticket?: string;
+}
+/**
+ *
+ @property email (`string`) - A valid email
+    *    Example - `"john.smith@nhost.io"`
+    *    Format - email
+ @property options? (`OptionsRedirectTo`) - */
+export interface UserPasswordResetRequest {
+    /**
+     * A valid email
+     *    Example - `"john.smith@nhost.io"`
+     *    Format - email
+     */
+    email: string;
+    /**
+     *
+     */
+    options?: OptionsRedirectTo;
+}
+/**
+ * A requirement for user verification for the operation
+ */
+export type UserVerificationRequirement = "required" | "preferred" | "discouraged";
+/**
+ *
+ @property credential (`CredentialCreationResponse`) -
+ @property nickname? (`string`) - Optional nickname for the security key*/
+export interface VerifyAddSecurityKeyRequest {
+    /**
+     *
+     */
+    credential: CredentialCreationResponse;
+    /**
+     * Optional nickname for the security key
+     */
+    nickname?: string;
+}
+/**
+ *
+ @property id (`string`) - The ID of the newly added security key
+    *    Example - `"123e4567-e89b-12d3-a456-426614174000"`
+ @property nickname? (`string`) - The nickname of the security key if provided*/
+export interface VerifyAddSecurityKeyResponse {
+    /**
+     * The ID of the newly added security key
+     *    Example - `"123e4567-e89b-12d3-a456-426614174000"`
+     */
+    id: string;
+    /**
+     * The nickname of the security key if provided
+     */
+    nickname?: string;
+}
+/**
+ *
+ @property token? (`string`) - JWT token to verify*/
+export interface VerifyTokenRequest {
+    /**
+     * JWT token to verify
+     */
+    token?: string;
+}
+/**
+ * Target URL for the redirect
+ */
+export type RedirectToQuery = string;
+/**
+ *
+ */
+export type SignInProvider = "apple" | "github" | "google" | "linkedin" | "discord" | "spotify" | "twitch" | "gitlab" | "bitbucket" | "workos" | "azuread" | "strava" | "facebook" | "windowslive" | "twitter";
+/**
+ * Ticket
+ */
+export type TicketQuery = string;
+/**
+ * Type of the ticket
+ */
+export type TicketTypeQuery = "emailVerify" | "emailConfirmChange" | "signinPasswordless" | "passwordReset";
+/**
+ *
+ @property version (`string`) - The version of the authentication service
+    *    Example - `"1.2.3"`*/
+export interface GetVersionResponse200 {
+    /**
+     * The version of the authentication service
+     *    Example - `"1.2.3"`
+     */
+    version: string;
+}
+/**
+ * Parameters for the signInProvider method.
+    @property allowedRoles? (string[]) - Array of allowed roles for the user
+  
+    @property defaultRole? (string) - Default role for the user
+  
+    @property displayName? (string) - Display name for the user
+  
+    @property locale? (string) - A two-characters locale
+  
+    @property metadata? (Record<string, unknown>) - Additional metadata for the user (JSON encoded string)
+  
+    @property redirectTo? (string) - URI to redirect to
+  
+    @property connect? (string) - If set, this means that the user is already authenticated and wants to link their account. This needs to be a valid JWT access token.
+  */
+export interface SignInProviderParams {
+    /**
+     * Array of allowed roles for the user
+    
+     */
+    allowedRoles?: string[];
+    /**
+     * Default role for the user
+    
+     */
+    defaultRole?: string;
+    /**
+     * Display name for the user
+    
+     */
+    displayName?: string;
+    /**
+     * A two-characters locale
+    
+     */
+    locale?: string;
+    /**
+     * Additional metadata for the user (JSON encoded string)
+    
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * URI to redirect to
+    
+     */
+    redirectTo?: string;
+    /**
+     * If set, this means that the user is already authenticated and wants to link their account. This needs to be a valid JWT access token.
+    
+     */
+    connect?: string;
+}
+/**
+ * Parameters for the verifyTicket method.
+    @property ticket (TicketQuery) - Ticket
+  
+    *    Ticket
+    @property type? (TicketTypeQuery) - Type of the ticket. Deprecated, no longer used
+  
+    *    Type of the ticket
+    @property redirectTo (RedirectToQuery) - Target URL for the redirect
+  
+    *    Target URL for the redirect*/
+export interface VerifyTicketParams {
+    /**
+     * Ticket
+    
+      *    Ticket
+     */
+    ticket: TicketQuery;
+    /**
+     * Type of the ticket. Deprecated, no longer used
+    
+      *    Type of the ticket
+     */
+    type?: TicketTypeQuery;
+    /**
+     * Target URL for the redirect
+    
+      *    Target URL for the redirect
+     */
+    redirectTo: RedirectToQuery;
+}
+export interface Client {
+    baseURL: string;
+    pushChainFunction(chainFunction: ChainFunction): void;
+    /**
+       Summary: Get public keys for JWT verification in JWK Set format
+       Retrieve the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures. This endpoint is used by clients to validate access tokens.
+  
+       This method may return different T based on the response code:
+       - 200: JWKSet
+       */
+    getJWKs(options?: RequestInit): Promise<FetchResponse<JWKSet>>;
+    /**
+       Summary: Elevate access for an already signed in user using FIDO2 Webauthn
+       Generate a Webauthn challenge for elevating user permissions
+  
+       This method may return different T based on the response code:
+       - 200: PublicKeyCredentialRequestOptions
+       */
+    elevateWebauthn(options?: RequestInit): Promise<FetchResponse<PublicKeyCredentialRequestOptions>>;
+    /**
+       Summary: Verify FIDO2 Webauthn authentication using public-key cryptography for elevation
+       Complete Webauthn elevation by verifying the authentication response
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    verifyElevateWebauthn(body: SignInWebauthnVerifyRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Health check (GET)
+       Verify if the authentication service is operational using GET method
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    healthCheckGet(options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Health check (HEAD)
+       Verify if the authentication service is operational using HEAD method
+  
+       This method may return different T based on the response code:
+       - 200: void
+       */
+    healthCheckHead(options?: RequestInit): Promise<FetchResponse<void>>;
+    /**
+       Summary: Link a user account with the provider's account using an id token
+       Link the authenticated user's account with an external OAuth provider account using an ID token. Requires elevated permissions.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    linkIdToken(body: LinkIdTokenRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Generate TOTP secret
+       Generate a Time-based One-Time Password (TOTP) secret for setting up multi-factor authentication
+  
+       This method may return different T based on the response code:
+       - 200: TotpGenerateResponse
+       */
+    changeUserMfa(options?: RequestInit): Promise<FetchResponse<TotpGenerateResponse>>;
+    /**
+       Summary: Create a Personal Access Token (PAT)
+       Generate a new Personal Access Token for programmatic API access. PATs are long-lived tokens that can be used instead of regular authentication for automated systems. Requires elevated permissions.
+  
+       This method may return different T based on the response code:
+       - 200: CreatePATResponse
+       */
+    createPAT(body: CreatePATRequest, options?: RequestInit): Promise<FetchResponse<CreatePATResponse>>;
+    /**
+       Summary: Sign in anonymously
+       Create an anonymous user session without providing credentials. Anonymous users can be converted to regular users later via the deanonymize endpoint.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    signInAnonymous(body?: SignInAnonymousRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Sign in with email and password
+       Authenticate a user with their email and password. Returns a session object or MFA challenge if two-factor authentication is enabled.
+  
+       This method may return different T based on the response code:
+       - 200: SignInEmailPasswordResponse
+       */
+    signInEmailPassword(body: SignInEmailPasswordRequest, options?: RequestInit): Promise<FetchResponse<SignInEmailPasswordResponse>>;
+    /**
+       Summary: Sign in with an ID token
+       Authenticate using an ID token from a supported OAuth provider (Apple or Google). Creates a new user account if one doesn't exist.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    signInIdToken(body: SignInIdTokenRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Verify TOTP for MFA
+       Complete the multi-factor authentication by verifying a Time-based One-Time Password (TOTP). Returns a session if validation is successful.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    verifySignInMfaTotp(body: SignInMfaTotpRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Sign in with email OTP
+       Initiate email-based one-time password authentication. Sends an OTP to the specified email address. If the user doesn't exist, a new account will be created with the provided options.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    signInOTPEmail(body: SignInOTPEmailRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Verify email OTP
+       Complete email OTP authentication by verifying the one-time password. Returns a session if validation is successful.
+  
+       This method may return different T based on the response code:
+       - 200: SignInOTPEmailVerifyResponse
+       */
+    verifySignInOTPEmail(body: SignInOTPEmailVerifyRequest, options?: RequestInit): Promise<FetchResponse<SignInOTPEmailVerifyResponse>>;
+    /**
+       Summary: Sign in with magic link email
+       Initiate passwordless authentication by sending a magic link to the user's email. If the user doesn't exist, a new account will be created with the provided options.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    signInPasswordlessEmail(body: SignInPasswordlessEmailRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Sign in with SMS OTP
+       Initiate passwordless authentication by sending a one-time password to the user's phone number. If the user doesn't exist, a new account will be created with the provided options.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    signInPasswordlessSms(body: SignInPasswordlessSmsRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Verify SMS OTP
+       Complete passwordless SMS authentication by verifying the one-time password. Returns a session if validation is successful.
+  
+       This method may return different T based on the response code:
+       - 200: SignInPasswordlessSmsOtpResponse
+       */
+    verifySignInPasswordlessSms(body: SignInPasswordlessSmsOtpRequest, options?: RequestInit): Promise<FetchResponse<SignInPasswordlessSmsOtpResponse>>;
+    /**
+       Summary: Sign in with Personal Access Token (PAT)
+       Authenticate using a Personal Access Token. PATs are long-lived tokens that can be used for programmatic access to the API.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    signInPAT(body: SignInPATRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Sign in with an OAuth2 provider
+       Initiate OAuth2 authentication flow with a social provider. Redirects the user to the provider's authorization page.
+  
+       As this method is a redirect, it returns a URL string instead of a Promise
+       */
+    signInProviderURL(provider: SignInProvider, params?: SignInProviderParams, options?: RequestInit): string;
+    /**
+       Summary: Sign in with Webauthn
+       Initiate a Webauthn sign-in process by sending a challenge to the user's device. The user must have previously registered a Webauthn credential.
+  
+       This method may return different T based on the response code:
+       - 200: PublicKeyCredentialRequestOptions
+       */
+    signInWebauthn(body?: SignInWebauthnRequest, options?: RequestInit): Promise<FetchResponse<PublicKeyCredentialRequestOptions>>;
+    /**
+       Summary: Verify Webauthn sign-in
+       Complete the Webauthn sign-in process by verifying the response from the user's device. Returns a session if validation is successful.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    verifySignInWebauthn(body: SignInWebauthnVerifyRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Sign out
+       End the current user session by invalidating refresh tokens. Optionally sign out from all devices.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    signOut(body: SignOutRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Sign up with email and password
+       Register a new user account with email and password. Returns a session if email verification is not required, otherwise returns null session.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    signUpEmailPassword(body: SignUpEmailPasswordRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Sign up with Webauthn
+       Initiate a Webauthn sign-up process by sending a challenge to the user's device. The user must not have an existing account.
+  
+       This method may return different T based on the response code:
+       - 200: PublicKeyCredentialCreationOptions
+       */
+    signUpWebauthn(body: SignUpWebauthnRequest, options?: RequestInit): Promise<FetchResponse<PublicKeyCredentialCreationOptions>>;
+    /**
+       Summary: Verify Webauthn sign-up
+       Complete the Webauthn sign-up process by verifying the response from the user's device. Returns a session if validation is successful.
+  
+       This method may return different T based on the response code:
+       - 200: SessionPayload
+       */
+    verifySignUpWebauthn(body: SignUpWebauthnVerifyRequest, options?: RequestInit): Promise<FetchResponse<SessionPayload>>;
+    /**
+       Summary: Refresh access token
+       Generate a new JWT access token using a valid refresh token. The refresh token used will be revoked and a new one will be issued.
+  
+       This method may return different T based on the response code:
+       - 200: Session
+       */
+    refreshToken(body: RefreshTokenRequest, options?: RequestInit): Promise<FetchResponse<Session>>;
+    /**
+       Summary: Verify JWT token
+       Verify the validity of a JWT access token. If no request body is provided, the Authorization header will be used for verification.
+  
+       This method may return different T based on the response code:
+       - 200: string
+       */
+    verifyToken(body?: VerifyTokenRequest, options?: RequestInit): Promise<FetchResponse<string>>;
+    /**
+       Summary: Get user information
+       Retrieve the authenticated user's profile information including roles, metadata, and account status.
+  
+       This method may return different T based on the response code:
+       - 200: User
+       */
+    getUser(options?: RequestInit): Promise<FetchResponse<User>>;
+    /**
+       Summary: Deanonymize an anonymous user
+       Convert an anonymous user to a regular user by adding email and optionally password credentials. A confirmation email will be sent if the server is configured to do so.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    deanonymizeUser(body: UserDeanonymizeRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Change user email
+       Request to change the authenticated user's email address. A verification email will be sent to the new address to confirm the change. Requires elevated permissions.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    changeUserEmail(body: UserEmailChangeRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Send verification email
+       Send an email verification link to the specified email address. Used to verify email addresses for new accounts or email changes.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    sendVerificationEmail(body: UserEmailSendVerificationEmailRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Manage multi-factor authentication
+       Activate or deactivate multi-factor authentication for the authenticated user
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    verifyChangeUserMfa(body: UserMfaRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Change user password
+       Change the user's password. The user must be authenticated with elevated permissions or provide a valid password reset ticket.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    changeUserPassword(body: UserPasswordRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Request password reset
+       Request a password reset for a user account. An email with a verification link will be sent to the user's email address to complete the password reset process.
+  
+       This method may return different T based on the response code:
+       - 200: OKResponse
+       */
+    sendPasswordResetEmail(body: UserPasswordResetRequest, options?: RequestInit): Promise<FetchResponse<OKResponse>>;
+    /**
+       Summary: Initialize adding of a new webauthn security key
+       Start the process of adding a new WebAuthn security key to the user's account. Returns a challenge that must be completed by the user's authenticator device. Requires elevated permissions.
+  
+       This method may return different T based on the response code:
+       - 200: PublicKeyCredentialCreationOptions
+       */
+    addSecurityKey(options?: RequestInit): Promise<FetchResponse<PublicKeyCredentialCreationOptions>>;
+    /**
+       Summary: Verify adding of a new webauthn security key
+       Complete the process of adding a new WebAuthn security key by verifying the authenticator response. Requires elevated permissions.
+  
+       This method may return different T based on the response code:
+       - 200: VerifyAddSecurityKeyResponse
+       */
+    verifyAddSecurityKey(body: VerifyAddSecurityKeyRequest, options?: RequestInit): Promise<FetchResponse<VerifyAddSecurityKeyResponse>>;
+    /**
+       Summary: Verify email and authentication tickets
+       Verify tickets created by email verification, magic link authentication, or password reset processes. Redirects the user to the appropriate destination upon successful verification.
+  
+       As this method is a redirect, it returns a URL string instead of a Promise
+       */
+    verifyTicketURL(params?: VerifyTicketParams, options?: RequestInit): string;
+    /**
+       Summary: Get service version
+       Retrieve version information about the authentication service
+  
+       This method may return different T based on the response code:
+       - 200: GetVersionResponse200
+       */
+    getVersion(options?: RequestInit): Promise<FetchResponse<GetVersionResponse200>>;
+}
+export declare const createAPIClient: (baseURL: string, chainFunctions?: ChainFunction[]) => Client;
+//# sourceMappingURL=client.d.ts.map