@wix/auto_sdk_identity_authentication 1.0.14 → 1.0.16

package/build/internal/cjs/{iam-authentication-v1-authentication-authentication.universal-D-41C26U.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Authentication {
 }
 interface RegisterV2Request {
@@ -819,6 +821,130 @@ interface WebAuthnVerifyData {
      */
     credential?: string | null;
 }
+type RegisterV2ApplicationErrors = {
+    code?: 'UNIMPLEMENTED_FEATURE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'THROTTLED_FEATURE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_CAPTCHA_TOKEN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CAPTCHA_TOKEN_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'IP_ADDRESS_FILTERED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'RECAPTCHA_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'RECAPTCHA_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_CAPTCHA_TOKEN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'USER_EMAIL_OFAC_ADDRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'UNSUPPORTED_FIELD';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ATTRIBUTE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CLIENT_METADATA_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_LD_SESSION';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'DUPLICATE_EMAIL';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'COULD_NOT_CREATE_SET_ACCOUNT_USER';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_USER_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'REGISTRATION_TO_EDITORX_NOT_ALLOWED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type RegisterV2ValidationErrors = {
+    ruleName?: 'PROVIDE_TENANT_ID';
+} | {
+    ruleName?: 'INVALID_AUTHENTICATOR_ID';
+} | {
+    ruleName?: 'VALUEֹֹ_TOO_SHORT';
+} | {
+    ruleName?: 'VALUEֹֹ_TOO_LONG';
+} | {
+    ruleName?: 'VALUE_DID_NOT_MATCH';
+};
+type LoginV2ApplicationErrors = {
+    code?: 'THROTTLED_FEATURE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_CAPTCHA_TOKEN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CAPTCHA_TOKEN_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'REENROLLMENT_REQUIRED_BY_ADMIN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'TRUSTED_CLIENTS_ONLY';
+    description?: string;
+    data?: Record<string, any>;
+};
+type LoginV2ValidationErrors = {
+    ruleName?: 'PROVIDE_TENANT_ID';
+} | {
+    ruleName?: 'INVALID_AUTHENTICATOR_ID';
+};
+/**
+ * Registers a new member.
+ *
+ * Typically, after a successful registration, you generate and use member tokens for the
+ * registered member so that subsequent API calls are called as part of a member session.
+ * Use the `sessionToken` in the response to [get the site member's access and refresh tokens](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#get-the-site-members-access-and-refresh-tokens).
+ *
+ * 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 the registering member.
+ * @public
+ * @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.metadata.tags` | `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`> & {
+    __applicationErrorsType?: RegisterV2ApplicationErrors;
+    __validationErrorsType?: RegisterV2ValidationErrors;
+}>;
 interface RegisterV2Options {
     /** Password of the registering member. */
     password?: string;
@@ -829,6 +955,21 @@ interface RegisterV2Options {
     /** Additional data that's relevant for the flow. */
     clientMetaData?: Record<string, any> | null;
 }
+/**
+ * Logs in an existing member.
+ *
+ * Typically, after a successful 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.
+ * Use the `sessionToken` in the response to [get the site member's access and refresh tokens](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#get-the-site-members-access-and-refresh-tokens).
+ * @param loginId - Identifier of identity logging in.
+ * @public
+ * @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.metadata.tags` | `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`> & {
+    __applicationErrorsType?: LoginV2ApplicationErrors;
+    __validationErrorsType?: LoginV2ValidationErrors;
+}>;
 interface LoginV2Options {
     /** Password of the identity logging in. */
     password?: string;
@@ -837,12 +978,36 @@ interface LoginV2Options {
     /** Additional data that's relevant for the flow. */
     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
+ * @public
+ * @documentationMaturity preview
+ * @requiredField newPassword
+ * @permissionId IAM.CHANGE_PASSWORD
+ * @fqn wix.iam.authentication.v1.AuthenticationService.ChangePassword
+ */
+declare function changePassword(newPassword: string): Promise<void>;
+/** @public
+ * @documentationMaturity preview
+ * @fqn wix.iam.authentication.v1.AuthenticationService.LoginCallback
+ */
+declare function loginCallback(options?: LoginCallbackOptions): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
 interface LoginCallbackOptions {
     /** state that that received on the redirect */
     state?: string;
     /** session token */
     sessionToken?: string;
 }
+/** @param loginId - the identifier of the identity
+ * @public
+ * @documentationMaturity preview
+ * @requiredField loginId
+ * @permissionId IAM.AUTHENTICAITON_SIGN_ON
+ * @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.metadata.tags` | `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`>>;
 interface SignOnOptions {
     /** profile of the identity */
     profile?: IdentityProfile;
@@ -851,6 +1016,13 @@ interface SignOnOptions {
     /** when false will create a new contact instead of merging the existing contact into the identity */
     mergeExistingContact?: boolean;
 }
+/**
+ * Logs out a member.
+ * @public
+ * @documentationMaturity preview
+ * @fqn wix.iam.authentication.v1.AuthenticationService.Logout
+ */
+declare function logout(options?: LogoutOptions): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
 interface LogoutOptions {
     /**
      * redirect after logout
@@ -863,6 +1035,12 @@ interface LogoutOptions {
      */
     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.metadata.tags` | `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`>>;
 interface VerifyOptions extends VerifyOptionsFactorDataOneOf {
     /**
      * TODO: is this a reasonable maxLength?
@@ -887,4 +1065,4 @@ interface VerifyOptionsFactorDataOneOf {
     webauthnData?: WebAuthnVerifyData;
 }
 
-export { type RequireMfaData as $, AddressTag as A, type StateMachineResponseStateDataOneOf as B, type CustomField as C, type Identity as D, EmailTag as E, type FactorTypeWithLiterals as F, type Connection as G, type ConnectionTypeOneOf as H, type IdentityProfile as I, type IdpConnection as J, type AuthenticatorConnection as K, type LoginId as L, MfaReason as M, type Metadata as N, type Email as O, PrivacyStatus as P, type StatusV2 as Q, type RegisterV2Options as R, type StateMachineResponse as S, TenantType as T, UserVerificationRequirement as U, type VerifyOptions as V, type Factor as W, type CustomValue as X, type CustomValueValueOneOf as Y, type ListValue as Z, type MapValue as _, type LoginV2Options as a, type V1Factor as a0, type MfaChallengeData as a1, type VerificationChallenge as a2, type VerificationChallengeFactorChallengeDataOneOf as a3, type PushChallengeData as a4, type WebAuthnChallengeData as a5, type PublicKeyCredentialDescriptor as a6, type AuthenticationExtensionInputs as a7, type AuthenticationExtensionInputsLargeBlobOperationOneOf as a8, type LoginV2Request as a9, type ChangePasswordRequest as aa, type ChangePasswordResponse as ab, type LoginWithIdpConnectionRequest as ac, type HeadersEntry as ad, type RawHttpRequest as ae, type PathParametersEntry as af, type QueryParametersEntry as ag, type LoginCallbackRequest as ah, type LoginWithIdpConnectionTokenParamsRequest as ai, type SignOnRequest as aj, type LogoutRequest as ak, type VerifyRequest as al, type VerifyRequestFactorDataOneOf as am, type SmsVerifyData as an, type CallVerifyData as ao, type ExternalEmailVerifyData as ap, type TotpVerifyData as aq, type PushVerifyData as ar, type WebAuthnVerifyData as as, type VerifyOptionsFactorDataOneOf as at, type LoginCallbackOptions as b, type RawHttpResponse as c, type SignOnOptions as d, type SignOnResponse as e, type LogoutOptions as f, PhoneTag as g, StateType as h, StatusName as i, Reason as j, FactorType as k, Status as l, FactorStatus as m, type Authentication as n, type RegisterV2Request as o, type LoginIdTypeOneOf as p, type V1CustomValue as q, type V1CustomValueValueOneOf as r, type V1ListValue as s, type V1MapValue as t, type SecondaryEmail as u, type Phone as v, type AddressWrapper as w, type Address as x, type CaptchaToken as y, type CaptchaTokenTokenOneOf as z };
+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 HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackOptions, 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, loginCallback, loginV2, logout, registerV2, signOn, verify };