@wix/auto_sdk_identity_authentication 1.0.30 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +33 -13
  2. package/build/cjs/index.js +2 -153
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +208 -180
  5. package/build/cjs/index.typings.js +2 -144
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +414 -59
  8. package/build/cjs/meta.js +120 -103
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +33 -13
  11. package/build/es/index.mjs +1 -150
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +208 -180
  14. package/build/es/index.typings.mjs +1 -141
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +414 -59
  17. package/build/es/meta.mjs +107 -101
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +33 -13
  20. package/build/internal/cjs/index.js +2 -153
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +208 -180
  23. package/build/internal/cjs/index.typings.js +2 -144
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +414 -59
  26. package/build/internal/cjs/meta.js +120 -103
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +33 -13
  29. package/build/internal/es/index.mjs +1 -150
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +208 -180
  32. package/build/internal/es/index.typings.mjs +1 -141
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +414 -59
  35. package/build/internal/es/meta.mjs +107 -101
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -1,6 +1,8 @@
1
- import { RegisterV2Request as RegisterV2Request$1, StateMachineResponse as StateMachineResponse$1, LoginV2Request as LoginV2Request$1, ChangePasswordRequest as ChangePasswordRequest$1, ChangePasswordResponse as ChangePasswordResponse$1, SignOnRequest as SignOnRequest$1, SignOnResponse as SignOnResponse$1, LogoutRequest as LogoutRequest$1, RawHttpResponse as RawHttpResponse$1, VerifyRequest as VerifyRequest$1 } from './index.typings.mjs';
1
+ import { RegisterV2Request as RegisterV2Request$1, StateMachineResponse as StateMachineResponse$1, LoginV2Request as LoginV2Request$1, ChangePasswordRequest as ChangePasswordRequest$1, ChangePasswordResponse as ChangePasswordResponse$1, SignOnRequest as SignOnRequest$1, SignOnResponse as SignOnResponse$1, LogoutRequest as LogoutRequest$1, RawHttpResponse as RawHttpResponse$1 } from './index.typings.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
+ interface Authentication {
5
+ }
4
6
  interface RegisterV2Request {
5
7
  /** Identifier of the registering member. */
6
8
  loginId: LoginId;
@@ -29,13 +31,13 @@ interface LoginIdTypeOneOf {
29
31
  email?: string;
30
32
  }
31
33
  interface IdentityProfile {
32
- /** Profile first name. */
34
+ /** Member's first name. */
33
35
  firstName?: string | null;
34
- /** Profile last name. */
36
+ /** Member's last name. */
35
37
  lastName?: string | null;
36
- /** Profile nickname. */
38
+ /** Member's display nickname. */
37
39
  nickname?: string | null;
38
- /** Profile picture URL. */
40
+ /** URL to member's profile picture. */
39
41
  picture?: string | null;
40
42
  /**
41
43
  * Deprecated. Use `secondaryEmails` instead.
@@ -52,27 +54,27 @@ interface IdentityProfile {
52
54
  */
53
55
  phones?: string[];
54
56
  /**
55
- * List of profile labels.
57
+ * Labels associated with the member.
56
58
  * @maxSize 2000
57
59
  */
58
60
  labels?: string[];
59
61
  /**
60
- * Profile language.
62
+ * Member's preferred language code.
61
63
  * @format LANGUAGE
62
64
  */
63
65
  language?: string | null;
64
- /** Profile privacy status. */
66
+ /** Member's profile visibility setting. */
65
67
  privacyStatus?: PrivacyStatusWithLiterals;
66
68
  /**
67
69
  * Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
68
70
  * are used to store additional information about your site or app's contacts.
69
71
  */
70
72
  customFields?: CustomField[];
71
- /** List of profile email addresses. */
73
+ /** Additional email addresses for the member. */
72
74
  secondaryEmails?: SecondaryEmail[];
73
- /** List of profile phone numbers. */
75
+ /** Phone numbers associated with the member. */
74
76
  phonesV2?: Phone[];
75
- /** List of profile physical addresses. */
77
+ /** Physical addresses for the member. */
76
78
  addresses?: AddressWrapper[];
77
79
  /**
78
80
  * Company name.
@@ -85,79 +87,79 @@ interface IdentityProfile {
85
87
  */
86
88
  position?: string | null;
87
89
  /**
88
- * Profile birthdate in `YYYY-MM-DD` format.
90
+ * Member's birth date in `YYYY-MM-DD` format.
89
91
  * @format LOCAL_DATE
90
92
  */
91
93
  birthdate?: string | null;
92
94
  /**
93
- * Profile slug.
95
+ * URL-friendly slug for the member's profile.
94
96
  * @maxLength 255
95
97
  */
96
98
  slug?: string | null;
97
- /** Consent to be added to mailing list */
99
+ /** Whether the member consents to receive marketing communications. */
98
100
  subscription?: boolean | null;
99
101
  /**
100
- * Government id for personal/corporate (Vat ID).
102
+ * Tax ID or VAT number for personal or corporate use.
101
103
  * @maxLength 1000
102
104
  */
103
105
  vatId?: string | null;
104
106
  }
105
107
  declare enum PrivacyStatus {
106
- /** No defined privacy status. */
108
+ /** No privacy status defined. */
107
109
  UNDEFINED = "UNDEFINED",
108
- /** Profile details, such as profile name and profile picture, are visible to other members. */
110
+ /** Profile details are visible to other members. */
109
111
  PUBLIC = "PUBLIC",
110
- /** Profile details aren't visible to other members. */
112
+ /** Profile details are hidden from other members. */
111
113
  PRIVATE = "PRIVATE"
112
114
  }
113
115
  /** @enumType */
114
116
  type PrivacyStatusWithLiterals = PrivacyStatus | 'UNDEFINED' | 'PUBLIC' | 'PRIVATE';
115
117
  interface CustomField {
116
118
  /**
117
- * Custom field name. The name must match one of the key properties of the objects returned by
118
- * [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
119
- * with the `custom.` prefix removed.
119
+ * Custom field name matching an extended field key (without `custom.` prefix).
120
+ *
121
+ * Must match a key from [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields).
120
122
  */
121
123
  name?: string;
122
- /** Custom field value. */
124
+ /** Value for the custom field. */
123
125
  value?: V1CustomValue;
124
126
  }
125
127
  interface V1CustomValue extends V1CustomValueValueOneOf {
126
- /** String value. */
128
+ /** Text value. */
127
129
  strValue?: string;
128
- /** Number value. */
130
+ /** Numeric value. */
129
131
  numValue?: number;
130
- /** Date value. */
132
+ /** Date/time value. */
131
133
  dateValue?: Date | null;
132
- /** Array of values. */
134
+ /** List of values. */
133
135
  listValue?: V1ListValue;
134
- /** Map of values. */
136
+ /** Key-value pairs. */
135
137
  mapValue?: V1MapValue;
136
138
  }
137
139
  /** @oneof */
138
140
  interface V1CustomValueValueOneOf {
139
- /** String value. */
141
+ /** Text value. */
140
142
  strValue?: string;
141
- /** Number value. */
143
+ /** Numeric value. */
142
144
  numValue?: number;
143
- /** Date value. */
145
+ /** Date/time value. */
144
146
  dateValue?: Date | null;
145
- /** Array of values. */
147
+ /** List of values. */
146
148
  listValue?: V1ListValue;
147
- /** Map of values. */
149
+ /** Key-value pairs. */
148
150
  mapValue?: V1MapValue;
149
151
  }
150
152
  interface V1ListValue {
151
- /** Custom value. */
153
+ /** List of custom values. */
152
154
  value?: V1CustomValue[];
153
155
  }
154
156
  interface V1MapValue {
155
- /** Mapped custom value. */
157
+ /** Map of custom field values. */
156
158
  value?: Record<string, V1CustomValue>;
157
159
  }
158
160
  interface SecondaryEmail {
159
161
  /**
160
- * Email address.
162
+ * Secondary email address.
161
163
  * @format EMAIL
162
164
  */
163
165
  email?: string;
@@ -174,12 +176,12 @@ declare enum EmailTag {
174
176
  type EmailTagWithLiterals = EmailTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'WORK';
175
177
  interface Phone {
176
178
  /**
177
- * Phone country code.
179
+ * Country code for the phone number.
178
180
  * @format COUNTRY
179
181
  */
180
182
  countryCode?: string | null;
181
183
  /**
182
- * Phone number.
184
+ * Phone number without country code.
183
185
  * @format PHONE
184
186
  */
185
187
  phone?: string;
@@ -197,7 +199,7 @@ declare enum PhoneTag {
197
199
  /** @enumType */
198
200
  type PhoneTagWithLiterals = PhoneTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'MOBILE' | 'WORK' | 'FAX';
199
201
  interface AddressWrapper {
200
- /** Address. */
202
+ /** Physical address details. */
201
203
  address?: Address;
202
204
  /** Address tag. */
203
205
  tag?: AddressTagWithLiterals;
@@ -276,11 +278,11 @@ declare enum StateType {
276
278
  UNKNOWN_STATE = "UNKNOWN_STATE",
277
279
  /** Login completed successfully. */
278
280
  SUCCESS = "SUCCESS",
279
- /** Indicates that the member needs the owner to approve their registration. */
281
+ /** Member needs the owner to approve their registration. */
280
282
  REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
281
- /** Indicates that the member needs to verify their email. */
283
+ /** Member needs to verify their email. */
282
284
  REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
283
- /** Indicates that the `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
285
+ /** The `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
284
286
  STATUS_CHECK = "STATUS_CHECK"
285
287
  }
286
288
  /** @enumType */
@@ -322,8 +324,6 @@ interface Identity {
322
324
  email?: Email;
323
325
  /** Identity's current status. */
324
326
  status?: StatusV2;
325
- /** Custom attributes. */
326
- customAttributes?: Record<string, any> | null;
327
327
  /**
328
328
  * Identity verification factors.
329
329
  * @maxSize 10
@@ -481,6 +481,85 @@ interface MapValue {
481
481
  /** Mapped custom value. */
482
482
  value?: Record<string, CustomValue>;
483
483
  }
484
+ interface RequireMfaData {
485
+ /**
486
+ * The factors available for the user to perform the required MFA.
487
+ * @maxSize 100
488
+ */
489
+ availableFactors?: V1Factor[];
490
+ /** The reason the user is required to perform MFA. */
491
+ reason?: MfaReasonWithLiterals;
492
+ }
493
+ interface V1Factor {
494
+ /** Type of verification factor. */
495
+ factorType?: FactorTypeWithLiterals;
496
+ /** Availability status for second factor */
497
+ factorStatus?: FactorStatusWithLiterals;
498
+ }
499
+ declare enum FactorStatus {
500
+ UNKNOWN_FACTOR_STATUS = "UNKNOWN_FACTOR_STATUS",
501
+ ENABLED = "ENABLED",
502
+ REQUIRE_ACTIVATION = "REQUIRE_ACTIVATION",
503
+ REQUIRE_REENROLL = "REQUIRE_REENROLL",
504
+ ENABLED_BY_RULE = "ENABLED_BY_RULE",
505
+ DISABLED_BY_RULE = "DISABLED_BY_RULE"
506
+ }
507
+ /** @enumType */
508
+ type FactorStatusWithLiterals = FactorStatus | 'UNKNOWN_FACTOR_STATUS' | 'ENABLED' | 'REQUIRE_ACTIVATION' | 'REQUIRE_REENROLL' | 'ENABLED_BY_RULE' | 'DISABLED_BY_RULE';
509
+ declare enum MfaReason {
510
+ UNKNOWN_MFA_REASON = "UNKNOWN_MFA_REASON",
511
+ /** Mfa is required due to user settings */
512
+ USER_SETTINGS = "USER_SETTINGS",
513
+ /** Mfa is required due to high risk login */
514
+ HIGH_RISK_LOGIN = "HIGH_RISK_LOGIN"
515
+ }
516
+ /** @enumType */
517
+ type MfaReasonWithLiterals = MfaReason | 'UNKNOWN_MFA_REASON' | 'USER_SETTINGS' | 'HIGH_RISK_LOGIN';
518
+ interface MfaChallengeData {
519
+ /** Type of verifation factor. */
520
+ factorType?: FactorTypeWithLiterals;
521
+ verificationChallengeData?: VerificationChallenge;
522
+ /**
523
+ * Factors types the user can choose from to verify themselves.
524
+ * @maxSize 100
525
+ */
526
+ availableFactors?: V1Factor[];
527
+ /** The reason the user is required for verification. */
528
+ reason?: MfaReasonWithLiterals;
529
+ }
530
+ interface VerificationChallenge extends VerificationChallengeFactorChallengeDataOneOf {
531
+ pushData?: PushChallengeData;
532
+ webauthnData?: WebAuthnChallengeData;
533
+ /** @maxLength 200 */
534
+ hint?: string | null;
535
+ }
536
+ /** @oneof */
537
+ interface VerificationChallengeFactorChallengeDataOneOf {
538
+ pushData?: PushChallengeData;
539
+ webauthnData?: WebAuthnChallengeData;
540
+ }
541
+ interface PushChallengeData {
542
+ /**
543
+ * This should be tied to a specific push notification.
544
+ * It will be sent in subsequent requests to verify the factor.
545
+ * @maxLength 36
546
+ */
547
+ transactionId?: string;
548
+ }
549
+ interface WebAuthnChallengeData {
550
+ /**
551
+ * A unique identifier for this challenge that will be used to correlate
552
+ * the authentication response with this challenge.
553
+ * This should be a cryptographically random GUID to prevent guessing attacks.
554
+ * @format GUID
555
+ */
556
+ challengeId?: string;
557
+ /**
558
+ * A PublicKeyCredentialRequestOptions JSON as defined in the WebAuthn spec (https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialrequestoptions).
559
+ * @maxLength 40000
560
+ */
561
+ publicKeyCredentialRequestOptionsJson?: string;
562
+ }
484
563
  interface LoginV2Request {
485
564
  /** Identifier of identity logging in. */
486
565
  loginId: LoginId;
@@ -522,11 +601,65 @@ interface ExternalEmailVerifyData {
522
601
  code?: string | null;
523
602
  }
524
603
  interface ChangePasswordRequest {
525
- /** The new password to set for the logged in user */
604
+ /**
605
+ * New password to set for the logged-in member.
606
+ *
607
+ * The password must meet the site's configured password requirements for length and complexity.
608
+ */
526
609
  newPassword: string;
527
610
  }
528
611
  interface ChangePasswordResponse {
529
612
  }
613
+ interface LoginWithIdpConnectionRequest {
614
+ /**
615
+ * The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData
616
+ * @format GUID
617
+ */
618
+ idpConnectionId?: string;
619
+ /**
620
+ * The id of the tenant the caller wants to login into
621
+ * @format GUID
622
+ */
623
+ tenantId?: string;
624
+ /** The type of the tenant the caller wants to login into */
625
+ tenantType?: TenantTypeWithLiterals;
626
+ customPayload?: Record<string, string>;
627
+ /**
628
+ * This flow ultimately returns an HTML page that asynchronously posts the LoginResponse via the BroadcastChannel API.
629
+ * The message will be posted to a channel named `wix-idp-$session_id`, and encrypted with the `encryption_key`.
630
+ * Encryption key should be base64 encoded. Encryption is done using AES-GCM with a random IV that's sent alongside the payload
631
+ */
632
+ sessionId?: string;
633
+ /**
634
+ * Base64-encoded encryption key for securing the authentication response.
635
+ *
636
+ * Used to encrypt the authentication response sent via BroadcastChannel API.
637
+ * Encryption uses AES-GCM with a random IV.
638
+ */
639
+ encryptionKey?: string;
640
+ /**
641
+ * Visitor ID for tracking purposes.
642
+ *
643
+ * Optional identifier for analytics and tracking the authentication flow.
644
+ */
645
+ visitorId?: string | null;
646
+ /**
647
+ * Browser session identifier.
648
+ *
649
+ * Optional identifier for correlating the authentication request with browser session data.
650
+ */
651
+ bsi?: string | null;
652
+ }
653
+ declare enum TenantType {
654
+ /** Unknown tenant type. This value isn't used. */
655
+ UNKNOWN_TENANT_TYPE = "UNKNOWN_TENANT_TYPE",
656
+ /** The identity is a Wix user. */
657
+ ACCOUNT = "ACCOUNT",
658
+ /** The identity is a member. */
659
+ SITE = "SITE"
660
+ }
661
+ /** @enumType */
662
+ type TenantTypeWithLiterals = TenantType | 'UNKNOWN_TENANT_TYPE' | 'ACCOUNT' | 'SITE';
530
663
  interface RawHttpResponse {
531
664
  body?: Uint8Array;
532
665
  statusCode?: number | null;
@@ -536,59 +669,155 @@ interface HeadersEntry {
536
669
  key?: string;
537
670
  value?: string;
538
671
  }
672
+ interface RawHttpRequest {
673
+ body?: Uint8Array;
674
+ pathParams?: PathParametersEntry[];
675
+ queryParams?: QueryParametersEntry[];
676
+ headers?: HeadersEntry[];
677
+ method?: string;
678
+ rawPath?: string;
679
+ rawQuery?: string;
680
+ }
681
+ interface PathParametersEntry {
682
+ key?: string;
683
+ value?: string;
684
+ }
685
+ interface QueryParametersEntry {
686
+ key?: string;
687
+ value?: string;
688
+ }
689
+ interface LoginCallbackRequest {
690
+ /** state that that received on the redirect */
691
+ state?: string;
692
+ /** session token */
693
+ sessionToken?: string;
694
+ }
695
+ interface LoginWithIdpConnectionTokenParamsRequest {
696
+ /**
697
+ * The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData)
698
+ * @format GUID
699
+ */
700
+ idpConnectionId?: string;
701
+ /** A set of fields that are required for the connection to be able to identify and authenticate the user */
702
+ tokenParams?: Record<string, string>;
703
+ }
539
704
  interface SignOnRequest {
540
- /** the identifier of the identity */
705
+ /**
706
+ * Member identifier for authentication.
707
+ *
708
+ * Currently only email addresses are supported.
709
+ */
541
710
  loginId: LoginId;
542
- /** profile of the identity */
711
+ /**
712
+ * Member profile information.
713
+ *
714
+ * Profile data such as first name, last name, and other member details.
715
+ * If the member already exists, provided profile information will update the existing member's profile.
716
+ * If the member doesn't exist, this profile information is used to create the new member.
717
+ */
543
718
  profile?: IdentityProfile;
544
- /** when true will mark the email of the identity as verified */
719
+ /**
720
+ * Whether to mark the member's email as verified without requiring verification.
721
+ *
722
+ * When `true`, marks the email as verified without requiring verification.
723
+ * Use with caution in production as this bypasses security verification.
724
+ *
725
+ * Default: `false`
726
+ */
545
727
  verifyEmail?: boolean;
546
- /** when false will create a new contact instead of merging the existing contact into the identity */
728
+ /**
729
+ * Whether to merge with an existing contact with the same email address.
730
+ *
731
+ * When `true`, links the member to an existing contact record with the same email
732
+ * and inherits contact data. When `false`, creates a new contact record.
733
+ *
734
+ * Default: `true`
735
+ */
547
736
  mergeExistingContact?: boolean;
548
737
  }
549
738
  interface SignOnResponse {
550
- /** session token for the requested identity */
739
+ /**
740
+ * Session token for the authenticated member.
741
+ *
742
+ * Use this token to obtain access and refresh tokens for subsequent API calls.
743
+ */
551
744
  sessionToken?: string;
552
- /** The Identity of the provided login_id */
745
+ /**
746
+ * Member identity information.
747
+ *
748
+ * Contains the member's identity details after successful authentication.
749
+ */
553
750
  identity?: Identity;
554
751
  }
555
752
  /** logout request payload */
556
753
  interface LogoutRequest {
557
754
  /**
558
- * redirect after logout
755
+ * URL to redirect to after logout.
756
+ *
757
+ * Optional redirect destination after the logout process completes.
559
758
  * @format WEB_URL
560
759
  */
561
760
  postLogoutRedirectUri?: string | null;
562
761
  /**
563
- * caller identifier
762
+ * Client identifier for the logout request.
763
+ *
764
+ * Identifies the application or client initiating the logout.
564
765
  * @format GUID
565
766
  */
566
767
  clientId?: string | null;
567
768
  }
568
769
  interface VerifyRequest extends VerifyRequestFactorDataOneOf {
770
+ /** SMS verification code sent to the member's phone number. */
569
771
  smsData?: SmsVerifyData;
772
+ /** Voice call verification code received by the member. */
570
773
  callData?: CallVerifyData;
774
+ /** Email verification code sent to the member's email address. */
571
775
  emailData?: ExternalEmailVerifyData;
776
+ /** TOTP code from the member's authenticator app. */
572
777
  totpData?: TotpVerifyData;
778
+ /** Push notification authentication response from the member's device. */
573
779
  pushData?: PushVerifyData;
780
+ /** WebAuthn response from biometric or security key authentication. */
574
781
  webauthnData?: WebAuthnVerifyData;
782
+ /** RecoveryCode response from a one-time code. */
783
+ recoveryCodeData?: RecoveryCodeVerifyData;
575
784
  /**
576
- * TODO: is this a reasonable maxLength?
785
+ * State token from the initial authentication response.
786
+ *
787
+ * Required to continue the multi-step authentication process.
577
788
  * @maxLength 1000
578
789
  */
579
790
  stateToken?: string;
580
- factorType: FactorTypeWithLiterals;
581
- /** Relevant for second factors only. */
791
+ /**
792
+ * Type of authentication factor being verified.
793
+ *
794
+ * Specifies which verification method is being used (SMS, email, TOTP, etc.).
795
+ */
796
+ factorType?: FactorTypeWithLiterals;
797
+ /**
798
+ * Whether to remember this device for future authentication.
799
+ *
800
+ * When `true`, reduces future authentication requirements for this device.
801
+ * Only applicable for second factor authentication.
802
+ */
582
803
  rememberThisDevice?: boolean;
583
804
  }
584
805
  /** @oneof */
585
806
  interface VerifyRequestFactorDataOneOf {
807
+ /** SMS verification code sent to the member's phone number. */
586
808
  smsData?: SmsVerifyData;
809
+ /** Voice call verification code received by the member. */
587
810
  callData?: CallVerifyData;
811
+ /** Email verification code sent to the member's email address. */
588
812
  emailData?: ExternalEmailVerifyData;
813
+ /** TOTP code from the member's authenticator app. */
589
814
  totpData?: TotpVerifyData;
815
+ /** Push notification authentication response from the member's device. */
590
816
  pushData?: PushVerifyData;
817
+ /** WebAuthn response from biometric or security key authentication. */
591
818
  webauthnData?: WebAuthnVerifyData;
819
+ /** RecoveryCode response from a one-time code. */
820
+ recoveryCodeData?: RecoveryCodeVerifyData;
592
821
  }
593
822
  interface SmsVerifyData {
594
823
  /**
@@ -615,6 +844,135 @@ interface PushVerifyData {
615
844
  /** @maxLength 36 */
616
845
  transactionId?: string | null;
617
846
  }
847
+ interface RecoveryCodeVerifyData {
848
+ /**
849
+ * @minLength 1
850
+ * @maxLength 100
851
+ */
852
+ code?: string | null;
853
+ }
854
+ interface GetWebauthnChallengeRequest {
855
+ /**
856
+ * Identifier of the member requesting the WebAuthn challenge.
857
+ *
858
+ * If not provided, returns an anonymous WebAuthn challenge for usernameless authentication.
859
+ */
860
+ loginId?: LoginId;
861
+ }
862
+ interface GetWebauthnChallengeResponse {
863
+ /** The challenge that will be used for a WebAuthn authentication ceremony. */
864
+ webauthn?: WebAuthnChallengeData;
865
+ }
866
+ /** @docsIgnore */
867
+ type RegisterV2ApplicationErrors = {
868
+ code?: 'UNIMPLEMENTED_FEATURE';
869
+ description?: string;
870
+ data?: Record<string, any>;
871
+ } | {
872
+ code?: 'THROTTLED_FEATURE';
873
+ description?: string;
874
+ data?: Record<string, any>;
875
+ } | {
876
+ code?: 'INVALID_CAPTCHA_TOKEN';
877
+ description?: string;
878
+ data?: Record<string, any>;
879
+ } | {
880
+ code?: 'CAPTCHA_TOKEN_REQUIRED';
881
+ description?: string;
882
+ data?: Record<string, any>;
883
+ } | {
884
+ code?: 'IP_ADDRESS_FILTERED';
885
+ description?: string;
886
+ data?: Record<string, any>;
887
+ } | {
888
+ code?: 'RECAPTCHA_FAILED';
889
+ description?: string;
890
+ data?: Record<string, any>;
891
+ } | {
892
+ code?: 'RECAPTCHA_REQUIRED';
893
+ description?: string;
894
+ data?: Record<string, any>;
895
+ } | {
896
+ code?: 'MISSING_CAPTCHA_TOKEN';
897
+ description?: string;
898
+ data?: Record<string, any>;
899
+ } | {
900
+ code?: 'USER_EMAIL_OFAC_ADDRESS';
901
+ description?: string;
902
+ data?: Record<string, any>;
903
+ } | {
904
+ code?: 'UNSUPPORTED_FIELD';
905
+ description?: string;
906
+ data?: Record<string, any>;
907
+ } | {
908
+ code?: 'ATTRIBUTE_NOT_FOUND';
909
+ description?: string;
910
+ data?: Record<string, any>;
911
+ } | {
912
+ code?: 'CLIENT_METADATA_NOT_FOUND';
913
+ description?: string;
914
+ data?: Record<string, any>;
915
+ } | {
916
+ code?: 'INVALID_LD_SESSION';
917
+ description?: string;
918
+ data?: Record<string, any>;
919
+ } | {
920
+ code?: 'DUPLICATE_EMAIL';
921
+ description?: string;
922
+ data?: Record<string, any>;
923
+ } | {
924
+ code?: 'COULD_NOT_CREATE_SET_ACCOUNT_USER';
925
+ description?: string;
926
+ data?: Record<string, any>;
927
+ } | {
928
+ code?: 'INVALID_USER_TYPE';
929
+ description?: string;
930
+ data?: Record<string, any>;
931
+ } | {
932
+ code?: 'REGISTRATION_TO_EDITORX_NOT_ALLOWED';
933
+ description?: string;
934
+ data?: Record<string, any>;
935
+ };
936
+ /** @docsIgnore */
937
+ type RegisterV2ValidationErrors = {
938
+ ruleName?: 'PROVIDE_TENANT_ID';
939
+ } | {
940
+ ruleName?: 'INVALID_AUTHENTICATOR_ID';
941
+ } | {
942
+ ruleName?: 'VALUEֹֹ_TOO_SHORT';
943
+ } | {
944
+ ruleName?: 'VALUEֹֹ_TOO_LONG';
945
+ } | {
946
+ ruleName?: 'VALUE_DID_NOT_MATCH';
947
+ };
948
+ /** @docsIgnore */
949
+ type LoginV2ApplicationErrors = {
950
+ code?: 'THROTTLED_FEATURE';
951
+ description?: string;
952
+ data?: Record<string, any>;
953
+ } | {
954
+ code?: 'INVALID_CAPTCHA_TOKEN';
955
+ description?: string;
956
+ data?: Record<string, any>;
957
+ } | {
958
+ code?: 'CAPTCHA_TOKEN_REQUIRED';
959
+ description?: string;
960
+ data?: Record<string, any>;
961
+ } | {
962
+ code?: 'REENROLLMENT_REQUIRED_BY_ADMIN';
963
+ description?: string;
964
+ data?: Record<string, any>;
965
+ } | {
966
+ code?: 'TRUSTED_CLIENTS_ONLY';
967
+ description?: string;
968
+ data?: Record<string, any>;
969
+ };
970
+ /** @docsIgnore */
971
+ type LoginV2ValidationErrors = {
972
+ ruleName?: 'PROVIDE_TENANT_ID';
973
+ } | {
974
+ ruleName?: 'INVALID_AUTHENTICATOR_ID';
975
+ };
618
976
 
619
977
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
620
978
  getUrl: (context: any) => string;
@@ -631,8 +989,5 @@ declare function loginV2(): __PublicMethodMetaInfo<'POST', {}, LoginV2Request$1,
631
989
  declare function changePassword(): __PublicMethodMetaInfo<'POST', {}, ChangePasswordRequest$1, ChangePasswordRequest, ChangePasswordResponse$1, ChangePasswordResponse>;
632
990
  declare function signOn(): __PublicMethodMetaInfo<'POST', {}, SignOnRequest$1, SignOnRequest, SignOnResponse$1, SignOnResponse>;
633
991
  declare function logout(): __PublicMethodMetaInfo<'GET', {}, LogoutRequest$1, LogoutRequest, RawHttpResponse$1, RawHttpResponse>;
634
- declare function verify(): __PublicMethodMetaInfo<'POST', {
635
- factorType: string;
636
- }, VerifyRequest$1, VerifyRequest, StateMachineResponse$1, StateMachineResponse>;
637
992
 
638
- export { type __PublicMethodMetaInfo, changePassword, loginV2, logout, registerV2, signOn, verify };
993
+ export { type Address as AddressOriginal, AddressTag as AddressTagOriginal, type AddressTagWithLiterals as AddressTagWithLiteralsOriginal, type AddressWrapper as AddressWrapperOriginal, type Authentication as AuthenticationOriginal, type AuthenticatorConnection as AuthenticatorConnectionOriginal, type CallVerifyData as CallVerifyDataOriginal, type CaptchaToken as CaptchaTokenOriginal, type CaptchaTokenTokenOneOf as CaptchaTokenTokenOneOfOriginal, type ChangePasswordRequest as ChangePasswordRequestOriginal, type ChangePasswordResponse as ChangePasswordResponseOriginal, type Connection as ConnectionOriginal, type ConnectionTypeOneOf as ConnectionTypeOneOfOriginal, type CustomField as CustomFieldOriginal, type CustomValue as CustomValueOriginal, type CustomValueValueOneOf as CustomValueValueOneOfOriginal, type Email as EmailOriginal, EmailTag as EmailTagOriginal, type EmailTagWithLiterals as EmailTagWithLiteralsOriginal, type ExternalEmailVerifyData as ExternalEmailVerifyDataOriginal, type Factor as FactorOriginal, FactorStatus as FactorStatusOriginal, type FactorStatusWithLiterals as FactorStatusWithLiteralsOriginal, FactorType as FactorTypeOriginal, type FactorTypeWithLiterals as FactorTypeWithLiteralsOriginal, type GetWebauthnChallengeRequest as GetWebauthnChallengeRequestOriginal, type GetWebauthnChallengeResponse as GetWebauthnChallengeResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type Identity as IdentityOriginal, type IdentityProfile as IdentityProfileOriginal, type IdpConnection as IdpConnectionOriginal, type ListValue as ListValueOriginal, type LoginCallbackRequest as LoginCallbackRequestOriginal, type LoginId as LoginIdOriginal, type LoginIdTypeOneOf as LoginIdTypeOneOfOriginal, type LoginV2ApplicationErrors as LoginV2ApplicationErrorsOriginal, type LoginV2Request as LoginV2RequestOriginal, type LoginV2ValidationErrors as LoginV2ValidationErrorsOriginal, type LoginWithIdpConnectionRequest as LoginWithIdpConnectionRequestOriginal, type LoginWithIdpConnectionTokenParamsRequest as LoginWithIdpConnectionTokenParamsRequestOriginal, type LogoutRequest as LogoutRequestOriginal, type MapValue as MapValueOriginal, type Metadata as MetadataOriginal, type MfaChallengeData as MfaChallengeDataOriginal, MfaReason as MfaReasonOriginal, type MfaReasonWithLiterals as MfaReasonWithLiteralsOriginal, type PathParametersEntry as PathParametersEntryOriginal, type Phone as PhoneOriginal, PhoneTag as PhoneTagOriginal, type PhoneTagWithLiterals as PhoneTagWithLiteralsOriginal, PrivacyStatus as PrivacyStatusOriginal, type PrivacyStatusWithLiterals as PrivacyStatusWithLiteralsOriginal, type PushChallengeData as PushChallengeDataOriginal, type PushVerifyData as PushVerifyDataOriginal, type QueryParametersEntry as QueryParametersEntryOriginal, type RawHttpRequest as RawHttpRequestOriginal, type RawHttpResponse as RawHttpResponseOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type RecoveryCodeVerifyData as RecoveryCodeVerifyDataOriginal, type RegisterV2ApplicationErrors as RegisterV2ApplicationErrorsOriginal, type RegisterV2Request as RegisterV2RequestOriginal, type RegisterV2ValidationErrors as RegisterV2ValidationErrorsOriginal, type RequireMfaData as RequireMfaDataOriginal, type SecondaryEmail as SecondaryEmailOriginal, type SignOnRequest as SignOnRequestOriginal, type SignOnResponse as SignOnResponseOriginal, type SmsVerifyData as SmsVerifyDataOriginal, type StateMachineResponse as StateMachineResponseOriginal, type StateMachineResponseStateDataOneOf as StateMachineResponseStateDataOneOfOriginal, StateType as StateTypeOriginal, type StateTypeWithLiterals as StateTypeWithLiteralsOriginal, StatusName as StatusNameOriginal, type StatusNameWithLiterals as StatusNameWithLiteralsOriginal, Status as StatusOriginal, type StatusV2 as StatusV2Original, type StatusWithLiterals as StatusWithLiteralsOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, type TotpVerifyData as TotpVerifyDataOriginal, type V1CustomValue as V1CustomValueOriginal, type V1CustomValueValueOneOf as V1CustomValueValueOneOfOriginal, type V1Factor as V1FactorOriginal, type V1ListValue as V1ListValueOriginal, type V1MapValue as V1MapValueOriginal, type VerificationChallengeFactorChallengeDataOneOf as VerificationChallengeFactorChallengeDataOneOfOriginal, type VerificationChallenge as VerificationChallengeOriginal, type VerifyRequestFactorDataOneOf as VerifyRequestFactorDataOneOfOriginal, type VerifyRequest as VerifyRequestOriginal, type WebAuthnChallengeData as WebAuthnChallengeDataOriginal, type WebAuthnVerifyData as WebAuthnVerifyDataOriginal, type __PublicMethodMetaInfo, changePassword, loginV2, logout, registerV2, signOn };