@wix/identity 1.0.98 → 1.0.99
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.
- package/context.js.map +1 -0
- package/context.ts +4 -0
- package/index.js.map +1 -0
- package/index.ts +6 -0
- package/meta.js.map +1 -0
- package/meta.ts +4 -0
- package/package.json +26 -21
- package/build/cjs/context.js.map +0 -1
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/meta.js.map +0 -1
- package/context/package.json +0 -7
- package/meta/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -2785
- package/type-bundles/index.bundle.d.ts +0 -2785
- package/type-bundles/meta.bundle.d.ts +0 -3329
- /package/{build/cjs/context.d.ts → context.d.ts} +0 -0
- /package/{build/cjs/context.js → context.js} +0 -0
- /package/{build/cjs/index.d.ts → index.d.ts} +0 -0
- /package/{build/cjs/index.js → index.js} +0 -0
- /package/{build/cjs/meta.d.ts → meta.d.ts} +0 -0
- /package/{build/cjs/meta.js → meta.js} +0 -0
|
@@ -1,3329 +0,0 @@
|
|
|
1
|
-
interface RegisterV2Request$1 {
|
|
2
|
-
/** Identifier of registering member. */
|
|
3
|
-
loginId: LoginId$1;
|
|
4
|
-
/** Password of registering member. */
|
|
5
|
-
password?: string;
|
|
6
|
-
/** Profile information of registering member. */
|
|
7
|
-
profile?: IdentityProfile$5;
|
|
8
|
-
/** CAPTCHA tokens, when CAPTCHA setting is on. */
|
|
9
|
-
captchaTokens?: CaptchaToken$1[];
|
|
10
|
-
/** Additional data, relevant for the flow. */
|
|
11
|
-
clientMetaData?: Record<string, any> | null;
|
|
12
|
-
}
|
|
13
|
-
interface LoginId$1 extends LoginIdTypeOneOf$1 {
|
|
14
|
-
/** Login email address. */
|
|
15
|
-
email?: string;
|
|
16
|
-
}
|
|
17
|
-
/** @oneof */
|
|
18
|
-
interface LoginIdTypeOneOf$1 {
|
|
19
|
-
/** Login email address. */
|
|
20
|
-
email?: string;
|
|
21
|
-
}
|
|
22
|
-
interface IdentityProfile$5 {
|
|
23
|
-
/** Profile first name. */
|
|
24
|
-
firstName?: string | null;
|
|
25
|
-
/** Profile last name. */
|
|
26
|
-
lastName?: string | null;
|
|
27
|
-
/** Profile nickname. */
|
|
28
|
-
nickname?: string | null;
|
|
29
|
-
/** Profile picture URL. */
|
|
30
|
-
picture?: string | null;
|
|
31
|
-
/**
|
|
32
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
33
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
34
|
-
* @replacedBy secondary_emails
|
|
35
|
-
* @targetRemovalDate 2023-11-01
|
|
36
|
-
*/
|
|
37
|
-
emails?: string[];
|
|
38
|
-
/**
|
|
39
|
-
* Deprecated. Use `phonesV2` instead.
|
|
40
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
41
|
-
* @replacedBy phones_v2
|
|
42
|
-
* @targetRemovalDate 2023-11-01
|
|
43
|
-
*/
|
|
44
|
-
phones?: string[];
|
|
45
|
-
/** List of profile labels. */
|
|
46
|
-
labels?: string[];
|
|
47
|
-
/** Profile language. */
|
|
48
|
-
language?: string | null;
|
|
49
|
-
/** Profile privacy status. */
|
|
50
|
-
privacyStatus?: PrivacyStatus$5;
|
|
51
|
-
/**
|
|
52
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
53
|
-
* are used to store additional information about your site or app's contacts.
|
|
54
|
-
*/
|
|
55
|
-
customFields?: CustomField$5[];
|
|
56
|
-
/** List of profile email addresses. */
|
|
57
|
-
secondaryEmails?: SecondaryEmail$5[];
|
|
58
|
-
/** List of profile phone numbers. */
|
|
59
|
-
phonesV2?: Phone$5[];
|
|
60
|
-
/** List of profile physical addresses. */
|
|
61
|
-
addresses?: AddressWrapper$5[];
|
|
62
|
-
/** Company name. */
|
|
63
|
-
company?: string | null;
|
|
64
|
-
/** Position within company. */
|
|
65
|
-
position?: string | null;
|
|
66
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
67
|
-
birthdate?: string | null;
|
|
68
|
-
/** slug */
|
|
69
|
-
slug?: string | null;
|
|
70
|
-
}
|
|
71
|
-
declare enum PrivacyStatus$5 {
|
|
72
|
-
UNDEFINED = "UNDEFINED",
|
|
73
|
-
PUBLIC = "PUBLIC",
|
|
74
|
-
PRIVATE = "PRIVATE"
|
|
75
|
-
}
|
|
76
|
-
interface CustomField$5 {
|
|
77
|
-
/**
|
|
78
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
79
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
80
|
-
* with the `custom.` prefix removed.
|
|
81
|
-
*/
|
|
82
|
-
name?: string;
|
|
83
|
-
/** Custom field value. */
|
|
84
|
-
value?: V1CustomValue$5;
|
|
85
|
-
}
|
|
86
|
-
interface V1CustomValue$5 extends V1CustomValueValueOneOf$5 {
|
|
87
|
-
/** String value. */
|
|
88
|
-
strValue?: string;
|
|
89
|
-
/** Number value. */
|
|
90
|
-
numValue?: number;
|
|
91
|
-
/** Date value. */
|
|
92
|
-
dateValue?: Date | null;
|
|
93
|
-
/** List value. */
|
|
94
|
-
listValue?: V1ListValue$5;
|
|
95
|
-
/** Map value. */
|
|
96
|
-
mapValue?: V1MapValue$5;
|
|
97
|
-
}
|
|
98
|
-
/** @oneof */
|
|
99
|
-
interface V1CustomValueValueOneOf$5 {
|
|
100
|
-
/** String value. */
|
|
101
|
-
strValue?: string;
|
|
102
|
-
/** Number value. */
|
|
103
|
-
numValue?: number;
|
|
104
|
-
/** Date value. */
|
|
105
|
-
dateValue?: Date | null;
|
|
106
|
-
/** List value. */
|
|
107
|
-
listValue?: V1ListValue$5;
|
|
108
|
-
/** Map value. */
|
|
109
|
-
mapValue?: V1MapValue$5;
|
|
110
|
-
}
|
|
111
|
-
interface V1ListValue$5 {
|
|
112
|
-
/** Custom value. */
|
|
113
|
-
value?: V1CustomValue$5[];
|
|
114
|
-
}
|
|
115
|
-
interface V1MapValue$5 {
|
|
116
|
-
/** Mapped custom value. */
|
|
117
|
-
value?: Record<string, V1CustomValue$5>;
|
|
118
|
-
}
|
|
119
|
-
interface SecondaryEmail$5 {
|
|
120
|
-
/** Email address. */
|
|
121
|
-
email?: string;
|
|
122
|
-
/** Email tag. */
|
|
123
|
-
tag?: EmailTag$5;
|
|
124
|
-
}
|
|
125
|
-
declare enum EmailTag$5 {
|
|
126
|
-
UNTAGGED = "UNTAGGED",
|
|
127
|
-
MAIN = "MAIN",
|
|
128
|
-
HOME = "HOME",
|
|
129
|
-
WORK = "WORK"
|
|
130
|
-
}
|
|
131
|
-
interface Phone$5 {
|
|
132
|
-
/** Phone country code. */
|
|
133
|
-
countryCode?: string | null;
|
|
134
|
-
/** Phone number. */
|
|
135
|
-
phone?: string;
|
|
136
|
-
/** Phone tag. */
|
|
137
|
-
tag?: PhoneTag$5;
|
|
138
|
-
}
|
|
139
|
-
declare enum PhoneTag$5 {
|
|
140
|
-
UNTAGGED = "UNTAGGED",
|
|
141
|
-
MAIN = "MAIN",
|
|
142
|
-
HOME = "HOME",
|
|
143
|
-
MOBILE = "MOBILE",
|
|
144
|
-
WORK = "WORK",
|
|
145
|
-
FAX = "FAX"
|
|
146
|
-
}
|
|
147
|
-
interface AddressWrapper$5 {
|
|
148
|
-
/** Address. */
|
|
149
|
-
address?: Address$5;
|
|
150
|
-
/** Address tag. */
|
|
151
|
-
tag?: AddressTag$5;
|
|
152
|
-
}
|
|
153
|
-
/** Physical address */
|
|
154
|
-
interface Address$5 {
|
|
155
|
-
/** Country code. */
|
|
156
|
-
country?: string | null;
|
|
157
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
158
|
-
subdivision?: string | null;
|
|
159
|
-
/** City name. */
|
|
160
|
-
city?: string | null;
|
|
161
|
-
/** Zip/postal code. */
|
|
162
|
-
postalCode?: string | null;
|
|
163
|
-
/** Main address line, usually street and number as free text. */
|
|
164
|
-
addressLine?: string | null;
|
|
165
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
166
|
-
addressLine2?: string | null;
|
|
167
|
-
}
|
|
168
|
-
declare enum AddressTag$5 {
|
|
169
|
-
UNTAGGED = "UNTAGGED",
|
|
170
|
-
HOME = "HOME",
|
|
171
|
-
WORK = "WORK",
|
|
172
|
-
BILLING = "BILLING",
|
|
173
|
-
SHIPPING = "SHIPPING"
|
|
174
|
-
}
|
|
175
|
-
interface CaptchaToken$1 extends CaptchaTokenTokenOneOf$1 {
|
|
176
|
-
Recaptcha?: string;
|
|
177
|
-
InvisibleRecaptcha?: string;
|
|
178
|
-
NoCaptcha?: string;
|
|
179
|
-
}
|
|
180
|
-
/** @oneof */
|
|
181
|
-
interface CaptchaTokenTokenOneOf$1 {
|
|
182
|
-
Recaptcha?: string;
|
|
183
|
-
InvisibleRecaptcha?: string;
|
|
184
|
-
NoCaptcha?: string;
|
|
185
|
-
}
|
|
186
|
-
interface StateMachineResponse$5 extends StateMachineResponseStateDataOneOf$5 {
|
|
187
|
-
requireMfaData?: RequireMfaData$5;
|
|
188
|
-
mfaChallengeData?: MfaChallengeData$5;
|
|
189
|
-
/** The current state of the login or registration process. */
|
|
190
|
-
state?: StateType$5;
|
|
191
|
-
/** If state is `SUCCESS`, a session token. */
|
|
192
|
-
sessionToken?: string | null;
|
|
193
|
-
/** A token representing the current state of the login or registration process. */
|
|
194
|
-
stateToken?: string | null;
|
|
195
|
-
/** Identing of the current member. */
|
|
196
|
-
identity?: Identity$5;
|
|
197
|
-
/** additional_data = 5; //TBD */
|
|
198
|
-
additionalData?: Record<string, CustomValue$5>;
|
|
199
|
-
}
|
|
200
|
-
/** @oneof */
|
|
201
|
-
interface StateMachineResponseStateDataOneOf$5 {
|
|
202
|
-
requireMfaData?: RequireMfaData$5;
|
|
203
|
-
mfaChallengeData?: MfaChallengeData$5;
|
|
204
|
-
}
|
|
205
|
-
declare enum StateType$5 {
|
|
206
|
-
/** Initial unknown state. */
|
|
207
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
208
|
-
/** The operation completed successfully. */
|
|
209
|
-
SUCCESS = "SUCCESS",
|
|
210
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
211
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
212
|
-
/**
|
|
213
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
214
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
215
|
-
*/
|
|
216
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
217
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
218
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
219
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
220
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
221
|
-
}
|
|
222
|
-
interface Identity$5 {
|
|
223
|
-
/** Identity ID */
|
|
224
|
-
id?: string | null;
|
|
225
|
-
/**
|
|
226
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
227
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
228
|
-
*/
|
|
229
|
-
revision?: string | null;
|
|
230
|
-
/**
|
|
231
|
-
* The time this identity was created.
|
|
232
|
-
* @readonly
|
|
233
|
-
*/
|
|
234
|
-
createdDate?: Date | null;
|
|
235
|
-
/**
|
|
236
|
-
* The time this identity was last updated.
|
|
237
|
-
* @readonly
|
|
238
|
-
*/
|
|
239
|
-
updatedDate?: Date | null;
|
|
240
|
-
/** The identity configured connections to authenticate with. */
|
|
241
|
-
connections?: Connection$5[];
|
|
242
|
-
/** Identity profile. */
|
|
243
|
-
identityProfile?: IdentityProfile$5;
|
|
244
|
-
/**
|
|
245
|
-
* Additional information about the identity that can impact user access.
|
|
246
|
-
* This data cannot be set.
|
|
247
|
-
*/
|
|
248
|
-
metadata?: Metadata$5;
|
|
249
|
-
/** Identity email address. */
|
|
250
|
-
email?: Email$5;
|
|
251
|
-
/** Identity's current status. */
|
|
252
|
-
status?: StatusV2$5;
|
|
253
|
-
/** filled by pre registered spi */
|
|
254
|
-
customAttributes?: Record<string, any> | null;
|
|
255
|
-
/**
|
|
256
|
-
* Identity factors.
|
|
257
|
-
* @readonly
|
|
258
|
-
*/
|
|
259
|
-
factors?: Factor$5[];
|
|
260
|
-
}
|
|
261
|
-
interface Connection$5 extends ConnectionTypeOneOf$5 {
|
|
262
|
-
/** IDP connection. */
|
|
263
|
-
idpConnection?: IdpConnection$5;
|
|
264
|
-
/** Authenticator connection. */
|
|
265
|
-
authenticatorConnection?: AuthenticatorConnection$5;
|
|
266
|
-
}
|
|
267
|
-
/** @oneof */
|
|
268
|
-
interface ConnectionTypeOneOf$5 {
|
|
269
|
-
/** IDP connection. */
|
|
270
|
-
idpConnection?: IdpConnection$5;
|
|
271
|
-
/** Authenticator connection. */
|
|
272
|
-
authenticatorConnection?: AuthenticatorConnection$5;
|
|
273
|
-
}
|
|
274
|
-
interface IdpConnection$5 {
|
|
275
|
-
/** IDP connection ID. */
|
|
276
|
-
idpConnectionId?: string;
|
|
277
|
-
/** IDP user ID. */
|
|
278
|
-
idpUserId?: string;
|
|
279
|
-
}
|
|
280
|
-
interface AuthenticatorConnection$5 {
|
|
281
|
-
/** Authenticator connection ID. */
|
|
282
|
-
authenticatorConnectionId?: string;
|
|
283
|
-
/** Whether re-enrollment is required. */
|
|
284
|
-
reEnrollmentRequired?: boolean;
|
|
285
|
-
}
|
|
286
|
-
interface Metadata$5 {
|
|
287
|
-
/**
|
|
288
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
289
|
-
* @readonly
|
|
290
|
-
*/
|
|
291
|
-
tags?: string[];
|
|
292
|
-
}
|
|
293
|
-
interface Email$5 {
|
|
294
|
-
address?: string;
|
|
295
|
-
isVerified?: boolean;
|
|
296
|
-
}
|
|
297
|
-
interface StatusV2$5 {
|
|
298
|
-
name?: StatusName$5;
|
|
299
|
-
reasons?: Reason$5[];
|
|
300
|
-
}
|
|
301
|
-
declare enum StatusName$5 {
|
|
302
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
303
|
-
PENDING = "PENDING",
|
|
304
|
-
ACTIVE = "ACTIVE",
|
|
305
|
-
DELETED = "DELETED",
|
|
306
|
-
BLOCKED = "BLOCKED",
|
|
307
|
-
OFFLINE = "OFFLINE"
|
|
308
|
-
}
|
|
309
|
-
declare enum Reason$5 {
|
|
310
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
311
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
312
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
313
|
-
}
|
|
314
|
-
interface Factor$5 {
|
|
315
|
-
/** Factor ID. */
|
|
316
|
-
factorId?: string;
|
|
317
|
-
/** Factor type. */
|
|
318
|
-
type?: FactorType$5;
|
|
319
|
-
/** Factor status. */
|
|
320
|
-
status?: Status$5;
|
|
321
|
-
}
|
|
322
|
-
declare enum FactorType$5 {
|
|
323
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
324
|
-
PASSWORD = "PASSWORD",
|
|
325
|
-
SMS = "SMS",
|
|
326
|
-
CALL = "CALL",
|
|
327
|
-
EMAIL = "EMAIL",
|
|
328
|
-
TOTP = "TOTP",
|
|
329
|
-
PUSH = "PUSH"
|
|
330
|
-
}
|
|
331
|
-
declare enum Status$5 {
|
|
332
|
-
/** Factor requires activation. */
|
|
333
|
-
INACTIVE = "INACTIVE",
|
|
334
|
-
/** Factor is active and can be used for authentication. */
|
|
335
|
-
ACTIVE = "ACTIVE",
|
|
336
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
337
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
338
|
-
}
|
|
339
|
-
interface CustomValue$5 extends CustomValueValueOneOf$5 {
|
|
340
|
-
/** String value. */
|
|
341
|
-
strValue?: string;
|
|
342
|
-
/** Number value. */
|
|
343
|
-
numValue?: number;
|
|
344
|
-
/** Date value. */
|
|
345
|
-
dateValue?: Date | null;
|
|
346
|
-
/** List value. */
|
|
347
|
-
listValue?: ListValue$5;
|
|
348
|
-
/** Map value. */
|
|
349
|
-
mapValue?: MapValue$5;
|
|
350
|
-
}
|
|
351
|
-
/** @oneof */
|
|
352
|
-
interface CustomValueValueOneOf$5 {
|
|
353
|
-
/** String value. */
|
|
354
|
-
strValue?: string;
|
|
355
|
-
/** Number value. */
|
|
356
|
-
numValue?: number;
|
|
357
|
-
/** Date value. */
|
|
358
|
-
dateValue?: Date | null;
|
|
359
|
-
/** List value. */
|
|
360
|
-
listValue?: ListValue$5;
|
|
361
|
-
/** Map value. */
|
|
362
|
-
mapValue?: MapValue$5;
|
|
363
|
-
}
|
|
364
|
-
interface ListValue$5 {
|
|
365
|
-
/** Custom value. */
|
|
366
|
-
value?: CustomValue$5[];
|
|
367
|
-
}
|
|
368
|
-
interface MapValue$5 {
|
|
369
|
-
/** Mapped custom value. */
|
|
370
|
-
value?: Record<string, CustomValue$5>;
|
|
371
|
-
}
|
|
372
|
-
interface RequireMfaData$5 {
|
|
373
|
-
availableFactors?: V1Factor$5[];
|
|
374
|
-
}
|
|
375
|
-
interface V1Factor$5 {
|
|
376
|
-
factorType?: FactorType$5;
|
|
377
|
-
}
|
|
378
|
-
interface MfaChallengeData$5 {
|
|
379
|
-
factorType?: FactorType$5;
|
|
380
|
-
verificationChallengeData?: VerificationChallenge$5;
|
|
381
|
-
availableFactors?: V1Factor$5[];
|
|
382
|
-
}
|
|
383
|
-
interface VerificationChallenge$5 {
|
|
384
|
-
hint?: string | null;
|
|
385
|
-
}
|
|
386
|
-
interface LoginV2Request$1 {
|
|
387
|
-
/** Identifier of identity logging in. */
|
|
388
|
-
loginId: LoginId$1;
|
|
389
|
-
/** Password of the identity logging in. */
|
|
390
|
-
password?: string;
|
|
391
|
-
/** CAPTCHA tokens, when CAPTCHA setting is on. */
|
|
392
|
-
captchaTokens?: CaptchaToken$1[];
|
|
393
|
-
/** Additional data, relevant for the flow. */
|
|
394
|
-
clientMetaData?: Record<string, any> | null;
|
|
395
|
-
}
|
|
396
|
-
interface ChangePasswordRequest$1 {
|
|
397
|
-
/** The new password to set for the logged in user */
|
|
398
|
-
newPassword: string;
|
|
399
|
-
}
|
|
400
|
-
interface ChangePasswordResponse$1 {
|
|
401
|
-
}
|
|
402
|
-
interface LoginWithIdpConnectionRequest$1 {
|
|
403
|
-
/** The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData */
|
|
404
|
-
idpConnectionId: string;
|
|
405
|
-
/** The id of the tenant the caller wants to login into */
|
|
406
|
-
tenantId: string;
|
|
407
|
-
/** The type of the tenant the caller wants to login into */
|
|
408
|
-
tenantType: TenantType$1;
|
|
409
|
-
customPayload?: Record<string, string>;
|
|
410
|
-
/**
|
|
411
|
-
* This flow ultimately returns an HTML page that asynchronously posts the LoginResponse via the BroadcastChannel API.
|
|
412
|
-
* The message will be posted to a channel named `wix-idp-$session_id`, and encrypted with the `encryption_key`.
|
|
413
|
-
* Encryption key should be base64 encoded. Encryption is done using AES-GCM with a random IV that's sent alongside the payload
|
|
414
|
-
*/
|
|
415
|
-
sessionId: string;
|
|
416
|
-
encryptionKey: string;
|
|
417
|
-
visitorId?: string | null;
|
|
418
|
-
bsi?: string | null;
|
|
419
|
-
}
|
|
420
|
-
declare enum TenantType$1 {
|
|
421
|
-
UNKNOWN_TENANT_TYPE = "UNKNOWN_TENANT_TYPE",
|
|
422
|
-
ACCOUNT = "ACCOUNT",
|
|
423
|
-
SITE = "SITE",
|
|
424
|
-
ROOT = "ROOT"
|
|
425
|
-
}
|
|
426
|
-
interface RawHttpResponse$3 {
|
|
427
|
-
body?: Uint8Array;
|
|
428
|
-
statusCode?: number | null;
|
|
429
|
-
headers?: HeadersEntry$3[];
|
|
430
|
-
}
|
|
431
|
-
interface HeadersEntry$3 {
|
|
432
|
-
key?: string;
|
|
433
|
-
value?: string;
|
|
434
|
-
}
|
|
435
|
-
interface LoginCallbackRequest$1 {
|
|
436
|
-
/** state that that received on the redirect */
|
|
437
|
-
state?: string;
|
|
438
|
-
/** session token */
|
|
439
|
-
sessionToken?: string;
|
|
440
|
-
}
|
|
441
|
-
interface LoginWithIdpConnectionTokenParamsRequest$1 {
|
|
442
|
-
/** The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData */
|
|
443
|
-
idpConnectionId?: string;
|
|
444
|
-
/** A set of fields that are required for the connection to be able to identify and authenticate the user */
|
|
445
|
-
tokenParams?: Record<string, string>;
|
|
446
|
-
}
|
|
447
|
-
interface SignOnRequest$1 {
|
|
448
|
-
/** the identifier of the identity */
|
|
449
|
-
loginId: LoginId$1;
|
|
450
|
-
/** profile of the identity */
|
|
451
|
-
profile?: IdentityProfile$5;
|
|
452
|
-
/** when true will mark the email of the identity as verified */
|
|
453
|
-
verifyEmail?: boolean;
|
|
454
|
-
/** when false will create a new contact instead of merging the existing contact into the identity */
|
|
455
|
-
mergeExistingContact?: boolean;
|
|
456
|
-
}
|
|
457
|
-
interface SignOnResponse$1 {
|
|
458
|
-
/** session token for the requested identity */
|
|
459
|
-
sessionToken?: string;
|
|
460
|
-
/** The Identity of the provided login_id */
|
|
461
|
-
identity?: Identity$5;
|
|
462
|
-
}
|
|
463
|
-
/** logout request payload */
|
|
464
|
-
interface LogoutRequest$1 {
|
|
465
|
-
/** redirect after logout */
|
|
466
|
-
postLogoutRedirectUri?: string | null;
|
|
467
|
-
/** caller identifier */
|
|
468
|
-
clientId?: string | null;
|
|
469
|
-
}
|
|
470
|
-
interface VerifyRequest$1 extends VerifyRequestFactorDataOneOf$1 {
|
|
471
|
-
smsData?: SmsVerifyData$1;
|
|
472
|
-
callData?: CallVerifyData$1;
|
|
473
|
-
emailData?: EmailVerifyData$1;
|
|
474
|
-
totpData?: TotpVerifyData$1;
|
|
475
|
-
/** TODO: is this a reasonable maxLength? */
|
|
476
|
-
stateToken?: string;
|
|
477
|
-
factorType: FactorType$5;
|
|
478
|
-
rememberThisDevice?: boolean;
|
|
479
|
-
}
|
|
480
|
-
/** @oneof */
|
|
481
|
-
interface VerifyRequestFactorDataOneOf$1 {
|
|
482
|
-
smsData?: SmsVerifyData$1;
|
|
483
|
-
callData?: CallVerifyData$1;
|
|
484
|
-
emailData?: EmailVerifyData$1;
|
|
485
|
-
totpData?: TotpVerifyData$1;
|
|
486
|
-
}
|
|
487
|
-
interface SmsVerifyData$1 {
|
|
488
|
-
code?: string | null;
|
|
489
|
-
}
|
|
490
|
-
interface CallVerifyData$1 {
|
|
491
|
-
code?: string | null;
|
|
492
|
-
}
|
|
493
|
-
interface EmailVerifyData$1 {
|
|
494
|
-
code?: string | null;
|
|
495
|
-
}
|
|
496
|
-
interface TotpVerifyData$1 {
|
|
497
|
-
code?: string | null;
|
|
498
|
-
}
|
|
499
|
-
interface V1FactorNonNullableFields$5 {
|
|
500
|
-
factorType: FactorType$5;
|
|
501
|
-
}
|
|
502
|
-
interface RequireMfaDataNonNullableFields$5 {
|
|
503
|
-
availableFactors: V1FactorNonNullableFields$5[];
|
|
504
|
-
}
|
|
505
|
-
interface MfaChallengeDataNonNullableFields$5 {
|
|
506
|
-
factorType: FactorType$5;
|
|
507
|
-
availableFactors: V1FactorNonNullableFields$5[];
|
|
508
|
-
}
|
|
509
|
-
interface IdpConnectionNonNullableFields$5 {
|
|
510
|
-
idpConnectionId: string;
|
|
511
|
-
idpUserId: string;
|
|
512
|
-
}
|
|
513
|
-
interface AuthenticatorConnectionNonNullableFields$5 {
|
|
514
|
-
authenticatorConnectionId: string;
|
|
515
|
-
reEnrollmentRequired: boolean;
|
|
516
|
-
}
|
|
517
|
-
interface ConnectionNonNullableFields$5 {
|
|
518
|
-
idpConnection?: IdpConnectionNonNullableFields$5;
|
|
519
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields$5;
|
|
520
|
-
}
|
|
521
|
-
interface V1ListValueNonNullableFields$5 {
|
|
522
|
-
value: V1CustomValueNonNullableFields$5[];
|
|
523
|
-
}
|
|
524
|
-
interface V1CustomValueNonNullableFields$5 {
|
|
525
|
-
strValue: string;
|
|
526
|
-
numValue: number;
|
|
527
|
-
listValue?: V1ListValueNonNullableFields$5;
|
|
528
|
-
}
|
|
529
|
-
interface CustomFieldNonNullableFields$5 {
|
|
530
|
-
name: string;
|
|
531
|
-
value?: V1CustomValueNonNullableFields$5;
|
|
532
|
-
}
|
|
533
|
-
interface SecondaryEmailNonNullableFields$5 {
|
|
534
|
-
email: string;
|
|
535
|
-
tag: EmailTag$5;
|
|
536
|
-
}
|
|
537
|
-
interface PhoneNonNullableFields$5 {
|
|
538
|
-
phone: string;
|
|
539
|
-
tag: PhoneTag$5;
|
|
540
|
-
}
|
|
541
|
-
interface AddressWrapperNonNullableFields$5 {
|
|
542
|
-
tag: AddressTag$5;
|
|
543
|
-
}
|
|
544
|
-
interface IdentityProfileNonNullableFields$5 {
|
|
545
|
-
emails: string[];
|
|
546
|
-
phones: string[];
|
|
547
|
-
labels: string[];
|
|
548
|
-
privacyStatus: PrivacyStatus$5;
|
|
549
|
-
customFields: CustomFieldNonNullableFields$5[];
|
|
550
|
-
secondaryEmails: SecondaryEmailNonNullableFields$5[];
|
|
551
|
-
phonesV2: PhoneNonNullableFields$5[];
|
|
552
|
-
addresses: AddressWrapperNonNullableFields$5[];
|
|
553
|
-
}
|
|
554
|
-
interface MetadataNonNullableFields$5 {
|
|
555
|
-
tags: string[];
|
|
556
|
-
}
|
|
557
|
-
interface EmailNonNullableFields$5 {
|
|
558
|
-
address: string;
|
|
559
|
-
isVerified: boolean;
|
|
560
|
-
}
|
|
561
|
-
interface StatusV2NonNullableFields$5 {
|
|
562
|
-
name: StatusName$5;
|
|
563
|
-
reasons: Reason$5[];
|
|
564
|
-
}
|
|
565
|
-
interface FactorNonNullableFields$5 {
|
|
566
|
-
factorId: string;
|
|
567
|
-
type: FactorType$5;
|
|
568
|
-
status: Status$5;
|
|
569
|
-
}
|
|
570
|
-
interface IdentityNonNullableFields$5 {
|
|
571
|
-
connections: ConnectionNonNullableFields$5[];
|
|
572
|
-
identityProfile?: IdentityProfileNonNullableFields$5;
|
|
573
|
-
metadata?: MetadataNonNullableFields$5;
|
|
574
|
-
email?: EmailNonNullableFields$5;
|
|
575
|
-
status?: StatusV2NonNullableFields$5;
|
|
576
|
-
factors: FactorNonNullableFields$5[];
|
|
577
|
-
}
|
|
578
|
-
interface StateMachineResponseNonNullableFields$5 {
|
|
579
|
-
requireMfaData?: RequireMfaDataNonNullableFields$5;
|
|
580
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields$5;
|
|
581
|
-
state: StateType$5;
|
|
582
|
-
identity?: IdentityNonNullableFields$5;
|
|
583
|
-
}
|
|
584
|
-
interface HeadersEntryNonNullableFields$3 {
|
|
585
|
-
key: string;
|
|
586
|
-
value: string;
|
|
587
|
-
}
|
|
588
|
-
interface RawHttpResponseNonNullableFields$3 {
|
|
589
|
-
body: Uint8Array;
|
|
590
|
-
headers: HeadersEntryNonNullableFields$3[];
|
|
591
|
-
}
|
|
592
|
-
interface SignOnResponseNonNullableFields$1 {
|
|
593
|
-
sessionToken: string;
|
|
594
|
-
identity?: IdentityNonNullableFields$5;
|
|
595
|
-
}
|
|
596
|
-
|
|
597
|
-
interface RegisterV2Request {
|
|
598
|
-
/** Identifier of registering member. */
|
|
599
|
-
loginId: LoginId;
|
|
600
|
-
/** Password of registering member. */
|
|
601
|
-
password?: string;
|
|
602
|
-
/** Profile information of registering member. */
|
|
603
|
-
profile?: IdentityProfile$4;
|
|
604
|
-
/** CAPTCHA tokens, when CAPTCHA setting is on. */
|
|
605
|
-
captchaTokens?: CaptchaToken[];
|
|
606
|
-
/** Additional data, relevant for the flow. */
|
|
607
|
-
clientMetaData?: Record<string, any> | null;
|
|
608
|
-
}
|
|
609
|
-
interface LoginId extends LoginIdTypeOneOf {
|
|
610
|
-
/** Login email address. */
|
|
611
|
-
email?: string;
|
|
612
|
-
}
|
|
613
|
-
/** @oneof */
|
|
614
|
-
interface LoginIdTypeOneOf {
|
|
615
|
-
/** Login email address. */
|
|
616
|
-
email?: string;
|
|
617
|
-
}
|
|
618
|
-
interface IdentityProfile$4 {
|
|
619
|
-
/** Profile first name. */
|
|
620
|
-
firstName?: string | null;
|
|
621
|
-
/** Profile last name. */
|
|
622
|
-
lastName?: string | null;
|
|
623
|
-
/** Profile nickname. */
|
|
624
|
-
nickname?: string | null;
|
|
625
|
-
/** Profile picture URL. */
|
|
626
|
-
picture?: string | null;
|
|
627
|
-
/**
|
|
628
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
629
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
630
|
-
* @replacedBy secondary_emails
|
|
631
|
-
* @targetRemovalDate 2023-11-01
|
|
632
|
-
*/
|
|
633
|
-
emails?: string[];
|
|
634
|
-
/**
|
|
635
|
-
* Deprecated. Use `phonesV2` instead.
|
|
636
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
637
|
-
* @replacedBy phones_v2
|
|
638
|
-
* @targetRemovalDate 2023-11-01
|
|
639
|
-
*/
|
|
640
|
-
phones?: string[];
|
|
641
|
-
/** List of profile labels. */
|
|
642
|
-
labels?: string[];
|
|
643
|
-
/** Profile language. */
|
|
644
|
-
language?: string | null;
|
|
645
|
-
/** Profile privacy status. */
|
|
646
|
-
privacyStatus?: PrivacyStatus$4;
|
|
647
|
-
/**
|
|
648
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
649
|
-
* are used to store additional information about your site or app's contacts.
|
|
650
|
-
*/
|
|
651
|
-
customFields?: CustomField$4[];
|
|
652
|
-
/** List of profile email addresses. */
|
|
653
|
-
secondaryEmails?: SecondaryEmail$4[];
|
|
654
|
-
/** List of profile phone numbers. */
|
|
655
|
-
phonesV2?: Phone$4[];
|
|
656
|
-
/** List of profile physical addresses. */
|
|
657
|
-
addresses?: AddressWrapper$4[];
|
|
658
|
-
/** Company name. */
|
|
659
|
-
company?: string | null;
|
|
660
|
-
/** Position within company. */
|
|
661
|
-
position?: string | null;
|
|
662
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
663
|
-
birthdate?: string | null;
|
|
664
|
-
/** slug */
|
|
665
|
-
slug?: string | null;
|
|
666
|
-
}
|
|
667
|
-
declare enum PrivacyStatus$4 {
|
|
668
|
-
UNDEFINED = "UNDEFINED",
|
|
669
|
-
PUBLIC = "PUBLIC",
|
|
670
|
-
PRIVATE = "PRIVATE"
|
|
671
|
-
}
|
|
672
|
-
interface CustomField$4 {
|
|
673
|
-
/**
|
|
674
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
675
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
676
|
-
* with the `custom.` prefix removed.
|
|
677
|
-
*/
|
|
678
|
-
name?: string;
|
|
679
|
-
/** Custom field value. */
|
|
680
|
-
value?: V1CustomValue$4;
|
|
681
|
-
}
|
|
682
|
-
interface V1CustomValue$4 extends V1CustomValueValueOneOf$4 {
|
|
683
|
-
/** String value. */
|
|
684
|
-
strValue?: string;
|
|
685
|
-
/** Number value. */
|
|
686
|
-
numValue?: number;
|
|
687
|
-
/** Date value. */
|
|
688
|
-
dateValue?: Date | null;
|
|
689
|
-
/** List value. */
|
|
690
|
-
listValue?: V1ListValue$4;
|
|
691
|
-
/** Map value. */
|
|
692
|
-
mapValue?: V1MapValue$4;
|
|
693
|
-
}
|
|
694
|
-
/** @oneof */
|
|
695
|
-
interface V1CustomValueValueOneOf$4 {
|
|
696
|
-
/** String value. */
|
|
697
|
-
strValue?: string;
|
|
698
|
-
/** Number value. */
|
|
699
|
-
numValue?: number;
|
|
700
|
-
/** Date value. */
|
|
701
|
-
dateValue?: Date | null;
|
|
702
|
-
/** List value. */
|
|
703
|
-
listValue?: V1ListValue$4;
|
|
704
|
-
/** Map value. */
|
|
705
|
-
mapValue?: V1MapValue$4;
|
|
706
|
-
}
|
|
707
|
-
interface V1ListValue$4 {
|
|
708
|
-
/** Custom value. */
|
|
709
|
-
value?: V1CustomValue$4[];
|
|
710
|
-
}
|
|
711
|
-
interface V1MapValue$4 {
|
|
712
|
-
/** Mapped custom value. */
|
|
713
|
-
value?: Record<string, V1CustomValue$4>;
|
|
714
|
-
}
|
|
715
|
-
interface SecondaryEmail$4 {
|
|
716
|
-
/** Email address. */
|
|
717
|
-
email?: string;
|
|
718
|
-
/** Email tag. */
|
|
719
|
-
tag?: EmailTag$4;
|
|
720
|
-
}
|
|
721
|
-
declare enum EmailTag$4 {
|
|
722
|
-
UNTAGGED = "UNTAGGED",
|
|
723
|
-
MAIN = "MAIN",
|
|
724
|
-
HOME = "HOME",
|
|
725
|
-
WORK = "WORK"
|
|
726
|
-
}
|
|
727
|
-
interface Phone$4 {
|
|
728
|
-
/** Phone country code. */
|
|
729
|
-
countryCode?: string | null;
|
|
730
|
-
/** Phone number. */
|
|
731
|
-
phone?: string;
|
|
732
|
-
/** Phone tag. */
|
|
733
|
-
tag?: PhoneTag$4;
|
|
734
|
-
}
|
|
735
|
-
declare enum PhoneTag$4 {
|
|
736
|
-
UNTAGGED = "UNTAGGED",
|
|
737
|
-
MAIN = "MAIN",
|
|
738
|
-
HOME = "HOME",
|
|
739
|
-
MOBILE = "MOBILE",
|
|
740
|
-
WORK = "WORK",
|
|
741
|
-
FAX = "FAX"
|
|
742
|
-
}
|
|
743
|
-
interface AddressWrapper$4 {
|
|
744
|
-
/** Address. */
|
|
745
|
-
address?: Address$4;
|
|
746
|
-
/** Address tag. */
|
|
747
|
-
tag?: AddressTag$4;
|
|
748
|
-
}
|
|
749
|
-
/** Physical address */
|
|
750
|
-
interface Address$4 {
|
|
751
|
-
/** Country code. */
|
|
752
|
-
country?: string | null;
|
|
753
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
754
|
-
subdivision?: string | null;
|
|
755
|
-
/** City name. */
|
|
756
|
-
city?: string | null;
|
|
757
|
-
/** Zip/postal code. */
|
|
758
|
-
postalCode?: string | null;
|
|
759
|
-
/** Main address line, usually street and number as free text. */
|
|
760
|
-
addressLine1?: string | null;
|
|
761
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
762
|
-
addressLine2?: string | null;
|
|
763
|
-
}
|
|
764
|
-
declare enum AddressTag$4 {
|
|
765
|
-
UNTAGGED = "UNTAGGED",
|
|
766
|
-
HOME = "HOME",
|
|
767
|
-
WORK = "WORK",
|
|
768
|
-
BILLING = "BILLING",
|
|
769
|
-
SHIPPING = "SHIPPING"
|
|
770
|
-
}
|
|
771
|
-
interface CaptchaToken extends CaptchaTokenTokenOneOf {
|
|
772
|
-
Recaptcha?: string;
|
|
773
|
-
InvisibleRecaptcha?: string;
|
|
774
|
-
NoCaptcha?: string;
|
|
775
|
-
}
|
|
776
|
-
/** @oneof */
|
|
777
|
-
interface CaptchaTokenTokenOneOf {
|
|
778
|
-
Recaptcha?: string;
|
|
779
|
-
InvisibleRecaptcha?: string;
|
|
780
|
-
NoCaptcha?: string;
|
|
781
|
-
}
|
|
782
|
-
interface StateMachineResponse$4 extends StateMachineResponseStateDataOneOf$4 {
|
|
783
|
-
requireMfaData?: RequireMfaData$4;
|
|
784
|
-
mfaChallengeData?: MfaChallengeData$4;
|
|
785
|
-
/** The current state of the login or registration process. */
|
|
786
|
-
state?: StateType$4;
|
|
787
|
-
/** If state is `SUCCESS`, a session token. */
|
|
788
|
-
sessionToken?: string | null;
|
|
789
|
-
/** A token representing the current state of the login or registration process. */
|
|
790
|
-
stateToken?: string | null;
|
|
791
|
-
/** Identing of the current member. */
|
|
792
|
-
identity?: Identity$4;
|
|
793
|
-
/** additional_data = 5; //TBD */
|
|
794
|
-
additionalData?: Record<string, CustomValue$4>;
|
|
795
|
-
}
|
|
796
|
-
/** @oneof */
|
|
797
|
-
interface StateMachineResponseStateDataOneOf$4 {
|
|
798
|
-
requireMfaData?: RequireMfaData$4;
|
|
799
|
-
mfaChallengeData?: MfaChallengeData$4;
|
|
800
|
-
}
|
|
801
|
-
declare enum StateType$4 {
|
|
802
|
-
/** Initial unknown state. */
|
|
803
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
804
|
-
/** The operation completed successfully. */
|
|
805
|
-
SUCCESS = "SUCCESS",
|
|
806
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
807
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
808
|
-
/**
|
|
809
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
810
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
811
|
-
*/
|
|
812
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
813
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
814
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
815
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
816
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
817
|
-
}
|
|
818
|
-
interface Identity$4 {
|
|
819
|
-
/** Identity ID */
|
|
820
|
-
_id?: string | null;
|
|
821
|
-
/**
|
|
822
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
823
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
824
|
-
*/
|
|
825
|
-
revision?: string | null;
|
|
826
|
-
/**
|
|
827
|
-
* The time this identity was created.
|
|
828
|
-
* @readonly
|
|
829
|
-
*/
|
|
830
|
-
_createdDate?: Date | null;
|
|
831
|
-
/**
|
|
832
|
-
* The time this identity was last updated.
|
|
833
|
-
* @readonly
|
|
834
|
-
*/
|
|
835
|
-
_updatedDate?: Date | null;
|
|
836
|
-
/** The identity configured connections to authenticate with. */
|
|
837
|
-
connections?: Connection$4[];
|
|
838
|
-
/** Identity profile. */
|
|
839
|
-
identityProfile?: IdentityProfile$4;
|
|
840
|
-
/**
|
|
841
|
-
* Additional information about the identity that can impact user access.
|
|
842
|
-
* This data cannot be set.
|
|
843
|
-
*/
|
|
844
|
-
metadata?: Metadata$4;
|
|
845
|
-
/** Identity email address. */
|
|
846
|
-
email?: Email$4;
|
|
847
|
-
/** Identity's current status. */
|
|
848
|
-
status?: StatusV2$4;
|
|
849
|
-
/** filled by pre registered spi */
|
|
850
|
-
customAttributes?: Record<string, any> | null;
|
|
851
|
-
/**
|
|
852
|
-
* Identity factors.
|
|
853
|
-
* @readonly
|
|
854
|
-
*/
|
|
855
|
-
factors?: Factor$4[];
|
|
856
|
-
}
|
|
857
|
-
interface Connection$4 extends ConnectionTypeOneOf$4 {
|
|
858
|
-
/** IDP connection. */
|
|
859
|
-
idpConnection?: IdpConnection$4;
|
|
860
|
-
/** Authenticator connection. */
|
|
861
|
-
authenticatorConnection?: AuthenticatorConnection$4;
|
|
862
|
-
}
|
|
863
|
-
/** @oneof */
|
|
864
|
-
interface ConnectionTypeOneOf$4 {
|
|
865
|
-
/** IDP connection. */
|
|
866
|
-
idpConnection?: IdpConnection$4;
|
|
867
|
-
/** Authenticator connection. */
|
|
868
|
-
authenticatorConnection?: AuthenticatorConnection$4;
|
|
869
|
-
}
|
|
870
|
-
interface IdpConnection$4 {
|
|
871
|
-
/** IDP connection ID. */
|
|
872
|
-
idpConnectionId?: string;
|
|
873
|
-
/** IDP user ID. */
|
|
874
|
-
idpUserId?: string;
|
|
875
|
-
}
|
|
876
|
-
interface AuthenticatorConnection$4 {
|
|
877
|
-
/** Authenticator connection ID. */
|
|
878
|
-
authenticatorConnectionId?: string;
|
|
879
|
-
/** Whether re-enrollment is required. */
|
|
880
|
-
reEnrollmentRequired?: boolean;
|
|
881
|
-
}
|
|
882
|
-
interface Metadata$4 {
|
|
883
|
-
/**
|
|
884
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
885
|
-
* @readonly
|
|
886
|
-
*/
|
|
887
|
-
tags?: string[];
|
|
888
|
-
}
|
|
889
|
-
interface Email$4 {
|
|
890
|
-
address?: string;
|
|
891
|
-
isVerified?: boolean;
|
|
892
|
-
}
|
|
893
|
-
interface StatusV2$4 {
|
|
894
|
-
name?: StatusName$4;
|
|
895
|
-
reasons?: Reason$4[];
|
|
896
|
-
}
|
|
897
|
-
declare enum StatusName$4 {
|
|
898
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
899
|
-
PENDING = "PENDING",
|
|
900
|
-
ACTIVE = "ACTIVE",
|
|
901
|
-
DELETED = "DELETED",
|
|
902
|
-
BLOCKED = "BLOCKED",
|
|
903
|
-
OFFLINE = "OFFLINE"
|
|
904
|
-
}
|
|
905
|
-
declare enum Reason$4 {
|
|
906
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
907
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
908
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
909
|
-
}
|
|
910
|
-
interface Factor$4 {
|
|
911
|
-
/** Factor ID. */
|
|
912
|
-
factorId?: string;
|
|
913
|
-
/** Factor type. */
|
|
914
|
-
type?: FactorType$4;
|
|
915
|
-
/** Factor status. */
|
|
916
|
-
status?: Status$4;
|
|
917
|
-
}
|
|
918
|
-
declare enum FactorType$4 {
|
|
919
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
920
|
-
PASSWORD = "PASSWORD",
|
|
921
|
-
SMS = "SMS",
|
|
922
|
-
CALL = "CALL",
|
|
923
|
-
EMAIL = "EMAIL",
|
|
924
|
-
TOTP = "TOTP",
|
|
925
|
-
PUSH = "PUSH"
|
|
926
|
-
}
|
|
927
|
-
declare enum Status$4 {
|
|
928
|
-
/** Factor requires activation. */
|
|
929
|
-
INACTIVE = "INACTIVE",
|
|
930
|
-
/** Factor is active and can be used for authentication. */
|
|
931
|
-
ACTIVE = "ACTIVE",
|
|
932
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
933
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
934
|
-
}
|
|
935
|
-
interface CustomValue$4 extends CustomValueValueOneOf$4 {
|
|
936
|
-
/** String value. */
|
|
937
|
-
strValue?: string;
|
|
938
|
-
/** Number value. */
|
|
939
|
-
numValue?: number;
|
|
940
|
-
/** Date value. */
|
|
941
|
-
dateValue?: Date | null;
|
|
942
|
-
/** List value. */
|
|
943
|
-
listValue?: ListValue$4;
|
|
944
|
-
/** Map value. */
|
|
945
|
-
mapValue?: MapValue$4;
|
|
946
|
-
}
|
|
947
|
-
/** @oneof */
|
|
948
|
-
interface CustomValueValueOneOf$4 {
|
|
949
|
-
/** String value. */
|
|
950
|
-
strValue?: string;
|
|
951
|
-
/** Number value. */
|
|
952
|
-
numValue?: number;
|
|
953
|
-
/** Date value. */
|
|
954
|
-
dateValue?: Date | null;
|
|
955
|
-
/** List value. */
|
|
956
|
-
listValue?: ListValue$4;
|
|
957
|
-
/** Map value. */
|
|
958
|
-
mapValue?: MapValue$4;
|
|
959
|
-
}
|
|
960
|
-
interface ListValue$4 {
|
|
961
|
-
/** Custom value. */
|
|
962
|
-
value?: CustomValue$4[];
|
|
963
|
-
}
|
|
964
|
-
interface MapValue$4 {
|
|
965
|
-
/** Mapped custom value. */
|
|
966
|
-
value?: Record<string, CustomValue$4>;
|
|
967
|
-
}
|
|
968
|
-
interface RequireMfaData$4 {
|
|
969
|
-
availableFactors?: V1Factor$4[];
|
|
970
|
-
}
|
|
971
|
-
interface V1Factor$4 {
|
|
972
|
-
factorType?: FactorType$4;
|
|
973
|
-
}
|
|
974
|
-
interface MfaChallengeData$4 {
|
|
975
|
-
factorType?: FactorType$4;
|
|
976
|
-
verificationChallengeData?: VerificationChallenge$4;
|
|
977
|
-
availableFactors?: V1Factor$4[];
|
|
978
|
-
}
|
|
979
|
-
interface VerificationChallenge$4 {
|
|
980
|
-
hint?: string | null;
|
|
981
|
-
}
|
|
982
|
-
interface LoginV2Request {
|
|
983
|
-
/** Identifier of identity logging in. */
|
|
984
|
-
loginId: LoginId;
|
|
985
|
-
/** Password of the identity logging in. */
|
|
986
|
-
password?: string;
|
|
987
|
-
/** CAPTCHA tokens, when CAPTCHA setting is on. */
|
|
988
|
-
captchaTokens?: CaptchaToken[];
|
|
989
|
-
/** Additional data, relevant for the flow. */
|
|
990
|
-
clientMetaData?: Record<string, any> | null;
|
|
991
|
-
}
|
|
992
|
-
interface ChangePasswordRequest {
|
|
993
|
-
/** The new password to set for the logged in user */
|
|
994
|
-
newPassword: string;
|
|
995
|
-
}
|
|
996
|
-
interface ChangePasswordResponse {
|
|
997
|
-
}
|
|
998
|
-
interface LoginWithIdpConnectionRequest {
|
|
999
|
-
/** The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData */
|
|
1000
|
-
idpConnectionId: string;
|
|
1001
|
-
/** The id of the tenant the caller wants to login into */
|
|
1002
|
-
tenantId: string;
|
|
1003
|
-
/** The type of the tenant the caller wants to login into */
|
|
1004
|
-
tenantType: TenantType;
|
|
1005
|
-
customPayload?: Record<string, string>;
|
|
1006
|
-
/**
|
|
1007
|
-
* This flow ultimately returns an HTML page that asynchronously posts the LoginResponse via the BroadcastChannel API.
|
|
1008
|
-
* The message will be posted to a channel named `wix-idp-$session_id`, and encrypted with the `encryption_key`.
|
|
1009
|
-
* Encryption key should be base64 encoded. Encryption is done using AES-GCM with a random IV that's sent alongside the payload
|
|
1010
|
-
*/
|
|
1011
|
-
sessionId: string;
|
|
1012
|
-
encryptionKey: string;
|
|
1013
|
-
visitorId?: string | null;
|
|
1014
|
-
bsi?: string | null;
|
|
1015
|
-
}
|
|
1016
|
-
declare enum TenantType {
|
|
1017
|
-
UNKNOWN_TENANT_TYPE = "UNKNOWN_TENANT_TYPE",
|
|
1018
|
-
ACCOUNT = "ACCOUNT",
|
|
1019
|
-
SITE = "SITE",
|
|
1020
|
-
ROOT = "ROOT"
|
|
1021
|
-
}
|
|
1022
|
-
interface RawHttpResponse$2 {
|
|
1023
|
-
body?: Uint8Array;
|
|
1024
|
-
statusCode?: number | null;
|
|
1025
|
-
headers?: HeadersEntry$2[];
|
|
1026
|
-
}
|
|
1027
|
-
interface HeadersEntry$2 {
|
|
1028
|
-
key?: string;
|
|
1029
|
-
value?: string;
|
|
1030
|
-
}
|
|
1031
|
-
interface LoginCallbackRequest {
|
|
1032
|
-
/** state that that received on the redirect */
|
|
1033
|
-
state?: string;
|
|
1034
|
-
/** session token */
|
|
1035
|
-
sessionToken?: string;
|
|
1036
|
-
}
|
|
1037
|
-
interface LoginWithIdpConnectionTokenParamsRequest {
|
|
1038
|
-
/** The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData */
|
|
1039
|
-
idpConnectionId?: string;
|
|
1040
|
-
/** A set of fields that are required for the connection to be able to identify and authenticate the user */
|
|
1041
|
-
tokenParams?: Record<string, string>;
|
|
1042
|
-
}
|
|
1043
|
-
interface SignOnRequest {
|
|
1044
|
-
/** the identifier of the identity */
|
|
1045
|
-
loginId: LoginId;
|
|
1046
|
-
/** profile of the identity */
|
|
1047
|
-
profile?: IdentityProfile$4;
|
|
1048
|
-
/** when true will mark the email of the identity as verified */
|
|
1049
|
-
verifyEmail?: boolean;
|
|
1050
|
-
/** when false will create a new contact instead of merging the existing contact into the identity */
|
|
1051
|
-
mergeExistingContact?: boolean;
|
|
1052
|
-
}
|
|
1053
|
-
interface SignOnResponse {
|
|
1054
|
-
/** session token for the requested identity */
|
|
1055
|
-
sessionToken?: string;
|
|
1056
|
-
/** The Identity of the provided login_id */
|
|
1057
|
-
identity?: Identity$4;
|
|
1058
|
-
}
|
|
1059
|
-
/** logout request payload */
|
|
1060
|
-
interface LogoutRequest {
|
|
1061
|
-
/** redirect after logout */
|
|
1062
|
-
postLogoutRedirectUri?: string | null;
|
|
1063
|
-
/** caller identifier */
|
|
1064
|
-
clientId?: string | null;
|
|
1065
|
-
}
|
|
1066
|
-
interface VerifyRequest extends VerifyRequestFactorDataOneOf {
|
|
1067
|
-
smsData?: SmsVerifyData;
|
|
1068
|
-
callData?: CallVerifyData;
|
|
1069
|
-
emailData?: EmailVerifyData;
|
|
1070
|
-
totpData?: TotpVerifyData;
|
|
1071
|
-
/** TODO: is this a reasonable maxLength? */
|
|
1072
|
-
stateToken?: string;
|
|
1073
|
-
factorType: FactorType$4;
|
|
1074
|
-
rememberThisDevice?: boolean;
|
|
1075
|
-
}
|
|
1076
|
-
/** @oneof */
|
|
1077
|
-
interface VerifyRequestFactorDataOneOf {
|
|
1078
|
-
smsData?: SmsVerifyData;
|
|
1079
|
-
callData?: CallVerifyData;
|
|
1080
|
-
emailData?: EmailVerifyData;
|
|
1081
|
-
totpData?: TotpVerifyData;
|
|
1082
|
-
}
|
|
1083
|
-
interface SmsVerifyData {
|
|
1084
|
-
code?: string | null;
|
|
1085
|
-
}
|
|
1086
|
-
interface CallVerifyData {
|
|
1087
|
-
code?: string | null;
|
|
1088
|
-
}
|
|
1089
|
-
interface EmailVerifyData {
|
|
1090
|
-
code?: string | null;
|
|
1091
|
-
}
|
|
1092
|
-
interface TotpVerifyData {
|
|
1093
|
-
code?: string | null;
|
|
1094
|
-
}
|
|
1095
|
-
interface V1FactorNonNullableFields$4 {
|
|
1096
|
-
factorType: FactorType$4;
|
|
1097
|
-
}
|
|
1098
|
-
interface RequireMfaDataNonNullableFields$4 {
|
|
1099
|
-
availableFactors: V1FactorNonNullableFields$4[];
|
|
1100
|
-
}
|
|
1101
|
-
interface MfaChallengeDataNonNullableFields$4 {
|
|
1102
|
-
factorType: FactorType$4;
|
|
1103
|
-
availableFactors: V1FactorNonNullableFields$4[];
|
|
1104
|
-
}
|
|
1105
|
-
interface IdpConnectionNonNullableFields$4 {
|
|
1106
|
-
idpConnectionId: string;
|
|
1107
|
-
idpUserId: string;
|
|
1108
|
-
}
|
|
1109
|
-
interface AuthenticatorConnectionNonNullableFields$4 {
|
|
1110
|
-
authenticatorConnectionId: string;
|
|
1111
|
-
reEnrollmentRequired: boolean;
|
|
1112
|
-
}
|
|
1113
|
-
interface ConnectionNonNullableFields$4 {
|
|
1114
|
-
idpConnection?: IdpConnectionNonNullableFields$4;
|
|
1115
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields$4;
|
|
1116
|
-
}
|
|
1117
|
-
interface V1ListValueNonNullableFields$4 {
|
|
1118
|
-
value: V1CustomValueNonNullableFields$4[];
|
|
1119
|
-
}
|
|
1120
|
-
interface V1CustomValueNonNullableFields$4 {
|
|
1121
|
-
strValue: string;
|
|
1122
|
-
numValue: number;
|
|
1123
|
-
listValue?: V1ListValueNonNullableFields$4;
|
|
1124
|
-
}
|
|
1125
|
-
interface CustomFieldNonNullableFields$4 {
|
|
1126
|
-
name: string;
|
|
1127
|
-
value?: V1CustomValueNonNullableFields$4;
|
|
1128
|
-
}
|
|
1129
|
-
interface SecondaryEmailNonNullableFields$4 {
|
|
1130
|
-
email: string;
|
|
1131
|
-
tag: EmailTag$4;
|
|
1132
|
-
}
|
|
1133
|
-
interface PhoneNonNullableFields$4 {
|
|
1134
|
-
phone: string;
|
|
1135
|
-
tag: PhoneTag$4;
|
|
1136
|
-
}
|
|
1137
|
-
interface AddressWrapperNonNullableFields$4 {
|
|
1138
|
-
tag: AddressTag$4;
|
|
1139
|
-
}
|
|
1140
|
-
interface IdentityProfileNonNullableFields$4 {
|
|
1141
|
-
emails: string[];
|
|
1142
|
-
phones: string[];
|
|
1143
|
-
labels: string[];
|
|
1144
|
-
privacyStatus: PrivacyStatus$4;
|
|
1145
|
-
customFields: CustomFieldNonNullableFields$4[];
|
|
1146
|
-
secondaryEmails: SecondaryEmailNonNullableFields$4[];
|
|
1147
|
-
phonesV2: PhoneNonNullableFields$4[];
|
|
1148
|
-
addresses: AddressWrapperNonNullableFields$4[];
|
|
1149
|
-
}
|
|
1150
|
-
interface MetadataNonNullableFields$4 {
|
|
1151
|
-
tags: string[];
|
|
1152
|
-
}
|
|
1153
|
-
interface EmailNonNullableFields$4 {
|
|
1154
|
-
address: string;
|
|
1155
|
-
isVerified: boolean;
|
|
1156
|
-
}
|
|
1157
|
-
interface StatusV2NonNullableFields$4 {
|
|
1158
|
-
name: StatusName$4;
|
|
1159
|
-
reasons: Reason$4[];
|
|
1160
|
-
}
|
|
1161
|
-
interface FactorNonNullableFields$4 {
|
|
1162
|
-
factorId: string;
|
|
1163
|
-
type: FactorType$4;
|
|
1164
|
-
status: Status$4;
|
|
1165
|
-
}
|
|
1166
|
-
interface IdentityNonNullableFields$4 {
|
|
1167
|
-
connections: ConnectionNonNullableFields$4[];
|
|
1168
|
-
identityProfile?: IdentityProfileNonNullableFields$4;
|
|
1169
|
-
metadata?: MetadataNonNullableFields$4;
|
|
1170
|
-
email?: EmailNonNullableFields$4;
|
|
1171
|
-
status?: StatusV2NonNullableFields$4;
|
|
1172
|
-
factors: FactorNonNullableFields$4[];
|
|
1173
|
-
}
|
|
1174
|
-
interface StateMachineResponseNonNullableFields$4 {
|
|
1175
|
-
requireMfaData?: RequireMfaDataNonNullableFields$4;
|
|
1176
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields$4;
|
|
1177
|
-
state: StateType$4;
|
|
1178
|
-
identity?: IdentityNonNullableFields$4;
|
|
1179
|
-
}
|
|
1180
|
-
interface HeadersEntryNonNullableFields$2 {
|
|
1181
|
-
key: string;
|
|
1182
|
-
value: string;
|
|
1183
|
-
}
|
|
1184
|
-
interface RawHttpResponseNonNullableFields$2 {
|
|
1185
|
-
body: Uint8Array;
|
|
1186
|
-
headers: HeadersEntryNonNullableFields$2[];
|
|
1187
|
-
}
|
|
1188
|
-
interface SignOnResponseNonNullableFields {
|
|
1189
|
-
sessionToken: string;
|
|
1190
|
-
identity?: IdentityNonNullableFields$4;
|
|
1191
|
-
}
|
|
1192
|
-
|
|
1193
|
-
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1194
|
-
getUrl: (context: any) => string;
|
|
1195
|
-
httpMethod: K;
|
|
1196
|
-
path: string;
|
|
1197
|
-
pathParams: M;
|
|
1198
|
-
__requestType: T;
|
|
1199
|
-
__originalRequestType: S;
|
|
1200
|
-
__responseType: Q;
|
|
1201
|
-
__originalResponseType: R;
|
|
1202
|
-
};
|
|
1203
|
-
declare function registerV2(): __PublicMethodMetaInfo$3<'POST', {}, RegisterV2Request, RegisterV2Request$1, StateMachineResponse$4 & StateMachineResponseNonNullableFields$4, StateMachineResponse$5 & StateMachineResponseNonNullableFields$5>;
|
|
1204
|
-
declare function loginV2(): __PublicMethodMetaInfo$3<'POST', {}, LoginV2Request, LoginV2Request$1, StateMachineResponse$4 & StateMachineResponseNonNullableFields$4, StateMachineResponse$5 & StateMachineResponseNonNullableFields$5>;
|
|
1205
|
-
declare function changePassword(): __PublicMethodMetaInfo$3<'POST', {}, ChangePasswordRequest, ChangePasswordRequest$1, ChangePasswordResponse, ChangePasswordResponse$1>;
|
|
1206
|
-
declare function loginWithIdpConnection(): __PublicMethodMetaInfo$3<'GET', {
|
|
1207
|
-
tenantId: string;
|
|
1208
|
-
idpConnectionId: string;
|
|
1209
|
-
}, LoginWithIdpConnectionRequest, LoginWithIdpConnectionRequest$1, RawHttpResponse$2 & RawHttpResponseNonNullableFields$2, RawHttpResponse$3 & RawHttpResponseNonNullableFields$3>;
|
|
1210
|
-
declare function loginCallback(): __PublicMethodMetaInfo$3<'GET', {}, LoginCallbackRequest, LoginCallbackRequest$1, RawHttpResponse$2 & RawHttpResponseNonNullableFields$2, RawHttpResponse$3 & RawHttpResponseNonNullableFields$3>;
|
|
1211
|
-
declare function loginWithIdpConnectionTokenParams(): __PublicMethodMetaInfo$3<'POST', {}, LoginWithIdpConnectionTokenParamsRequest, LoginWithIdpConnectionTokenParamsRequest$1, StateMachineResponse$4 & StateMachineResponseNonNullableFields$4, StateMachineResponse$5 & StateMachineResponseNonNullableFields$5>;
|
|
1212
|
-
declare function signOn(): __PublicMethodMetaInfo$3<'POST', {}, SignOnRequest, SignOnRequest$1, SignOnResponse & SignOnResponseNonNullableFields, SignOnResponse$1 & SignOnResponseNonNullableFields$1>;
|
|
1213
|
-
declare function logout(): __PublicMethodMetaInfo$3<'GET', {}, LogoutRequest, LogoutRequest$1, RawHttpResponse$2 & RawHttpResponseNonNullableFields$2, RawHttpResponse$3 & RawHttpResponseNonNullableFields$3>;
|
|
1214
|
-
declare function verify(): __PublicMethodMetaInfo$3<'POST', {
|
|
1215
|
-
factorType: string;
|
|
1216
|
-
}, VerifyRequest, VerifyRequest$1, StateMachineResponse$4 & StateMachineResponseNonNullableFields$4, StateMachineResponse$5 & StateMachineResponseNonNullableFields$5>;
|
|
1217
|
-
|
|
1218
|
-
declare const meta$3_changePassword: typeof changePassword;
|
|
1219
|
-
declare const meta$3_loginCallback: typeof loginCallback;
|
|
1220
|
-
declare const meta$3_loginV2: typeof loginV2;
|
|
1221
|
-
declare const meta$3_loginWithIdpConnection: typeof loginWithIdpConnection;
|
|
1222
|
-
declare const meta$3_loginWithIdpConnectionTokenParams: typeof loginWithIdpConnectionTokenParams;
|
|
1223
|
-
declare const meta$3_logout: typeof logout;
|
|
1224
|
-
declare const meta$3_registerV2: typeof registerV2;
|
|
1225
|
-
declare const meta$3_signOn: typeof signOn;
|
|
1226
|
-
declare const meta$3_verify: typeof verify;
|
|
1227
|
-
declare namespace meta$3 {
|
|
1228
|
-
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_changePassword as changePassword, meta$3_loginCallback as loginCallback, meta$3_loginV2 as loginV2, meta$3_loginWithIdpConnection as loginWithIdpConnection, meta$3_loginWithIdpConnectionTokenParams as loginWithIdpConnectionTokenParams, meta$3_logout as logout, meta$3_registerV2 as registerV2, meta$3_signOn as signOn, meta$3_verify as verify };
|
|
1229
|
-
}
|
|
1230
|
-
|
|
1231
|
-
interface SendRecoveryEmailRequest$1 {
|
|
1232
|
-
/** Email address associated with the account to recover. */
|
|
1233
|
-
email: string;
|
|
1234
|
-
/** Language of the email to be sent. Defaults to the language specified in the member's profile. */
|
|
1235
|
-
language?: string | null;
|
|
1236
|
-
/** Where to redirect to after a successful recovery. */
|
|
1237
|
-
redirect?: Redirect$1;
|
|
1238
|
-
}
|
|
1239
|
-
interface Redirect$1 {
|
|
1240
|
-
/** The URL to redirect to after a successful recovery. */
|
|
1241
|
-
url?: string;
|
|
1242
|
-
/** Caller identifier. */
|
|
1243
|
-
clientId?: string | null;
|
|
1244
|
-
}
|
|
1245
|
-
interface SendRecoveryEmailResponse$1 {
|
|
1246
|
-
}
|
|
1247
|
-
interface SendActivationEmailRequest$1 {
|
|
1248
|
-
/** Id of the activating user */
|
|
1249
|
-
identityId: string;
|
|
1250
|
-
/** Options for the activation email */
|
|
1251
|
-
emailOptions?: EmailOptions$1;
|
|
1252
|
-
}
|
|
1253
|
-
interface EmailOptions$1 {
|
|
1254
|
-
/** language of the email - if not received will fallback to the identity language */
|
|
1255
|
-
language?: string | null;
|
|
1256
|
-
/** Where to redirect after a successful activation process */
|
|
1257
|
-
redirect?: Redirect$1;
|
|
1258
|
-
}
|
|
1259
|
-
interface SendActivationEmailResponse$1 {
|
|
1260
|
-
}
|
|
1261
|
-
interface RecoverRequest$1 {
|
|
1262
|
-
/** recovery token */
|
|
1263
|
-
recoveryToken: string;
|
|
1264
|
-
/** new password to set for the identity */
|
|
1265
|
-
password?: string | null;
|
|
1266
|
-
}
|
|
1267
|
-
interface StateMachineResponse$3 extends StateMachineResponseStateDataOneOf$3 {
|
|
1268
|
-
requireMfaData?: RequireMfaData$3;
|
|
1269
|
-
mfaChallengeData?: MfaChallengeData$3;
|
|
1270
|
-
/** The current state of the login or registration process. */
|
|
1271
|
-
state?: StateType$3;
|
|
1272
|
-
/** If state is `SUCCESS`, a session token. */
|
|
1273
|
-
sessionToken?: string | null;
|
|
1274
|
-
/** A token representing the current state of the login or registration process. */
|
|
1275
|
-
stateToken?: string | null;
|
|
1276
|
-
/** Identing of the current member. */
|
|
1277
|
-
identity?: Identity$3;
|
|
1278
|
-
/** additional_data = 5; //TBD */
|
|
1279
|
-
additionalData?: Record<string, CustomValue$3>;
|
|
1280
|
-
}
|
|
1281
|
-
/** @oneof */
|
|
1282
|
-
interface StateMachineResponseStateDataOneOf$3 {
|
|
1283
|
-
requireMfaData?: RequireMfaData$3;
|
|
1284
|
-
mfaChallengeData?: MfaChallengeData$3;
|
|
1285
|
-
}
|
|
1286
|
-
declare enum StateType$3 {
|
|
1287
|
-
/** Initial unknown state. */
|
|
1288
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
1289
|
-
/** The operation completed successfully. */
|
|
1290
|
-
SUCCESS = "SUCCESS",
|
|
1291
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
1292
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
1293
|
-
/**
|
|
1294
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
1295
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
1296
|
-
*/
|
|
1297
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
1298
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
1299
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
1300
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
1301
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
1302
|
-
}
|
|
1303
|
-
interface Identity$3 {
|
|
1304
|
-
/** Identity ID */
|
|
1305
|
-
id?: string | null;
|
|
1306
|
-
/**
|
|
1307
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
1308
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
1309
|
-
*/
|
|
1310
|
-
revision?: string | null;
|
|
1311
|
-
/**
|
|
1312
|
-
* The time this identity was created.
|
|
1313
|
-
* @readonly
|
|
1314
|
-
*/
|
|
1315
|
-
createdDate?: Date | null;
|
|
1316
|
-
/**
|
|
1317
|
-
* The time this identity was last updated.
|
|
1318
|
-
* @readonly
|
|
1319
|
-
*/
|
|
1320
|
-
updatedDate?: Date | null;
|
|
1321
|
-
/** The identity configured connections to authenticate with. */
|
|
1322
|
-
connections?: Connection$3[];
|
|
1323
|
-
/** Identity profile. */
|
|
1324
|
-
identityProfile?: IdentityProfile$3;
|
|
1325
|
-
/**
|
|
1326
|
-
* Additional information about the identity that can impact user access.
|
|
1327
|
-
* This data cannot be set.
|
|
1328
|
-
*/
|
|
1329
|
-
metadata?: Metadata$3;
|
|
1330
|
-
/** Identity email address. */
|
|
1331
|
-
email?: Email$3;
|
|
1332
|
-
/** Identity's current status. */
|
|
1333
|
-
status?: StatusV2$3;
|
|
1334
|
-
/** filled by pre registered spi */
|
|
1335
|
-
customAttributes?: Record<string, any> | null;
|
|
1336
|
-
/**
|
|
1337
|
-
* Identity factors.
|
|
1338
|
-
* @readonly
|
|
1339
|
-
*/
|
|
1340
|
-
factors?: Factor$3[];
|
|
1341
|
-
}
|
|
1342
|
-
interface Connection$3 extends ConnectionTypeOneOf$3 {
|
|
1343
|
-
/** IDP connection. */
|
|
1344
|
-
idpConnection?: IdpConnection$3;
|
|
1345
|
-
/** Authenticator connection. */
|
|
1346
|
-
authenticatorConnection?: AuthenticatorConnection$3;
|
|
1347
|
-
}
|
|
1348
|
-
/** @oneof */
|
|
1349
|
-
interface ConnectionTypeOneOf$3 {
|
|
1350
|
-
/** IDP connection. */
|
|
1351
|
-
idpConnection?: IdpConnection$3;
|
|
1352
|
-
/** Authenticator connection. */
|
|
1353
|
-
authenticatorConnection?: AuthenticatorConnection$3;
|
|
1354
|
-
}
|
|
1355
|
-
interface IdpConnection$3 {
|
|
1356
|
-
/** IDP connection ID. */
|
|
1357
|
-
idpConnectionId?: string;
|
|
1358
|
-
/** IDP user ID. */
|
|
1359
|
-
idpUserId?: string;
|
|
1360
|
-
}
|
|
1361
|
-
interface AuthenticatorConnection$3 {
|
|
1362
|
-
/** Authenticator connection ID. */
|
|
1363
|
-
authenticatorConnectionId?: string;
|
|
1364
|
-
/** Whether re-enrollment is required. */
|
|
1365
|
-
reEnrollmentRequired?: boolean;
|
|
1366
|
-
}
|
|
1367
|
-
interface IdentityProfile$3 {
|
|
1368
|
-
/** Profile first name. */
|
|
1369
|
-
firstName?: string | null;
|
|
1370
|
-
/** Profile last name. */
|
|
1371
|
-
lastName?: string | null;
|
|
1372
|
-
/** Profile nickname. */
|
|
1373
|
-
nickname?: string | null;
|
|
1374
|
-
/** Profile picture URL. */
|
|
1375
|
-
picture?: string | null;
|
|
1376
|
-
/**
|
|
1377
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
1378
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
1379
|
-
* @replacedBy secondary_emails
|
|
1380
|
-
* @targetRemovalDate 2023-11-01
|
|
1381
|
-
*/
|
|
1382
|
-
emails?: string[];
|
|
1383
|
-
/**
|
|
1384
|
-
* Deprecated. Use `phonesV2` instead.
|
|
1385
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
1386
|
-
* @replacedBy phones_v2
|
|
1387
|
-
* @targetRemovalDate 2023-11-01
|
|
1388
|
-
*/
|
|
1389
|
-
phones?: string[];
|
|
1390
|
-
/** List of profile labels. */
|
|
1391
|
-
labels?: string[];
|
|
1392
|
-
/** Profile language. */
|
|
1393
|
-
language?: string | null;
|
|
1394
|
-
/** Profile privacy status. */
|
|
1395
|
-
privacyStatus?: PrivacyStatus$3;
|
|
1396
|
-
/**
|
|
1397
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
1398
|
-
* are used to store additional information about your site or app's contacts.
|
|
1399
|
-
*/
|
|
1400
|
-
customFields?: CustomField$3[];
|
|
1401
|
-
/** List of profile email addresses. */
|
|
1402
|
-
secondaryEmails?: SecondaryEmail$3[];
|
|
1403
|
-
/** List of profile phone numbers. */
|
|
1404
|
-
phonesV2?: Phone$3[];
|
|
1405
|
-
/** List of profile physical addresses. */
|
|
1406
|
-
addresses?: AddressWrapper$3[];
|
|
1407
|
-
/** Company name. */
|
|
1408
|
-
company?: string | null;
|
|
1409
|
-
/** Position within company. */
|
|
1410
|
-
position?: string | null;
|
|
1411
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
1412
|
-
birthdate?: string | null;
|
|
1413
|
-
/** slug */
|
|
1414
|
-
slug?: string | null;
|
|
1415
|
-
}
|
|
1416
|
-
declare enum PrivacyStatus$3 {
|
|
1417
|
-
UNDEFINED = "UNDEFINED",
|
|
1418
|
-
PUBLIC = "PUBLIC",
|
|
1419
|
-
PRIVATE = "PRIVATE"
|
|
1420
|
-
}
|
|
1421
|
-
interface CustomField$3 {
|
|
1422
|
-
/**
|
|
1423
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
1424
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
1425
|
-
* with the `custom.` prefix removed.
|
|
1426
|
-
*/
|
|
1427
|
-
name?: string;
|
|
1428
|
-
/** Custom field value. */
|
|
1429
|
-
value?: V1CustomValue$3;
|
|
1430
|
-
}
|
|
1431
|
-
interface V1CustomValue$3 extends V1CustomValueValueOneOf$3 {
|
|
1432
|
-
/** String value. */
|
|
1433
|
-
strValue?: string;
|
|
1434
|
-
/** Number value. */
|
|
1435
|
-
numValue?: number;
|
|
1436
|
-
/** Date value. */
|
|
1437
|
-
dateValue?: Date | null;
|
|
1438
|
-
/** List value. */
|
|
1439
|
-
listValue?: V1ListValue$3;
|
|
1440
|
-
/** Map value. */
|
|
1441
|
-
mapValue?: V1MapValue$3;
|
|
1442
|
-
}
|
|
1443
|
-
/** @oneof */
|
|
1444
|
-
interface V1CustomValueValueOneOf$3 {
|
|
1445
|
-
/** String value. */
|
|
1446
|
-
strValue?: string;
|
|
1447
|
-
/** Number value. */
|
|
1448
|
-
numValue?: number;
|
|
1449
|
-
/** Date value. */
|
|
1450
|
-
dateValue?: Date | null;
|
|
1451
|
-
/** List value. */
|
|
1452
|
-
listValue?: V1ListValue$3;
|
|
1453
|
-
/** Map value. */
|
|
1454
|
-
mapValue?: V1MapValue$3;
|
|
1455
|
-
}
|
|
1456
|
-
interface V1ListValue$3 {
|
|
1457
|
-
/** Custom value. */
|
|
1458
|
-
value?: V1CustomValue$3[];
|
|
1459
|
-
}
|
|
1460
|
-
interface V1MapValue$3 {
|
|
1461
|
-
/** Mapped custom value. */
|
|
1462
|
-
value?: Record<string, V1CustomValue$3>;
|
|
1463
|
-
}
|
|
1464
|
-
interface SecondaryEmail$3 {
|
|
1465
|
-
/** Email address. */
|
|
1466
|
-
email?: string;
|
|
1467
|
-
/** Email tag. */
|
|
1468
|
-
tag?: EmailTag$3;
|
|
1469
|
-
}
|
|
1470
|
-
declare enum EmailTag$3 {
|
|
1471
|
-
UNTAGGED = "UNTAGGED",
|
|
1472
|
-
MAIN = "MAIN",
|
|
1473
|
-
HOME = "HOME",
|
|
1474
|
-
WORK = "WORK"
|
|
1475
|
-
}
|
|
1476
|
-
interface Phone$3 {
|
|
1477
|
-
/** Phone country code. */
|
|
1478
|
-
countryCode?: string | null;
|
|
1479
|
-
/** Phone number. */
|
|
1480
|
-
phone?: string;
|
|
1481
|
-
/** Phone tag. */
|
|
1482
|
-
tag?: PhoneTag$3;
|
|
1483
|
-
}
|
|
1484
|
-
declare enum PhoneTag$3 {
|
|
1485
|
-
UNTAGGED = "UNTAGGED",
|
|
1486
|
-
MAIN = "MAIN",
|
|
1487
|
-
HOME = "HOME",
|
|
1488
|
-
MOBILE = "MOBILE",
|
|
1489
|
-
WORK = "WORK",
|
|
1490
|
-
FAX = "FAX"
|
|
1491
|
-
}
|
|
1492
|
-
interface AddressWrapper$3 {
|
|
1493
|
-
/** Address. */
|
|
1494
|
-
address?: Address$3;
|
|
1495
|
-
/** Address tag. */
|
|
1496
|
-
tag?: AddressTag$3;
|
|
1497
|
-
}
|
|
1498
|
-
/** Physical address */
|
|
1499
|
-
interface Address$3 {
|
|
1500
|
-
/** Country code. */
|
|
1501
|
-
country?: string | null;
|
|
1502
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
1503
|
-
subdivision?: string | null;
|
|
1504
|
-
/** City name. */
|
|
1505
|
-
city?: string | null;
|
|
1506
|
-
/** Zip/postal code. */
|
|
1507
|
-
postalCode?: string | null;
|
|
1508
|
-
/** Main address line, usually street and number as free text. */
|
|
1509
|
-
addressLine?: string | null;
|
|
1510
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
1511
|
-
addressLine2?: string | null;
|
|
1512
|
-
}
|
|
1513
|
-
declare enum AddressTag$3 {
|
|
1514
|
-
UNTAGGED = "UNTAGGED",
|
|
1515
|
-
HOME = "HOME",
|
|
1516
|
-
WORK = "WORK",
|
|
1517
|
-
BILLING = "BILLING",
|
|
1518
|
-
SHIPPING = "SHIPPING"
|
|
1519
|
-
}
|
|
1520
|
-
interface Metadata$3 {
|
|
1521
|
-
/**
|
|
1522
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
1523
|
-
* @readonly
|
|
1524
|
-
*/
|
|
1525
|
-
tags?: string[];
|
|
1526
|
-
}
|
|
1527
|
-
interface Email$3 {
|
|
1528
|
-
address?: string;
|
|
1529
|
-
isVerified?: boolean;
|
|
1530
|
-
}
|
|
1531
|
-
interface StatusV2$3 {
|
|
1532
|
-
name?: StatusName$3;
|
|
1533
|
-
reasons?: Reason$3[];
|
|
1534
|
-
}
|
|
1535
|
-
declare enum StatusName$3 {
|
|
1536
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1537
|
-
PENDING = "PENDING",
|
|
1538
|
-
ACTIVE = "ACTIVE",
|
|
1539
|
-
DELETED = "DELETED",
|
|
1540
|
-
BLOCKED = "BLOCKED",
|
|
1541
|
-
OFFLINE = "OFFLINE"
|
|
1542
|
-
}
|
|
1543
|
-
declare enum Reason$3 {
|
|
1544
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
1545
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
1546
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
1547
|
-
}
|
|
1548
|
-
interface Factor$3 {
|
|
1549
|
-
/** Factor ID. */
|
|
1550
|
-
factorId?: string;
|
|
1551
|
-
/** Factor type. */
|
|
1552
|
-
type?: FactorType$3;
|
|
1553
|
-
/** Factor status. */
|
|
1554
|
-
status?: Status$3;
|
|
1555
|
-
}
|
|
1556
|
-
declare enum FactorType$3 {
|
|
1557
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
1558
|
-
PASSWORD = "PASSWORD",
|
|
1559
|
-
SMS = "SMS",
|
|
1560
|
-
CALL = "CALL",
|
|
1561
|
-
EMAIL = "EMAIL",
|
|
1562
|
-
TOTP = "TOTP",
|
|
1563
|
-
PUSH = "PUSH"
|
|
1564
|
-
}
|
|
1565
|
-
declare enum Status$3 {
|
|
1566
|
-
/** Factor requires activation. */
|
|
1567
|
-
INACTIVE = "INACTIVE",
|
|
1568
|
-
/** Factor is active and can be used for authentication. */
|
|
1569
|
-
ACTIVE = "ACTIVE",
|
|
1570
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
1571
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
1572
|
-
}
|
|
1573
|
-
interface CustomValue$3 extends CustomValueValueOneOf$3 {
|
|
1574
|
-
/** String value. */
|
|
1575
|
-
strValue?: string;
|
|
1576
|
-
/** Number value. */
|
|
1577
|
-
numValue?: number;
|
|
1578
|
-
/** Date value. */
|
|
1579
|
-
dateValue?: Date | null;
|
|
1580
|
-
/** List value. */
|
|
1581
|
-
listValue?: ListValue$3;
|
|
1582
|
-
/** Map value. */
|
|
1583
|
-
mapValue?: MapValue$3;
|
|
1584
|
-
}
|
|
1585
|
-
/** @oneof */
|
|
1586
|
-
interface CustomValueValueOneOf$3 {
|
|
1587
|
-
/** String value. */
|
|
1588
|
-
strValue?: string;
|
|
1589
|
-
/** Number value. */
|
|
1590
|
-
numValue?: number;
|
|
1591
|
-
/** Date value. */
|
|
1592
|
-
dateValue?: Date | null;
|
|
1593
|
-
/** List value. */
|
|
1594
|
-
listValue?: ListValue$3;
|
|
1595
|
-
/** Map value. */
|
|
1596
|
-
mapValue?: MapValue$3;
|
|
1597
|
-
}
|
|
1598
|
-
interface ListValue$3 {
|
|
1599
|
-
/** Custom value. */
|
|
1600
|
-
value?: CustomValue$3[];
|
|
1601
|
-
}
|
|
1602
|
-
interface MapValue$3 {
|
|
1603
|
-
/** Mapped custom value. */
|
|
1604
|
-
value?: Record<string, CustomValue$3>;
|
|
1605
|
-
}
|
|
1606
|
-
interface RequireMfaData$3 {
|
|
1607
|
-
availableFactors?: V1Factor$3[];
|
|
1608
|
-
}
|
|
1609
|
-
interface V1Factor$3 {
|
|
1610
|
-
factorType?: FactorType$3;
|
|
1611
|
-
}
|
|
1612
|
-
interface MfaChallengeData$3 {
|
|
1613
|
-
factorType?: FactorType$3;
|
|
1614
|
-
verificationChallengeData?: VerificationChallenge$3;
|
|
1615
|
-
availableFactors?: V1Factor$3[];
|
|
1616
|
-
}
|
|
1617
|
-
interface VerificationChallenge$3 {
|
|
1618
|
-
hint?: string | null;
|
|
1619
|
-
}
|
|
1620
|
-
interface V1FactorNonNullableFields$3 {
|
|
1621
|
-
factorType: FactorType$3;
|
|
1622
|
-
}
|
|
1623
|
-
interface RequireMfaDataNonNullableFields$3 {
|
|
1624
|
-
availableFactors: V1FactorNonNullableFields$3[];
|
|
1625
|
-
}
|
|
1626
|
-
interface MfaChallengeDataNonNullableFields$3 {
|
|
1627
|
-
factorType: FactorType$3;
|
|
1628
|
-
availableFactors: V1FactorNonNullableFields$3[];
|
|
1629
|
-
}
|
|
1630
|
-
interface IdpConnectionNonNullableFields$3 {
|
|
1631
|
-
idpConnectionId: string;
|
|
1632
|
-
idpUserId: string;
|
|
1633
|
-
}
|
|
1634
|
-
interface AuthenticatorConnectionNonNullableFields$3 {
|
|
1635
|
-
authenticatorConnectionId: string;
|
|
1636
|
-
reEnrollmentRequired: boolean;
|
|
1637
|
-
}
|
|
1638
|
-
interface ConnectionNonNullableFields$3 {
|
|
1639
|
-
idpConnection?: IdpConnectionNonNullableFields$3;
|
|
1640
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields$3;
|
|
1641
|
-
}
|
|
1642
|
-
interface V1ListValueNonNullableFields$3 {
|
|
1643
|
-
value: V1CustomValueNonNullableFields$3[];
|
|
1644
|
-
}
|
|
1645
|
-
interface V1CustomValueNonNullableFields$3 {
|
|
1646
|
-
strValue: string;
|
|
1647
|
-
numValue: number;
|
|
1648
|
-
listValue?: V1ListValueNonNullableFields$3;
|
|
1649
|
-
}
|
|
1650
|
-
interface CustomFieldNonNullableFields$3 {
|
|
1651
|
-
name: string;
|
|
1652
|
-
value?: V1CustomValueNonNullableFields$3;
|
|
1653
|
-
}
|
|
1654
|
-
interface SecondaryEmailNonNullableFields$3 {
|
|
1655
|
-
email: string;
|
|
1656
|
-
tag: EmailTag$3;
|
|
1657
|
-
}
|
|
1658
|
-
interface PhoneNonNullableFields$3 {
|
|
1659
|
-
phone: string;
|
|
1660
|
-
tag: PhoneTag$3;
|
|
1661
|
-
}
|
|
1662
|
-
interface AddressWrapperNonNullableFields$3 {
|
|
1663
|
-
tag: AddressTag$3;
|
|
1664
|
-
}
|
|
1665
|
-
interface IdentityProfileNonNullableFields$3 {
|
|
1666
|
-
emails: string[];
|
|
1667
|
-
phones: string[];
|
|
1668
|
-
labels: string[];
|
|
1669
|
-
privacyStatus: PrivacyStatus$3;
|
|
1670
|
-
customFields: CustomFieldNonNullableFields$3[];
|
|
1671
|
-
secondaryEmails: SecondaryEmailNonNullableFields$3[];
|
|
1672
|
-
phonesV2: PhoneNonNullableFields$3[];
|
|
1673
|
-
addresses: AddressWrapperNonNullableFields$3[];
|
|
1674
|
-
}
|
|
1675
|
-
interface MetadataNonNullableFields$3 {
|
|
1676
|
-
tags: string[];
|
|
1677
|
-
}
|
|
1678
|
-
interface EmailNonNullableFields$3 {
|
|
1679
|
-
address: string;
|
|
1680
|
-
isVerified: boolean;
|
|
1681
|
-
}
|
|
1682
|
-
interface StatusV2NonNullableFields$3 {
|
|
1683
|
-
name: StatusName$3;
|
|
1684
|
-
reasons: Reason$3[];
|
|
1685
|
-
}
|
|
1686
|
-
interface FactorNonNullableFields$3 {
|
|
1687
|
-
factorId: string;
|
|
1688
|
-
type: FactorType$3;
|
|
1689
|
-
status: Status$3;
|
|
1690
|
-
}
|
|
1691
|
-
interface IdentityNonNullableFields$3 {
|
|
1692
|
-
connections: ConnectionNonNullableFields$3[];
|
|
1693
|
-
identityProfile?: IdentityProfileNonNullableFields$3;
|
|
1694
|
-
metadata?: MetadataNonNullableFields$3;
|
|
1695
|
-
email?: EmailNonNullableFields$3;
|
|
1696
|
-
status?: StatusV2NonNullableFields$3;
|
|
1697
|
-
factors: FactorNonNullableFields$3[];
|
|
1698
|
-
}
|
|
1699
|
-
interface StateMachineResponseNonNullableFields$3 {
|
|
1700
|
-
requireMfaData?: RequireMfaDataNonNullableFields$3;
|
|
1701
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields$3;
|
|
1702
|
-
state: StateType$3;
|
|
1703
|
-
identity?: IdentityNonNullableFields$3;
|
|
1704
|
-
}
|
|
1705
|
-
|
|
1706
|
-
interface SendRecoveryEmailRequest {
|
|
1707
|
-
/** Email address associated with the account to recover. */
|
|
1708
|
-
email: string;
|
|
1709
|
-
/** Language of the email to be sent. Defaults to the language specified in the member's profile. */
|
|
1710
|
-
language?: string | null;
|
|
1711
|
-
/** Where to redirect to after a successful recovery. */
|
|
1712
|
-
redirect?: Redirect;
|
|
1713
|
-
}
|
|
1714
|
-
interface Redirect {
|
|
1715
|
-
/** The URL to redirect to after a successful recovery. */
|
|
1716
|
-
url?: string;
|
|
1717
|
-
/** Caller identifier. */
|
|
1718
|
-
clientId?: string | null;
|
|
1719
|
-
}
|
|
1720
|
-
interface SendRecoveryEmailResponse {
|
|
1721
|
-
}
|
|
1722
|
-
interface SendActivationEmailRequest {
|
|
1723
|
-
/** Id of the activating user */
|
|
1724
|
-
identityId: string;
|
|
1725
|
-
/** Options for the activation email */
|
|
1726
|
-
emailOptions?: EmailOptions;
|
|
1727
|
-
}
|
|
1728
|
-
interface EmailOptions {
|
|
1729
|
-
/** language of the email - if not received will fallback to the identity language */
|
|
1730
|
-
language?: string | null;
|
|
1731
|
-
/** Where to redirect after a successful activation process */
|
|
1732
|
-
redirect?: Redirect;
|
|
1733
|
-
}
|
|
1734
|
-
interface SendActivationEmailResponse {
|
|
1735
|
-
}
|
|
1736
|
-
interface RecoverRequest {
|
|
1737
|
-
/** recovery token */
|
|
1738
|
-
recoveryToken: string;
|
|
1739
|
-
/** new password to set for the identity */
|
|
1740
|
-
password?: string | null;
|
|
1741
|
-
}
|
|
1742
|
-
interface StateMachineResponse$2 extends StateMachineResponseStateDataOneOf$2 {
|
|
1743
|
-
requireMfaData?: RequireMfaData$2;
|
|
1744
|
-
mfaChallengeData?: MfaChallengeData$2;
|
|
1745
|
-
/** The current state of the login or registration process. */
|
|
1746
|
-
state?: StateType$2;
|
|
1747
|
-
/** If state is `SUCCESS`, a session token. */
|
|
1748
|
-
sessionToken?: string | null;
|
|
1749
|
-
/** A token representing the current state of the login or registration process. */
|
|
1750
|
-
stateToken?: string | null;
|
|
1751
|
-
/** Identing of the current member. */
|
|
1752
|
-
identity?: Identity$2;
|
|
1753
|
-
/** additional_data = 5; //TBD */
|
|
1754
|
-
additionalData?: Record<string, CustomValue$2>;
|
|
1755
|
-
}
|
|
1756
|
-
/** @oneof */
|
|
1757
|
-
interface StateMachineResponseStateDataOneOf$2 {
|
|
1758
|
-
requireMfaData?: RequireMfaData$2;
|
|
1759
|
-
mfaChallengeData?: MfaChallengeData$2;
|
|
1760
|
-
}
|
|
1761
|
-
declare enum StateType$2 {
|
|
1762
|
-
/** Initial unknown state. */
|
|
1763
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
1764
|
-
/** The operation completed successfully. */
|
|
1765
|
-
SUCCESS = "SUCCESS",
|
|
1766
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
1767
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
1768
|
-
/**
|
|
1769
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
1770
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
1771
|
-
*/
|
|
1772
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
1773
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
1774
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
1775
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
1776
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
1777
|
-
}
|
|
1778
|
-
interface Identity$2 {
|
|
1779
|
-
/** Identity ID */
|
|
1780
|
-
_id?: string | null;
|
|
1781
|
-
/**
|
|
1782
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
1783
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
1784
|
-
*/
|
|
1785
|
-
revision?: string | null;
|
|
1786
|
-
/**
|
|
1787
|
-
* The time this identity was created.
|
|
1788
|
-
* @readonly
|
|
1789
|
-
*/
|
|
1790
|
-
_createdDate?: Date | null;
|
|
1791
|
-
/**
|
|
1792
|
-
* The time this identity was last updated.
|
|
1793
|
-
* @readonly
|
|
1794
|
-
*/
|
|
1795
|
-
_updatedDate?: Date | null;
|
|
1796
|
-
/** The identity configured connections to authenticate with. */
|
|
1797
|
-
connections?: Connection$2[];
|
|
1798
|
-
/** Identity profile. */
|
|
1799
|
-
identityProfile?: IdentityProfile$2;
|
|
1800
|
-
/**
|
|
1801
|
-
* Additional information about the identity that can impact user access.
|
|
1802
|
-
* This data cannot be set.
|
|
1803
|
-
*/
|
|
1804
|
-
metadata?: Metadata$2;
|
|
1805
|
-
/** Identity email address. */
|
|
1806
|
-
email?: Email$2;
|
|
1807
|
-
/** Identity's current status. */
|
|
1808
|
-
status?: StatusV2$2;
|
|
1809
|
-
/** filled by pre registered spi */
|
|
1810
|
-
customAttributes?: Record<string, any> | null;
|
|
1811
|
-
/**
|
|
1812
|
-
* Identity factors.
|
|
1813
|
-
* @readonly
|
|
1814
|
-
*/
|
|
1815
|
-
factors?: Factor$2[];
|
|
1816
|
-
}
|
|
1817
|
-
interface Connection$2 extends ConnectionTypeOneOf$2 {
|
|
1818
|
-
/** IDP connection. */
|
|
1819
|
-
idpConnection?: IdpConnection$2;
|
|
1820
|
-
/** Authenticator connection. */
|
|
1821
|
-
authenticatorConnection?: AuthenticatorConnection$2;
|
|
1822
|
-
}
|
|
1823
|
-
/** @oneof */
|
|
1824
|
-
interface ConnectionTypeOneOf$2 {
|
|
1825
|
-
/** IDP connection. */
|
|
1826
|
-
idpConnection?: IdpConnection$2;
|
|
1827
|
-
/** Authenticator connection. */
|
|
1828
|
-
authenticatorConnection?: AuthenticatorConnection$2;
|
|
1829
|
-
}
|
|
1830
|
-
interface IdpConnection$2 {
|
|
1831
|
-
/** IDP connection ID. */
|
|
1832
|
-
idpConnectionId?: string;
|
|
1833
|
-
/** IDP user ID. */
|
|
1834
|
-
idpUserId?: string;
|
|
1835
|
-
}
|
|
1836
|
-
interface AuthenticatorConnection$2 {
|
|
1837
|
-
/** Authenticator connection ID. */
|
|
1838
|
-
authenticatorConnectionId?: string;
|
|
1839
|
-
/** Whether re-enrollment is required. */
|
|
1840
|
-
reEnrollmentRequired?: boolean;
|
|
1841
|
-
}
|
|
1842
|
-
interface IdentityProfile$2 {
|
|
1843
|
-
/** Profile first name. */
|
|
1844
|
-
firstName?: string | null;
|
|
1845
|
-
/** Profile last name. */
|
|
1846
|
-
lastName?: string | null;
|
|
1847
|
-
/** Profile nickname. */
|
|
1848
|
-
nickname?: string | null;
|
|
1849
|
-
/** Profile picture URL. */
|
|
1850
|
-
picture?: string | null;
|
|
1851
|
-
/**
|
|
1852
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
1853
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
1854
|
-
* @replacedBy secondary_emails
|
|
1855
|
-
* @targetRemovalDate 2023-11-01
|
|
1856
|
-
*/
|
|
1857
|
-
emails?: string[];
|
|
1858
|
-
/**
|
|
1859
|
-
* Deprecated. Use `phonesV2` instead.
|
|
1860
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
1861
|
-
* @replacedBy phones_v2
|
|
1862
|
-
* @targetRemovalDate 2023-11-01
|
|
1863
|
-
*/
|
|
1864
|
-
phones?: string[];
|
|
1865
|
-
/** List of profile labels. */
|
|
1866
|
-
labels?: string[];
|
|
1867
|
-
/** Profile language. */
|
|
1868
|
-
language?: string | null;
|
|
1869
|
-
/** Profile privacy status. */
|
|
1870
|
-
privacyStatus?: PrivacyStatus$2;
|
|
1871
|
-
/**
|
|
1872
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
1873
|
-
* are used to store additional information about your site or app's contacts.
|
|
1874
|
-
*/
|
|
1875
|
-
customFields?: CustomField$2[];
|
|
1876
|
-
/** List of profile email addresses. */
|
|
1877
|
-
secondaryEmails?: SecondaryEmail$2[];
|
|
1878
|
-
/** List of profile phone numbers. */
|
|
1879
|
-
phonesV2?: Phone$2[];
|
|
1880
|
-
/** List of profile physical addresses. */
|
|
1881
|
-
addresses?: AddressWrapper$2[];
|
|
1882
|
-
/** Company name. */
|
|
1883
|
-
company?: string | null;
|
|
1884
|
-
/** Position within company. */
|
|
1885
|
-
position?: string | null;
|
|
1886
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
1887
|
-
birthdate?: string | null;
|
|
1888
|
-
/** slug */
|
|
1889
|
-
slug?: string | null;
|
|
1890
|
-
}
|
|
1891
|
-
declare enum PrivacyStatus$2 {
|
|
1892
|
-
UNDEFINED = "UNDEFINED",
|
|
1893
|
-
PUBLIC = "PUBLIC",
|
|
1894
|
-
PRIVATE = "PRIVATE"
|
|
1895
|
-
}
|
|
1896
|
-
interface CustomField$2 {
|
|
1897
|
-
/**
|
|
1898
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
1899
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
1900
|
-
* with the `custom.` prefix removed.
|
|
1901
|
-
*/
|
|
1902
|
-
name?: string;
|
|
1903
|
-
/** Custom field value. */
|
|
1904
|
-
value?: V1CustomValue$2;
|
|
1905
|
-
}
|
|
1906
|
-
interface V1CustomValue$2 extends V1CustomValueValueOneOf$2 {
|
|
1907
|
-
/** String value. */
|
|
1908
|
-
strValue?: string;
|
|
1909
|
-
/** Number value. */
|
|
1910
|
-
numValue?: number;
|
|
1911
|
-
/** Date value. */
|
|
1912
|
-
dateValue?: Date | null;
|
|
1913
|
-
/** List value. */
|
|
1914
|
-
listValue?: V1ListValue$2;
|
|
1915
|
-
/** Map value. */
|
|
1916
|
-
mapValue?: V1MapValue$2;
|
|
1917
|
-
}
|
|
1918
|
-
/** @oneof */
|
|
1919
|
-
interface V1CustomValueValueOneOf$2 {
|
|
1920
|
-
/** String value. */
|
|
1921
|
-
strValue?: string;
|
|
1922
|
-
/** Number value. */
|
|
1923
|
-
numValue?: number;
|
|
1924
|
-
/** Date value. */
|
|
1925
|
-
dateValue?: Date | null;
|
|
1926
|
-
/** List value. */
|
|
1927
|
-
listValue?: V1ListValue$2;
|
|
1928
|
-
/** Map value. */
|
|
1929
|
-
mapValue?: V1MapValue$2;
|
|
1930
|
-
}
|
|
1931
|
-
interface V1ListValue$2 {
|
|
1932
|
-
/** Custom value. */
|
|
1933
|
-
value?: V1CustomValue$2[];
|
|
1934
|
-
}
|
|
1935
|
-
interface V1MapValue$2 {
|
|
1936
|
-
/** Mapped custom value. */
|
|
1937
|
-
value?: Record<string, V1CustomValue$2>;
|
|
1938
|
-
}
|
|
1939
|
-
interface SecondaryEmail$2 {
|
|
1940
|
-
/** Email address. */
|
|
1941
|
-
email?: string;
|
|
1942
|
-
/** Email tag. */
|
|
1943
|
-
tag?: EmailTag$2;
|
|
1944
|
-
}
|
|
1945
|
-
declare enum EmailTag$2 {
|
|
1946
|
-
UNTAGGED = "UNTAGGED",
|
|
1947
|
-
MAIN = "MAIN",
|
|
1948
|
-
HOME = "HOME",
|
|
1949
|
-
WORK = "WORK"
|
|
1950
|
-
}
|
|
1951
|
-
interface Phone$2 {
|
|
1952
|
-
/** Phone country code. */
|
|
1953
|
-
countryCode?: string | null;
|
|
1954
|
-
/** Phone number. */
|
|
1955
|
-
phone?: string;
|
|
1956
|
-
/** Phone tag. */
|
|
1957
|
-
tag?: PhoneTag$2;
|
|
1958
|
-
}
|
|
1959
|
-
declare enum PhoneTag$2 {
|
|
1960
|
-
UNTAGGED = "UNTAGGED",
|
|
1961
|
-
MAIN = "MAIN",
|
|
1962
|
-
HOME = "HOME",
|
|
1963
|
-
MOBILE = "MOBILE",
|
|
1964
|
-
WORK = "WORK",
|
|
1965
|
-
FAX = "FAX"
|
|
1966
|
-
}
|
|
1967
|
-
interface AddressWrapper$2 {
|
|
1968
|
-
/** Address. */
|
|
1969
|
-
address?: Address$2;
|
|
1970
|
-
/** Address tag. */
|
|
1971
|
-
tag?: AddressTag$2;
|
|
1972
|
-
}
|
|
1973
|
-
/** Physical address */
|
|
1974
|
-
interface Address$2 {
|
|
1975
|
-
/** Country code. */
|
|
1976
|
-
country?: string | null;
|
|
1977
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
1978
|
-
subdivision?: string | null;
|
|
1979
|
-
/** City name. */
|
|
1980
|
-
city?: string | null;
|
|
1981
|
-
/** Zip/postal code. */
|
|
1982
|
-
postalCode?: string | null;
|
|
1983
|
-
/** Main address line, usually street and number as free text. */
|
|
1984
|
-
addressLine1?: string | null;
|
|
1985
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
1986
|
-
addressLine2?: string | null;
|
|
1987
|
-
}
|
|
1988
|
-
declare enum AddressTag$2 {
|
|
1989
|
-
UNTAGGED = "UNTAGGED",
|
|
1990
|
-
HOME = "HOME",
|
|
1991
|
-
WORK = "WORK",
|
|
1992
|
-
BILLING = "BILLING",
|
|
1993
|
-
SHIPPING = "SHIPPING"
|
|
1994
|
-
}
|
|
1995
|
-
interface Metadata$2 {
|
|
1996
|
-
/**
|
|
1997
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
1998
|
-
* @readonly
|
|
1999
|
-
*/
|
|
2000
|
-
tags?: string[];
|
|
2001
|
-
}
|
|
2002
|
-
interface Email$2 {
|
|
2003
|
-
address?: string;
|
|
2004
|
-
isVerified?: boolean;
|
|
2005
|
-
}
|
|
2006
|
-
interface StatusV2$2 {
|
|
2007
|
-
name?: StatusName$2;
|
|
2008
|
-
reasons?: Reason$2[];
|
|
2009
|
-
}
|
|
2010
|
-
declare enum StatusName$2 {
|
|
2011
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2012
|
-
PENDING = "PENDING",
|
|
2013
|
-
ACTIVE = "ACTIVE",
|
|
2014
|
-
DELETED = "DELETED",
|
|
2015
|
-
BLOCKED = "BLOCKED",
|
|
2016
|
-
OFFLINE = "OFFLINE"
|
|
2017
|
-
}
|
|
2018
|
-
declare enum Reason$2 {
|
|
2019
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2020
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
2021
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
2022
|
-
}
|
|
2023
|
-
interface Factor$2 {
|
|
2024
|
-
/** Factor ID. */
|
|
2025
|
-
factorId?: string;
|
|
2026
|
-
/** Factor type. */
|
|
2027
|
-
type?: FactorType$2;
|
|
2028
|
-
/** Factor status. */
|
|
2029
|
-
status?: Status$2;
|
|
2030
|
-
}
|
|
2031
|
-
declare enum FactorType$2 {
|
|
2032
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
2033
|
-
PASSWORD = "PASSWORD",
|
|
2034
|
-
SMS = "SMS",
|
|
2035
|
-
CALL = "CALL",
|
|
2036
|
-
EMAIL = "EMAIL",
|
|
2037
|
-
TOTP = "TOTP",
|
|
2038
|
-
PUSH = "PUSH"
|
|
2039
|
-
}
|
|
2040
|
-
declare enum Status$2 {
|
|
2041
|
-
/** Factor requires activation. */
|
|
2042
|
-
INACTIVE = "INACTIVE",
|
|
2043
|
-
/** Factor is active and can be used for authentication. */
|
|
2044
|
-
ACTIVE = "ACTIVE",
|
|
2045
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
2046
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
2047
|
-
}
|
|
2048
|
-
interface CustomValue$2 extends CustomValueValueOneOf$2 {
|
|
2049
|
-
/** String value. */
|
|
2050
|
-
strValue?: string;
|
|
2051
|
-
/** Number value. */
|
|
2052
|
-
numValue?: number;
|
|
2053
|
-
/** Date value. */
|
|
2054
|
-
dateValue?: Date | null;
|
|
2055
|
-
/** List value. */
|
|
2056
|
-
listValue?: ListValue$2;
|
|
2057
|
-
/** Map value. */
|
|
2058
|
-
mapValue?: MapValue$2;
|
|
2059
|
-
}
|
|
2060
|
-
/** @oneof */
|
|
2061
|
-
interface CustomValueValueOneOf$2 {
|
|
2062
|
-
/** String value. */
|
|
2063
|
-
strValue?: string;
|
|
2064
|
-
/** Number value. */
|
|
2065
|
-
numValue?: number;
|
|
2066
|
-
/** Date value. */
|
|
2067
|
-
dateValue?: Date | null;
|
|
2068
|
-
/** List value. */
|
|
2069
|
-
listValue?: ListValue$2;
|
|
2070
|
-
/** Map value. */
|
|
2071
|
-
mapValue?: MapValue$2;
|
|
2072
|
-
}
|
|
2073
|
-
interface ListValue$2 {
|
|
2074
|
-
/** Custom value. */
|
|
2075
|
-
value?: CustomValue$2[];
|
|
2076
|
-
}
|
|
2077
|
-
interface MapValue$2 {
|
|
2078
|
-
/** Mapped custom value. */
|
|
2079
|
-
value?: Record<string, CustomValue$2>;
|
|
2080
|
-
}
|
|
2081
|
-
interface RequireMfaData$2 {
|
|
2082
|
-
availableFactors?: V1Factor$2[];
|
|
2083
|
-
}
|
|
2084
|
-
interface V1Factor$2 {
|
|
2085
|
-
factorType?: FactorType$2;
|
|
2086
|
-
}
|
|
2087
|
-
interface MfaChallengeData$2 {
|
|
2088
|
-
factorType?: FactorType$2;
|
|
2089
|
-
verificationChallengeData?: VerificationChallenge$2;
|
|
2090
|
-
availableFactors?: V1Factor$2[];
|
|
2091
|
-
}
|
|
2092
|
-
interface VerificationChallenge$2 {
|
|
2093
|
-
hint?: string | null;
|
|
2094
|
-
}
|
|
2095
|
-
interface V1FactorNonNullableFields$2 {
|
|
2096
|
-
factorType: FactorType$2;
|
|
2097
|
-
}
|
|
2098
|
-
interface RequireMfaDataNonNullableFields$2 {
|
|
2099
|
-
availableFactors: V1FactorNonNullableFields$2[];
|
|
2100
|
-
}
|
|
2101
|
-
interface MfaChallengeDataNonNullableFields$2 {
|
|
2102
|
-
factorType: FactorType$2;
|
|
2103
|
-
availableFactors: V1FactorNonNullableFields$2[];
|
|
2104
|
-
}
|
|
2105
|
-
interface IdpConnectionNonNullableFields$2 {
|
|
2106
|
-
idpConnectionId: string;
|
|
2107
|
-
idpUserId: string;
|
|
2108
|
-
}
|
|
2109
|
-
interface AuthenticatorConnectionNonNullableFields$2 {
|
|
2110
|
-
authenticatorConnectionId: string;
|
|
2111
|
-
reEnrollmentRequired: boolean;
|
|
2112
|
-
}
|
|
2113
|
-
interface ConnectionNonNullableFields$2 {
|
|
2114
|
-
idpConnection?: IdpConnectionNonNullableFields$2;
|
|
2115
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields$2;
|
|
2116
|
-
}
|
|
2117
|
-
interface V1ListValueNonNullableFields$2 {
|
|
2118
|
-
value: V1CustomValueNonNullableFields$2[];
|
|
2119
|
-
}
|
|
2120
|
-
interface V1CustomValueNonNullableFields$2 {
|
|
2121
|
-
strValue: string;
|
|
2122
|
-
numValue: number;
|
|
2123
|
-
listValue?: V1ListValueNonNullableFields$2;
|
|
2124
|
-
}
|
|
2125
|
-
interface CustomFieldNonNullableFields$2 {
|
|
2126
|
-
name: string;
|
|
2127
|
-
value?: V1CustomValueNonNullableFields$2;
|
|
2128
|
-
}
|
|
2129
|
-
interface SecondaryEmailNonNullableFields$2 {
|
|
2130
|
-
email: string;
|
|
2131
|
-
tag: EmailTag$2;
|
|
2132
|
-
}
|
|
2133
|
-
interface PhoneNonNullableFields$2 {
|
|
2134
|
-
phone: string;
|
|
2135
|
-
tag: PhoneTag$2;
|
|
2136
|
-
}
|
|
2137
|
-
interface AddressWrapperNonNullableFields$2 {
|
|
2138
|
-
tag: AddressTag$2;
|
|
2139
|
-
}
|
|
2140
|
-
interface IdentityProfileNonNullableFields$2 {
|
|
2141
|
-
emails: string[];
|
|
2142
|
-
phones: string[];
|
|
2143
|
-
labels: string[];
|
|
2144
|
-
privacyStatus: PrivacyStatus$2;
|
|
2145
|
-
customFields: CustomFieldNonNullableFields$2[];
|
|
2146
|
-
secondaryEmails: SecondaryEmailNonNullableFields$2[];
|
|
2147
|
-
phonesV2: PhoneNonNullableFields$2[];
|
|
2148
|
-
addresses: AddressWrapperNonNullableFields$2[];
|
|
2149
|
-
}
|
|
2150
|
-
interface MetadataNonNullableFields$2 {
|
|
2151
|
-
tags: string[];
|
|
2152
|
-
}
|
|
2153
|
-
interface EmailNonNullableFields$2 {
|
|
2154
|
-
address: string;
|
|
2155
|
-
isVerified: boolean;
|
|
2156
|
-
}
|
|
2157
|
-
interface StatusV2NonNullableFields$2 {
|
|
2158
|
-
name: StatusName$2;
|
|
2159
|
-
reasons: Reason$2[];
|
|
2160
|
-
}
|
|
2161
|
-
interface FactorNonNullableFields$2 {
|
|
2162
|
-
factorId: string;
|
|
2163
|
-
type: FactorType$2;
|
|
2164
|
-
status: Status$2;
|
|
2165
|
-
}
|
|
2166
|
-
interface IdentityNonNullableFields$2 {
|
|
2167
|
-
connections: ConnectionNonNullableFields$2[];
|
|
2168
|
-
identityProfile?: IdentityProfileNonNullableFields$2;
|
|
2169
|
-
metadata?: MetadataNonNullableFields$2;
|
|
2170
|
-
email?: EmailNonNullableFields$2;
|
|
2171
|
-
status?: StatusV2NonNullableFields$2;
|
|
2172
|
-
factors: FactorNonNullableFields$2[];
|
|
2173
|
-
}
|
|
2174
|
-
interface StateMachineResponseNonNullableFields$2 {
|
|
2175
|
-
requireMfaData?: RequireMfaDataNonNullableFields$2;
|
|
2176
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields$2;
|
|
2177
|
-
state: StateType$2;
|
|
2178
|
-
identity?: IdentityNonNullableFields$2;
|
|
2179
|
-
}
|
|
2180
|
-
|
|
2181
|
-
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2182
|
-
getUrl: (context: any) => string;
|
|
2183
|
-
httpMethod: K;
|
|
2184
|
-
path: string;
|
|
2185
|
-
pathParams: M;
|
|
2186
|
-
__requestType: T;
|
|
2187
|
-
__originalRequestType: S;
|
|
2188
|
-
__responseType: Q;
|
|
2189
|
-
__originalResponseType: R;
|
|
2190
|
-
};
|
|
2191
|
-
declare function sendRecoveryEmail(): __PublicMethodMetaInfo$2<'POST', {}, SendRecoveryEmailRequest, SendRecoveryEmailRequest$1, SendRecoveryEmailResponse, SendRecoveryEmailResponse$1>;
|
|
2192
|
-
declare function sendActivationEmail(): __PublicMethodMetaInfo$2<'POST', {}, SendActivationEmailRequest, SendActivationEmailRequest$1, SendActivationEmailResponse, SendActivationEmailResponse$1>;
|
|
2193
|
-
declare function recover(): __PublicMethodMetaInfo$2<'POST', {}, RecoverRequest, RecoverRequest$1, StateMachineResponse$2 & StateMachineResponseNonNullableFields$2, StateMachineResponse$3 & StateMachineResponseNonNullableFields$3>;
|
|
2194
|
-
|
|
2195
|
-
declare const meta$2_recover: typeof recover;
|
|
2196
|
-
declare const meta$2_sendActivationEmail: typeof sendActivationEmail;
|
|
2197
|
-
declare const meta$2_sendRecoveryEmail: typeof sendRecoveryEmail;
|
|
2198
|
-
declare namespace meta$2 {
|
|
2199
|
-
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_recover as recover, meta$2_sendActivationEmail as sendActivationEmail, meta$2_sendRecoveryEmail as sendRecoveryEmail };
|
|
2200
|
-
}
|
|
2201
|
-
|
|
2202
|
-
interface StartResponse$1 {
|
|
2203
|
-
/** the identifier of the verification process */
|
|
2204
|
-
verificationId?: string;
|
|
2205
|
-
}
|
|
2206
|
-
interface StartRequest$1 {
|
|
2207
|
-
/**
|
|
2208
|
-
* an identity_Id.
|
|
2209
|
-
* If not provided - currently, an exception is thrown. In the future the identity from identity response will be taken.
|
|
2210
|
-
*/
|
|
2211
|
-
identityId?: string | null;
|
|
2212
|
-
/** the delivery target */
|
|
2213
|
-
target?: Target$1;
|
|
2214
|
-
}
|
|
2215
|
-
declare enum Target$1 {
|
|
2216
|
-
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
2217
|
-
EMAIL = "EMAIL"
|
|
2218
|
-
}
|
|
2219
|
-
interface VerifyDuringAuthenticationRequest$1 {
|
|
2220
|
-
/** The code to verify. */
|
|
2221
|
-
code: string;
|
|
2222
|
-
/** A state token representing the `REQUIRE_EMAIL_VERIFICATION` state. */
|
|
2223
|
-
stateToken: string;
|
|
2224
|
-
}
|
|
2225
|
-
interface StateMachineResponse$1 extends StateMachineResponseStateDataOneOf$1 {
|
|
2226
|
-
requireMfaData?: RequireMfaData$1;
|
|
2227
|
-
mfaChallengeData?: MfaChallengeData$1;
|
|
2228
|
-
/** The current state of the login or registration process. */
|
|
2229
|
-
state?: StateType$1;
|
|
2230
|
-
/** If state is `SUCCESS`, a session token. */
|
|
2231
|
-
sessionToken?: string | null;
|
|
2232
|
-
/** A token representing the current state of the login or registration process. */
|
|
2233
|
-
stateToken?: string | null;
|
|
2234
|
-
/** Identing of the current member. */
|
|
2235
|
-
identity?: Identity$1;
|
|
2236
|
-
/** additional_data = 5; //TBD */
|
|
2237
|
-
additionalData?: Record<string, CustomValue$1>;
|
|
2238
|
-
}
|
|
2239
|
-
/** @oneof */
|
|
2240
|
-
interface StateMachineResponseStateDataOneOf$1 {
|
|
2241
|
-
requireMfaData?: RequireMfaData$1;
|
|
2242
|
-
mfaChallengeData?: MfaChallengeData$1;
|
|
2243
|
-
}
|
|
2244
|
-
declare enum StateType$1 {
|
|
2245
|
-
/** Initial unknown state. */
|
|
2246
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
2247
|
-
/** The operation completed successfully. */
|
|
2248
|
-
SUCCESS = "SUCCESS",
|
|
2249
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
2250
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
2251
|
-
/**
|
|
2252
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
2253
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
2254
|
-
*/
|
|
2255
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
2256
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
2257
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
2258
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
2259
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
2260
|
-
}
|
|
2261
|
-
interface Identity$1 {
|
|
2262
|
-
/** Identity ID */
|
|
2263
|
-
id?: string | null;
|
|
2264
|
-
/**
|
|
2265
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
2266
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
2267
|
-
*/
|
|
2268
|
-
revision?: string | null;
|
|
2269
|
-
/**
|
|
2270
|
-
* The time this identity was created.
|
|
2271
|
-
* @readonly
|
|
2272
|
-
*/
|
|
2273
|
-
createdDate?: Date | null;
|
|
2274
|
-
/**
|
|
2275
|
-
* The time this identity was last updated.
|
|
2276
|
-
* @readonly
|
|
2277
|
-
*/
|
|
2278
|
-
updatedDate?: Date | null;
|
|
2279
|
-
/** The identity configured connections to authenticate with. */
|
|
2280
|
-
connections?: Connection$1[];
|
|
2281
|
-
/** Identity profile. */
|
|
2282
|
-
identityProfile?: IdentityProfile$1;
|
|
2283
|
-
/**
|
|
2284
|
-
* Additional information about the identity that can impact user access.
|
|
2285
|
-
* This data cannot be set.
|
|
2286
|
-
*/
|
|
2287
|
-
metadata?: Metadata$1;
|
|
2288
|
-
/** Identity email address. */
|
|
2289
|
-
email?: Email$1;
|
|
2290
|
-
/** Identity's current status. */
|
|
2291
|
-
status?: StatusV2$1;
|
|
2292
|
-
/** filled by pre registered spi */
|
|
2293
|
-
customAttributes?: Record<string, any> | null;
|
|
2294
|
-
/**
|
|
2295
|
-
* Identity factors.
|
|
2296
|
-
* @readonly
|
|
2297
|
-
*/
|
|
2298
|
-
factors?: Factor$1[];
|
|
2299
|
-
}
|
|
2300
|
-
interface Connection$1 extends ConnectionTypeOneOf$1 {
|
|
2301
|
-
/** IDP connection. */
|
|
2302
|
-
idpConnection?: IdpConnection$1;
|
|
2303
|
-
/** Authenticator connection. */
|
|
2304
|
-
authenticatorConnection?: AuthenticatorConnection$1;
|
|
2305
|
-
}
|
|
2306
|
-
/** @oneof */
|
|
2307
|
-
interface ConnectionTypeOneOf$1 {
|
|
2308
|
-
/** IDP connection. */
|
|
2309
|
-
idpConnection?: IdpConnection$1;
|
|
2310
|
-
/** Authenticator connection. */
|
|
2311
|
-
authenticatorConnection?: AuthenticatorConnection$1;
|
|
2312
|
-
}
|
|
2313
|
-
interface IdpConnection$1 {
|
|
2314
|
-
/** IDP connection ID. */
|
|
2315
|
-
idpConnectionId?: string;
|
|
2316
|
-
/** IDP user ID. */
|
|
2317
|
-
idpUserId?: string;
|
|
2318
|
-
}
|
|
2319
|
-
interface AuthenticatorConnection$1 {
|
|
2320
|
-
/** Authenticator connection ID. */
|
|
2321
|
-
authenticatorConnectionId?: string;
|
|
2322
|
-
/** Whether re-enrollment is required. */
|
|
2323
|
-
reEnrollmentRequired?: boolean;
|
|
2324
|
-
}
|
|
2325
|
-
interface IdentityProfile$1 {
|
|
2326
|
-
/** Profile first name. */
|
|
2327
|
-
firstName?: string | null;
|
|
2328
|
-
/** Profile last name. */
|
|
2329
|
-
lastName?: string | null;
|
|
2330
|
-
/** Profile nickname. */
|
|
2331
|
-
nickname?: string | null;
|
|
2332
|
-
/** Profile picture URL. */
|
|
2333
|
-
picture?: string | null;
|
|
2334
|
-
/**
|
|
2335
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
2336
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
2337
|
-
* @replacedBy secondary_emails
|
|
2338
|
-
* @targetRemovalDate 2023-11-01
|
|
2339
|
-
*/
|
|
2340
|
-
emails?: string[];
|
|
2341
|
-
/**
|
|
2342
|
-
* Deprecated. Use `phonesV2` instead.
|
|
2343
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
2344
|
-
* @replacedBy phones_v2
|
|
2345
|
-
* @targetRemovalDate 2023-11-01
|
|
2346
|
-
*/
|
|
2347
|
-
phones?: string[];
|
|
2348
|
-
/** List of profile labels. */
|
|
2349
|
-
labels?: string[];
|
|
2350
|
-
/** Profile language. */
|
|
2351
|
-
language?: string | null;
|
|
2352
|
-
/** Profile privacy status. */
|
|
2353
|
-
privacyStatus?: PrivacyStatus$1;
|
|
2354
|
-
/**
|
|
2355
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
2356
|
-
* are used to store additional information about your site or app's contacts.
|
|
2357
|
-
*/
|
|
2358
|
-
customFields?: CustomField$1[];
|
|
2359
|
-
/** List of profile email addresses. */
|
|
2360
|
-
secondaryEmails?: SecondaryEmail$1[];
|
|
2361
|
-
/** List of profile phone numbers. */
|
|
2362
|
-
phonesV2?: Phone$1[];
|
|
2363
|
-
/** List of profile physical addresses. */
|
|
2364
|
-
addresses?: AddressWrapper$1[];
|
|
2365
|
-
/** Company name. */
|
|
2366
|
-
company?: string | null;
|
|
2367
|
-
/** Position within company. */
|
|
2368
|
-
position?: string | null;
|
|
2369
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
2370
|
-
birthdate?: string | null;
|
|
2371
|
-
/** slug */
|
|
2372
|
-
slug?: string | null;
|
|
2373
|
-
}
|
|
2374
|
-
declare enum PrivacyStatus$1 {
|
|
2375
|
-
UNDEFINED = "UNDEFINED",
|
|
2376
|
-
PUBLIC = "PUBLIC",
|
|
2377
|
-
PRIVATE = "PRIVATE"
|
|
2378
|
-
}
|
|
2379
|
-
interface CustomField$1 {
|
|
2380
|
-
/**
|
|
2381
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
2382
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
2383
|
-
* with the `custom.` prefix removed.
|
|
2384
|
-
*/
|
|
2385
|
-
name?: string;
|
|
2386
|
-
/** Custom field value. */
|
|
2387
|
-
value?: V1CustomValue$1;
|
|
2388
|
-
}
|
|
2389
|
-
interface V1CustomValue$1 extends V1CustomValueValueOneOf$1 {
|
|
2390
|
-
/** String value. */
|
|
2391
|
-
strValue?: string;
|
|
2392
|
-
/** Number value. */
|
|
2393
|
-
numValue?: number;
|
|
2394
|
-
/** Date value. */
|
|
2395
|
-
dateValue?: Date | null;
|
|
2396
|
-
/** List value. */
|
|
2397
|
-
listValue?: V1ListValue$1;
|
|
2398
|
-
/** Map value. */
|
|
2399
|
-
mapValue?: V1MapValue$1;
|
|
2400
|
-
}
|
|
2401
|
-
/** @oneof */
|
|
2402
|
-
interface V1CustomValueValueOneOf$1 {
|
|
2403
|
-
/** String value. */
|
|
2404
|
-
strValue?: string;
|
|
2405
|
-
/** Number value. */
|
|
2406
|
-
numValue?: number;
|
|
2407
|
-
/** Date value. */
|
|
2408
|
-
dateValue?: Date | null;
|
|
2409
|
-
/** List value. */
|
|
2410
|
-
listValue?: V1ListValue$1;
|
|
2411
|
-
/** Map value. */
|
|
2412
|
-
mapValue?: V1MapValue$1;
|
|
2413
|
-
}
|
|
2414
|
-
interface V1ListValue$1 {
|
|
2415
|
-
/** Custom value. */
|
|
2416
|
-
value?: V1CustomValue$1[];
|
|
2417
|
-
}
|
|
2418
|
-
interface V1MapValue$1 {
|
|
2419
|
-
/** Mapped custom value. */
|
|
2420
|
-
value?: Record<string, V1CustomValue$1>;
|
|
2421
|
-
}
|
|
2422
|
-
interface SecondaryEmail$1 {
|
|
2423
|
-
/** Email address. */
|
|
2424
|
-
email?: string;
|
|
2425
|
-
/** Email tag. */
|
|
2426
|
-
tag?: EmailTag$1;
|
|
2427
|
-
}
|
|
2428
|
-
declare enum EmailTag$1 {
|
|
2429
|
-
UNTAGGED = "UNTAGGED",
|
|
2430
|
-
MAIN = "MAIN",
|
|
2431
|
-
HOME = "HOME",
|
|
2432
|
-
WORK = "WORK"
|
|
2433
|
-
}
|
|
2434
|
-
interface Phone$1 {
|
|
2435
|
-
/** Phone country code. */
|
|
2436
|
-
countryCode?: string | null;
|
|
2437
|
-
/** Phone number. */
|
|
2438
|
-
phone?: string;
|
|
2439
|
-
/** Phone tag. */
|
|
2440
|
-
tag?: PhoneTag$1;
|
|
2441
|
-
}
|
|
2442
|
-
declare enum PhoneTag$1 {
|
|
2443
|
-
UNTAGGED = "UNTAGGED",
|
|
2444
|
-
MAIN = "MAIN",
|
|
2445
|
-
HOME = "HOME",
|
|
2446
|
-
MOBILE = "MOBILE",
|
|
2447
|
-
WORK = "WORK",
|
|
2448
|
-
FAX = "FAX"
|
|
2449
|
-
}
|
|
2450
|
-
interface AddressWrapper$1 {
|
|
2451
|
-
/** Address. */
|
|
2452
|
-
address?: Address$1;
|
|
2453
|
-
/** Address tag. */
|
|
2454
|
-
tag?: AddressTag$1;
|
|
2455
|
-
}
|
|
2456
|
-
/** Physical address */
|
|
2457
|
-
interface Address$1 {
|
|
2458
|
-
/** Country code. */
|
|
2459
|
-
country?: string | null;
|
|
2460
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
2461
|
-
subdivision?: string | null;
|
|
2462
|
-
/** City name. */
|
|
2463
|
-
city?: string | null;
|
|
2464
|
-
/** Zip/postal code. */
|
|
2465
|
-
postalCode?: string | null;
|
|
2466
|
-
/** Main address line, usually street and number as free text. */
|
|
2467
|
-
addressLine?: string | null;
|
|
2468
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
2469
|
-
addressLine2?: string | null;
|
|
2470
|
-
}
|
|
2471
|
-
declare enum AddressTag$1 {
|
|
2472
|
-
UNTAGGED = "UNTAGGED",
|
|
2473
|
-
HOME = "HOME",
|
|
2474
|
-
WORK = "WORK",
|
|
2475
|
-
BILLING = "BILLING",
|
|
2476
|
-
SHIPPING = "SHIPPING"
|
|
2477
|
-
}
|
|
2478
|
-
interface Metadata$1 {
|
|
2479
|
-
/**
|
|
2480
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
2481
|
-
* @readonly
|
|
2482
|
-
*/
|
|
2483
|
-
tags?: string[];
|
|
2484
|
-
}
|
|
2485
|
-
interface Email$1 {
|
|
2486
|
-
address?: string;
|
|
2487
|
-
isVerified?: boolean;
|
|
2488
|
-
}
|
|
2489
|
-
interface StatusV2$1 {
|
|
2490
|
-
name?: StatusName$1;
|
|
2491
|
-
reasons?: Reason$1[];
|
|
2492
|
-
}
|
|
2493
|
-
declare enum StatusName$1 {
|
|
2494
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2495
|
-
PENDING = "PENDING",
|
|
2496
|
-
ACTIVE = "ACTIVE",
|
|
2497
|
-
DELETED = "DELETED",
|
|
2498
|
-
BLOCKED = "BLOCKED",
|
|
2499
|
-
OFFLINE = "OFFLINE"
|
|
2500
|
-
}
|
|
2501
|
-
declare enum Reason$1 {
|
|
2502
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2503
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
2504
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
2505
|
-
}
|
|
2506
|
-
interface Factor$1 {
|
|
2507
|
-
/** Factor ID. */
|
|
2508
|
-
factorId?: string;
|
|
2509
|
-
/** Factor type. */
|
|
2510
|
-
type?: FactorType$1;
|
|
2511
|
-
/** Factor status. */
|
|
2512
|
-
status?: Status$1;
|
|
2513
|
-
}
|
|
2514
|
-
declare enum FactorType$1 {
|
|
2515
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
2516
|
-
PASSWORD = "PASSWORD",
|
|
2517
|
-
SMS = "SMS",
|
|
2518
|
-
CALL = "CALL",
|
|
2519
|
-
EMAIL = "EMAIL",
|
|
2520
|
-
TOTP = "TOTP",
|
|
2521
|
-
PUSH = "PUSH"
|
|
2522
|
-
}
|
|
2523
|
-
declare enum Status$1 {
|
|
2524
|
-
/** Factor requires activation. */
|
|
2525
|
-
INACTIVE = "INACTIVE",
|
|
2526
|
-
/** Factor is active and can be used for authentication. */
|
|
2527
|
-
ACTIVE = "ACTIVE",
|
|
2528
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
2529
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
2530
|
-
}
|
|
2531
|
-
interface CustomValue$1 extends CustomValueValueOneOf$1 {
|
|
2532
|
-
/** String value. */
|
|
2533
|
-
strValue?: string;
|
|
2534
|
-
/** Number value. */
|
|
2535
|
-
numValue?: number;
|
|
2536
|
-
/** Date value. */
|
|
2537
|
-
dateValue?: Date | null;
|
|
2538
|
-
/** List value. */
|
|
2539
|
-
listValue?: ListValue$1;
|
|
2540
|
-
/** Map value. */
|
|
2541
|
-
mapValue?: MapValue$1;
|
|
2542
|
-
}
|
|
2543
|
-
/** @oneof */
|
|
2544
|
-
interface CustomValueValueOneOf$1 {
|
|
2545
|
-
/** String value. */
|
|
2546
|
-
strValue?: string;
|
|
2547
|
-
/** Number value. */
|
|
2548
|
-
numValue?: number;
|
|
2549
|
-
/** Date value. */
|
|
2550
|
-
dateValue?: Date | null;
|
|
2551
|
-
/** List value. */
|
|
2552
|
-
listValue?: ListValue$1;
|
|
2553
|
-
/** Map value. */
|
|
2554
|
-
mapValue?: MapValue$1;
|
|
2555
|
-
}
|
|
2556
|
-
interface ListValue$1 {
|
|
2557
|
-
/** Custom value. */
|
|
2558
|
-
value?: CustomValue$1[];
|
|
2559
|
-
}
|
|
2560
|
-
interface MapValue$1 {
|
|
2561
|
-
/** Mapped custom value. */
|
|
2562
|
-
value?: Record<string, CustomValue$1>;
|
|
2563
|
-
}
|
|
2564
|
-
interface RequireMfaData$1 {
|
|
2565
|
-
availableFactors?: V1Factor$1[];
|
|
2566
|
-
}
|
|
2567
|
-
interface V1Factor$1 {
|
|
2568
|
-
factorType?: FactorType$1;
|
|
2569
|
-
}
|
|
2570
|
-
interface MfaChallengeData$1 {
|
|
2571
|
-
factorType?: FactorType$1;
|
|
2572
|
-
verificationChallengeData?: VerificationChallenge$1;
|
|
2573
|
-
availableFactors?: V1Factor$1[];
|
|
2574
|
-
}
|
|
2575
|
-
interface VerificationChallenge$1 {
|
|
2576
|
-
hint?: string | null;
|
|
2577
|
-
}
|
|
2578
|
-
interface ResendDuringAuthenticationRequest$1 {
|
|
2579
|
-
/** A state token representing the `REQUIRE_EMAIL_VERIFICATION` state. */
|
|
2580
|
-
stateToken: string;
|
|
2581
|
-
}
|
|
2582
|
-
interface StartResponseNonNullableFields$1 {
|
|
2583
|
-
verificationId: string;
|
|
2584
|
-
}
|
|
2585
|
-
interface V1FactorNonNullableFields$1 {
|
|
2586
|
-
factorType: FactorType$1;
|
|
2587
|
-
}
|
|
2588
|
-
interface RequireMfaDataNonNullableFields$1 {
|
|
2589
|
-
availableFactors: V1FactorNonNullableFields$1[];
|
|
2590
|
-
}
|
|
2591
|
-
interface MfaChallengeDataNonNullableFields$1 {
|
|
2592
|
-
factorType: FactorType$1;
|
|
2593
|
-
availableFactors: V1FactorNonNullableFields$1[];
|
|
2594
|
-
}
|
|
2595
|
-
interface IdpConnectionNonNullableFields$1 {
|
|
2596
|
-
idpConnectionId: string;
|
|
2597
|
-
idpUserId: string;
|
|
2598
|
-
}
|
|
2599
|
-
interface AuthenticatorConnectionNonNullableFields$1 {
|
|
2600
|
-
authenticatorConnectionId: string;
|
|
2601
|
-
reEnrollmentRequired: boolean;
|
|
2602
|
-
}
|
|
2603
|
-
interface ConnectionNonNullableFields$1 {
|
|
2604
|
-
idpConnection?: IdpConnectionNonNullableFields$1;
|
|
2605
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields$1;
|
|
2606
|
-
}
|
|
2607
|
-
interface V1ListValueNonNullableFields$1 {
|
|
2608
|
-
value: V1CustomValueNonNullableFields$1[];
|
|
2609
|
-
}
|
|
2610
|
-
interface V1CustomValueNonNullableFields$1 {
|
|
2611
|
-
strValue: string;
|
|
2612
|
-
numValue: number;
|
|
2613
|
-
listValue?: V1ListValueNonNullableFields$1;
|
|
2614
|
-
}
|
|
2615
|
-
interface CustomFieldNonNullableFields$1 {
|
|
2616
|
-
name: string;
|
|
2617
|
-
value?: V1CustomValueNonNullableFields$1;
|
|
2618
|
-
}
|
|
2619
|
-
interface SecondaryEmailNonNullableFields$1 {
|
|
2620
|
-
email: string;
|
|
2621
|
-
tag: EmailTag$1;
|
|
2622
|
-
}
|
|
2623
|
-
interface PhoneNonNullableFields$1 {
|
|
2624
|
-
phone: string;
|
|
2625
|
-
tag: PhoneTag$1;
|
|
2626
|
-
}
|
|
2627
|
-
interface AddressWrapperNonNullableFields$1 {
|
|
2628
|
-
tag: AddressTag$1;
|
|
2629
|
-
}
|
|
2630
|
-
interface IdentityProfileNonNullableFields$1 {
|
|
2631
|
-
emails: string[];
|
|
2632
|
-
phones: string[];
|
|
2633
|
-
labels: string[];
|
|
2634
|
-
privacyStatus: PrivacyStatus$1;
|
|
2635
|
-
customFields: CustomFieldNonNullableFields$1[];
|
|
2636
|
-
secondaryEmails: SecondaryEmailNonNullableFields$1[];
|
|
2637
|
-
phonesV2: PhoneNonNullableFields$1[];
|
|
2638
|
-
addresses: AddressWrapperNonNullableFields$1[];
|
|
2639
|
-
}
|
|
2640
|
-
interface MetadataNonNullableFields$1 {
|
|
2641
|
-
tags: string[];
|
|
2642
|
-
}
|
|
2643
|
-
interface EmailNonNullableFields$1 {
|
|
2644
|
-
address: string;
|
|
2645
|
-
isVerified: boolean;
|
|
2646
|
-
}
|
|
2647
|
-
interface StatusV2NonNullableFields$1 {
|
|
2648
|
-
name: StatusName$1;
|
|
2649
|
-
reasons: Reason$1[];
|
|
2650
|
-
}
|
|
2651
|
-
interface FactorNonNullableFields$1 {
|
|
2652
|
-
factorId: string;
|
|
2653
|
-
type: FactorType$1;
|
|
2654
|
-
status: Status$1;
|
|
2655
|
-
}
|
|
2656
|
-
interface IdentityNonNullableFields$1 {
|
|
2657
|
-
connections: ConnectionNonNullableFields$1[];
|
|
2658
|
-
identityProfile?: IdentityProfileNonNullableFields$1;
|
|
2659
|
-
metadata?: MetadataNonNullableFields$1;
|
|
2660
|
-
email?: EmailNonNullableFields$1;
|
|
2661
|
-
status?: StatusV2NonNullableFields$1;
|
|
2662
|
-
factors: FactorNonNullableFields$1[];
|
|
2663
|
-
}
|
|
2664
|
-
interface StateMachineResponseNonNullableFields$1 {
|
|
2665
|
-
requireMfaData?: RequireMfaDataNonNullableFields$1;
|
|
2666
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields$1;
|
|
2667
|
-
state: StateType$1;
|
|
2668
|
-
identity?: IdentityNonNullableFields$1;
|
|
2669
|
-
}
|
|
2670
|
-
|
|
2671
|
-
interface StartResponse {
|
|
2672
|
-
/** the identifier of the verification process */
|
|
2673
|
-
verificationId?: string;
|
|
2674
|
-
}
|
|
2675
|
-
interface StartRequest {
|
|
2676
|
-
/**
|
|
2677
|
-
* an identity_Id.
|
|
2678
|
-
* If not provided - currently, an exception is thrown. In the future the identity from identity response will be taken.
|
|
2679
|
-
*/
|
|
2680
|
-
identityId?: string | null;
|
|
2681
|
-
/** the delivery target */
|
|
2682
|
-
target?: Target;
|
|
2683
|
-
}
|
|
2684
|
-
declare enum Target {
|
|
2685
|
-
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
2686
|
-
EMAIL = "EMAIL"
|
|
2687
|
-
}
|
|
2688
|
-
interface VerifyDuringAuthenticationRequest {
|
|
2689
|
-
/** The code to verify. */
|
|
2690
|
-
code: string;
|
|
2691
|
-
/** A state token representing the `REQUIRE_EMAIL_VERIFICATION` state. */
|
|
2692
|
-
stateToken: string;
|
|
2693
|
-
}
|
|
2694
|
-
interface StateMachineResponse extends StateMachineResponseStateDataOneOf {
|
|
2695
|
-
requireMfaData?: RequireMfaData;
|
|
2696
|
-
mfaChallengeData?: MfaChallengeData;
|
|
2697
|
-
/** The current state of the login or registration process. */
|
|
2698
|
-
state?: StateType;
|
|
2699
|
-
/** If state is `SUCCESS`, a session token. */
|
|
2700
|
-
sessionToken?: string | null;
|
|
2701
|
-
/** A token representing the current state of the login or registration process. */
|
|
2702
|
-
stateToken?: string | null;
|
|
2703
|
-
/** Identing of the current member. */
|
|
2704
|
-
identity?: Identity;
|
|
2705
|
-
/** additional_data = 5; //TBD */
|
|
2706
|
-
additionalData?: Record<string, CustomValue>;
|
|
2707
|
-
}
|
|
2708
|
-
/** @oneof */
|
|
2709
|
-
interface StateMachineResponseStateDataOneOf {
|
|
2710
|
-
requireMfaData?: RequireMfaData;
|
|
2711
|
-
mfaChallengeData?: MfaChallengeData;
|
|
2712
|
-
}
|
|
2713
|
-
declare enum StateType {
|
|
2714
|
-
/** Initial unknown state. */
|
|
2715
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
2716
|
-
/** The operation completed successfully. */
|
|
2717
|
-
SUCCESS = "SUCCESS",
|
|
2718
|
-
/** State that indicates that the member needs owner approval to proceed, available action in: OwnerApprovalStateHandler */
|
|
2719
|
-
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
2720
|
-
/**
|
|
2721
|
-
* State that indicates a member waiting for verification, available action are: verifyDuringAuthentication or resendDuringAuthentication
|
|
2722
|
-
* https://dev.wix.com/docs/rest/api-reference/auth-management/verification-v1/verify-during-authentication
|
|
2723
|
-
*/
|
|
2724
|
-
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
2725
|
-
/** State that indicates checking that the status is not one of the `invalidStates` before proceeding. */
|
|
2726
|
-
STATUS_CHECK = "STATUS_CHECK",
|
|
2727
|
-
REQUIRE_MFA = "REQUIRE_MFA",
|
|
2728
|
-
MFA_CHALLENGE = "MFA_CHALLENGE"
|
|
2729
|
-
}
|
|
2730
|
-
interface Identity {
|
|
2731
|
-
/** Identity ID */
|
|
2732
|
-
_id?: string | null;
|
|
2733
|
-
/**
|
|
2734
|
-
* Represents the current state of an item. Each time the item is modified, its `revision` changes.
|
|
2735
|
-
* For an update operation to succeed, you MUST pass the latest revision.
|
|
2736
|
-
*/
|
|
2737
|
-
revision?: string | null;
|
|
2738
|
-
/**
|
|
2739
|
-
* The time this identity was created.
|
|
2740
|
-
* @readonly
|
|
2741
|
-
*/
|
|
2742
|
-
_createdDate?: Date | null;
|
|
2743
|
-
/**
|
|
2744
|
-
* The time this identity was last updated.
|
|
2745
|
-
* @readonly
|
|
2746
|
-
*/
|
|
2747
|
-
_updatedDate?: Date | null;
|
|
2748
|
-
/** The identity configured connections to authenticate with. */
|
|
2749
|
-
connections?: Connection[];
|
|
2750
|
-
/** Identity profile. */
|
|
2751
|
-
identityProfile?: IdentityProfile;
|
|
2752
|
-
/**
|
|
2753
|
-
* Additional information about the identity that can impact user access.
|
|
2754
|
-
* This data cannot be set.
|
|
2755
|
-
*/
|
|
2756
|
-
metadata?: Metadata;
|
|
2757
|
-
/** Identity email address. */
|
|
2758
|
-
email?: Email;
|
|
2759
|
-
/** Identity's current status. */
|
|
2760
|
-
status?: StatusV2;
|
|
2761
|
-
/** filled by pre registered spi */
|
|
2762
|
-
customAttributes?: Record<string, any> | null;
|
|
2763
|
-
/**
|
|
2764
|
-
* Identity factors.
|
|
2765
|
-
* @readonly
|
|
2766
|
-
*/
|
|
2767
|
-
factors?: Factor[];
|
|
2768
|
-
}
|
|
2769
|
-
interface Connection extends ConnectionTypeOneOf {
|
|
2770
|
-
/** IDP connection. */
|
|
2771
|
-
idpConnection?: IdpConnection;
|
|
2772
|
-
/** Authenticator connection. */
|
|
2773
|
-
authenticatorConnection?: AuthenticatorConnection;
|
|
2774
|
-
}
|
|
2775
|
-
/** @oneof */
|
|
2776
|
-
interface ConnectionTypeOneOf {
|
|
2777
|
-
/** IDP connection. */
|
|
2778
|
-
idpConnection?: IdpConnection;
|
|
2779
|
-
/** Authenticator connection. */
|
|
2780
|
-
authenticatorConnection?: AuthenticatorConnection;
|
|
2781
|
-
}
|
|
2782
|
-
interface IdpConnection {
|
|
2783
|
-
/** IDP connection ID. */
|
|
2784
|
-
idpConnectionId?: string;
|
|
2785
|
-
/** IDP user ID. */
|
|
2786
|
-
idpUserId?: string;
|
|
2787
|
-
}
|
|
2788
|
-
interface AuthenticatorConnection {
|
|
2789
|
-
/** Authenticator connection ID. */
|
|
2790
|
-
authenticatorConnectionId?: string;
|
|
2791
|
-
/** Whether re-enrollment is required. */
|
|
2792
|
-
reEnrollmentRequired?: boolean;
|
|
2793
|
-
}
|
|
2794
|
-
interface IdentityProfile {
|
|
2795
|
-
/** Profile first name. */
|
|
2796
|
-
firstName?: string | null;
|
|
2797
|
-
/** Profile last name. */
|
|
2798
|
-
lastName?: string | null;
|
|
2799
|
-
/** Profile nickname. */
|
|
2800
|
-
nickname?: string | null;
|
|
2801
|
-
/** Profile picture URL. */
|
|
2802
|
-
picture?: string | null;
|
|
2803
|
-
/**
|
|
2804
|
-
* Deprecated. Use `secondaryEmails` instead.
|
|
2805
|
-
* @deprecated Deprecated. Use `secondaryEmails` instead.
|
|
2806
|
-
* @replacedBy secondary_emails
|
|
2807
|
-
* @targetRemovalDate 2023-11-01
|
|
2808
|
-
*/
|
|
2809
|
-
emails?: string[];
|
|
2810
|
-
/**
|
|
2811
|
-
* Deprecated. Use `phonesV2` instead.
|
|
2812
|
-
* @deprecated Deprecated. Use `phonesV2` instead.
|
|
2813
|
-
* @replacedBy phones_v2
|
|
2814
|
-
* @targetRemovalDate 2023-11-01
|
|
2815
|
-
*/
|
|
2816
|
-
phones?: string[];
|
|
2817
|
-
/** List of profile labels. */
|
|
2818
|
-
labels?: string[];
|
|
2819
|
-
/** Profile language. */
|
|
2820
|
-
language?: string | null;
|
|
2821
|
-
/** Profile privacy status. */
|
|
2822
|
-
privacyStatus?: PrivacyStatus;
|
|
2823
|
-
/**
|
|
2824
|
-
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
2825
|
-
* are used to store additional information about your site or app's contacts.
|
|
2826
|
-
*/
|
|
2827
|
-
customFields?: CustomField[];
|
|
2828
|
-
/** List of profile email addresses. */
|
|
2829
|
-
secondaryEmails?: SecondaryEmail[];
|
|
2830
|
-
/** List of profile phone numbers. */
|
|
2831
|
-
phonesV2?: Phone[];
|
|
2832
|
-
/** List of profile physical addresses. */
|
|
2833
|
-
addresses?: AddressWrapper[];
|
|
2834
|
-
/** Company name. */
|
|
2835
|
-
company?: string | null;
|
|
2836
|
-
/** Position within company. */
|
|
2837
|
-
position?: string | null;
|
|
2838
|
-
/** Profile birthdate - ISO-8601 extended local date format (YYYY-MM-DD). */
|
|
2839
|
-
birthdate?: string | null;
|
|
2840
|
-
/** slug */
|
|
2841
|
-
slug?: string | null;
|
|
2842
|
-
}
|
|
2843
|
-
declare enum PrivacyStatus {
|
|
2844
|
-
UNDEFINED = "UNDEFINED",
|
|
2845
|
-
PUBLIC = "PUBLIC",
|
|
2846
|
-
PRIVATE = "PRIVATE"
|
|
2847
|
-
}
|
|
2848
|
-
interface CustomField {
|
|
2849
|
-
/**
|
|
2850
|
-
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
2851
|
-
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
2852
|
-
* with the `custom.` prefix removed.
|
|
2853
|
-
*/
|
|
2854
|
-
name?: string;
|
|
2855
|
-
/** Custom field value. */
|
|
2856
|
-
value?: V1CustomValue;
|
|
2857
|
-
}
|
|
2858
|
-
interface V1CustomValue extends V1CustomValueValueOneOf {
|
|
2859
|
-
/** String value. */
|
|
2860
|
-
strValue?: string;
|
|
2861
|
-
/** Number value. */
|
|
2862
|
-
numValue?: number;
|
|
2863
|
-
/** Date value. */
|
|
2864
|
-
dateValue?: Date | null;
|
|
2865
|
-
/** List value. */
|
|
2866
|
-
listValue?: V1ListValue;
|
|
2867
|
-
/** Map value. */
|
|
2868
|
-
mapValue?: V1MapValue;
|
|
2869
|
-
}
|
|
2870
|
-
/** @oneof */
|
|
2871
|
-
interface V1CustomValueValueOneOf {
|
|
2872
|
-
/** String value. */
|
|
2873
|
-
strValue?: string;
|
|
2874
|
-
/** Number value. */
|
|
2875
|
-
numValue?: number;
|
|
2876
|
-
/** Date value. */
|
|
2877
|
-
dateValue?: Date | null;
|
|
2878
|
-
/** List value. */
|
|
2879
|
-
listValue?: V1ListValue;
|
|
2880
|
-
/** Map value. */
|
|
2881
|
-
mapValue?: V1MapValue;
|
|
2882
|
-
}
|
|
2883
|
-
interface V1ListValue {
|
|
2884
|
-
/** Custom value. */
|
|
2885
|
-
value?: V1CustomValue[];
|
|
2886
|
-
}
|
|
2887
|
-
interface V1MapValue {
|
|
2888
|
-
/** Mapped custom value. */
|
|
2889
|
-
value?: Record<string, V1CustomValue>;
|
|
2890
|
-
}
|
|
2891
|
-
interface SecondaryEmail {
|
|
2892
|
-
/** Email address. */
|
|
2893
|
-
email?: string;
|
|
2894
|
-
/** Email tag. */
|
|
2895
|
-
tag?: EmailTag;
|
|
2896
|
-
}
|
|
2897
|
-
declare enum EmailTag {
|
|
2898
|
-
UNTAGGED = "UNTAGGED",
|
|
2899
|
-
MAIN = "MAIN",
|
|
2900
|
-
HOME = "HOME",
|
|
2901
|
-
WORK = "WORK"
|
|
2902
|
-
}
|
|
2903
|
-
interface Phone {
|
|
2904
|
-
/** Phone country code. */
|
|
2905
|
-
countryCode?: string | null;
|
|
2906
|
-
/** Phone number. */
|
|
2907
|
-
phone?: string;
|
|
2908
|
-
/** Phone tag. */
|
|
2909
|
-
tag?: PhoneTag;
|
|
2910
|
-
}
|
|
2911
|
-
declare enum PhoneTag {
|
|
2912
|
-
UNTAGGED = "UNTAGGED",
|
|
2913
|
-
MAIN = "MAIN",
|
|
2914
|
-
HOME = "HOME",
|
|
2915
|
-
MOBILE = "MOBILE",
|
|
2916
|
-
WORK = "WORK",
|
|
2917
|
-
FAX = "FAX"
|
|
2918
|
-
}
|
|
2919
|
-
interface AddressWrapper {
|
|
2920
|
-
/** Address. */
|
|
2921
|
-
address?: Address;
|
|
2922
|
-
/** Address tag. */
|
|
2923
|
-
tag?: AddressTag;
|
|
2924
|
-
}
|
|
2925
|
-
/** Physical address */
|
|
2926
|
-
interface Address {
|
|
2927
|
-
/** Country code. */
|
|
2928
|
-
country?: string | null;
|
|
2929
|
-
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
2930
|
-
subdivision?: string | null;
|
|
2931
|
-
/** City name. */
|
|
2932
|
-
city?: string | null;
|
|
2933
|
-
/** Zip/postal code. */
|
|
2934
|
-
postalCode?: string | null;
|
|
2935
|
-
/** Main address line, usually street and number as free text. */
|
|
2936
|
-
addressLine1?: string | null;
|
|
2937
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
2938
|
-
addressLine2?: string | null;
|
|
2939
|
-
}
|
|
2940
|
-
declare enum AddressTag {
|
|
2941
|
-
UNTAGGED = "UNTAGGED",
|
|
2942
|
-
HOME = "HOME",
|
|
2943
|
-
WORK = "WORK",
|
|
2944
|
-
BILLING = "BILLING",
|
|
2945
|
-
SHIPPING = "SHIPPING"
|
|
2946
|
-
}
|
|
2947
|
-
interface Metadata {
|
|
2948
|
-
/**
|
|
2949
|
-
* represents general tags such as "isOwner", "isContributor"
|
|
2950
|
-
* @readonly
|
|
2951
|
-
*/
|
|
2952
|
-
tags?: string[];
|
|
2953
|
-
}
|
|
2954
|
-
interface Email {
|
|
2955
|
-
address?: string;
|
|
2956
|
-
isVerified?: boolean;
|
|
2957
|
-
}
|
|
2958
|
-
interface StatusV2 {
|
|
2959
|
-
name?: StatusName;
|
|
2960
|
-
reasons?: Reason[];
|
|
2961
|
-
}
|
|
2962
|
-
declare enum StatusName {
|
|
2963
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2964
|
-
PENDING = "PENDING",
|
|
2965
|
-
ACTIVE = "ACTIVE",
|
|
2966
|
-
DELETED = "DELETED",
|
|
2967
|
-
BLOCKED = "BLOCKED",
|
|
2968
|
-
OFFLINE = "OFFLINE"
|
|
2969
|
-
}
|
|
2970
|
-
declare enum Reason {
|
|
2971
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2972
|
-
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
2973
|
-
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
2974
|
-
}
|
|
2975
|
-
interface Factor {
|
|
2976
|
-
/** Factor ID. */
|
|
2977
|
-
factorId?: string;
|
|
2978
|
-
/** Factor type. */
|
|
2979
|
-
type?: FactorType;
|
|
2980
|
-
/** Factor status. */
|
|
2981
|
-
status?: Status;
|
|
2982
|
-
}
|
|
2983
|
-
declare enum FactorType {
|
|
2984
|
-
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
2985
|
-
PASSWORD = "PASSWORD",
|
|
2986
|
-
SMS = "SMS",
|
|
2987
|
-
CALL = "CALL",
|
|
2988
|
-
EMAIL = "EMAIL",
|
|
2989
|
-
TOTP = "TOTP",
|
|
2990
|
-
PUSH = "PUSH"
|
|
2991
|
-
}
|
|
2992
|
-
declare enum Status {
|
|
2993
|
-
/** Factor requires activation. */
|
|
2994
|
-
INACTIVE = "INACTIVE",
|
|
2995
|
-
/** Factor is active and can be used for authentication. */
|
|
2996
|
-
ACTIVE = "ACTIVE",
|
|
2997
|
-
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
2998
|
-
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
2999
|
-
}
|
|
3000
|
-
interface CustomValue extends CustomValueValueOneOf {
|
|
3001
|
-
/** String value. */
|
|
3002
|
-
strValue?: string;
|
|
3003
|
-
/** Number value. */
|
|
3004
|
-
numValue?: number;
|
|
3005
|
-
/** Date value. */
|
|
3006
|
-
dateValue?: Date | null;
|
|
3007
|
-
/** List value. */
|
|
3008
|
-
listValue?: ListValue;
|
|
3009
|
-
/** Map value. */
|
|
3010
|
-
mapValue?: MapValue;
|
|
3011
|
-
}
|
|
3012
|
-
/** @oneof */
|
|
3013
|
-
interface CustomValueValueOneOf {
|
|
3014
|
-
/** String value. */
|
|
3015
|
-
strValue?: string;
|
|
3016
|
-
/** Number value. */
|
|
3017
|
-
numValue?: number;
|
|
3018
|
-
/** Date value. */
|
|
3019
|
-
dateValue?: Date | null;
|
|
3020
|
-
/** List value. */
|
|
3021
|
-
listValue?: ListValue;
|
|
3022
|
-
/** Map value. */
|
|
3023
|
-
mapValue?: MapValue;
|
|
3024
|
-
}
|
|
3025
|
-
interface ListValue {
|
|
3026
|
-
/** Custom value. */
|
|
3027
|
-
value?: CustomValue[];
|
|
3028
|
-
}
|
|
3029
|
-
interface MapValue {
|
|
3030
|
-
/** Mapped custom value. */
|
|
3031
|
-
value?: Record<string, CustomValue>;
|
|
3032
|
-
}
|
|
3033
|
-
interface RequireMfaData {
|
|
3034
|
-
availableFactors?: V1Factor[];
|
|
3035
|
-
}
|
|
3036
|
-
interface V1Factor {
|
|
3037
|
-
factorType?: FactorType;
|
|
3038
|
-
}
|
|
3039
|
-
interface MfaChallengeData {
|
|
3040
|
-
factorType?: FactorType;
|
|
3041
|
-
verificationChallengeData?: VerificationChallenge;
|
|
3042
|
-
availableFactors?: V1Factor[];
|
|
3043
|
-
}
|
|
3044
|
-
interface VerificationChallenge {
|
|
3045
|
-
hint?: string | null;
|
|
3046
|
-
}
|
|
3047
|
-
interface ResendDuringAuthenticationRequest {
|
|
3048
|
-
/** A state token representing the `REQUIRE_EMAIL_VERIFICATION` state. */
|
|
3049
|
-
stateToken: string;
|
|
3050
|
-
}
|
|
3051
|
-
interface StartResponseNonNullableFields {
|
|
3052
|
-
verificationId: string;
|
|
3053
|
-
}
|
|
3054
|
-
interface V1FactorNonNullableFields {
|
|
3055
|
-
factorType: FactorType;
|
|
3056
|
-
}
|
|
3057
|
-
interface RequireMfaDataNonNullableFields {
|
|
3058
|
-
availableFactors: V1FactorNonNullableFields[];
|
|
3059
|
-
}
|
|
3060
|
-
interface MfaChallengeDataNonNullableFields {
|
|
3061
|
-
factorType: FactorType;
|
|
3062
|
-
availableFactors: V1FactorNonNullableFields[];
|
|
3063
|
-
}
|
|
3064
|
-
interface IdpConnectionNonNullableFields {
|
|
3065
|
-
idpConnectionId: string;
|
|
3066
|
-
idpUserId: string;
|
|
3067
|
-
}
|
|
3068
|
-
interface AuthenticatorConnectionNonNullableFields {
|
|
3069
|
-
authenticatorConnectionId: string;
|
|
3070
|
-
reEnrollmentRequired: boolean;
|
|
3071
|
-
}
|
|
3072
|
-
interface ConnectionNonNullableFields {
|
|
3073
|
-
idpConnection?: IdpConnectionNonNullableFields;
|
|
3074
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields;
|
|
3075
|
-
}
|
|
3076
|
-
interface V1ListValueNonNullableFields {
|
|
3077
|
-
value: V1CustomValueNonNullableFields[];
|
|
3078
|
-
}
|
|
3079
|
-
interface V1CustomValueNonNullableFields {
|
|
3080
|
-
strValue: string;
|
|
3081
|
-
numValue: number;
|
|
3082
|
-
listValue?: V1ListValueNonNullableFields;
|
|
3083
|
-
}
|
|
3084
|
-
interface CustomFieldNonNullableFields {
|
|
3085
|
-
name: string;
|
|
3086
|
-
value?: V1CustomValueNonNullableFields;
|
|
3087
|
-
}
|
|
3088
|
-
interface SecondaryEmailNonNullableFields {
|
|
3089
|
-
email: string;
|
|
3090
|
-
tag: EmailTag;
|
|
3091
|
-
}
|
|
3092
|
-
interface PhoneNonNullableFields {
|
|
3093
|
-
phone: string;
|
|
3094
|
-
tag: PhoneTag;
|
|
3095
|
-
}
|
|
3096
|
-
interface AddressWrapperNonNullableFields {
|
|
3097
|
-
tag: AddressTag;
|
|
3098
|
-
}
|
|
3099
|
-
interface IdentityProfileNonNullableFields {
|
|
3100
|
-
emails: string[];
|
|
3101
|
-
phones: string[];
|
|
3102
|
-
labels: string[];
|
|
3103
|
-
privacyStatus: PrivacyStatus;
|
|
3104
|
-
customFields: CustomFieldNonNullableFields[];
|
|
3105
|
-
secondaryEmails: SecondaryEmailNonNullableFields[];
|
|
3106
|
-
phonesV2: PhoneNonNullableFields[];
|
|
3107
|
-
addresses: AddressWrapperNonNullableFields[];
|
|
3108
|
-
}
|
|
3109
|
-
interface MetadataNonNullableFields {
|
|
3110
|
-
tags: string[];
|
|
3111
|
-
}
|
|
3112
|
-
interface EmailNonNullableFields {
|
|
3113
|
-
address: string;
|
|
3114
|
-
isVerified: boolean;
|
|
3115
|
-
}
|
|
3116
|
-
interface StatusV2NonNullableFields {
|
|
3117
|
-
name: StatusName;
|
|
3118
|
-
reasons: Reason[];
|
|
3119
|
-
}
|
|
3120
|
-
interface FactorNonNullableFields {
|
|
3121
|
-
factorId: string;
|
|
3122
|
-
type: FactorType;
|
|
3123
|
-
status: Status;
|
|
3124
|
-
}
|
|
3125
|
-
interface IdentityNonNullableFields {
|
|
3126
|
-
connections: ConnectionNonNullableFields[];
|
|
3127
|
-
identityProfile?: IdentityProfileNonNullableFields;
|
|
3128
|
-
metadata?: MetadataNonNullableFields;
|
|
3129
|
-
email?: EmailNonNullableFields;
|
|
3130
|
-
status?: StatusV2NonNullableFields;
|
|
3131
|
-
factors: FactorNonNullableFields[];
|
|
3132
|
-
}
|
|
3133
|
-
interface StateMachineResponseNonNullableFields {
|
|
3134
|
-
requireMfaData?: RequireMfaDataNonNullableFields;
|
|
3135
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields;
|
|
3136
|
-
state: StateType;
|
|
3137
|
-
identity?: IdentityNonNullableFields;
|
|
3138
|
-
}
|
|
3139
|
-
|
|
3140
|
-
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3141
|
-
getUrl: (context: any) => string;
|
|
3142
|
-
httpMethod: K;
|
|
3143
|
-
path: string;
|
|
3144
|
-
pathParams: M;
|
|
3145
|
-
__requestType: T;
|
|
3146
|
-
__originalRequestType: S;
|
|
3147
|
-
__responseType: Q;
|
|
3148
|
-
__originalResponseType: R;
|
|
3149
|
-
};
|
|
3150
|
-
declare function start(): __PublicMethodMetaInfo$1<'POST', {}, StartRequest, StartRequest$1, StartResponse & StartResponseNonNullableFields, StartResponse$1 & StartResponseNonNullableFields$1>;
|
|
3151
|
-
declare function verifyDuringAuthentication(): __PublicMethodMetaInfo$1<'POST', {}, VerifyDuringAuthenticationRequest, VerifyDuringAuthenticationRequest$1, StateMachineResponse & StateMachineResponseNonNullableFields, StateMachineResponse$1 & StateMachineResponseNonNullableFields$1>;
|
|
3152
|
-
declare function resendDuringAuthentication(): __PublicMethodMetaInfo$1<'POST', {}, ResendDuringAuthenticationRequest, ResendDuringAuthenticationRequest$1, StateMachineResponse & StateMachineResponseNonNullableFields, StateMachineResponse$1 & StateMachineResponseNonNullableFields$1>;
|
|
3153
|
-
|
|
3154
|
-
declare const meta$1_resendDuringAuthentication: typeof resendDuringAuthentication;
|
|
3155
|
-
declare const meta$1_start: typeof start;
|
|
3156
|
-
declare const meta$1_verifyDuringAuthentication: typeof verifyDuringAuthentication;
|
|
3157
|
-
declare namespace meta$1 {
|
|
3158
|
-
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_resendDuringAuthentication as resendDuringAuthentication, meta$1_start as start, meta$1_verifyDuringAuthentication as verifyDuringAuthentication };
|
|
3159
|
-
}
|
|
3160
|
-
|
|
3161
|
-
interface RawHttpResponse$1 {
|
|
3162
|
-
body?: Uint8Array;
|
|
3163
|
-
statusCode?: number | null;
|
|
3164
|
-
headers?: HeadersEntry$1[];
|
|
3165
|
-
}
|
|
3166
|
-
interface HeadersEntry$1 {
|
|
3167
|
-
key?: string;
|
|
3168
|
-
value?: string;
|
|
3169
|
-
}
|
|
3170
|
-
interface RawHttpRequest$1 {
|
|
3171
|
-
body?: Uint8Array;
|
|
3172
|
-
pathParams?: PathParametersEntry$1[];
|
|
3173
|
-
queryParams?: QueryParametersEntry$1[];
|
|
3174
|
-
headers?: HeadersEntry$1[];
|
|
3175
|
-
method?: string;
|
|
3176
|
-
rawPath?: string;
|
|
3177
|
-
rawQuery?: string;
|
|
3178
|
-
}
|
|
3179
|
-
interface PathParametersEntry$1 {
|
|
3180
|
-
key?: string;
|
|
3181
|
-
value?: string;
|
|
3182
|
-
}
|
|
3183
|
-
interface QueryParametersEntry$1 {
|
|
3184
|
-
key?: string;
|
|
3185
|
-
value?: string;
|
|
3186
|
-
}
|
|
3187
|
-
interface TokenInfoResponse$1 {
|
|
3188
|
-
active?: boolean;
|
|
3189
|
-
/** subject type. */
|
|
3190
|
-
subjectType?: SubjectType$1;
|
|
3191
|
-
/** subject id */
|
|
3192
|
-
subjectId?: string;
|
|
3193
|
-
/** Expiration time of the token */
|
|
3194
|
-
exp?: string | null;
|
|
3195
|
-
/** Issued time of the token */
|
|
3196
|
-
iat?: string | null;
|
|
3197
|
-
/** Client id */
|
|
3198
|
-
clientId?: string;
|
|
3199
|
-
/** Account id */
|
|
3200
|
-
accountId?: string | null;
|
|
3201
|
-
/** Site id */
|
|
3202
|
-
siteId?: string | null;
|
|
3203
|
-
/** Instance Id */
|
|
3204
|
-
instanceId?: string | null;
|
|
3205
|
-
/** Vendor Product Id */
|
|
3206
|
-
vendorProductId?: string | null;
|
|
3207
|
-
}
|
|
3208
|
-
declare enum SubjectType$1 {
|
|
3209
|
-
/** unknown subject type */
|
|
3210
|
-
UNKNOWN = "UNKNOWN",
|
|
3211
|
-
/** user subject type */
|
|
3212
|
-
USER = "USER",
|
|
3213
|
-
/** visitor subject type */
|
|
3214
|
-
VISITOR = "VISITOR",
|
|
3215
|
-
/** member subject type */
|
|
3216
|
-
MEMBER = "MEMBER",
|
|
3217
|
-
/** app subject type */
|
|
3218
|
-
APP = "APP"
|
|
3219
|
-
}
|
|
3220
|
-
interface HeadersEntryNonNullableFields$1 {
|
|
3221
|
-
key: string;
|
|
3222
|
-
value: string;
|
|
3223
|
-
}
|
|
3224
|
-
interface RawHttpResponseNonNullableFields$1 {
|
|
3225
|
-
body: Uint8Array;
|
|
3226
|
-
headers: HeadersEntryNonNullableFields$1[];
|
|
3227
|
-
}
|
|
3228
|
-
interface TokenInfoResponseNonNullableFields$1 {
|
|
3229
|
-
active: boolean;
|
|
3230
|
-
subjectType: SubjectType$1;
|
|
3231
|
-
subjectId: string;
|
|
3232
|
-
clientId: string;
|
|
3233
|
-
}
|
|
3234
|
-
|
|
3235
|
-
interface RawHttpResponse {
|
|
3236
|
-
body?: Uint8Array;
|
|
3237
|
-
statusCode?: number | null;
|
|
3238
|
-
headers?: HeadersEntry[];
|
|
3239
|
-
}
|
|
3240
|
-
interface HeadersEntry {
|
|
3241
|
-
key?: string;
|
|
3242
|
-
value?: string;
|
|
3243
|
-
}
|
|
3244
|
-
interface RawHttpRequest {
|
|
3245
|
-
body?: Uint8Array;
|
|
3246
|
-
pathParams?: PathParametersEntry[];
|
|
3247
|
-
queryParams?: QueryParametersEntry[];
|
|
3248
|
-
headers?: HeadersEntry[];
|
|
3249
|
-
method?: string;
|
|
3250
|
-
rawPath?: string;
|
|
3251
|
-
rawQuery?: string;
|
|
3252
|
-
}
|
|
3253
|
-
interface PathParametersEntry {
|
|
3254
|
-
key?: string;
|
|
3255
|
-
value?: string;
|
|
3256
|
-
}
|
|
3257
|
-
interface QueryParametersEntry {
|
|
3258
|
-
key?: string;
|
|
3259
|
-
value?: string;
|
|
3260
|
-
}
|
|
3261
|
-
interface TokenInfoResponse {
|
|
3262
|
-
active?: boolean;
|
|
3263
|
-
/** subject type. */
|
|
3264
|
-
subjectType?: SubjectType;
|
|
3265
|
-
/** subject id */
|
|
3266
|
-
subjectId?: string;
|
|
3267
|
-
/** Expiration time of the token */
|
|
3268
|
-
exp?: string | null;
|
|
3269
|
-
/** Issued time of the token */
|
|
3270
|
-
iat?: string | null;
|
|
3271
|
-
/** Client id */
|
|
3272
|
-
clientId?: string;
|
|
3273
|
-
/** Account id */
|
|
3274
|
-
accountId?: string | null;
|
|
3275
|
-
/** Site id */
|
|
3276
|
-
siteId?: string | null;
|
|
3277
|
-
/** Instance Id */
|
|
3278
|
-
instanceId?: string | null;
|
|
3279
|
-
/** Vendor Product Id */
|
|
3280
|
-
vendorProductId?: string | null;
|
|
3281
|
-
}
|
|
3282
|
-
declare enum SubjectType {
|
|
3283
|
-
/** unknown subject type */
|
|
3284
|
-
UNKNOWN = "UNKNOWN",
|
|
3285
|
-
/** user subject type */
|
|
3286
|
-
USER = "USER",
|
|
3287
|
-
/** visitor subject type */
|
|
3288
|
-
VISITOR = "VISITOR",
|
|
3289
|
-
/** member subject type */
|
|
3290
|
-
MEMBER = "MEMBER",
|
|
3291
|
-
/** app subject type */
|
|
3292
|
-
APP = "APP"
|
|
3293
|
-
}
|
|
3294
|
-
interface HeadersEntryNonNullableFields {
|
|
3295
|
-
key: string;
|
|
3296
|
-
value: string;
|
|
3297
|
-
}
|
|
3298
|
-
interface RawHttpResponseNonNullableFields {
|
|
3299
|
-
body: Uint8Array;
|
|
3300
|
-
headers: HeadersEntryNonNullableFields[];
|
|
3301
|
-
}
|
|
3302
|
-
interface TokenInfoResponseNonNullableFields {
|
|
3303
|
-
active: boolean;
|
|
3304
|
-
subjectType: SubjectType;
|
|
3305
|
-
subjectId: string;
|
|
3306
|
-
clientId: string;
|
|
3307
|
-
}
|
|
3308
|
-
|
|
3309
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3310
|
-
getUrl: (context: any) => string;
|
|
3311
|
-
httpMethod: K;
|
|
3312
|
-
path: string;
|
|
3313
|
-
pathParams: M;
|
|
3314
|
-
__requestType: T;
|
|
3315
|
-
__originalRequestType: S;
|
|
3316
|
-
__responseType: Q;
|
|
3317
|
-
__originalResponseType: R;
|
|
3318
|
-
};
|
|
3319
|
-
declare function token(): __PublicMethodMetaInfo<'POST', {}, RawHttpRequest, RawHttpRequest$1, RawHttpResponse & RawHttpResponseNonNullableFields, RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
|
|
3320
|
-
declare function tokenInfo(): __PublicMethodMetaInfo<'POST', {}, RawHttpRequest, RawHttpRequest$1, TokenInfoResponse & TokenInfoResponseNonNullableFields, TokenInfoResponse$1 & TokenInfoResponseNonNullableFields$1>;
|
|
3321
|
-
|
|
3322
|
-
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
3323
|
-
declare const meta_token: typeof token;
|
|
3324
|
-
declare const meta_tokenInfo: typeof tokenInfo;
|
|
3325
|
-
declare namespace meta {
|
|
3326
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_token as token, meta_tokenInfo as tokenInfo };
|
|
3327
|
-
}
|
|
3328
|
-
|
|
3329
|
-
export { meta$3 as authentication, meta as oauth, meta$2 as recovery, meta$1 as verification };
|