@wix/identity 1.0.50 → 1.0.51

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 (51) hide show
  1. package/build/cjs/src/iam-authentication-v1-authentication.http.d.ts +16 -1
  2. package/build/cjs/src/iam-authentication-v1-authentication.http.js +16 -1
  3. package/build/cjs/src/iam-authentication-v1-authentication.http.js.map +1 -1
  4. package/build/cjs/src/iam-authentication-v1-authentication.public.d.ts +1 -1
  5. package/build/cjs/src/iam-authentication-v1-authentication.types.d.ts +87 -17
  6. package/build/cjs/src/iam-authentication-v1-authentication.types.js.map +1 -1
  7. package/build/cjs/src/iam-authentication-v1-authentication.universal.d.ts +111 -25
  8. package/build/cjs/src/iam-authentication-v1-authentication.universal.js +18 -3
  9. package/build/cjs/src/iam-authentication-v1-authentication.universal.js.map +1 -1
  10. package/build/cjs/src/iam-recovery-v1-recovery.http.d.ts +4 -1
  11. package/build/cjs/src/iam-recovery-v1-recovery.http.js +4 -1
  12. package/build/cjs/src/iam-recovery-v1-recovery.http.js.map +1 -1
  13. package/build/cjs/src/iam-recovery-v1-recovery.types.d.ts +76 -15
  14. package/build/cjs/src/iam-recovery-v1-recovery.types.js.map +1 -1
  15. package/build/cjs/src/iam-recovery-v1-recovery.universal.d.ts +81 -19
  16. package/build/cjs/src/iam-recovery-v1-recovery.universal.js +3 -2
  17. package/build/cjs/src/iam-recovery-v1-recovery.universal.js.map +1 -1
  18. package/build/cjs/src/iam-verification-v1-start-response.http.d.ts +7 -3
  19. package/build/cjs/src/iam-verification-v1-start-response.http.js +7 -3
  20. package/build/cjs/src/iam-verification-v1-start-response.http.js.map +1 -1
  21. package/build/cjs/src/iam-verification-v1-start-response.types.d.ts +73 -12
  22. package/build/cjs/src/iam-verification-v1-start-response.types.js.map +1 -1
  23. package/build/cjs/src/iam-verification-v1-start-response.universal.d.ts +82 -17
  24. package/build/cjs/src/iam-verification-v1-start-response.universal.js +8 -4
  25. package/build/cjs/src/iam-verification-v1-start-response.universal.js.map +1 -1
  26. package/build/es/src/iam-authentication-v1-authentication.http.d.ts +16 -1
  27. package/build/es/src/iam-authentication-v1-authentication.http.js +16 -1
  28. package/build/es/src/iam-authentication-v1-authentication.http.js.map +1 -1
  29. package/build/es/src/iam-authentication-v1-authentication.public.d.ts +1 -1
  30. package/build/es/src/iam-authentication-v1-authentication.types.d.ts +87 -17
  31. package/build/es/src/iam-authentication-v1-authentication.types.js.map +1 -1
  32. package/build/es/src/iam-authentication-v1-authentication.universal.d.ts +111 -25
  33. package/build/es/src/iam-authentication-v1-authentication.universal.js +18 -3
  34. package/build/es/src/iam-authentication-v1-authentication.universal.js.map +1 -1
  35. package/build/es/src/iam-recovery-v1-recovery.http.d.ts +4 -1
  36. package/build/es/src/iam-recovery-v1-recovery.http.js +4 -1
  37. package/build/es/src/iam-recovery-v1-recovery.http.js.map +1 -1
  38. package/build/es/src/iam-recovery-v1-recovery.types.d.ts +76 -15
  39. package/build/es/src/iam-recovery-v1-recovery.types.js.map +1 -1
  40. package/build/es/src/iam-recovery-v1-recovery.universal.d.ts +81 -19
  41. package/build/es/src/iam-recovery-v1-recovery.universal.js +3 -2
  42. package/build/es/src/iam-recovery-v1-recovery.universal.js.map +1 -1
  43. package/build/es/src/iam-verification-v1-start-response.http.d.ts +7 -3
  44. package/build/es/src/iam-verification-v1-start-response.http.js +7 -3
  45. package/build/es/src/iam-verification-v1-start-response.http.js.map +1 -1
  46. package/build/es/src/iam-verification-v1-start-response.types.d.ts +73 -12
  47. package/build/es/src/iam-verification-v1-start-response.types.js.map +1 -1
  48. package/build/es/src/iam-verification-v1-start-response.universal.d.ts +82 -17
  49. package/build/es/src/iam-verification-v1-start-response.universal.js +8 -4
  50. package/build/es/src/iam-verification-v1-start-response.universal.js.map +1 -1
  51. package/package.json +2 -2
@@ -33,17 +33,17 @@ export declare enum TenantType {
33
33
  ROOT = "ROOT"
34
34
  }
35
35
  export interface SendRecoveryEmailRequest {
36
- /** email of the identity */
36
+ /** Email address associated with the account to recover. */
37
37
  email: string;
38
- /** language of the email - if not recived will fallback to the identity language */
38
+ /** Language of the email to be sent. Defaults to the language specified in the member's profile. */
39
39
  language?: string | null;
40
- /** Where to redirect after a successful recovery process */
40
+ /** Where to redirect to after a successful recovery. */
41
41
  redirect?: Redirect;
42
42
  }
43
43
  export interface Redirect {
44
- /** The url where to redirect after a successful recovery process */
44
+ /** The URL to redirect to after a successful recovery. */
45
45
  url?: string;
46
- /** caller identifier */
46
+ /** Caller identifier. */
47
47
  clientId?: string | null;
48
48
  }
49
49
  export interface SendRecoveryEmailResponse {
@@ -55,13 +55,13 @@ export interface RecoverRequest {
55
55
  password?: string | null;
56
56
  }
57
57
  export interface StateMachineResponse {
58
- /** The current state */
58
+ /** The current state of the login or registration process. */
59
59
  state?: StateType;
60
- /** Session token - will be returned only when the state is success */
60
+ /** If state is `SUCCESS`, a session token. */
61
61
  sessionToken?: string | null;
62
- /** State token */
62
+ /** A token representing the current state of the login or registration process. */
63
63
  stateToken?: string | null;
64
- /** The current identity */
64
+ /** Identing of the current member. */
65
65
  identity?: Identity;
66
66
  }
67
67
  export declare enum StateType {
@@ -74,25 +74,35 @@ export declare enum StateType {
74
74
  export interface Identity {
75
75
  /** Identity ID */
76
76
  id?: string | null;
77
+ /** Identifiers */
77
78
  identifiers?: Identifier[];
78
- /** 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 */
79
+ /**
80
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes.
81
+ * For an update operation to succeed, you MUST pass the latest revision.
82
+ */
79
83
  revision?: string | null;
80
84
  /**
81
- * Represents the time this Identity was created
85
+ * The time this identity was created.
82
86
  * @readonly
83
87
  */
84
88
  createdDate?: Date;
85
89
  /**
86
- * Represents the time this Identity was last updated
90
+ * The time this identity was last updated.
87
91
  * @readonly
88
92
  */
89
93
  updatedDate?: Date;
90
- /** All the identity configured connections to authenticate with */
94
+ /** The identity configured connections to authenticate with. */
91
95
  connections?: Connection[];
96
+ /** Identity profile. */
92
97
  identityProfile?: IdentityProfile;
93
- /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
98
+ /**
99
+ * Additional information about the identity that can impact user access.
100
+ * This data cannot be set.
101
+ */
94
102
  metadata?: Metadata;
103
+ /** Identity email address. */
95
104
  email?: Email;
105
+ /** Identity's current status. */
96
106
  status?: StatusV2;
97
107
  }
98
108
  export interface Identifier extends IdentifierValueOneOf {
@@ -105,39 +115,65 @@ export interface IdentifierValueOneOf {
105
115
  userName?: string;
106
116
  }
107
117
  export interface Connection extends ConnectionTypeOneOf {
118
+ /** IDP connection. */
108
119
  idpConnection?: IdpConnection;
120
+ /** Authenticator connection. */
109
121
  authenticatorConnection?: AuthenticatorConnection;
110
122
  }
111
123
  /** @oneof */
112
124
  export interface ConnectionTypeOneOf {
125
+ /** IDP connection. */
113
126
  idpConnection?: IdpConnection;
127
+ /** Authenticator connection. */
114
128
  authenticatorConnection?: AuthenticatorConnection;
115
129
  }
116
130
  export interface IdpConnection {
131
+ /** IDP connection ID. */
117
132
  idpConnectionId?: string;
133
+ /** IDP user ID. */
118
134
  idpUserId?: string;
119
135
  }
120
136
  export interface AuthenticatorConnection {
137
+ /** Authenticator connection ID. */
121
138
  authenticatorConnectionId?: string;
139
+ /** Whether re-enrollment is required. */
122
140
  reEnrollmentRequired?: boolean;
123
141
  }
124
142
  export interface IdentityProfile {
143
+ /** Profile first name. */
125
144
  firstName?: string | null;
145
+ /** Profile last name. */
126
146
  lastName?: string | null;
147
+ /** Profile nickname. */
127
148
  nickname?: string | null;
149
+ /** Profile picture URL. */
128
150
  picture?: string | null;
151
+ /** Deprecated. Use `secondaryEmails` instead. */
129
152
  emails?: string[];
153
+ /** Deprecated. Use `phonesV2` instead. */
130
154
  phones?: string[];
155
+ /** List of profile labels. */
131
156
  labels?: string[];
157
+ /** Profile language. */
132
158
  language?: string | null;
159
+ /** Profile privacy status. */
133
160
  privacyStatus?: PrivacyStatus;
134
- /** custom profile fields */
161
+ /**
162
+ * Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
163
+ * are used to store additional information about your site or app's contacts.
164
+ */
135
165
  customFields?: CustomField[];
166
+ /** List of profile email addresses. */
136
167
  secondaryEmails?: SecondaryEmail[];
168
+ /** List of profile phone numbers. */
137
169
  phonesV2?: Phone[];
170
+ /** List of profile physical addresses. */
138
171
  addresses?: AddressWrapper[];
172
+ /** Company name. */
139
173
  company?: string | null;
174
+ /** Position within company. */
140
175
  position?: string | null;
176
+ /** Profile birthdate. */
141
177
  birthdate?: string | null;
142
178
  }
143
179
  export declare enum PrivacyStatus {
@@ -146,32 +182,52 @@ export declare enum PrivacyStatus {
146
182
  PRIVATE = "PRIVATE"
147
183
  }
148
184
  export interface CustomField {
185
+ /**
186
+ * Custom field name. The name must match one of the key properties of the objects returned by
187
+ * [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
188
+ * with the `custom.` prefix removed.
189
+ */
149
190
  name?: string;
191
+ /** Custom field value. */
150
192
  value?: CustomValue;
151
193
  }
152
194
  export interface CustomValue extends CustomValueValueOneOf {
195
+ /** String value. */
153
196
  strValue?: string;
197
+ /** Number value. */
154
198
  numValue?: number;
199
+ /** Date value. */
155
200
  dateValue?: Date;
201
+ /** List value. */
156
202
  listValue?: ListValue;
203
+ /** Map value. */
157
204
  mapValue?: MapValue;
158
205
  }
159
206
  /** @oneof */
160
207
  export interface CustomValueValueOneOf {
208
+ /** String value. */
161
209
  strValue?: string;
210
+ /** Number value. */
162
211
  numValue?: number;
212
+ /** Date value. */
163
213
  dateValue?: Date;
214
+ /** List value. */
164
215
  listValue?: ListValue;
216
+ /** Map value. */
165
217
  mapValue?: MapValue;
166
218
  }
167
219
  export interface ListValue {
220
+ /** Custom value. */
168
221
  value?: CustomValue[];
169
222
  }
170
223
  export interface MapValue {
224
+ /** Mapped custom value. */
171
225
  value?: Record<string, CustomValue>;
172
226
  }
173
227
  export interface SecondaryEmail {
228
+ /** Email address. */
174
229
  email?: string;
230
+ /** Email tag. */
175
231
  tag?: EmailTag;
176
232
  }
177
233
  export declare enum EmailTag {
@@ -181,8 +237,11 @@ export declare enum EmailTag {
181
237
  WORK = "WORK"
182
238
  }
183
239
  export interface Phone {
240
+ /** Phone country code. */
184
241
  countryCode?: string | null;
242
+ /** Phone number. */
185
243
  phone?: string;
244
+ /** Phone tag. */
186
245
  tag?: PhoneTag;
187
246
  }
188
247
  export declare enum PhoneTag {
@@ -194,7 +253,9 @@ export declare enum PhoneTag {
194
253
  FAX = "FAX"
195
254
  }
196
255
  export interface AddressWrapper {
256
+ /** Address. */
197
257
  address?: Address;
258
+ /** Address tag. */
198
259
  tag?: AddressTag;
199
260
  }
200
261
  /** Physical address */
@@ -1 +1 @@
1
- {"version":3,"file":"iam-recovery-v1-recovery.types.js","sourceRoot":"","sources":["../../../src/iam-recovery-v1-recovery.types.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAsCD,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,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AA+ED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAqCD,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AAQD,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,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAuBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAoBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,GAAN,cAAM,KAAN,cAAM,QAIjB"}
1
+ {"version":3,"file":"iam-recovery-v1-recovery.types.js","sourceRoot":"","sources":["../../../src/iam-recovery-v1-recovery.types.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAsCD,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,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AAmHD,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAyDD,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AAWD,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,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAyBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAoBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,GAAN,cAAM,KAAN,cAAM,QAIjB"}
@@ -39,17 +39,17 @@ export declare enum TenantType {
39
39
  ROOT = "ROOT"
40
40
  }
41
41
  export interface SendRecoveryEmailRequest {
42
- /** email of the identity */
42
+ /** Email address associated with the account to recover. */
43
43
  email: string;
44
- /** language of the email - if not recived will fallback to the identity language */
44
+ /** Language of the email to be sent. Defaults to the language specified in the member's profile. */
45
45
  language?: string | null;
46
- /** Where to redirect after a successful recovery process */
46
+ /** Where to redirect to after a successful recovery. */
47
47
  redirect?: Redirect;
48
48
  }
49
49
  export interface Redirect {
50
- /** The url where to redirect after a successful recovery process */
50
+ /** The URL to redirect to after a successful recovery. */
51
51
  url?: string;
52
- /** caller identifier */
52
+ /** Caller identifier. */
53
53
  clientId?: string | null;
54
54
  }
55
55
  export interface SendRecoveryEmailResponse {
@@ -61,13 +61,13 @@ export interface RecoverRequest {
61
61
  password?: string | null;
62
62
  }
63
63
  export interface StateMachineResponse {
64
- /** The current state */
64
+ /** The current state of the login or registration process. */
65
65
  state?: StateType;
66
- /** Session token - will be returned only when the state is success */
66
+ /** If state is `SUCCESS`, a session token. */
67
67
  sessionToken?: string | null;
68
- /** State token */
68
+ /** A token representing the current state of the login or registration process. */
69
69
  stateToken?: string | null;
70
- /** The current identity */
70
+ /** Identing of the current member. */
71
71
  identity?: Identity;
72
72
  }
73
73
  export declare enum StateType {
@@ -80,25 +80,35 @@ export declare enum StateType {
80
80
  export interface Identity {
81
81
  /** Identity ID */
82
82
  _id?: string | null;
83
+ /** Identifiers */
83
84
  identifiers?: Identifier[];
84
- /** 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 */
85
+ /**
86
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes.
87
+ * For an update operation to succeed, you MUST pass the latest revision.
88
+ */
85
89
  revision?: string | null;
86
90
  /**
87
- * Represents the time this Identity was created
91
+ * The time this identity was created.
88
92
  * @readonly
89
93
  */
90
94
  _createdDate?: Date;
91
95
  /**
92
- * Represents the time this Identity was last updated
96
+ * The time this identity was last updated.
93
97
  * @readonly
94
98
  */
95
99
  _updatedDate?: Date;
96
- /** All the identity configured connections to authenticate with */
100
+ /** The identity configured connections to authenticate with. */
97
101
  connections?: Connection[];
102
+ /** Identity profile. */
98
103
  identityProfile?: IdentityProfile;
99
- /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
104
+ /**
105
+ * Additional information about the identity that can impact user access.
106
+ * This data cannot be set.
107
+ */
100
108
  metadata?: Metadata;
109
+ /** Identity email address. */
101
110
  email?: Email;
111
+ /** Identity's current status. */
102
112
  status?: StatusV2;
103
113
  }
104
114
  export interface Identifier extends IdentifierValueOneOf {
@@ -111,39 +121,65 @@ export interface IdentifierValueOneOf {
111
121
  userName?: string;
112
122
  }
113
123
  export interface Connection extends ConnectionTypeOneOf {
124
+ /** IDP connection. */
114
125
  idpConnection?: IdpConnection;
126
+ /** Authenticator connection. */
115
127
  authenticatorConnection?: AuthenticatorConnection;
116
128
  }
117
129
  /** @oneof */
118
130
  export interface ConnectionTypeOneOf {
131
+ /** IDP connection. */
119
132
  idpConnection?: IdpConnection;
133
+ /** Authenticator connection. */
120
134
  authenticatorConnection?: AuthenticatorConnection;
121
135
  }
122
136
  export interface IdpConnection {
137
+ /** IDP connection ID. */
123
138
  idpConnectionId?: string;
139
+ /** IDP user ID. */
124
140
  idpUserId?: string;
125
141
  }
126
142
  export interface AuthenticatorConnection {
143
+ /** Authenticator connection ID. */
127
144
  authenticatorConnectionId?: string;
145
+ /** Whether re-enrollment is required. */
128
146
  reEnrollmentRequired?: boolean;
129
147
  }
130
148
  export interface IdentityProfile {
149
+ /** Profile first name. */
131
150
  firstName?: string | null;
151
+ /** Profile last name. */
132
152
  lastName?: string | null;
153
+ /** Profile nickname. */
133
154
  nickname?: string | null;
155
+ /** Profile picture URL. */
134
156
  picture?: string | null;
157
+ /** Deprecated. Use `secondaryEmails` instead. */
135
158
  emails?: string[];
159
+ /** Deprecated. Use `phonesV2` instead. */
136
160
  phones?: string[];
161
+ /** List of profile labels. */
137
162
  labels?: string[];
163
+ /** Profile language. */
138
164
  language?: string | null;
165
+ /** Profile privacy status. */
139
166
  privacyStatus?: PrivacyStatus;
140
- /** custom profile fields */
167
+ /**
168
+ * Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
169
+ * are used to store additional information about your site or app's contacts.
170
+ */
141
171
  customFields?: CustomField[];
172
+ /** List of profile email addresses. */
142
173
  secondaryEmails?: SecondaryEmail[];
174
+ /** List of profile phone numbers. */
143
175
  phonesV2?: Phone[];
176
+ /** List of profile physical addresses. */
144
177
  addresses?: AddressWrapper[];
178
+ /** Company name. */
145
179
  company?: string | null;
180
+ /** Position within company. */
146
181
  position?: string | null;
182
+ /** Profile birthdate. */
147
183
  birthdate?: string | null;
148
184
  }
149
185
  export declare enum PrivacyStatus {
@@ -152,32 +188,52 @@ export declare enum PrivacyStatus {
152
188
  PRIVATE = "PRIVATE"
153
189
  }
154
190
  export interface CustomField {
191
+ /**
192
+ * Custom field name. The name must match one of the key properties of the objects returned by
193
+ * [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
194
+ * with the `custom.` prefix removed.
195
+ */
155
196
  name?: string;
197
+ /** Custom field value. */
156
198
  value?: CustomValue;
157
199
  }
158
200
  export interface CustomValue extends CustomValueValueOneOf {
201
+ /** String value. */
159
202
  strValue?: string;
203
+ /** Number value. */
160
204
  numValue?: number;
205
+ /** Date value. */
161
206
  dateValue?: Date;
207
+ /** List value. */
162
208
  listValue?: ListValue;
209
+ /** Map value. */
163
210
  mapValue?: MapValue;
164
211
  }
165
212
  /** @oneof */
166
213
  export interface CustomValueValueOneOf {
214
+ /** String value. */
167
215
  strValue?: string;
216
+ /** Number value. */
168
217
  numValue?: number;
218
+ /** Date value. */
169
219
  dateValue?: Date;
220
+ /** List value. */
170
221
  listValue?: ListValue;
222
+ /** Map value. */
171
223
  mapValue?: MapValue;
172
224
  }
173
225
  export interface ListValue {
226
+ /** Custom value. */
174
227
  value?: CustomValue[];
175
228
  }
176
229
  export interface MapValue {
230
+ /** Mapped custom value. */
177
231
  value?: Record<string, CustomValue>;
178
232
  }
179
233
  export interface SecondaryEmail {
234
+ /** Email address. */
180
235
  email?: string;
236
+ /** Email tag. */
181
237
  tag?: EmailTag;
182
238
  }
183
239
  export declare enum EmailTag {
@@ -187,8 +243,11 @@ export declare enum EmailTag {
187
243
  WORK = "WORK"
188
244
  }
189
245
  export interface Phone {
246
+ /** Phone country code. */
190
247
  countryCode?: string | null;
248
+ /** Phone number. */
191
249
  phone?: string;
250
+ /** Phone tag. */
192
251
  tag?: PhoneTag;
193
252
  }
194
253
  export declare enum PhoneTag {
@@ -200,7 +259,9 @@ export declare enum PhoneTag {
200
259
  FAX = "FAX"
201
260
  }
202
261
  export interface AddressWrapper {
262
+ /** Address. */
203
263
  address?: Address;
264
+ /** Address tag. */
204
265
  tag?: AddressTag;
205
266
  }
206
267
  /** Physical address */
@@ -253,17 +314,18 @@ export declare enum Reason {
253
314
  PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
254
315
  }
255
316
  /**
256
- * Sends an recovery email with recovery token
257
- * @param email - email of the identity
317
+ * Sends a member an email containing a customized link to a Wix-managed page
318
+ * where the member can set a new password for their account.
319
+ * @param email - Email address associated with the account to recover.
258
320
  * @public
259
321
  * @documentationMaturity preview
260
322
  * @requiredField email
261
323
  */
262
324
  export declare function sendRecoveryEmail(email: string, options?: SendRecoveryEmailOptions): Promise<void>;
263
325
  export interface SendRecoveryEmailOptions {
264
- /** language of the email - if not recived will fallback to the identity language */
326
+ /** Language of the email to be sent. Defaults to the language specified in the member's profile. */
265
327
  language?: string | null;
266
- /** Where to redirect after a successful recovery process */
328
+ /** Where to redirect to after a successful recovery. */
267
329
  redirect?: Redirect;
268
330
  }
269
331
  /** @param recoveryToken - recovery token
@@ -120,8 +120,9 @@ const _sendRecoveryEmailRequest = {};
120
120
  const _sendRecoveryEmailResponse = {};
121
121
  const _stateMachineResponse = { identity: '_identity' };
122
122
  /**
123
- * Sends an recovery email with recovery token
124
- * @param email - email of the identity
123
+ * Sends a member an email containing a customized link to a Wix-managed page
124
+ * where the member can set a new password for their account.
125
+ * @param email - Email address associated with the account to recover.
125
126
  * @public
126
127
  * @documentationMaturity preview
127
128
  * @requiredField email
@@ -1 +1 @@
1
- {"version":3,"file":"iam-recovery-v1-recovery.universal.js","sourceRoot":"","sources":["../../../src/iam-recovery-v1-recovery.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,oGAAsF;AAEtF,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+B5B,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAsCD,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,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AA+ED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAqCD,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AAQD,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,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAuBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAoBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,GAAN,cAAM,KAAN,cAAM,QAIjB;AAED,MAAM,eAAe,GAAG,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAC1D,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC/C,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACxE,MAAM,SAAS,GAAG,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC;AAC1D,MAAM,gBAAgB,GAAG;IACvB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,iBAAiB;CAC7B,CAAC;AACF,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC7C,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAChD,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAExD;;;;;;GAMG;AACH,SAAsB,iBAAiB,CACrC,KAAa,EACb,OAAkC;;;QAElC,MAAM,qBAAqB,GAAG;YAC5B,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,eAAe;SAC1B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,kCAAkC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,KAAK,CAAC,6CAA6C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEzE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA1DD,8CA0DC;AASD;;;;GAIG;AACH,SAAsB,OAAO,CAC3B,aAAqB,EACrB,OAAwB;;;QAExB,MAAM,qBAAqB,GAAG;YAC5B,aAAa,EAAE,MAAM;YACrB,QAAQ,EAAE,eAAe;SAC1B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE;gBACV,eAAe;gBACf,YAAY;gBACZ,YAAY;gBACZ,SAAS;gBACT,gBAAgB;gBAChB,UAAU;gBACV,SAAS;aACV;YACD,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,kCAAkC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEpE,KAAK,CAAC,mCAAmC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE/D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,eAAe;gBACf,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAjED,0BAiEC"}
1
+ {"version":3,"file":"iam-recovery-v1-recovery.universal.js","sourceRoot":"","sources":["../../../src/iam-recovery-v1-recovery.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,oGAAsF;AAEtF,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+B5B,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAsCD,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,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AAmHD,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAyDD,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AAWD,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,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAyBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAoBD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,GAAN,cAAM,KAAN,cAAM,QAIjB;AAED,MAAM,eAAe,GAAG,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAC1D,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC/C,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACxE,MAAM,SAAS,GAAG,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC;AAC1D,MAAM,gBAAgB,GAAG;IACvB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,iBAAiB;CAC7B,CAAC;AACF,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC7C,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAChD,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAExD;;;;;;;GAOG;AACH,SAAsB,iBAAiB,CACrC,KAAa,EACb,OAAkC;;;QAElC,MAAM,qBAAqB,GAAG;YAC5B,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,eAAe;SAC1B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,kCAAkC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,KAAK,CAAC,6CAA6C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEzE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA1DD,8CA0DC;AASD;;;;GAIG;AACH,SAAsB,OAAO,CAC3B,aAAqB,EACrB,OAAwB;;;QAExB,MAAM,qBAAqB,GAAG;YAC5B,aAAa,EAAE,MAAM;YACrB,QAAQ,EAAE,eAAe;SAC1B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE;gBACV,eAAe;gBACf,YAAY;gBACZ,YAAY;gBACZ,SAAS;gBACT,gBAAgB;gBAChB,UAAU;gBACV,SAAS;aACV;YACD,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,kCAAkC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEpE,KAAK,CAAC,mCAAmC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE/D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,eAAe;gBACf,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAjED,0BAiEC"}
@@ -6,8 +6,12 @@ import { StateMachineResponse, StartRequest, StartResponse, VerifyDuringAuthenti
6
6
  */
7
7
  export declare function start(payload: StartRequest): RequestOptionsFactory<StartResponse>;
8
8
  /**
9
- * verifies the code in the request.
10
- * this endpoint is meant to be called during the authentication process only, thus it requires a stateToken.
11
- * the identity_id and the verification_id are extracted from the stateToken
9
+ * Continues the registration process when a member is required to verify an email address
10
+ * using a verification code received by email.
11
+ *
12
+ * Email verification is required when the registering member is already listed as a contact.
13
+ *
14
+ * Typically, after a sucessful verification, you generate and use member tokens for the
15
+ * registered member so that subsequent API calls are called as part of a member session.
12
16
  */
13
17
  export declare function verifyDuringAuthentication(payload: VerifyDuringAuthenticationRequest): RequestOptionsFactory<StateMachineResponse>;
@@ -67,9 +67,13 @@ function start(payload) {
67
67
  }
68
68
  exports.start = start;
69
69
  /**
70
- * verifies the code in the request.
71
- * this endpoint is meant to be called during the authentication process only, thus it requires a stateToken.
72
- * the identity_id and the verification_id are extracted from the stateToken
70
+ * Continues the registration process when a member is required to verify an email address
71
+ * using a verification code received by email.
72
+ *
73
+ * Email verification is required when the registering member is already listed as a contact.
74
+ *
75
+ * Typically, after a sucessful verification, you generate and use member tokens for the
76
+ * registered member so that subsequent API calls are called as part of a member session.
73
77
  */
74
78
  function verifyDuringAuthentication(payload) {
75
79
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_verifyDuringAuthenticationRequest, {});
@@ -1 +1 @@
1
- {"version":3,"file":"iam-verification-v1-start-response.http.js","sourceRoot":"","sources":["../../../src/iam-verification-v1-start-response.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC/C,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,WAAW;CACtB,CAAC;AACF,MAAM,SAAS,GAAG;IAChB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,eAAe,EAAE,kBAAkB;CACpC,CAAC;AACF,MAAM,gBAAgB,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAC1D,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC7C,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAChD,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACxD,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAE9C,SAAS,iDAAiD,CACxD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CACnB,OAAqB;IAErB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAE7D,SAAS,OAAO,CAAC,EAAE,IAAI,EAAO;QAC5B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,mDAAmD;YAC9D,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B,OAAO,OAAO,CAAC;AACjB,CAAC;AA3BD,sBA2BC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,OAA0C;IAE1C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kCAAkC,EAClC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,qBAAqB,EAAE;QAC9D,YAAY;QACZ,YAAY;QACZ,SAAS;QACT,gBAAgB;QAChB,UAAU;QACV,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,4BAA4B,CAAC,EAAE,IAAI,EAAO;QACjD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,wEAAwE;YAC1E,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4BAA4B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/C,OAAO,4BAA4B,CAAC;AACtC,CAAC;AAtCD,gEAsCC"}
1
+ {"version":3,"file":"iam-verification-v1-start-response.http.js","sourceRoot":"","sources":["../../../src/iam-verification-v1-start-response.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC/C,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,WAAW;CACtB,CAAC;AACF,MAAM,SAAS,GAAG;IAChB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,eAAe,EAAE,kBAAkB;CACpC,CAAC;AACF,MAAM,gBAAgB,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAC1D,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC7C,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAChD,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACxD,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAE9C,SAAS,iDAAiD,CACxD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CACnB,OAAqB;IAErB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAE7D,SAAS,OAAO,CAAC,EAAE,IAAI,EAAO;QAC5B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,mDAAmD;YAC9D,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B,OAAO,OAAO,CAAC;AACjB,CAAC;AA3BD,sBA2BC;AAED;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CACxC,OAA0C;IAE1C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kCAAkC,EAClC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,qBAAqB,EAAE;QAC9D,YAAY;QACZ,YAAY;QACZ,SAAS;QACT,gBAAgB;QAChB,UAAU;QACV,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,4BAA4B,CAAC,EAAE,IAAI,EAAO;QACjD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,wEAAwE;YAC1E,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4BAA4B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/C,OAAO,4BAA4B,CAAC;AACtC,CAAC;AAtCD,gEAsCC"}