@wix/identity 1.0.50 → 1.0.51

package/build/es/src/iam-authentication-v1-authentication.types.d.ts

@@ -10,25 +10,35 @@ export interface RegisterRequest {
 export interface Identity {
     /** Identity ID */
     id?: string | null;
+    /** Identifiers */
     identifiers?: Identifier[];
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes.
+     * For an update operation to succeed, you MUST pass the latest revision.
+     */
     revision?: string | null;
     /**
-     * Represents the time this Identity was created
+     * The time this identity was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this Identity was last updated
+     * The time this identity was last updated.
      * @readonly
      */
     updatedDate?: Date;
-    /** All the identity configured connections to authenticate with */
+    /** The identity configured connections to authenticate with. */
     connections?: Connection[];
+    /** Identity profile. */
     identityProfile?: IdentityProfile;
-    /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
+    /**
+     * Additional information about the identity that can impact user access.
+     * This data cannot be set.
+     */
     metadata?: Metadata;
+    /** Identity email address. */
     email?: Email;
+    /** Identity's current status. */
     status?: StatusV2;
 }
 export interface Identifier extends IdentifierValueOneOf {
@@ -41,39 +51,65 @@ export interface IdentifierValueOneOf {
     userName?: string;
 }
 export interface Connection extends ConnectionTypeOneOf {
+    /** IDP connection. */
     idpConnection?: IdpConnection;
+    /** Authenticator connection. */
     authenticatorConnection?: AuthenticatorConnection;
 }
 /** @oneof */
 export interface ConnectionTypeOneOf {
+    /** IDP connection. */
     idpConnection?: IdpConnection;
+    /** Authenticator connection. */
     authenticatorConnection?: AuthenticatorConnection;
 }
 export interface IdpConnection {
+    /** IDP connection ID. */
     idpConnectionId?: string;
+    /** IDP user ID. */
     idpUserId?: string;
 }
 export interface AuthenticatorConnection {
+    /** Authenticator connection ID. */
     authenticatorConnectionId?: string;
+    /** Whether re-enrollment is required. */
     reEnrollmentRequired?: boolean;
 }
 export interface IdentityProfile {
+    /** Profile first name. */
     firstName?: string | null;
+    /** Profile last name. */
     lastName?: string | null;
+    /** Profile nickname. */
     nickname?: string | null;
+    /** Profile picture URL. */
     picture?: string | null;
+    /** Deprecated. Use `secondaryEmails` instead. */
     emails?: string[];
+    /** Deprecated. Use `phonesV2` instead. */
     phones?: string[];
+    /** List of profile labels. */
     labels?: string[];
+    /** Profile language. */
     language?: string | null;
+    /** Profile privacy status. */
     privacyStatus?: PrivacyStatus;
-    /** custom profile fields */
+    /**
+     * 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. */
     secondaryEmails?: SecondaryEmail[];
+    /** List of profile phone numbers. */
     phonesV2?: Phone[];
+    /** List of profile physical addresses. */
     addresses?: AddressWrapper[];
+    /** Company name. */
     company?: string | null;
+    /** Position within company. */
     position?: string | null;
+    /** Profile birthdate. */
     birthdate?: string | null;
 }
 export declare enum PrivacyStatus {
@@ -82,32 +118,52 @@ export declare enum PrivacyStatus {
     PRIVATE = "PRIVATE"
 }
 export 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.
+     */
     name?: string;
+    /** Custom field value. */
     value?: CustomValue;
 }
 export interface CustomValue extends CustomValueValueOneOf {
+    /** String value. */
     strValue?: string;
+    /** Number value. */
     numValue?: number;
+    /** Date value. */
     dateValue?: Date;
+    /** List value. */
     listValue?: ListValue;
+    /** Map value. */
     mapValue?: MapValue;
 }
 /** @oneof */
 export interface CustomValueValueOneOf {
+    /** String value. */
     strValue?: string;
+    /** Number value. */
     numValue?: number;
+    /** Date value. */
     dateValue?: Date;
+    /** List value. */
     listValue?: ListValue;
+    /** Map value. */
     mapValue?: MapValue;
 }
 export interface ListValue {
+    /** Custom value. */
     value?: CustomValue[];
 }
 export interface MapValue {
+    /** Mapped custom value. */
     value?: Record<string, CustomValue>;
 }
 export interface SecondaryEmail {
+    /** Email address. */
     email?: string;
+    /** Email tag. */
     tag?: EmailTag;
 }
 export declare enum EmailTag {
@@ -117,8 +173,11 @@ export declare enum EmailTag {
     WORK = "WORK"
 }
 export interface Phone {
+    /** Phone country code. */
     countryCode?: string | null;
+    /** Phone number. */
     phone?: string;
+    /** Phone tag. */
     tag?: PhoneTag;
 }
 export declare enum PhoneTag {
@@ -130,7 +189,9 @@ export declare enum PhoneTag {
     FAX = "FAX"
 }
 export interface AddressWrapper {
+    /** Address. */
     address?: Address;
+    /** Address tag. */
     tag?: AddressTag;
 }
 /** Physical address */
@@ -217,33 +278,35 @@ export interface LoginRequest {
     loginId?: LoginId;
 }
 export interface LoginId extends LoginIdTypeOneOf {
+    /** Login email address. */
     email?: string;
 }
 /** @oneof */
 export interface LoginIdTypeOneOf {
+    /** Login email address. */
     email?: string;
 }
 export interface SuccessfulLoginEvent {
     identity?: Identity;
 }
 export interface RegisterV2Request {
-    /** the identifier of the identity */
+    /** Identifier of registering member. */
     loginId: LoginId;
-    /** the password of the identity */
+    /** Password of registering member. */
     password?: string;
-    /** profile of the identity */
+    /** Profile information of registering member. */
     profile?: IdentityProfile;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
 export interface StateMachineResponse {
-    /** The current state */
+    /** The current state of the login or registration process. */
     state?: StateType;
-    /** Session token - will be returned only when the state is success */
+    /** If state is `SUCCESS`, a session token. */
     sessionToken?: string | null;
-    /** State token */
+    /** A token representing the current state of the login or registration process. */
     stateToken?: string | null;
-    /** The current identity */
+    /** Identing of the current member. */
     identity?: Identity;
 }
 export declare enum StateType {
@@ -254,11 +317,11 @@ export declare enum StateType {
     STATUS_CHECK = "STATUS_CHECK"
 }
 export interface LoginV2Request {
-    /** the identifier of the identity */
+    /** Identifier of member logging in. */
     loginId: LoginId;
-    /** the password of the identity */
+    /** Password of the member logging in. */
     password?: string;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
 export interface LoginWithIdpConnectionRequest {
@@ -309,7 +372,14 @@ export interface QueryParametersEntry {
     key?: string;
     value?: string;
 }
+export interface LoginCallbackRequest {
+    /** state that that received on the redirect */
+    state?: string;
+    /** session token */
+    sessionToken?: string;
+}
 export interface ProceedToNextStateRequest {
+    /** State token received from the previous step in the registration or login process. */
     stateToken?: string;
 }
 export interface SignOnRequest {

package/build/es/src/iam-authentication-v1-authentication.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"iam-authentication-v1-authentication.types.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.types.ts"],"names":[],"mappings":"AAuFA,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAqCD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAQD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAuBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAoBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA0BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gEAAiD,CAAA;IACjD,4CAA6B,CAAA;AAC/B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AA+CD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IACzD,0CAA6B,CAAA;AAC/B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AA4BD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}
+{"version":3,"file":"iam-authentication-v1-authentication.types.js","sourceRoot":"","sources":["../../../src/iam-authentication-v1-authentication.types.ts"],"names":[],"mappings":"AA2HA,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAyDD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAWD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAyBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAoBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA0BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gEAAiD,CAAA;IACjD,4CAA6B,CAAA;AAC/B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAiDD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IACzD,0CAA6B,CAAA;AAC/B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AA4BD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}

package/build/es/src/iam-authentication-v1-authentication.universal.d.ts

@@ -16,25 +16,35 @@ export interface RegisterRequest {
 export interface Identity {
     /** Identity ID */
     _id?: string | null;
+    /** Identifiers */
     identifiers?: Identifier[];
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes.
+     * For an update operation to succeed, you MUST pass the latest revision.
+     */
     revision?: string | null;
     /**
-     * Represents the time this Identity was created
+     * The time this identity was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Identity was last updated
+     * The time this identity was last updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** All the identity configured connections to authenticate with */
+    /** The identity configured connections to authenticate with. */
     connections?: Connection[];
+    /** Identity profile. */
     identityProfile?: IdentityProfile;
-    /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
+    /**
+     * Additional information about the identity that can impact user access.
+     * This data cannot be set.
+     */
     metadata?: Metadata;
+    /** Identity email address. */
     email?: Email;
+    /** Identity's current status. */
     status?: StatusV2;
 }
 export interface Identifier extends IdentifierValueOneOf {
@@ -47,39 +57,65 @@ export interface IdentifierValueOneOf {
     userName?: string;
 }
 export interface Connection extends ConnectionTypeOneOf {
+    /** IDP connection. */
     idpConnection?: IdpConnection;
+    /** Authenticator connection. */
     authenticatorConnection?: AuthenticatorConnection;
 }
 /** @oneof */
 export interface ConnectionTypeOneOf {
+    /** IDP connection. */
     idpConnection?: IdpConnection;
+    /** Authenticator connection. */
     authenticatorConnection?: AuthenticatorConnection;
 }
 export interface IdpConnection {
+    /** IDP connection ID. */
     idpConnectionId?: string;
+    /** IDP user ID. */
     idpUserId?: string;
 }
 export interface AuthenticatorConnection {
+    /** Authenticator connection ID. */
     authenticatorConnectionId?: string;
+    /** Whether re-enrollment is required. */
     reEnrollmentRequired?: boolean;
 }
 export interface IdentityProfile {
+    /** Profile first name. */
     firstName?: string | null;
+    /** Profile last name. */
     lastName?: string | null;
+    /** Profile nickname. */
     nickname?: string | null;
+    /** Profile picture URL. */
     picture?: string | null;
+    /** Deprecated. Use `secondaryEmails` instead. */
     emails?: string[];
+    /** Deprecated. Use `phonesV2` instead. */
     phones?: string[];
+    /** List of profile labels. */
     labels?: string[];
+    /** Profile language. */
     language?: string | null;
+    /** Profile privacy status. */
     privacyStatus?: PrivacyStatus;
-    /** custom profile fields */
+    /**
+     * 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. */
     secondaryEmails?: SecondaryEmail[];
+    /** List of profile phone numbers. */
     phonesV2?: Phone[];
+    /** List of profile physical addresses. */
     addresses?: AddressWrapper[];
+    /** Company name. */
     company?: string | null;
+    /** Position within company. */
     position?: string | null;
+    /** Profile birthdate. */
     birthdate?: string | null;
 }
 export declare enum PrivacyStatus {
@@ -88,32 +124,52 @@ export declare enum PrivacyStatus {
     PRIVATE = "PRIVATE"
 }
 export 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.
+     */
     name?: string;
+    /** Custom field value. */
     value?: CustomValue;
 }
 export interface CustomValue extends CustomValueValueOneOf {
+    /** String value. */
     strValue?: string;
+    /** Number value. */
     numValue?: number;
+    /** Date value. */
     dateValue?: Date;
+    /** List value. */
     listValue?: ListValue;
+    /** Map value. */
     mapValue?: MapValue;
 }
 /** @oneof */
 export interface CustomValueValueOneOf {
+    /** String value. */
     strValue?: string;
+    /** Number value. */
     numValue?: number;
+    /** Date value. */
     dateValue?: Date;
+    /** List value. */
     listValue?: ListValue;
+    /** Map value. */
     mapValue?: MapValue;
 }
 export interface ListValue {
+    /** Custom value. */
     value?: CustomValue[];
 }
 export interface MapValue {
+    /** Mapped custom value. */
     value?: Record<string, CustomValue>;
 }
 export interface SecondaryEmail {
+    /** Email address. */
     email?: string;
+    /** Email tag. */
     tag?: EmailTag;
 }
 export declare enum EmailTag {
@@ -123,8 +179,11 @@ export declare enum EmailTag {
     WORK = "WORK"
 }
 export interface Phone {
+    /** Phone country code. */
     countryCode?: string | null;
+    /** Phone number. */
     phone?: string;
+    /** Phone tag. */
     tag?: PhoneTag;
 }
 export declare enum PhoneTag {
@@ -136,7 +195,9 @@ export declare enum PhoneTag {
     FAX = "FAX"
 }
 export interface AddressWrapper {
+    /** Address. */
     address?: Address;
+    /** Address tag. */
     tag?: AddressTag;
 }
 /** Physical address */
@@ -223,33 +284,35 @@ export interface LoginRequest {
     loginId?: LoginId;
 }
 export interface LoginId extends LoginIdTypeOneOf {
+    /** Login email address. */
     email?: string;
 }
 /** @oneof */
 export interface LoginIdTypeOneOf {
+    /** Login email address. */
     email?: string;
 }
 export interface SuccessfulLoginEvent {
     identity?: Identity;
 }
 export interface RegisterV2Request {
-    /** the identifier of the identity */
+    /** Identifier of registering member. */
     loginId: LoginId;
-    /** the password of the identity */
+    /** Password of registering member. */
     password?: string;
-    /** profile of the identity */
+    /** Profile information of registering member. */
     profile?: IdentityProfile;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
 export interface StateMachineResponse {
-    /** The current state */
+    /** The current state of the login or registration process. */
     state?: StateType;
-    /** Session token - will be returned only when the state is success */
+    /** If state is `SUCCESS`, a session token. */
     sessionToken?: string | null;
-    /** State token */
+    /** A token representing the current state of the login or registration process. */
     stateToken?: string | null;
-    /** The current identity */
+    /** Identing of the current member. */
     identity?: Identity;
 }
 export declare enum StateType {
@@ -260,11 +323,11 @@ export declare enum StateType {
     STATUS_CHECK = "STATUS_CHECK"
 }
 export interface LoginV2Request {
-    /** the identifier of the identity */
+    /** Identifier of member logging in. */
     loginId: LoginId;
-    /** the password of the identity */
+    /** Password of the member logging in. */
     password?: string;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
 export interface LoginWithIdpConnectionRequest {
@@ -315,7 +378,14 @@ export interface QueryParametersEntry {
     key?: string;
     value?: string;
 }
+export interface LoginCallbackRequest {
+    /** state that that received on the redirect */
+    state?: string;
+    /** session token */
+    sessionToken?: string;
+}
 export interface ProceedToNextStateRequest {
+    /** State token received from the previous step in the registration or login process. */
     stateToken?: string;
 }
 export interface SignOnRequest {
@@ -363,30 +433,43 @@ export interface LoginOptions {
     /** the identifier of the identity */
     loginId?: LoginId;
 }
-/** @param loginId - the identifier of the identity
+/**
+ * Registers a new member.
+ *
+ * Typically, after a sucessful registration, you generate and use member tokens for the
+ * registered member so that subsequent API calls are called as part of a member session.
+ *
+ * If the email used to register the member already exists as a contact email, the registering
+ * member need to verify the email address using a code that is sent to the address.
+ * @param loginId - Identifier of registering member.
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
  */
 export declare function registerV2(loginId: LoginId, options?: RegisterV2Options): Promise<StateMachineResponse>;
 export interface RegisterV2Options {
-    /** the password of the identity */
+    /** Password of registering member. */
     password?: string;
-    /** profile of the identity */
+    /** Profile information of registering member. */
     profile?: IdentityProfile;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
-/** @param loginId - the identifier of the identity
+/**
+ * Logs in an existing user.
+ *
+ * Typically, after a sucessful login, you generate and use member tokens for the
+ * logged-in member so that subsequent API calls are called as part of a member session.
+ * @param loginId - Identifier of member logging in.
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
  */
 export declare function loginV2(loginId: LoginId, options?: LoginV2Options): Promise<StateMachineResponse>;
 export interface LoginV2Options {
-    /** the password of the identity */
+    /** Password of the member logging in. */
     password?: string;
-    /** captcha tokens - necessary when the captcha settings is on */
+    /** CAPTCHA tokens, when CAPTCHA setting is on. */
     captchaTokens?: CaptchaToken[];
 }
 /** @public
@@ -394,12 +477,15 @@ export interface LoginV2Options {
  */
 export declare function proceedToNextState(options?: ProceedToNextStateOptions): Promise<LoginResponse>;
 export interface ProceedToNextStateOptions {
+    /** State token received from the previous step in the registration or login process. */
     stateToken?: string;
 }
 /** @param loginId - the identifier of the identity
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
+ * @permissionScope IAM.AUTHENTICAITON_SIGN_ON
+ * @applicableIdentity APP
  */
 export declare function signOn(loginId: LoginId, options?: SignOnOptions): Promise<SignOnResponse>;
 export interface SignOnOptions {
@@ -411,7 +497,7 @@ export interface SignOnOptions {
     mergeExistingContact?: boolean;
 }
 /**
- * called for logged in member/ user to cleanup its auth session
+ * Logs out a member.
  * @public
  * @documentationMaturity preview
  */

package/build/es/src/iam-authentication-v1-authentication.universal.js

@@ -244,7 +244,15 @@ export function login(identifier, options) {
         }
     });
 }
-/** @param loginId - the identifier of the identity
+/**
+ * Registers a new member.
+ *
+ * Typically, after a sucessful registration, you generate and use member tokens for the
+ * registered member so that subsequent API calls are called as part of a member session.
+ *
+ * If the email used to register the member already exists as a contact email, the registering
+ * member need to verify the email address using a code that is sent to the address.
+ * @param loginId - Identifier of registering member.
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
@@ -313,7 +321,12 @@ export function registerV2(loginId, options) {
         }
     });
 }
-/** @param loginId - the identifier of the identity
+/**
+ * Logs in an existing user.
+ *
+ * Typically, after a sucessful login, you generate and use member tokens for the
+ * logged-in member so that subsequent API calls are called as part of a member session.
+ * @param loginId - Identifier of member logging in.
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
@@ -432,6 +445,8 @@ export function proceedToNextState(options) {
  * @public
  * @documentationMaturity preview
  * @requiredField loginId
+ * @permissionScope IAM.AUTHENTICAITON_SIGN_ON
+ * @applicableIdentity APP
  */
 export function signOn(loginId, options) {
     var _a, _b, _c;
@@ -490,7 +505,7 @@ export function signOn(loginId, options) {
     });
 }
 /**
- * called for logged in member/ user to cleanup its auth session
+ * Logs out a member.
  * @public
  * @documentationMaturity preview
  */