@wix/members 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +2 -1
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +3 -0
  5. package/build/cjs/index.typings.js +26 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/src/badges-v3-badge.universal.d.ts +21 -12
  8. package/build/cjs/src/badges-v3-badge.universal.js +21 -12
  9. package/build/cjs/src/badges-v3-badge.universal.js.map +1 -1
  10. package/build/cjs/src/identity-members-v1-member.http.d.ts +10 -0
  11. package/build/cjs/src/identity-members-v1-member.http.js +221 -0
  12. package/build/cjs/src/identity-members-v1-member.http.js.map +1 -0
  13. package/build/cjs/src/identity-members-v1-member.public.d.ts +8 -0
  14. package/build/cjs/src/identity-members-v1-member.public.js +19 -0
  15. package/build/cjs/src/identity-members-v1-member.public.js.map +1 -0
  16. package/build/cjs/src/identity-members-v1-member.types.d.ts +655 -0
  17. package/build/cjs/src/identity-members-v1-member.types.js +48 -0
  18. package/build/cjs/src/identity-members-v1-member.types.js.map +1 -0
  19. package/build/cjs/src/identity-members-v1-member.universal.d.ts +682 -0
  20. package/build/cjs/src/identity-members-v1-member.universal.js +158 -0
  21. package/build/cjs/src/identity-members-v1-member.universal.js.map +1 -0
  22. package/build/cjs/src/members-v1-member.public.d.ts +1 -1
  23. package/build/cjs/src/members-v1-member.types.d.ts +35 -11
  24. package/build/cjs/src/members-v1-member.types.js.map +1 -1
  25. package/build/cjs/src/members-v1-member.universal.d.ts +64 -17
  26. package/build/cjs/src/members-v1-member.universal.js +22 -0
  27. package/build/cjs/src/members-v1-member.universal.js.map +1 -1
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +1 -0
  30. package/build/es/index.js.map +1 -1
  31. package/build/es/index.typings.d.ts +3 -0
  32. package/build/es/index.typings.js +4 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/src/badges-v3-badge.universal.d.ts +21 -12
  35. package/build/es/src/badges-v3-badge.universal.js +21 -12
  36. package/build/es/src/badges-v3-badge.universal.js.map +1 -1
  37. package/build/es/src/identity-members-v1-member.http.d.ts +10 -0
  38. package/build/es/src/identity-members-v1-member.http.js +217 -0
  39. package/build/es/src/identity-members-v1-member.http.js.map +1 -0
  40. package/build/es/src/identity-members-v1-member.public.d.ts +8 -0
  41. package/build/es/src/identity-members-v1-member.public.js +9 -0
  42. package/build/es/src/identity-members-v1-member.public.js.map +1 -0
  43. package/build/es/src/identity-members-v1-member.types.d.ts +655 -0
  44. package/build/es/src/identity-members-v1-member.types.js +45 -0
  45. package/build/es/src/identity-members-v1-member.types.js.map +1 -0
  46. package/build/es/src/identity-members-v1-member.universal.d.ts +682 -0
  47. package/build/es/src/identity-members-v1-member.universal.js +135 -0
  48. package/build/es/src/identity-members-v1-member.universal.js.map +1 -0
  49. package/build/es/src/members-v1-member.public.d.ts +1 -1
  50. package/build/es/src/members-v1-member.types.d.ts +35 -11
  51. package/build/es/src/members-v1-member.types.js.map +1 -1
  52. package/build/es/src/members-v1-member.universal.d.ts +64 -17
  53. package/build/es/src/members-v1-member.universal.js +22 -0
  54. package/build/es/src/members-v1-member.universal.js.map +1 -1
  55. package/package.json +2 -2
@@ -0,0 +1,655 @@
1
+ export interface Member {
2
+ /**
3
+ * member's id
4
+ * @readonly
5
+ */
6
+ id?: string;
7
+ /**
8
+ * `true` if member completed email verification, otherwise `false`
9
+ * @readonly
10
+ */
11
+ emailVerified?: boolean;
12
+ /**
13
+ * member's role:
14
+ *
15
+ * `OWNER` - member that belongs to site owner
16
+ * `CONTRIBUTOR` - member that belongs to a contributor in site
17
+ * `MEMBER` - other members that registered to site
18
+ */
19
+ role?: Role;
20
+ /** email to be used when logging in */
21
+ loginEmail?: string | null;
22
+ /** member's full name */
23
+ memberName?: string | null;
24
+ /** member's first name */
25
+ firstName?: string | null;
26
+ /** member's last name */
27
+ lastName?: string | null;
28
+ /**
29
+ * Deprecated: please use `picture` field instead.
30
+ * URL for member's profile image
31
+ */
32
+ imageUrl?: string | null;
33
+ /** member's nickname (exposed to other members) */
34
+ nickname?: string | null;
35
+ /** `PUBLIC` if other members can view this profile, `PRIVATE` otherwise */
36
+ profilePrivacyStatus?: SiteMemberPrivacyStatus;
37
+ /** url segment for accessing the member's profile */
38
+ slug?: string | null;
39
+ /** member's language */
40
+ language?: string | null;
41
+ /**
42
+ * member's status:
43
+ *
44
+ * `ACTIVE` - when member is approved
45
+ * `APPLICANT` - when pending site owner's approval
46
+ * `BLOCKED` - when member is blocked by the site's owner
47
+ * `INACTIVE` - not used
48
+ */
49
+ status?: SiteMemberStatus;
50
+ /**
51
+ * date the member was created
52
+ * @readonly
53
+ */
54
+ creationDate?: Date;
55
+ /**
56
+ * date the member was last updated
57
+ * @readonly
58
+ */
59
+ lastUpdateDate?: Date;
60
+ /**
61
+ * date of last login
62
+ * @readonly
63
+ */
64
+ lastLoginDate?: Date;
65
+ /**
66
+ * member's email addresses
67
+ * (returned when `include_contact_details` is set to `true`)
68
+ */
69
+ emails?: string[];
70
+ /**
71
+ * member's phone numbers
72
+ * (returned when `include_contact_details` is set to `true`)
73
+ */
74
+ phones?: string[];
75
+ /**
76
+ * member's addresses
77
+ * (returned when `include_contact_details` is set to `true`)
78
+ */
79
+ addresses?: Address[];
80
+ /**
81
+ * labels attached to the member by the owner (in contacts dashboard)
82
+ * (returned when `include_contact_details` is set to `true`)
83
+ */
84
+ labels?: string[];
85
+ /**
86
+ * custom fields set for the member by the owner (in contacts dashboard)
87
+ * (returned when `include_contact_details` is set to `true`)
88
+ */
89
+ customFields?: CustomField[];
90
+ /**
91
+ * member's profile picture
92
+ * supports both media-items and external urls
93
+ */
94
+ picture?: Image;
95
+ /** member's user id */
96
+ userId?: string | null;
97
+ /** Groups the the member is registered to */
98
+ groups?: Group[];
99
+ /**
100
+ * member's contact id
101
+ * @readonly
102
+ */
103
+ contactId?: string | null;
104
+ }
105
+ export declare enum Role {
106
+ UNDEFINED_ROLE = "UNDEFINED_ROLE",
107
+ MEMBER = "MEMBER",
108
+ OWNER = "OWNER",
109
+ CONTRIBUTOR = "CONTRIBUTOR"
110
+ }
111
+ export declare enum SiteMemberPrivacyStatus {
112
+ UNDEFINED = "UNDEFINED",
113
+ PUBLIC = "PUBLIC",
114
+ PRIVATE = "PRIVATE",
115
+ COMMUNITY = "COMMUNITY"
116
+ }
117
+ export declare enum SiteMemberStatus {
118
+ UNDEFINED_STATUS = "UNDEFINED_STATUS",
119
+ APPLICANT = "APPLICANT",
120
+ ACTIVE = "ACTIVE",
121
+ INACTIVE = "INACTIVE",
122
+ BLOCKED = "BLOCKED",
123
+ OFFLINE_ONLY = "OFFLINE_ONLY"
124
+ }
125
+ export interface Address {
126
+ /** member's street address */
127
+ street?: string | null;
128
+ /** member's city */
129
+ city?: string | null;
130
+ /** member's region */
131
+ region?: string | null;
132
+ /** member's country */
133
+ country?: string | null;
134
+ /** member's postal code */
135
+ postalCode?: string | null;
136
+ }
137
+ export interface CustomField extends CustomFieldValueOneOf {
138
+ strValue?: string | null;
139
+ numValue?: number;
140
+ dateValue?: Date;
141
+ name?: string;
142
+ }
143
+ /** @oneof */
144
+ export interface CustomFieldValueOneOf {
145
+ strValue?: string | null;
146
+ numValue?: number;
147
+ dateValue?: Date;
148
+ }
149
+ export interface Image {
150
+ /** WixMedia image ID. */
151
+ id?: string;
152
+ /** Image URL. */
153
+ url?: string;
154
+ /**
155
+ * Original image height.
156
+ * @readonly
157
+ */
158
+ height?: number;
159
+ /**
160
+ * Original image width.
161
+ * @readonly
162
+ */
163
+ width?: number;
164
+ /** Image alt text. */
165
+ altText?: string | null;
166
+ /**
167
+ * Image filename.
168
+ * @readonly
169
+ */
170
+ filename?: string | null;
171
+ }
172
+ export interface Group {
173
+ id?: string;
174
+ name?: string;
175
+ type?: string;
176
+ }
177
+ export interface ListMembersRequest {
178
+ /** for paging - maximum number of records to retrieve */
179
+ limit?: number;
180
+ /** for paging - how many records to skip */
181
+ offset?: number;
182
+ /** sort order - list of field and direction tuples. e.g. `["first_name:asc", "last_name:desc"]` */
183
+ order?: string[];
184
+ /** partial response request - list of field names to get back in response */
185
+ fields?: string[];
186
+ /** filter members with specific status */
187
+ status?: SiteMemberStatus;
188
+ /** whether to include contact details */
189
+ includeContactDetails?: boolean;
190
+ }
191
+ export interface ListMembersResponse {
192
+ /** members returned by List request */
193
+ members?: Member[];
194
+ /** pagination information */
195
+ pagination?: PaginationResponse;
196
+ }
197
+ export interface PaginationResponse {
198
+ /** offset that was applied to the request */
199
+ offset?: number;
200
+ /** limit that was applied to the request */
201
+ limit?: number;
202
+ /** total rows available */
203
+ total?: number;
204
+ /** indication that the total count was too expensive to calculate */
205
+ tooManyToCount?: boolean;
206
+ }
207
+ export interface SearchRequest {
208
+ /** paging - offset and limit */
209
+ paging?: Paging;
210
+ /** search by field */
211
+ searchBy?: SearchBy;
212
+ /** partial response request - list of field names to get back in response */
213
+ fields?: string[];
214
+ /** filters */
215
+ filterBy?: FilterBy;
216
+ /** ASC or DESC order */
217
+ sort?: Sorting;
218
+ }
219
+ export interface Paging {
220
+ /** Number of items to load. */
221
+ limit?: number | null;
222
+ /** Number of items to skip in the current sort order. */
223
+ offset?: number | null;
224
+ }
225
+ export interface SearchBy {
226
+ /** nick name filter */
227
+ nickname?: string | null;
228
+ }
229
+ export interface FilterBy {
230
+ /** filter members with specific status */
231
+ status?: string | null;
232
+ /** group Id filter */
233
+ groupId?: string | null;
234
+ /** privacy status filter */
235
+ privacyStatus?: SiteMemberPrivacyStatus;
236
+ /** roles filter */
237
+ roles?: Role[];
238
+ }
239
+ export declare enum Sorting {
240
+ DESC = "DESC",
241
+ ASC = "ASC"
242
+ }
243
+ export interface SearchResponse {
244
+ /** members returned by List request */
245
+ members?: Member[];
246
+ /** pagination information */
247
+ pagination?: PaginationResponse;
248
+ }
249
+ export interface GetCurrentMemberRequest {
250
+ }
251
+ export interface GetMemberResponse {
252
+ member?: Member;
253
+ }
254
+ export interface GetMemberRequest {
255
+ /** unique identifier of the requested member(required) */
256
+ id?: string;
257
+ /** whether to include contact details */
258
+ includeContactDetails?: boolean;
259
+ /** whether to include groups details */
260
+ includeGroupsDetails?: boolean;
261
+ }
262
+ export interface GetUserMembershipsRequest {
263
+ /** unique identifier of the requested **Wix** user */
264
+ userId?: string;
265
+ /** paging - offset and limit ( the max limit for page is 200) */
266
+ paging?: Paging;
267
+ }
268
+ export interface GetUserMembershipsResponse {
269
+ /** sequence of member's of the user with there metaSiteId */
270
+ userMemberships?: UserMembership[];
271
+ }
272
+ export interface UserMembership {
273
+ /** member id */
274
+ memberId?: string;
275
+ /** meta site id whom the member existing on */
276
+ metasiteId?: string;
277
+ }
278
+ export interface GetMemberRoleRequest {
279
+ id?: string;
280
+ }
281
+ export interface GetMemberRoleResponse {
282
+ /**
283
+ * member's role:
284
+ *
285
+ * `OWNER` - member that belongs to site owner
286
+ * `CONTRIBUTOR` - member that belongs to a contributor in site
287
+ * `MEMBER` - other members that registered to site
288
+ */
289
+ role?: Role;
290
+ userId?: string | null;
291
+ status?: SiteMemberStatus;
292
+ contactId?: string | null;
293
+ }
294
+ export interface GetMemberRolesRequest {
295
+ /** user_id and/or contact_id */
296
+ ids?: string[];
297
+ }
298
+ export interface GetMemberRolesResponse {
299
+ idsToRoles?: Record<string, MemberRole>;
300
+ }
301
+ export interface MemberRole {
302
+ /**
303
+ * member's role:
304
+ *
305
+ * `OWNER` - member that belongs to site owner
306
+ * `CONTRIBUTOR` - member that belongs to a contributor in site
307
+ * `MEMBER` - other members that registered to site
308
+ */
309
+ role?: Role;
310
+ userId?: string | null;
311
+ status?: SiteMemberStatus;
312
+ contactId?: string | null;
313
+ }
314
+ export interface BatchGetMembersRequest {
315
+ /** unique identifier of the requested member(required) */
316
+ ids?: string[];
317
+ /** whether to include contact details */
318
+ includeContactDetails?: boolean;
319
+ /** whether to include groups details */
320
+ includeGroupsDetails?: boolean;
321
+ }
322
+ export interface BatchGetMembersResponse {
323
+ /** lest of members details */
324
+ members?: Member[];
325
+ }
326
+ export interface GetAuthorizedPagesRequest {
327
+ id?: string;
328
+ siteId?: string;
329
+ }
330
+ export interface GetAuthorizedPagesResponse {
331
+ authorizedPages?: Record<string, string>;
332
+ }
333
+ export interface UpdateMemberRequest {
334
+ /** member id */
335
+ id?: string;
336
+ /** the Member object containing the fields to update */
337
+ member?: Member;
338
+ /**
339
+ * an explicit declaration of contact fields that should be updated by this request.
340
+ * *Currently only affects contact fields.
341
+ */
342
+ fieldMask?: string[];
343
+ }
344
+ export interface UpdateMemberResponse {
345
+ /** updated member */
346
+ member?: Member;
347
+ }
348
+ export interface ChangeLoginEmailRequest {
349
+ /** unique identifier of the requested member(required) */
350
+ id?: string;
351
+ /** Email to update to */
352
+ newEmail?: string;
353
+ /** Should revoke active sessions straight after changing the member's login email */
354
+ revokeCurrentSessions?: boolean | null;
355
+ }
356
+ export interface ChangeLoginEmailResponse {
357
+ /** Updated member with the new email */
358
+ member?: Member;
359
+ }
360
+ export interface QueryMembersRequest {
361
+ /**
362
+ * query - See https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md
363
+ * supported fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`
364
+ */
365
+ query?: string;
366
+ /** whether to include contact details */
367
+ includeContactDetails?: boolean;
368
+ /** whether to include offline members */
369
+ includeOfflineMembers?: boolean;
370
+ }
371
+ export interface QueryMembersResponse {
372
+ /** members matching the query criteria */
373
+ members?: Member[];
374
+ /** pagination information */
375
+ pagination?: PaginationResponse;
376
+ }
377
+ export interface DeleteMemberRequest {
378
+ /** id of member that should be deleted (required) */
379
+ id?: string;
380
+ /** defines if the request is a bulk action */
381
+ isBulkAction?: boolean;
382
+ }
383
+ export interface DeleteMemberResponse {
384
+ }
385
+ export interface ApproveMemberRequest extends ApproveMemberRequestMemberIdentifierOneOf {
386
+ /** ID of the member to approve. */
387
+ id?: string;
388
+ /** Login email address of the member to approve. */
389
+ email?: string;
390
+ /**
391
+ * <!--ONLY:VELO
392
+ * Approval token returned by `register()`.
393
+ * <!--END:ONLY:VELO-->
394
+ */
395
+ token?: string;
396
+ }
397
+ /** @oneof */
398
+ export interface ApproveMemberRequestMemberIdentifierOneOf {
399
+ /** ID of the member to approve. */
400
+ id?: string;
401
+ /** Login email address of the member to approve. */
402
+ email?: string;
403
+ /**
404
+ * <!--ONLY:VELO
405
+ * Approval token returned by `register()`.
406
+ * <!--END:ONLY:VELO-->
407
+ */
408
+ token?: string;
409
+ }
410
+ export interface ApproveMemberResponse {
411
+ session?: Session;
412
+ }
413
+ export interface Session {
414
+ token?: string | null;
415
+ }
416
+ export interface BlockMemberRequest extends BlockMemberRequestMemberIdentifierOneOf {
417
+ id?: string;
418
+ /** Login email address of the member to block. */
419
+ email?: string;
420
+ /** Indicate the source of the block request */
421
+ source?: Source;
422
+ }
423
+ /** @oneof */
424
+ export interface BlockMemberRequestMemberIdentifierOneOf {
425
+ id?: string;
426
+ /** Login email address of the member to block. */
427
+ email?: string;
428
+ }
429
+ export declare enum Source {
430
+ UNKNOWN = "UNKNOWN",
431
+ HANDLING_SPAM = "HANDLING_SPAM"
432
+ }
433
+ export interface BlockMemberResponse {
434
+ }
435
+ export interface MakeMemberOfflineRequest {
436
+ /** unique identifier of the requested member */
437
+ id?: string;
438
+ }
439
+ export interface MakeMemberOfflineResponse {
440
+ }
441
+ /** Registration options. */
442
+ export interface RegisterRequest {
443
+ /** Login email address for the new site member. */
444
+ email?: string;
445
+ /**
446
+ * Password the new site member will use to log in.
447
+ *
448
+ * Must be 4 to 15 ASCII-printable characters.
449
+ */
450
+ password?: string;
451
+ /** Contact information for the registered member. */
452
+ contactInfo?: MemberContactInfo;
453
+ /** identification of the app that initiated the register request */
454
+ dialogData?: DialogData;
455
+ /**
456
+ * Sets the privacy status of a new member upon registration.
457
+ *
458
+ * - `PUBLIC`: Member is visible to everyone.
459
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
460
+ * - `UNKNOWN`: Insufficient permissions to get the status.
461
+ */
462
+ profilePrivacyStatus?: SiteMemberPrivacyStatus;
463
+ /** is registration offline */
464
+ isOfflineRegistration?: boolean;
465
+ recaptchaToken?: string | null;
466
+ invisibleRecaptchaToken?: string | null;
467
+ emailVerification?: EmailVerification;
468
+ /**
469
+ * an indication that the request needs to follow mobile signup flow
470
+ * difference from the regular flow is the OTP email
471
+ */
472
+ isMobile?: boolean | null;
473
+ }
474
+ export interface MemberContactInfo {
475
+ /** First name. */
476
+ firstName?: string | null;
477
+ /** Last name. */
478
+ lastName?: string | null;
479
+ /** Contact's profile picture. */
480
+ picture?: string | null;
481
+ /** Contact's email addresses. */
482
+ emails?: string[];
483
+ /** Contact's phone numbers. */
484
+ phones?: string[];
485
+ /** List of contact's labels. */
486
+ labels?: string[];
487
+ /**
488
+ * Contact's locale, formatted as an
489
+ * [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).
490
+ * Typically, this is a lowercase 2-letter language code,
491
+ * followed by a hyphen,
492
+ * followed by an uppercase 2-letter country code.
493
+ *
494
+ * For example, German from Germany is formatted as `"de-DE"`,
495
+ * and U.S. English is formatted as `"en-US"`.
496
+ */
497
+ locale?: string | null;
498
+ /**
499
+ * Any number of custom fields.
500
+ * [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
501
+ * are used to store additional information about your site's contacts.
502
+ * When setting a custom field, use key:value pairs,
503
+ * where the key matches the names defined in your site's
504
+ * [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
505
+ * You can only set values for custom fields that already exist in the Contacts application.
506
+ */
507
+ customFields?: CustomField[];
508
+ }
509
+ export interface DialogData {
510
+ visitorId?: string | null;
511
+ appId?: string | null;
512
+ initiator?: string | null;
513
+ }
514
+ export interface EmailVerification {
515
+ /** Id of the verification process */
516
+ verificationId?: string;
517
+ /** 6-digit code to verify (between 100000 and 999999) */
518
+ otp?: string;
519
+ }
520
+ export interface RegisterResponse {
521
+ /** Newly registered member. */
522
+ member?: Member;
523
+ /**
524
+ * in case the site is open for registration, all members are automatically
525
+ * approved. they will get a temporary token for obtaining a valid session
526
+ */
527
+ session?: Session;
528
+ /**
529
+ * in case the site requires members approval, the registered member
530
+ * will be an applicant until he's approved. the token can be used as a member
531
+ * identifier for approval using the `MembersService.Approve` API
532
+ */
533
+ approvalToken?: string | null;
534
+ }
535
+ export interface EmailVerificationRequired {
536
+ /** Id of the verification process. */
537
+ verificationId?: string;
538
+ }
539
+ export interface EmailVerificationFailed {
540
+ /** Id of the failed verification process. */
541
+ verificationId?: string;
542
+ /** Reason for verification failure. */
543
+ verificationFailureReason?: VerificationFailureReason;
544
+ }
545
+ export declare enum VerificationFailureReason {
546
+ /** Default value - means no failure */
547
+ UNSPECIFIED = "UNSPECIFIED",
548
+ /** Bad verification code */
549
+ BAD_CODE = "BAD_CODE",
550
+ /** Verification code was not found */
551
+ NOT_FOUND = "NOT_FOUND",
552
+ /** Error while sending the code to the user */
553
+ SEND_CODE_ERROR = "SEND_CODE_ERROR"
554
+ }
555
+ export interface LoginRequest {
556
+ /** Email address to use when logging the member in. */
557
+ email?: string;
558
+ /** Password to use when logging the member in. */
559
+ password?: string;
560
+ /** recaptcha token */
561
+ recaptchaToken?: string;
562
+ /** invisible recaptcha token */
563
+ invisibleRecaptchaToken?: string;
564
+ emailVerification?: EmailVerification;
565
+ /**
566
+ * an indication that the request needs to follow mobile login flow
567
+ * difference from the regular flow is the OTP email
568
+ */
569
+ isMobile?: boolean | null;
570
+ }
571
+ /** Session token for logging the member in. */
572
+ export interface LoginResponse {
573
+ session?: Session;
574
+ /** the member's details */
575
+ member?: Member;
576
+ }
577
+ export interface GetResetPasswordLinkRequest {
578
+ /** Contact ID of the member whose password will be reset. */
579
+ contactId?: string;
580
+ }
581
+ export interface GetResetPasswordLinkResponse {
582
+ /**
583
+ * Reset password link.
584
+ * Valid for one use, up to two weeks from when it is created.
585
+ */
586
+ resetPasswordLink?: string;
587
+ }
588
+ export interface SendSetPasswordEmailRequest {
589
+ /** Login email of the member whose password will be set. */
590
+ email: string;
591
+ /**
592
+ * > **Deprecated:**
593
+ * > This field has been replaced with
594
+ * > `hideIgnoreMessage`
595
+ * > and will be removed on June 30, 2022.
596
+ * > If your app uses this field,
597
+ * > we recommend updating your code as soon as possible.
598
+ *
599
+ * Whether the email is being sent by member request.
600
+ *
601
+ * If `true`, the email tells the member
602
+ * they can safely ignore
603
+ * if they did not request the password change.
604
+ *
605
+ * Defaults to `false`.
606
+ */
607
+ requestedByMember?: boolean;
608
+ /**
609
+ * Whether to hide the ignore this email message .
610
+ *
611
+ * If `true`, the email tells the member
612
+ * they can safely ignore
613
+ * if they did not request the password change.
614
+ *
615
+ * Defaults to `false`.
616
+ */
617
+ hideIgnoreMessage?: boolean;
618
+ }
619
+ export interface SendSetPasswordEmailResponse {
620
+ /** Indicates if the request was successfully received. */
621
+ accepted?: boolean;
622
+ }
623
+ export interface ResetPasswordRequest {
624
+ /** Contact ID of the member whose password will be reset. */
625
+ contactId?: string;
626
+ }
627
+ export interface ResetPasswordResponse {
628
+ /** Indicates if the request was successfully received. */
629
+ accepted?: boolean;
630
+ }
631
+ export interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
632
+ appleLogin?: AppleLogin;
633
+ googleLogin?: GoogleLogin;
634
+ facebookLogin?: FacebookLogin;
635
+ /** Must either pass explicit msid OR signed instance with visitor */
636
+ metaSiteId?: string | null;
637
+ }
638
+ /** @oneof */
639
+ export interface SocialLoginRequestLoginOneOf {
640
+ appleLogin?: AppleLogin;
641
+ googleLogin?: GoogleLogin;
642
+ facebookLogin?: FacebookLogin;
643
+ }
644
+ export interface AppleLogin {
645
+ /** JWT signed by apple, contains target (aud), email etc */
646
+ token?: string;
647
+ }
648
+ export interface GoogleLogin {
649
+ /** JWT signed by Google, contains target (aud), email etc */
650
+ token?: string;
651
+ }
652
+ export interface FacebookLogin {
653
+ /** AccessToken created by Facebook, used to later fetch details over API */
654
+ token?: string;
655
+ }
@@ -0,0 +1,45 @@
1
+ export var Role;
2
+ (function (Role) {
3
+ Role["UNDEFINED_ROLE"] = "UNDEFINED_ROLE";
4
+ Role["MEMBER"] = "MEMBER";
5
+ Role["OWNER"] = "OWNER";
6
+ Role["CONTRIBUTOR"] = "CONTRIBUTOR";
7
+ })(Role || (Role = {}));
8
+ export var SiteMemberPrivacyStatus;
9
+ (function (SiteMemberPrivacyStatus) {
10
+ SiteMemberPrivacyStatus["UNDEFINED"] = "UNDEFINED";
11
+ SiteMemberPrivacyStatus["PUBLIC"] = "PUBLIC";
12
+ SiteMemberPrivacyStatus["PRIVATE"] = "PRIVATE";
13
+ SiteMemberPrivacyStatus["COMMUNITY"] = "COMMUNITY";
14
+ })(SiteMemberPrivacyStatus || (SiteMemberPrivacyStatus = {}));
15
+ export var SiteMemberStatus;
16
+ (function (SiteMemberStatus) {
17
+ SiteMemberStatus["UNDEFINED_STATUS"] = "UNDEFINED_STATUS";
18
+ SiteMemberStatus["APPLICANT"] = "APPLICANT";
19
+ SiteMemberStatus["ACTIVE"] = "ACTIVE";
20
+ SiteMemberStatus["INACTIVE"] = "INACTIVE";
21
+ SiteMemberStatus["BLOCKED"] = "BLOCKED";
22
+ SiteMemberStatus["OFFLINE_ONLY"] = "OFFLINE_ONLY";
23
+ })(SiteMemberStatus || (SiteMemberStatus = {}));
24
+ export var Sorting;
25
+ (function (Sorting) {
26
+ Sorting["DESC"] = "DESC";
27
+ Sorting["ASC"] = "ASC";
28
+ })(Sorting || (Sorting = {}));
29
+ export var Source;
30
+ (function (Source) {
31
+ Source["UNKNOWN"] = "UNKNOWN";
32
+ Source["HANDLING_SPAM"] = "HANDLING_SPAM";
33
+ })(Source || (Source = {}));
34
+ export var VerificationFailureReason;
35
+ (function (VerificationFailureReason) {
36
+ /** Default value - means no failure */
37
+ VerificationFailureReason["UNSPECIFIED"] = "UNSPECIFIED";
38
+ /** Bad verification code */
39
+ VerificationFailureReason["BAD_CODE"] = "BAD_CODE";
40
+ /** Verification code was not found */
41
+ VerificationFailureReason["NOT_FOUND"] = "NOT_FOUND";
42
+ /** Error while sending the code to the user */
43
+ VerificationFailureReason["SEND_CODE_ERROR"] = "SEND_CODE_ERROR";
44
+ })(VerificationFailureReason || (VerificationFailureReason = {}));
45
+ //# sourceMappingURL=identity-members-v1-member.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"identity-members-v1-member.types.js","sourceRoot":"","sources":["../../../src/identity-members-v1-member.types.ts"],"names":[],"mappings":"AAyGA,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,yCAAiC,CAAA;IACjC,yBAAiB,CAAA;IACjB,uBAAe,CAAA;IACf,mCAA2B,CAAA;AAC7B,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf;AAED,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,4CAAiB,CAAA;IACjB,8CAAmB,CAAA;IACnB,kDAAuB,CAAA;AACzB,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAED,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAqC,CAAA;IACrC,2CAAuB,CAAA;IACvB,qCAAiB,CAAA;IACjB,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,iDAA6B,CAAA;AAC/B,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAgID,MAAM,CAAN,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,wBAAa,CAAA;IACb,sBAAW,CAAA;AACb,CAAC,EAHW,OAAO,KAAP,OAAO,QAGlB;AA0ND,MAAM,CAAN,IAAY,MAGX;AAHD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;AACjC,CAAC,EAHW,MAAM,KAAN,MAAM,QAGjB;AA0HD,MAAM,CAAN,IAAY,yBASX;AATD,WAAY,yBAAyB;IACnC,uCAAuC;IACvC,wDAA2B,CAAA;IAC3B,4BAA4B;IAC5B,kDAAqB,CAAA;IACrB,sCAAsC;IACtC,oDAAuB,CAAA;IACvB,+CAA+C;IAC/C,gEAAmC,CAAA;AACrC,CAAC,EATW,yBAAyB,KAAzB,yBAAyB,QASpC"}