@wix/auto_sdk_identity_authentication 1.0.31 → 1.0.33

package/build/internal/cjs/index.typings.d.ts

@@ -30,13 +30,13 @@ interface LoginIdTypeOneOf {
     email?: string;
 }
 interface IdentityProfile {
-    /** Profile first name. */
+    /** Member's first name. */
     firstName?: string | null;
-    /** Profile last name. */
+    /** Member's last name. */
     lastName?: string | null;
-    /** Profile nickname. */
+    /** Member's display nickname. */
     nickname?: string | null;
-    /** Profile picture URL. */
+    /** URL to member's profile picture. */
     picture?: string | null;
     /**
      * Deprecated. Use `secondaryEmails` instead.
@@ -53,27 +53,27 @@ interface IdentityProfile {
      */
     phones?: string[];
     /**
-     * List of profile labels.
+     * Labels associated with the member.
      * @maxSize 2000
      */
     labels?: string[];
     /**
-     * Profile language.
+     * Member's preferred language code.
      * @format LANGUAGE
      */
     language?: string | null;
-    /** Profile privacy status. */
+    /** Member's profile visibility setting. */
     privacyStatus?: PrivacyStatusWithLiterals;
     /**
      * Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
      * are used to store additional information about your site or app's contacts.
      */
     customFields?: CustomField[];
-    /** List of profile email addresses. */
+    /** Additional email addresses for the member. */
     secondaryEmails?: SecondaryEmail[];
-    /** List of profile phone numbers. */
+    /** Phone numbers associated with the member. */
     phonesV2?: Phone[];
-    /** List of profile physical addresses. */
+    /** Physical addresses for the member. */
     addresses?: AddressWrapper[];
     /**
      * Company name.
@@ -86,79 +86,83 @@ interface IdentityProfile {
      */
     position?: string | null;
     /**
-     * Profile birthdate in `YYYY-MM-DD` format.
+     * Member's birth date in `YYYY-MM-DD` format.
      * @format LOCAL_DATE
      */
     birthdate?: string | null;
     /**
-     * Profile slug.
+     * URL-friendly slug for the member's profile.
      * @maxLength 255
      */
     slug?: string | null;
-    /** Consent to be added to mailing list */
+    /** Whether the member consents to receive marketing communications. */
     subscription?: boolean | null;
     /**
-     * Government id for personal/corporate (Vat ID).
+     * Tax ID or VAT number for personal or corporate use.
      * @maxLength 1000
      */
     vatId?: string | null;
 }
 declare enum PrivacyStatus {
-    /** No defined privacy status. */
+    /** No privacy status defined. */
     UNDEFINED = "UNDEFINED",
-    /** Profile details, such as profile name and profile picture, are visible to other members. */
+    /** Profile details are visible to other members. */
     PUBLIC = "PUBLIC",
-    /** Profile details aren't visible to other members. */
+    /** Profile details are hidden from other members. */
     PRIVATE = "PRIVATE"
 }
 /** @enumType */
 type PrivacyStatusWithLiterals = PrivacyStatus | 'UNDEFINED' | 'PUBLIC' | 'PRIVATE';
 interface CustomField {
     /**
-     * Custom field name. The name must match one of the key properties of the objects returned by
-     * [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
-     * with the `custom.` prefix removed.
+     * Custom field name matching an extended field key (without `custom.` prefix).
+     *
+     * Must match a key from [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields).
      */
     name?: string;
-    /** Custom field value. */
+    /** Value for the custom field. */
     value?: V1CustomValue;
 }
 interface V1CustomValue extends V1CustomValueValueOneOf {
-    /** String value. */
+    /** Text value. */
     strValue?: string;
-    /** Number value. */
+    /** Numeric value. */
     numValue?: number;
-    /** Date value. */
+    /** Date/time value. */
     dateValue?: Date | null;
-    /** Array of values. */
+    /** List of values. */
     listValue?: V1ListValue;
-    /** Map of values. */
+    /** Key-value pairs. */
     mapValue?: V1MapValue;
+    /** Bool value */
+    boolValue?: boolean;
 }
 /** @oneof */
 interface V1CustomValueValueOneOf {
-    /** String value. */
+    /** Text value. */
     strValue?: string;
-    /** Number value. */
+    /** Numeric value. */
     numValue?: number;
-    /** Date value. */
+    /** Date/time value. */
     dateValue?: Date | null;
-    /** Array of values. */
+    /** List of values. */
     listValue?: V1ListValue;
-    /** Map of values. */
+    /** Key-value pairs. */
     mapValue?: V1MapValue;
+    /** Bool value */
+    boolValue?: boolean;
 }
 interface V1ListValue {
-    /** Custom value. */
+    /** List of custom values. */
     value?: V1CustomValue[];
 }
 interface V1MapValue {
-    /** Mapped custom value. */
+    /** Map of custom field values. */
     value?: Record<string, V1CustomValue>;
 }
 interface SecondaryEmail {
     /**
-     * Email address.
+     * Secondary email address.
      * @format EMAIL
      */
     email?: string;
@@ -175,12 +179,12 @@ declare enum EmailTag {
 type EmailTagWithLiterals = EmailTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'WORK';
 interface Phone {
     /**
-     * Phone country code.
+     * Country code for the phone number.
      * @format COUNTRY
      */
     countryCode?: string | null;
     /**
-     * Phone number.
+     * Phone number without country code.
      * @format PHONE
      */
     phone?: string;
@@ -198,7 +202,7 @@ declare enum PhoneTag {
 /** @enumType */
 type PhoneTagWithLiterals = PhoneTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'MOBILE' | 'WORK' | 'FAX';
 interface AddressWrapper {
-    /** Address. */
+    /** Physical address details. */
     address?: Address;
     /** Address tag. */
     tag?: AddressTagWithLiterals;
@@ -267,11 +271,11 @@ declare enum StateType {
     UNKNOWN_STATE = "UNKNOWN_STATE",
     /** Login completed successfully. */
     SUCCESS = "SUCCESS",
-    /** Indicates that the member needs the owner to approve their registration. */
+    /** Member needs the owner to approve their registration. */
     REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
-    /** Indicates that the member needs to verify their email. */
+    /** Member needs to verify their email. */
     REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
-    /** Indicates that the `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
+    /** The `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
     STATUS_CHECK = "STATUS_CHECK"
 }
 /** @enumType */
@@ -313,8 +317,6 @@ interface Identity {
     email?: Email;
     /** Identity's current status. */
     status?: StatusV2;
-    /** Custom attributes. */
-    customAttributes?: Record<string, any> | null;
     /**
      * Identity verification factors.
      * @maxSize 10
@@ -546,91 +548,10 @@ interface WebAuthnChallengeData {
      */
     challengeId?: string;
     /**
-     * The challenge that will be signed by the authenticator during the WebAuthn authentication ceremony.
-     * This should be a cryptographically secure random value with at least 16 bytes of entropy.
-     * The value is used to prevent replay attacks and MUST be randomly generated by the implementer.
-     */
-    challenge?: Uint8Array;
-    /**
-     * The timeout in milliseconds for the WebAuthn authentication ceremony.
-     * After this time, the challenge will be considered expired and the authentication will need to be restarted.
-     * This is optional and may be overridden by the client if provided.
-     * The WebAuthn spec recommends a timeout of at least 1 minute (60000ms).
-     */
-    timeoutMs?: number | null;
-    /**
-     * Optional list of credentials that are acceptable for this authentication ceremony.
-     * If empty, all credentials associated with the user will be considered.
-     * @maxSize 50
-     */
-    allowCredentials?: PublicKeyCredentialDescriptor[];
-    /** Specifies the requirement for user verification during the authentication ceremony. */
-    userVerification?: UserVerificationRequirementWithLiterals;
-    /**
-     * Optional hints to guide the client UI
-     * Examples include "security-key" to emphasize external authenticators
-     * or "client-device" to emphasize built-in authenticators
-     * @maxLength 50
-     * @maxSize 10
-     */
-    hints?: string[];
-    /**
-     * Optional extensions for the authentication ceremony
-     * Provides additional parameters for specialized WebAuthn functionality
-     */
-    extensions?: AuthenticationExtensionInputs;
-}
-interface PublicKeyCredentialDescriptor {
-    /** The credential ID */
-    _id?: Uint8Array;
-    /**
-     * An optional hint as to the transports used by the credential
-     * Examples include "usb", "nfc", "ble", "internal", "hybrid"
-     * @maxLength 50
-     * @maxSize 10
-     */
-    transports?: string[];
-}
-declare enum UserVerificationRequirement {
-    /** Default unspecified value */
-    USER_VERIFICATION_UNSPECIFIED = "USER_VERIFICATION_UNSPECIFIED",
-    /**
-     * The Relying Party requires user verification and will fail the operation if the response doesn't have the UV flag
-     * set
-     */
-    USER_VERIFICATION_REQUIRED = "USER_VERIFICATION_REQUIRED",
-    /** The Relying Party prefers user verification but will not fail the operation if unavailable */
-    USER_VERIFICATION_PREFERRED = "USER_VERIFICATION_PREFERRED",
-    /** The Relying Party does not want user verification employed (e.g., to minimize disruption to the user experience) */
-    USER_VERIFICATION_DISCOURAGED = "USER_VERIFICATION_DISCOURAGED"
-}
-/** @enumType */
-type UserVerificationRequirementWithLiterals = UserVerificationRequirement | 'USER_VERIFICATION_UNSPECIFIED' | 'USER_VERIFICATION_REQUIRED' | 'USER_VERIFICATION_PREFERRED' | 'USER_VERIFICATION_DISCOURAGED';
-interface AuthenticationExtensionInputs extends AuthenticationExtensionInputsLargeBlobOperationOneOf {
-    /** Read existing large blob data from the authenticator */
-    largeBlobRead?: boolean;
-    /** Write data to the authenticator's large blob storage */
-    largeBlobWrite?: Uint8Array;
-    /**
-     * FIDO AppID Extension (appid)
-     * An AppID that was used for previously registered U2F authenticators
-     * This makes already-registered U2F credentials forward-compatible with the WebAuthn API
-     * @maxLength 256
-     */
-    appid?: string;
-    /**
-     * User Verification Method Extension (uvm)
-     * Requests the authenticator to report which verification methods were used
-     * Examples include fingerprint, PIN, or facial recognition
+     * A PublicKeyCredentialRequestOptions JSON as defined in the WebAuthn spec (https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialrequestoptions).
+     * @maxLength 40000
      */
-    uvm?: boolean;
-}
-/** @oneof */
-interface AuthenticationExtensionInputsLargeBlobOperationOneOf {
-    /** Read existing large blob data from the authenticator */
-    largeBlobRead?: boolean;
-    /** Write data to the authenticator's large blob storage */
-    largeBlobWrite?: Uint8Array;
+    publicKeyCredentialRequestOptionsJson?: string;
 }
 interface LoginV2Request {
     /** Identifier of identity logging in. */
@@ -673,7 +594,11 @@ interface ExternalEmailVerifyData {
     code?: string | null;
 }
 interface ChangePasswordRequest {
-    /** The new password to set for the logged in user */
+    /**
+     * New password to set for the logged-in member.
+     *
+     * The password must meet the site's configured password requirements for length and complexity.
+     */
     newPassword: string;
 }
 interface ChangePasswordResponse {
@@ -698,8 +623,24 @@ interface LoginWithIdpConnectionRequest {
      * Encryption key should be base64 encoded. Encryption is done using AES-GCM with a random IV that's sent alongside the payload
      */
     sessionId?: string;
+    /**
+     * Base64-encoded encryption key for securing the authentication response.
+     *
+     * Used to encrypt the authentication response sent via BroadcastChannel API.
+     * Encryption uses AES-GCM with a random IV.
+     */
     encryptionKey?: string;
+    /**
+     * Visitor ID for tracking purposes.
+     *
+     * Optional identifier for analytics and tracking the authentication flow.
+     */
     visitorId?: string | null;
+    /**
+     * Browser session identifier.
+     *
+     * Optional identifier for correlating the authentication request with browser session data.
+     */
     bsi?: string | null;
 }
 declare enum TenantType {
@@ -754,58 +695,122 @@ interface LoginWithIdpConnectionTokenParamsRequest {
     tokenParams?: Record<string, string>;
 }
 interface SignOnRequest {
-    /** the identifier of the identity */
+    /**
+     * Member identifier for authentication.
+     *
+     * Currently only email addresses are supported.
+     */
     loginId: LoginId;
-    /** profile of the identity */
+    /**
+     * Member profile information.
+     *
+     * Profile data such as first name, last name, and other member details.
+     * If the member already exists, provided profile information will update the existing member's profile.
+     * If the member doesn't exist, this profile information is used to create the new member.
+     */
     profile?: IdentityProfile;
-    /** when true will mark the email of the identity as verified */
+    /**
+     * Whether to mark the member's email as verified without requiring verification.
+     *
+     * When `true`, marks the email as verified without requiring verification.
+     * Use with caution in production as this bypasses security verification.
+     *
+     * Default: `false`
+     */
     verifyEmail?: boolean;
-    /** when false will create a new contact instead of merging the existing contact into the identity */
+    /**
+     * Whether to merge with an existing contact with the same email address.
+     *
+     * When `true`, links the member to an existing contact record with the same email
+     * and inherits contact data. When `false`, creates a new contact record.
+     *
+     * Default: `true`
+     */
     mergeExistingContact?: boolean;
 }
 interface SignOnResponse {
-    /** session token for the requested identity */
+    /**
+     * Session token for the authenticated member.
+     *
+     * Use this token to obtain access and refresh tokens for subsequent API calls.
+     */
     sessionToken?: string;
-    /** The Identity of the provided login_id */
+    /**
+     * Member identity information.
+     *
+     * Contains the member's identity details after successful authentication.
+     */
     identity?: Identity;
 }
 /** logout request payload */
 interface LogoutRequest {
     /**
-     * redirect after logout
+     * URL to redirect to after logout.
+     *
+     * Optional redirect destination after the logout process completes.
      * @format WEB_URL
      */
     postLogoutRedirectUri?: string | null;
     /**
-     * caller identifier
+     * Client identifier for the logout request.
+     *
+     * Identifies the application or client initiating the logout.
      * @format GUID
      */
     clientId?: string | null;
 }
 interface VerifyRequest extends VerifyRequestFactorDataOneOf {
+    /** SMS verification code sent to the member's phone number. */
     smsData?: SmsVerifyData;
+    /** Voice call verification code received by the member. */
     callData?: CallVerifyData;
+    /** Email verification code sent to the member's email address. */
     emailData?: ExternalEmailVerifyData;
+    /** TOTP code from the member's authenticator app. */
     totpData?: TotpVerifyData;
+    /** Push notification authentication response from the member's device. */
     pushData?: PushVerifyData;
+    /** WebAuthn response from biometric or security key authentication. */
     webauthnData?: WebAuthnVerifyData;
+    /** RecoveryCode response from a one-time code. */
+    recoveryCodeData?: RecoveryCodeVerifyData;
     /**
-     * TODO: is this a reasonable maxLength?
+     * State token from the initial authentication response.
+     *
+     * Required to continue the multi-step authentication process.
      * @maxLength 1000
      */
     stateToken?: string;
-    factorType: FactorTypeWithLiterals;
-    /** Relevant for second factors only. */
+    /**
+     * Type of authentication factor being verified.
+     *
+     * Specifies which verification method is being used (SMS, email, TOTP, etc.).
+     */
+    factorType?: FactorTypeWithLiterals;
+    /**
+     * Whether to remember this device for future authentication.
+     *
+     * When `true`, reduces future authentication requirements for this device.
+     * Only applicable for second factor authentication.
+     */
     rememberThisDevice?: boolean;
 }
 /** @oneof */
 interface VerifyRequestFactorDataOneOf {
+    /** SMS verification code sent to the member's phone number. */
     smsData?: SmsVerifyData;
+    /** Voice call verification code received by the member. */
     callData?: CallVerifyData;
+    /** Email verification code sent to the member's email address. */
     emailData?: ExternalEmailVerifyData;
+    /** TOTP code from the member's authenticator app. */
     totpData?: TotpVerifyData;
+    /** Push notification authentication response from the member's device. */
     pushData?: PushVerifyData;
+    /** WebAuthn response from biometric or security key authentication. */
     webauthnData?: WebAuthnVerifyData;
+    /** RecoveryCode response from a one-time code. */
+    recoveryCodeData?: RecoveryCodeVerifyData;
 }
 interface SmsVerifyData {
     /**
@@ -832,10 +837,18 @@ interface PushVerifyData {
     /** @maxLength 36 */
     transactionId?: string | null;
 }
+interface RecoveryCodeVerifyData {
+    /**
+     * @minLength 1
+     * @maxLength 100
+     */
+    code?: string | null;
+}
 interface GetWebauthnChallengeRequest {
     /**
-     * Identifier of identity for which the WebAuthn challenge is requested for.
-     * If not provided an anonymous webAuthn challenge will be returned.
+     * Identifier of the member requesting the WebAuthn challenge.
+     *
+     * If not provided, returns an anonymous WebAuthn challenge for usernameless authentication.
      */
     loginId?: LoginId;
 }
@@ -967,7 +980,7 @@ type LoginV2ValidationErrors = {
  * @requiredField loginId
  * @fqn wix.iam.authentication.v1.AuthenticationService.RegisterV2
  */
-declare function registerV2(loginId: LoginId, options?: RegisterV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7> & {
+declare function registerV2(loginId: LoginId, options?: RegisterV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.customFields.${number}.value.boolValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7> & {
     __applicationErrorsType?: RegisterV2ApplicationErrors;
     __validationErrorsType?: RegisterV2ValidationErrors;
 }>;
@@ -992,7 +1005,7 @@ interface RegisterV2Options {
  * @requiredField loginId
  * @fqn wix.iam.authentication.v1.AuthenticationService.LoginV2
  */
-declare function loginV2(loginId: LoginId, options?: LoginV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7> & {
+declare function loginV2(loginId: LoginId, options?: LoginV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.customFields.${number}.value.boolValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7> & {
     __applicationErrorsType?: LoginV2ApplicationErrors;
     __validationErrorsType?: LoginV2ValidationErrors;
 }>;
@@ -1005,8 +1018,18 @@ interface LoginV2Options {
     clientMetaData?: Record<string, any> | null;
 }
 /**
- * Changes the password of a logged in user.
- * @param newPassword - The new password to set for the logged in user
+ * Changes the password of a logged-in member.
+ *
+ * Updates the password for an authenticated member. The member must have a valid session
+ * to use this method.
+ *
+ * The member's session remains valid after password change.
+ *
+ * The new password must meet the site's configured password requirements for length
+ * and complexity. These requirements are enforced automatically when processing the request.
+ * @param newPassword - New password to set for the logged-in member.
+ *
+ * The password must meet the site's configured password requirements for length and complexity.
  * @public
  * @documentationMaturity preview
  * @requiredField newPassword
@@ -1014,7 +1037,15 @@ interface LoginV2Options {
  * @fqn wix.iam.authentication.v1.AuthenticationService.ChangePassword
  */
 declare function changePassword(newPassword: string): Promise<void>;
-/** @param loginId - the identifier of the identity
+/**
+ * Authenticates a member without credentials and returns a session token.
+ *
+ * This method provides authentication that automatically creates or updates
+ * member accounts as needed during the authentication process.
+ * Use this for trusted integrations and scenarios where you already have verified user information.
+ * @param loginId - Member identifier for authentication.
+ *
+ * Currently only email addresses are supported.
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
@@ -1022,17 +1053,44 @@ declare function changePassword(newPassword: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.iam.authentication.v1.AuthenticationService.SignOn
  */
-declare function signOn(loginId: LoginId, options?: SignOnOptions): Promise<NonNullablePaths<SignOnResponse, `sessionToken` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7>>;
+declare function signOn(loginId: LoginId, options?: SignOnOptions): Promise<NonNullablePaths<SignOnResponse, `sessionToken` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.customFields.${number}.value.boolValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7>>;
 interface SignOnOptions {
-    /** profile of the identity */
+    /**
+     * Member profile information.
+     *
+     * Profile data such as first name, last name, and other member details.
+     * If the member already exists, provided profile information will update the existing member's profile.
+     * If the member doesn't exist, this profile information is used to create the new member.
+     */
     profile?: IdentityProfile;
-    /** when true will mark the email of the identity as verified */
+    /**
+     * Whether to mark the member's email as verified without requiring verification.
+     *
+     * When `true`, marks the email as verified without requiring verification.
+     * Use with caution in production as this bypasses security verification.
+     *
+     * Default: `false`
+     */
     verifyEmail?: boolean;
-    /** when false will create a new contact instead of merging the existing contact into the identity */
+    /**
+     * Whether to merge with an existing contact with the same email address.
+     *
+     * When `true`, links the member to an existing contact record with the same email
+     * and inherits contact data. When `false`, creates a new contact record.
+     *
+     * Default: `true`
+     */
     mergeExistingContact?: boolean;
 }
 /**
- * Logs out a member.
+ * Terminates the member's session and clears authentication cookies.
+ *
+ * Returns the following:
+ * - `body`: HTML content for the logout response
+ * - `statusCode`: HTTP status code (200 for success, 302 for redirect)
+ * - `headers`: Array of key-value pairs including:
+ * - `Set-Cookie` headers to remove all session cookies
+ * - `Location` header (when `postLogoutRedirectUri` is provided, with 302 status)
  * @public
  * @documentationMaturity preview
  * @fqn wix.iam.authentication.v1.AuthenticationService.Logout
@@ -1040,45 +1098,19 @@ interface SignOnOptions {
 declare function logout(options?: LogoutOptions): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 4>>;
 interface LogoutOptions {
     /**
-     * redirect after logout
+     * URL to redirect to after logout.
+     *
+     * Optional redirect destination after the logout process completes.
      * @format WEB_URL
      */
     postLogoutRedirectUri?: string | null;
     /**
-     * caller identifier
+     * Client identifier for the logout request.
+     *
+     * Identifies the application or client initiating the logout.
      * @format GUID
      */
     clientId?: string | null;
 }
-/** @public
- * @documentationMaturity preview
- * @requiredField factorType
- * @fqn wix.iam.authentication.v1.AuthenticationService.Verify
- */
-declare function verify(factorType: FactorTypeWithLiterals, options?: VerifyOptions): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`, 7>>;
-interface VerifyOptions extends VerifyOptionsFactorDataOneOf {
-    /**
-     * TODO: is this a reasonable maxLength?
-     * @maxLength 1000
-     */
-    stateToken?: string;
-    /** Relevant for second factors only. */
-    rememberThisDevice?: boolean;
-    smsData?: SmsVerifyData;
-    callData?: CallVerifyData;
-    emailData?: ExternalEmailVerifyData;
-    totpData?: TotpVerifyData;
-    pushData?: PushVerifyData;
-    webauthnData?: WebAuthnVerifyData;
-}
-/** @oneof */
-interface VerifyOptionsFactorDataOneOf {
-    smsData?: SmsVerifyData;
-    callData?: CallVerifyData;
-    emailData?: ExternalEmailVerifyData;
-    totpData?: TotpVerifyData;
-    pushData?: PushVerifyData;
-    webauthnData?: WebAuthnVerifyData;
-}
 
-export { type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticationExtensionInputs, type AuthenticationExtensionInputsLargeBlobOperationOneOf, type AuthenticatorConnection, type CallVerifyData, type CaptchaToken, type CaptchaTokenTokenOneOf, type ChangePasswordRequest, type ChangePasswordResponse, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, type Email, EmailTag, type EmailTagWithLiterals, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PublicKeyCredentialDescriptor, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, UserVerificationRequirement, type UserVerificationRequirementWithLiterals, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyOptions, type VerifyOptionsFactorDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, changePassword, loginV2, logout, registerV2, signOn, verify };
+export { type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, type CaptchaToken, type CaptchaTokenTokenOneOf, type ChangePasswordRequest, type ChangePasswordResponse, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, type Email, EmailTag, type EmailTagWithLiterals, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, changePassword, loginV2, logout, registerV2, signOn };