@wix/members 1.0.86 → 1.0.87

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.
@@ -0,0 +1,3096 @@
1
+ interface Badge$1 {
2
+ /**
3
+ * Badge ID.
4
+ * @readonly
5
+ */
6
+ id?: string;
7
+ /** Text displayed on the badge in the Wix UI. */
8
+ title?: string | null;
9
+ /** Badge description. */
10
+ description?: string | null;
11
+ /**
12
+ * Badge background color in hexadecimal RGB format.
13
+ * Uppercase letters only.
14
+ * Example: `#FFFFFF`.
15
+ */
16
+ backgroundColor?: string | null;
17
+ /**
18
+ * Badge text color in hexadecimal RGB format.
19
+ * Uppercase letters only.
20
+ * Example: `#C81B53`.
21
+ */
22
+ textColor?: string | null;
23
+ /**
24
+ * URL of the badge icon image.
25
+ * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.
26
+ */
27
+ icon?: string | null;
28
+ /**
29
+ * Whether the badge has special permissions
30
+ * to access specific members-only pages.
31
+ * When `true`, members with the badge receive special permissions,
32
+ * and site contributors can
33
+ * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)
34
+ * in the Dashboard.
35
+ * When `false`, members with the badge receive no special permissions.
36
+ */
37
+ permissionsEnabled?: boolean | null;
38
+ /**
39
+ * Slugified name. Used to represent the badge in a URL.
40
+ * @readonly
41
+ */
42
+ slug?: string | null;
43
+ /**
44
+ * Date the badge was created.
45
+ * @readonly
46
+ */
47
+ createdDate?: Date;
48
+ /**
49
+ * Date the badge was updated.
50
+ * @readonly
51
+ */
52
+ updatedDate?: Date;
53
+ }
54
+ interface CreateBadgeRequest$1 {
55
+ /** Badge to create. */
56
+ badge: Badge$1;
57
+ }
58
+ interface CreateBadgeResponse$1 {
59
+ /** Created badge. */
60
+ badge?: Badge$1;
61
+ }
62
+ interface UpdateBadgeRequest$1 {
63
+ /** Badge to update. */
64
+ badge: Badge$1;
65
+ }
66
+ interface UpdateBadgeResponse$1 {
67
+ /** Updated badge. */
68
+ badge?: Badge$1;
69
+ }
70
+ interface ListBadgesRequest$1 {
71
+ /**
72
+ * Pagination options. For more information, see
73
+ * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
74
+ */
75
+ paging?: Paging$3;
76
+ }
77
+ interface Paging$3 {
78
+ /** Number of items to load. */
79
+ limit?: number | null;
80
+ /** Number of items to skip in the current sort order. */
81
+ offset?: number | null;
82
+ }
83
+ interface ListBadgesResponse$1 {
84
+ /** List of badges. */
85
+ badges?: Badge$1[];
86
+ /** Metadata for the paginated results. */
87
+ metadata?: PagingMetadata$3;
88
+ }
89
+ interface PagingMetadata$3 {
90
+ /** Number of items returned in the response. */
91
+ count?: number | null;
92
+ /** Offset that was requested. */
93
+ offset?: number | null;
94
+ /** Total number of items that match the query. */
95
+ total?: number | null;
96
+ /** Flag that indicates the server failed to calculate the `total` field. */
97
+ tooManyToCount?: boolean | null;
98
+ }
99
+ interface GetBadgeRequest$1 {
100
+ /** Badge ID. */
101
+ id: string;
102
+ }
103
+ interface GetBadgeResponse$1 {
104
+ /** Badge. */
105
+ badge?: Badge$1;
106
+ }
107
+ interface DeleteBadgeRequest$1 {
108
+ /** Badge ID. */
109
+ id: string;
110
+ }
111
+ interface DeleteBadgeResponse$1 {
112
+ }
113
+ interface AssignBadgeRequest$1 {
114
+ /** Badge ID. */
115
+ id: string;
116
+ /** List of member IDs to assign to the badge. */
117
+ memberIds: string[];
118
+ }
119
+ interface AssignBadgeResponse$1 {
120
+ /** List of member IDs assigned to the badge. */
121
+ memberIds?: string[];
122
+ }
123
+ interface UnassignBadgeRequest$1 {
124
+ /** Badge ID. */
125
+ id: string;
126
+ /** List of members to remove. */
127
+ memberIds: string[];
128
+ }
129
+ interface UnassignBadgeResponse$1 {
130
+ }
131
+ interface ListMembersRequest$3 {
132
+ /** Badge ID. */
133
+ id: string;
134
+ /**
135
+ * Pagination options. For more information, see
136
+ * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
137
+ */
138
+ paging?: Paging$3;
139
+ }
140
+ interface ListMembersResponse$3 {
141
+ /** Member IDs assigned to the badge. */
142
+ memberIds?: string[];
143
+ /** Metadata for the paginated results. */
144
+ metadata?: PagingMetadata$3;
145
+ }
146
+ interface ListMembersBadgeIdsRequest$1 {
147
+ /** List of members. */
148
+ memberIds: string[];
149
+ }
150
+ interface ListMembersBadgeIdsResponse$1 {
151
+ /** List of members and the badges they're assigned to. */
152
+ memberBadgeIds?: MemberBadgeIds$1[];
153
+ }
154
+ interface MemberBadgeIds$1 {
155
+ /** Member ID. */
156
+ memberId?: string;
157
+ /** List of badges the member is assigned to. */
158
+ badgeIds?: string[];
159
+ }
160
+ interface GetMemberCountsPerBadgeRequest$1 {
161
+ }
162
+ interface GetMemberCountsPerBadgeResponse$1 {
163
+ /** List of badges and counts of members who have each badge. */
164
+ badgeMemberCounts?: BadgeMemberCount$1[];
165
+ }
166
+ interface BadgeMemberCount$1 {
167
+ /** Badge ID. */
168
+ badgeId?: string;
169
+ /** Badge member count. */
170
+ memberCount?: number;
171
+ }
172
+ interface UpdateBadgesDisplayOrderRequest$1 {
173
+ /** Ordered badge IDs. */
174
+ badgeIds: string[];
175
+ }
176
+ interface UpdateBadgesDisplayOrderResponse$1 {
177
+ /** Reordered badges list. */
178
+ badges?: Badge$1[];
179
+ }
180
+ interface CreateBadgeResponseNonNullableFields$1 {
181
+ badge?: {
182
+ id: string;
183
+ };
184
+ }
185
+ interface UpdateBadgeResponseNonNullableFields$1 {
186
+ badge?: {
187
+ id: string;
188
+ };
189
+ }
190
+ interface ListBadgesResponseNonNullableFields$1 {
191
+ badges: {
192
+ id: string;
193
+ }[];
194
+ }
195
+ interface GetBadgeResponseNonNullableFields$1 {
196
+ badge?: {
197
+ id: string;
198
+ };
199
+ }
200
+ interface AssignBadgeResponseNonNullableFields$1 {
201
+ memberIds: string[];
202
+ }
203
+ interface ListMembersResponseNonNullableFields$3 {
204
+ memberIds: string[];
205
+ }
206
+ interface ListMembersBadgeIdsResponseNonNullableFields$1 {
207
+ memberBadgeIds: {
208
+ memberId: string;
209
+ badgeIds: string[];
210
+ }[];
211
+ }
212
+ interface GetMemberCountsPerBadgeResponseNonNullableFields$1 {
213
+ badgeMemberCounts: {
214
+ badgeId: string;
215
+ memberCount: number;
216
+ }[];
217
+ }
218
+ interface UpdateBadgesDisplayOrderResponseNonNullableFields$1 {
219
+ badges: {
220
+ id: string;
221
+ }[];
222
+ }
223
+
224
+ interface Badge {
225
+ /**
226
+ * Badge ID.
227
+ * @readonly
228
+ */
229
+ _id?: string;
230
+ /** Text displayed on the badge in the Wix UI. */
231
+ title?: string | null;
232
+ /** Badge description. */
233
+ description?: string | null;
234
+ /**
235
+ * Badge background color in hexadecimal RGB format. Uppercase letters only.
236
+ *
237
+ * Default: `#796EFF ` (purple).
238
+ */
239
+ backgroundColor?: string | null;
240
+ /**
241
+ * Badge text color in hexadecimal RGB format. Uppercase letters only.
242
+ *
243
+ * Default: `"#FFFFFF"` (white).
244
+ */
245
+ textColor?: string | null;
246
+ /**
247
+ * Badge icon as an SVG image. One of:
248
+ *
249
+ * - An external web URL in the following format: `http(s)://<image url>`.
250
+ * - The [source URL](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getfileurl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.
251
+ */
252
+ icon?: string | null;
253
+ /**
254
+ * Whether the badge has special permissions
255
+ * to access specific members-only pages.
256
+ * When `true`, members with the badge receive special permissions,
257
+ * and site contributors can
258
+ * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)
259
+ * in the Dashboard.
260
+ * When `false`, members with the badge receive no special permissions.
261
+ */
262
+ permissionsEnabled?: boolean | null;
263
+ /**
264
+ * Slugified name. Used to represent the badge in a URL.
265
+ * @readonly
266
+ */
267
+ slug?: string | null;
268
+ /**
269
+ * Date the badge was created.
270
+ * @readonly
271
+ */
272
+ _createdDate?: Date;
273
+ /**
274
+ * Date the badge was updated.
275
+ * @readonly
276
+ */
277
+ _updatedDate?: Date;
278
+ }
279
+ interface CreateBadgeRequest {
280
+ /** Badge to create. */
281
+ badge: Badge;
282
+ }
283
+ interface CreateBadgeResponse {
284
+ /** Created badge. */
285
+ badge?: Badge;
286
+ }
287
+ interface UpdateBadgeRequest {
288
+ /** Badge to update. */
289
+ badge: Badge;
290
+ }
291
+ interface UpdateBadgeResponse {
292
+ /** Updated badge. */
293
+ badge?: Badge;
294
+ }
295
+ interface ListBadgesRequest {
296
+ /** Pagination options. */
297
+ paging?: Paging$2;
298
+ }
299
+ interface Paging$2 {
300
+ /** Number of items to load. */
301
+ limit?: number | null;
302
+ /** Number of items to skip in the current sort order. */
303
+ offset?: number | null;
304
+ }
305
+ interface ListBadgesResponse {
306
+ /** List of badges. */
307
+ badges?: Badge[];
308
+ /** Metadata for the paginated results. */
309
+ metadata?: PagingMetadata$2;
310
+ }
311
+ interface PagingMetadata$2 {
312
+ /** Number of items returned in the response. */
313
+ count?: number | null;
314
+ /** Offset that was requested. */
315
+ offset?: number | null;
316
+ /** Total number of items that match the query. */
317
+ total?: number | null;
318
+ /** Flag that indicates the server failed to calculate the `total` field. */
319
+ tooManyToCount?: boolean | null;
320
+ }
321
+ interface GetBadgeRequest {
322
+ /** Badge ID. */
323
+ _id: string;
324
+ }
325
+ interface GetBadgeResponse {
326
+ /** Badge. */
327
+ badge?: Badge;
328
+ }
329
+ interface DeleteBadgeRequest {
330
+ /** Badge ID. */
331
+ _id: string;
332
+ }
333
+ interface DeleteBadgeResponse {
334
+ }
335
+ interface AssignBadgeRequest {
336
+ /** Badge ID. */
337
+ _id: string;
338
+ /** List of member IDs to assign to the badge. */
339
+ memberIds: string[];
340
+ }
341
+ interface AssignBadgeResponse {
342
+ /** List of member IDs assigned to the badge. */
343
+ memberIds?: string[];
344
+ }
345
+ interface UnassignBadgeRequest {
346
+ /** Badge ID. */
347
+ _id: string;
348
+ /** List of members to remove. */
349
+ memberIds: string[];
350
+ }
351
+ interface UnassignBadgeResponse {
352
+ }
353
+ interface ListMembersRequest$2 {
354
+ /** Badge ID. */
355
+ _id: string;
356
+ /** Pagination options. */
357
+ paging?: Paging$2;
358
+ }
359
+ interface ListMembersResponse$2 {
360
+ /** Member IDs assigned to the badge. */
361
+ memberIds?: string[];
362
+ /** Metadata for the paginated results. */
363
+ metadata?: PagingMetadata$2;
364
+ }
365
+ interface ListMembersBadgeIdsRequest {
366
+ /** List of members. */
367
+ memberIds: string[];
368
+ }
369
+ interface ListMembersBadgeIdsResponse {
370
+ /** List of members and the badges they're assigned to. */
371
+ memberBadgeIds?: MemberBadgeIds[];
372
+ }
373
+ interface MemberBadgeIds {
374
+ /** Member ID. */
375
+ memberId?: string;
376
+ /** List of badges the member is assigned to. */
377
+ badgeIds?: string[];
378
+ }
379
+ interface GetMemberCountsPerBadgeRequest {
380
+ }
381
+ interface GetMemberCountsPerBadgeResponse {
382
+ /** List of badges and counts of members who have each badge. */
383
+ badgeMemberCounts?: BadgeMemberCount[];
384
+ }
385
+ interface BadgeMemberCount {
386
+ /** Badge ID. */
387
+ badgeId?: string;
388
+ /** Badge member count. */
389
+ memberCount?: number;
390
+ }
391
+ interface UpdateBadgesDisplayOrderRequest {
392
+ /** Ordered badge IDs. */
393
+ badgeIds: string[];
394
+ }
395
+ interface UpdateBadgesDisplayOrderResponse {
396
+ /** Reordered badges list. */
397
+ badges?: Badge[];
398
+ }
399
+ interface CreateBadgeResponseNonNullableFields {
400
+ badge?: {
401
+ _id: string;
402
+ };
403
+ }
404
+ interface UpdateBadgeResponseNonNullableFields {
405
+ badge?: {
406
+ _id: string;
407
+ };
408
+ }
409
+ interface ListBadgesResponseNonNullableFields {
410
+ badges: {
411
+ _id: string;
412
+ }[];
413
+ }
414
+ interface GetBadgeResponseNonNullableFields {
415
+ badge?: {
416
+ _id: string;
417
+ };
418
+ }
419
+ interface AssignBadgeResponseNonNullableFields {
420
+ memberIds: string[];
421
+ }
422
+ interface ListMembersResponseNonNullableFields$2 {
423
+ memberIds: string[];
424
+ }
425
+ interface ListMembersBadgeIdsResponseNonNullableFields {
426
+ memberBadgeIds: {
427
+ memberId: string;
428
+ badgeIds: string[];
429
+ }[];
430
+ }
431
+ interface GetMemberCountsPerBadgeResponseNonNullableFields {
432
+ badgeMemberCounts: {
433
+ badgeId: string;
434
+ memberCount: number;
435
+ }[];
436
+ }
437
+ interface UpdateBadgesDisplayOrderResponseNonNullableFields {
438
+ badges: {
439
+ _id: string;
440
+ }[];
441
+ }
442
+
443
+ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
444
+ getUrl: (context: any) => string;
445
+ httpMethod: K;
446
+ path: string;
447
+ pathParams: M;
448
+ __requestType: T;
449
+ __originalRequestType: S;
450
+ __responseType: Q;
451
+ __originalResponseType: R;
452
+ };
453
+ declare function createBadge(): __PublicMethodMetaInfo$2<'POST', {}, CreateBadgeRequest, CreateBadgeRequest$1, CreateBadgeResponse & CreateBadgeResponseNonNullableFields, CreateBadgeResponse$1 & CreateBadgeResponseNonNullableFields$1>;
454
+ declare function updateBadge(): __PublicMethodMetaInfo$2<'PATCH', {
455
+ badgeId: string;
456
+ }, UpdateBadgeRequest, UpdateBadgeRequest$1, UpdateBadgeResponse & UpdateBadgeResponseNonNullableFields, UpdateBadgeResponse$1 & UpdateBadgeResponseNonNullableFields$1>;
457
+ declare function listBadges(): __PublicMethodMetaInfo$2<'GET', {}, ListBadgesRequest, ListBadgesRequest$1, ListBadgesResponse & ListBadgesResponseNonNullableFields, ListBadgesResponse$1 & ListBadgesResponseNonNullableFields$1>;
458
+ declare function getBadge(): __PublicMethodMetaInfo$2<'GET', {
459
+ id: string;
460
+ }, GetBadgeRequest, GetBadgeRequest$1, GetBadgeResponse & GetBadgeResponseNonNullableFields, GetBadgeResponse$1 & GetBadgeResponseNonNullableFields$1>;
461
+ declare function deleteBadge(): __PublicMethodMetaInfo$2<'DELETE', {
462
+ id: string;
463
+ }, DeleteBadgeRequest, DeleteBadgeRequest$1, DeleteBadgeResponse, DeleteBadgeResponse$1>;
464
+ declare function assignBadge(): __PublicMethodMetaInfo$2<'POST', {
465
+ id: string;
466
+ }, AssignBadgeRequest, AssignBadgeRequest$1, AssignBadgeResponse & AssignBadgeResponseNonNullableFields, AssignBadgeResponse$1 & AssignBadgeResponseNonNullableFields$1>;
467
+ declare function unassignBadge(): __PublicMethodMetaInfo$2<'DELETE', {
468
+ id: string;
469
+ }, UnassignBadgeRequest, UnassignBadgeRequest$1, UnassignBadgeResponse, UnassignBadgeResponse$1>;
470
+ declare function listMembersByBadge(): __PublicMethodMetaInfo$2<'GET', {
471
+ id: string;
472
+ }, ListMembersRequest$2, ListMembersRequest$3, ListMembersResponse$2 & ListMembersResponseNonNullableFields$2, ListMembersResponse$3 & ListMembersResponseNonNullableFields$3>;
473
+ declare function listBadgesPerMember(): __PublicMethodMetaInfo$2<'POST', {}, ListMembersBadgeIdsRequest, ListMembersBadgeIdsRequest$1, ListMembersBadgeIdsResponse & ListMembersBadgeIdsResponseNonNullableFields, ListMembersBadgeIdsResponse$1 & ListMembersBadgeIdsResponseNonNullableFields$1>;
474
+ declare function getMemberCountsPerBadge(): __PublicMethodMetaInfo$2<'GET', {}, GetMemberCountsPerBadgeRequest, GetMemberCountsPerBadgeRequest$1, GetMemberCountsPerBadgeResponse & GetMemberCountsPerBadgeResponseNonNullableFields, GetMemberCountsPerBadgeResponse$1 & GetMemberCountsPerBadgeResponseNonNullableFields$1>;
475
+ declare function updateBadgesDisplayOrder(): __PublicMethodMetaInfo$2<'PATCH', {}, UpdateBadgesDisplayOrderRequest, UpdateBadgesDisplayOrderRequest$1, UpdateBadgesDisplayOrderResponse & UpdateBadgesDisplayOrderResponseNonNullableFields, UpdateBadgesDisplayOrderResponse$1 & UpdateBadgesDisplayOrderResponseNonNullableFields$1>;
476
+
477
+ declare const meta$2_assignBadge: typeof assignBadge;
478
+ declare const meta$2_createBadge: typeof createBadge;
479
+ declare const meta$2_deleteBadge: typeof deleteBadge;
480
+ declare const meta$2_getBadge: typeof getBadge;
481
+ declare const meta$2_getMemberCountsPerBadge: typeof getMemberCountsPerBadge;
482
+ declare const meta$2_listBadges: typeof listBadges;
483
+ declare const meta$2_listBadgesPerMember: typeof listBadgesPerMember;
484
+ declare const meta$2_listMembersByBadge: typeof listMembersByBadge;
485
+ declare const meta$2_unassignBadge: typeof unassignBadge;
486
+ declare const meta$2_updateBadge: typeof updateBadge;
487
+ declare const meta$2_updateBadgesDisplayOrder: typeof updateBadgesDisplayOrder;
488
+ declare namespace meta$2 {
489
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_assignBadge as assignBadge, meta$2_createBadge as createBadge, meta$2_deleteBadge as deleteBadge, meta$2_getBadge as getBadge, meta$2_getMemberCountsPerBadge as getMemberCountsPerBadge, meta$2_listBadges as listBadges, meta$2_listBadgesPerMember as listBadgesPerMember, meta$2_listMembersByBadge as listMembersByBadge, meta$2_unassignBadge as unassignBadge, meta$2_updateBadge as updateBadge, meta$2_updateBadgesDisplayOrder as updateBadgesDisplayOrder };
490
+ }
491
+
492
+ interface Member$3 {
493
+ /**
494
+ * member's id
495
+ * @readonly
496
+ */
497
+ id?: string;
498
+ /**
499
+ * `true` if member completed email verification, otherwise `false`
500
+ * @readonly
501
+ */
502
+ emailVerified?: boolean;
503
+ /**
504
+ * member's role:
505
+ *
506
+ * `OWNER` - member that belongs to site owner
507
+ * `CONTRIBUTOR` - member that belongs to a contributor in site
508
+ * `MEMBER` - other members that registered to site
509
+ */
510
+ role?: Role$1;
511
+ /** email to be used when logging in */
512
+ loginEmail?: string | null;
513
+ /** member's full name */
514
+ memberName?: string | null;
515
+ /** member's first name */
516
+ firstName?: string | null;
517
+ /** member's last name */
518
+ lastName?: string | null;
519
+ /**
520
+ * Deprecated: please use `picture` field instead.
521
+ * URL for member's profile image
522
+ * @deprecated
523
+ */
524
+ imageUrl?: string | null;
525
+ /** member's nickname (exposed to other members) */
526
+ nickname?: string | null;
527
+ /** `PUBLIC` if other members can view this profile, `PRIVATE` otherwise */
528
+ profilePrivacyStatus?: SiteMemberPrivacyStatus$1;
529
+ /** url segment for accessing the member's profile */
530
+ slug?: string | null;
531
+ /** member's language */
532
+ language?: string | null;
533
+ /**
534
+ * member's status:
535
+ *
536
+ * `ACTIVE` - when member is approved
537
+ * `APPLICANT` - when pending site owner's approval
538
+ * `BLOCKED` - when member is blocked by the site's owner
539
+ * `INACTIVE` - not used
540
+ */
541
+ status?: SiteMemberStatus$1;
542
+ /**
543
+ * date the member was created
544
+ * @readonly
545
+ */
546
+ creationDate?: Date;
547
+ /**
548
+ * date the member was last updated
549
+ * @readonly
550
+ */
551
+ lastUpdateDate?: Date;
552
+ /**
553
+ * date of last login
554
+ * @readonly
555
+ */
556
+ lastLoginDate?: Date;
557
+ /**
558
+ * member's email addresses
559
+ * (returned when `include_contact_details` is set to `true`)
560
+ */
561
+ emails?: string[];
562
+ /**
563
+ * member's phone numbers
564
+ * (returned when `include_contact_details` is set to `true`)
565
+ */
566
+ phones?: string[];
567
+ /**
568
+ * member's addresses
569
+ * (returned when `include_contact_details` is set to `true`)
570
+ */
571
+ addresses?: Address$3[];
572
+ /**
573
+ * labels attached to the member by the owner (in contacts dashboard)
574
+ * (returned when `include_contact_details` is set to `true`)
575
+ */
576
+ labels?: string[];
577
+ /**
578
+ * custom fields set for the member by the owner (in contacts dashboard)
579
+ * (returned when `include_contact_details` is set to `true`)
580
+ */
581
+ customFields?: CustomField$3[];
582
+ /**
583
+ * member's profile picture
584
+ * supports both media-items and external urls
585
+ */
586
+ picture?: Image$2;
587
+ /** member's user id */
588
+ userId?: string | null;
589
+ /** Groups the the member is registered to */
590
+ groups?: Group$1[];
591
+ /**
592
+ * member's contact id
593
+ * @readonly
594
+ */
595
+ contactId?: string | null;
596
+ }
597
+ declare enum Role$1 {
598
+ UNDEFINED_ROLE = "UNDEFINED_ROLE",
599
+ MEMBER = "MEMBER",
600
+ OWNER = "OWNER",
601
+ CONTRIBUTOR = "CONTRIBUTOR"
602
+ }
603
+ declare enum SiteMemberPrivacyStatus$1 {
604
+ UNDEFINED = "UNDEFINED",
605
+ PUBLIC = "PUBLIC",
606
+ PRIVATE = "PRIVATE",
607
+ COMMUNITY = "COMMUNITY"
608
+ }
609
+ declare enum SiteMemberStatus$1 {
610
+ UNDEFINED_STATUS = "UNDEFINED_STATUS",
611
+ APPLICANT = "APPLICANT",
612
+ ACTIVE = "ACTIVE",
613
+ INACTIVE = "INACTIVE",
614
+ BLOCKED = "BLOCKED",
615
+ OFFLINE_ONLY = "OFFLINE_ONLY"
616
+ }
617
+ interface Address$3 {
618
+ /** member's street address */
619
+ street?: string | null;
620
+ /** member's city */
621
+ city?: string | null;
622
+ /** member's region */
623
+ region?: string | null;
624
+ /** member's country */
625
+ country?: string | null;
626
+ /** member's postal code */
627
+ postalCode?: string | null;
628
+ }
629
+ interface CustomField$3 extends CustomFieldValueOneOf$1 {
630
+ strValue?: string | null;
631
+ numValue?: number;
632
+ dateValue?: Date;
633
+ name?: string;
634
+ }
635
+ /** @oneof */
636
+ interface CustomFieldValueOneOf$1 {
637
+ strValue?: string | null;
638
+ numValue?: number;
639
+ dateValue?: Date;
640
+ }
641
+ interface Image$2 {
642
+ /** WixMedia image ID. */
643
+ id?: string;
644
+ /** Image URL. */
645
+ url?: string;
646
+ /**
647
+ * Original image height.
648
+ * @readonly
649
+ */
650
+ height?: number;
651
+ /**
652
+ * Original image width.
653
+ * @readonly
654
+ */
655
+ width?: number;
656
+ /** Image alt text. */
657
+ altText?: string | null;
658
+ /**
659
+ * Image filename.
660
+ * @readonly
661
+ */
662
+ filename?: string | null;
663
+ }
664
+ interface Group$1 {
665
+ id?: string;
666
+ name?: string;
667
+ type?: string;
668
+ }
669
+ interface ChangeLoginEmailRequest$1 {
670
+ /** Member ID. */
671
+ id: string;
672
+ /** New login email address. */
673
+ newEmail?: string;
674
+ /** Whether to revoke active sessions immediately after changing the member's login email. */
675
+ revokeCurrentSessions?: boolean | null;
676
+ }
677
+ interface ChangeLoginEmailResponse$1 {
678
+ /** Member with the updated login email address. */
679
+ member?: Member$3;
680
+ }
681
+ interface ApproveMemberRequest$1 extends ApproveMemberRequestMemberIdentifierOneOf$1 {
682
+ /** ID of the member to approve. */
683
+ id?: string;
684
+ /** Login email address of the member to approve. */
685
+ email?: string;
686
+ /**
687
+ * <!--ONLY:VELO
688
+ * Approval token returned by `register()`.
689
+ * <!--END:ONLY:VELO-->
690
+ */
691
+ token?: string;
692
+ }
693
+ /** @oneof */
694
+ interface ApproveMemberRequestMemberIdentifierOneOf$1 {
695
+ /** ID of the member to approve. */
696
+ id?: string;
697
+ /** Login email address of the member to approve. */
698
+ email?: string;
699
+ /**
700
+ * <!--ONLY:VELO
701
+ * Approval token returned by `register()`.
702
+ * <!--END:ONLY:VELO-->
703
+ */
704
+ token?: string;
705
+ }
706
+ interface ApproveMemberResponse$1 {
707
+ session?: Session$1;
708
+ }
709
+ interface Session$1 {
710
+ token?: string | null;
711
+ }
712
+ interface BlockMemberRequest$1 extends BlockMemberRequestMemberIdentifierOneOf$1 {
713
+ id?: string;
714
+ /** Login email address of the member to block. */
715
+ email?: string;
716
+ /** Indicate the source of the block request */
717
+ source?: Source$1;
718
+ }
719
+ /** @oneof */
720
+ interface BlockMemberRequestMemberIdentifierOneOf$1 {
721
+ id?: string;
722
+ /** Login email address of the member to block. */
723
+ email?: string;
724
+ }
725
+ declare enum Source$1 {
726
+ UNKNOWN = "UNKNOWN",
727
+ HANDLING_SPAM = "HANDLING_SPAM"
728
+ }
729
+ interface BlockMemberResponse$1 {
730
+ }
731
+ /** Registration options. */
732
+ interface RegisterRequest$1 {
733
+ /** Login email address for the new site member. */
734
+ email?: string;
735
+ /**
736
+ * Password the new site member will use to log in.
737
+ *
738
+ * Must be 4 to 15 ASCII-printable characters.
739
+ */
740
+ password?: string;
741
+ /** Contact information for the registered member. */
742
+ contactInfo?: MemberContactInfo$1;
743
+ /** identification of the app that initiated the register request */
744
+ dialogData?: DialogData$1;
745
+ /**
746
+ * Sets the privacy status of a new member upon registration.
747
+ *
748
+ * - `PUBLIC`: Member is visible to everyone.
749
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
750
+ * - `UNKNOWN`: Insufficient permissions to get the status.
751
+ */
752
+ profilePrivacyStatus?: SiteMemberPrivacyStatus$1;
753
+ /** is registration offline */
754
+ isOfflineRegistration?: boolean;
755
+ recaptchaToken?: string | null;
756
+ invisibleRecaptchaToken?: string | null;
757
+ emailVerification?: EmailVerification$1;
758
+ /**
759
+ * an indication that the request needs to follow mobile signup flow
760
+ * difference from the regular flow is the OTP email
761
+ */
762
+ isMobile?: boolean | null;
763
+ }
764
+ interface MemberContactInfo$1 {
765
+ /** First name. */
766
+ firstName?: string | null;
767
+ /** Last name. */
768
+ lastName?: string | null;
769
+ /** Contact's profile picture. */
770
+ picture?: string | null;
771
+ /** Contact's email addresses. */
772
+ emails?: string[];
773
+ /** Contact's phone numbers. */
774
+ phones?: string[];
775
+ /** List of contact's labels. */
776
+ labels?: string[];
777
+ /**
778
+ * Contact's locale, formatted as an
779
+ * [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).
780
+ * Typically, this is a lowercase 2-letter language code,
781
+ * followed by a hyphen,
782
+ * followed by an uppercase 2-letter country code.
783
+ *
784
+ * For example, German from Germany is formatted as `"de-DE"`,
785
+ * and U.S. English is formatted as `"en-US"`.
786
+ */
787
+ locale?: string | null;
788
+ /**
789
+ * Any number of custom fields.
790
+ * [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
791
+ * are used to store additional information about your site's contacts.
792
+ * When setting a custom field, use key:value pairs,
793
+ * where the key matches the names defined in your site's
794
+ * [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
795
+ * You can only set values for custom fields that already exist in the Contacts application.
796
+ */
797
+ customFields?: CustomField$3[];
798
+ }
799
+ interface DialogData$1 {
800
+ visitorId?: string | null;
801
+ appId?: string | null;
802
+ initiator?: string | null;
803
+ }
804
+ interface EmailVerification$1 {
805
+ /** Id of the verification process */
806
+ verificationId?: string;
807
+ /** 6-digit code to verify (between 100000 and 999999) */
808
+ otp?: string;
809
+ }
810
+ interface RegisterResponse$1 {
811
+ /** Newly registered member. */
812
+ member?: Member$3;
813
+ /**
814
+ * in case the site is open for registration, all members are automatically
815
+ * approved. they will get a temporary token for obtaining a valid session
816
+ */
817
+ session?: Session$1;
818
+ /**
819
+ * in case the site requires members approval, the registered member
820
+ * will be an applicant until he's approved. the token can be used as a member
821
+ * identifier for approval using the `MembersService.Approve` API
822
+ */
823
+ approvalToken?: string | null;
824
+ }
825
+ interface LoginRequest$1 {
826
+ /** Login email address. */
827
+ email?: string;
828
+ /** Member password. */
829
+ password?: string;
830
+ /** Recaptcha token. */
831
+ recaptchaToken?: string;
832
+ /** Invisible recaptcha token. */
833
+ invisibleRecaptchaToken?: string;
834
+ emailVerification?: EmailVerification$1;
835
+ /**
836
+ * an indication that the request needs to follow mobile login flow
837
+ * difference from the regular flow is the OTP email
838
+ */
839
+ isMobile?: boolean | null;
840
+ }
841
+ /** Session token for logging the member in. */
842
+ interface LoginResponse$1 {
843
+ session?: Session$1;
844
+ /** the member's details */
845
+ member?: Member$3;
846
+ }
847
+ interface SendSetPasswordEmailRequest$1 {
848
+ /** Login email of the member whose password will be set. */
849
+ email: string;
850
+ /**
851
+ * > **Deprecated:**
852
+ * > This field has been replaced with
853
+ * > `hideIgnoreMessage`
854
+ * > and will be removed on June 30, 2022.
855
+ * > If your app uses this field,
856
+ * > we recommend updating your code as soon as possible.
857
+ *
858
+ * Whether the email is being sent by member request.
859
+ *
860
+ * If `true`, the email tells the member
861
+ * they can safely ignore
862
+ * if they did not request the password change.
863
+ *
864
+ * Defaults to `false`.
865
+ * @deprecated
866
+ */
867
+ requestedByMember?: boolean;
868
+ /**
869
+ * Whether to hide the ignore this email message .
870
+ *
871
+ * If `true`, the email tells the member
872
+ * they can safely ignore
873
+ * if they did not request the password change.
874
+ *
875
+ * Default: `false`.
876
+ */
877
+ hideIgnoreMessage?: boolean;
878
+ }
879
+ interface SendSetPasswordEmailResponse$1 {
880
+ /** Indicates if the request was successfully received. */
881
+ accepted?: boolean;
882
+ }
883
+ interface ChangeLoginEmailResponseNonNullableFields$1 {
884
+ member?: {
885
+ id: string;
886
+ emailVerified: boolean;
887
+ role: Role$1;
888
+ profilePrivacyStatus: SiteMemberPrivacyStatus$1;
889
+ status: SiteMemberStatus$1;
890
+ emails: string[];
891
+ phones: string[];
892
+ addresses: Address$3[];
893
+ labels: string[];
894
+ customFields: {
895
+ numValue: number;
896
+ name: string;
897
+ }[];
898
+ picture?: {
899
+ id: string;
900
+ url: string;
901
+ height: number;
902
+ width: number;
903
+ };
904
+ groups: {
905
+ id: string;
906
+ name: string;
907
+ type: string;
908
+ }[];
909
+ };
910
+ }
911
+ interface RegisterResponseNonNullableFields$1 {
912
+ member?: {
913
+ id: string;
914
+ emailVerified: boolean;
915
+ role: Role$1;
916
+ profilePrivacyStatus: SiteMemberPrivacyStatus$1;
917
+ status: SiteMemberStatus$1;
918
+ emails: string[];
919
+ phones: string[];
920
+ addresses: Address$3[];
921
+ labels: string[];
922
+ customFields: {
923
+ numValue: number;
924
+ name: string;
925
+ }[];
926
+ picture?: {
927
+ id: string;
928
+ url: string;
929
+ height: number;
930
+ width: number;
931
+ };
932
+ groups: {
933
+ id: string;
934
+ name: string;
935
+ type: string;
936
+ }[];
937
+ };
938
+ }
939
+ interface LoginResponseNonNullableFields$1 {
940
+ member?: {
941
+ id: string;
942
+ emailVerified: boolean;
943
+ role: Role$1;
944
+ profilePrivacyStatus: SiteMemberPrivacyStatus$1;
945
+ status: SiteMemberStatus$1;
946
+ emails: string[];
947
+ phones: string[];
948
+ addresses: Address$3[];
949
+ labels: string[];
950
+ customFields: {
951
+ numValue: number;
952
+ name: string;
953
+ }[];
954
+ picture?: {
955
+ id: string;
956
+ url: string;
957
+ height: number;
958
+ width: number;
959
+ };
960
+ groups: {
961
+ id: string;
962
+ name: string;
963
+ type: string;
964
+ }[];
965
+ };
966
+ }
967
+ interface SendSetPasswordEmailResponseNonNullableFields$1 {
968
+ accepted: boolean;
969
+ }
970
+
971
+ interface Member$2 {
972
+ /**
973
+ * Member ID.
974
+ * @readonly
975
+ */
976
+ _id?: string;
977
+ /**
978
+ * @internal
979
+ * @internal
980
+ * @readonly
981
+ */
982
+ emailVerified?: boolean;
983
+ /**
984
+ * @internal
985
+ * @internal */
986
+ role?: Role;
987
+ /**
988
+ * Email used by the member to log in to the site.
989
+ *
990
+ *
991
+ */
992
+ loginEmail?: string | null;
993
+ /**
994
+ * @internal
995
+ * @internal */
996
+ memberName?: string | null;
997
+ /** Member's first name. */
998
+ firstName?: string | null;
999
+ /** Member's last name. */
1000
+ lastName?: string | null;
1001
+ /**
1002
+ * @internal
1003
+ * @internal
1004
+ * @deprecated
1005
+ */
1006
+ imageUrl?: string | null;
1007
+ /** Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog. */
1008
+ nickname?: string | null;
1009
+ /**
1010
+ * Member privacy status.
1011
+ *
1012
+ * One of:
1013
+ * - `"PUBLIC"`: Member is visible to everyone.
1014
+ * - `"PRIVATE"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
1015
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
1016
+ */
1017
+ profilePrivacyStatus?: SiteMemberPrivacyStatus;
1018
+ /** URL segment that determines the member's profile page. */
1019
+ slug?: string | null;
1020
+ /**
1021
+ * @internal
1022
+ * @internal */
1023
+ language?: string | null;
1024
+ /**
1025
+ * Member site access status.
1026
+ *
1027
+ * One of:
1028
+ * - `"PENDING"`: Member created and is waiting for approval by site owner.
1029
+ * - `"APPROVED"`: Member can log in to the site.
1030
+ * - "OFFLINE"`: Member is a guest author for the site blog and cannot log in to the site.
1031
+ * - `"BLOCKED"`: Member is blocked and cannot log in to the site.
1032
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
1033
+ */
1034
+ status?: SiteMemberStatus;
1035
+ /**
1036
+ * Date and time when the member was created.
1037
+ * @readonly
1038
+ */
1039
+ creationDate?: Date;
1040
+ /**
1041
+ * Date and time when the member was last updated.
1042
+ *
1043
+ *
1044
+ * @readonly
1045
+ */
1046
+ lastUpdateDate?: Date;
1047
+ /**
1048
+ * Date and time when the member last logged in to the site.
1049
+ *
1050
+ * @readonly
1051
+ */
1052
+ lastLoginDate?: Date;
1053
+ /**
1054
+ * List of email addresses.
1055
+ *
1056
+ *
1057
+ */
1058
+ emails?: string[];
1059
+ /** List of phone numbers. */
1060
+ phones?: string[];
1061
+ /** List of street addresses. */
1062
+ addresses?: Address$2[];
1063
+ /**
1064
+ * @internal
1065
+ * @internal */
1066
+ labels?: string[];
1067
+ /**
1068
+ * Custom fields, structured as key:object pairs. Custom field keys are defined in the Contacts Extended Fields API. The paired object contains the `name` and `value` properties, where `name` is the display name and `value` is the value stored for the member.
1069
+ *
1070
+ * Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.
1071
+ *
1072
+ * When updating a member, `name` is ignored.
1073
+ */
1074
+ customFields?: CustomField$2[];
1075
+ /** Member's profile picture URL. */
1076
+ picture?: string;
1077
+ /**
1078
+ * @internal
1079
+ * @internal */
1080
+ userId?: string | null;
1081
+ /**
1082
+ * @internal
1083
+ * @internal */
1084
+ groups?: Group[];
1085
+ /**
1086
+ * Member's contact ID.
1087
+ * @readonly
1088
+ */
1089
+ contactId?: string | null;
1090
+ }
1091
+ declare enum Role {
1092
+ UNDEFINED_ROLE = "UNDEFINED_ROLE",
1093
+ MEMBER = "MEMBER",
1094
+ OWNER = "OWNER",
1095
+ CONTRIBUTOR = "CONTRIBUTOR"
1096
+ }
1097
+ declare enum SiteMemberPrivacyStatus {
1098
+ UNDEFINED = "UNDEFINED",
1099
+ PUBLIC = "PUBLIC",
1100
+ PRIVATE = "PRIVATE",
1101
+ COMMUNITY = "COMMUNITY"
1102
+ }
1103
+ declare enum SiteMemberStatus {
1104
+ UNDEFINED_STATUS = "UNDEFINED_STATUS",
1105
+ APPLICANT = "APPLICANT",
1106
+ ACTIVE = "ACTIVE",
1107
+ INACTIVE = "INACTIVE",
1108
+ BLOCKED = "BLOCKED",
1109
+ OFFLINE_ONLY = "OFFLINE_ONLY"
1110
+ }
1111
+ interface Address$2 {
1112
+ /** Street address. */
1113
+ street?: string | null;
1114
+ /** City name. */
1115
+ city?: string | null;
1116
+ /** Region name. */
1117
+ region?: string | null;
1118
+ /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1119
+ country?: string | null;
1120
+ /** Postal code. */
1121
+ postalCode?: string | null;
1122
+ }
1123
+ interface CustomField$2 extends CustomFieldValueOneOf {
1124
+ /** String value. */
1125
+ strValue?: string | null;
1126
+ /** Number value. */
1127
+ numValue?: number;
1128
+ /** Date value. */
1129
+ dateValue?: Date;
1130
+ /** Display name. */
1131
+ name?: string;
1132
+ }
1133
+ /** @oneof */
1134
+ interface CustomFieldValueOneOf {
1135
+ strValue?: string | null;
1136
+ numValue?: number;
1137
+ dateValue?: Date;
1138
+ }
1139
+ interface Group {
1140
+ _id?: string;
1141
+ name?: string;
1142
+ type?: string;
1143
+ }
1144
+ interface ChangeLoginEmailRequest {
1145
+ /** Member ID. */
1146
+ _id: string;
1147
+ /** New login email address. */
1148
+ newEmail?: string;
1149
+ /**
1150
+ * @internal
1151
+ * @internal */
1152
+ revokeCurrentSessions?: boolean | null;
1153
+ }
1154
+ interface ChangeLoginEmailResponse {
1155
+ /** Member with the updated login email address. */
1156
+ member?: Member$2;
1157
+ }
1158
+ interface ApproveMemberRequest extends ApproveMemberRequestMemberIdentifierOneOf {
1159
+ /** ID of the member to approve. */
1160
+ _id?: string;
1161
+ /** Login email address of the member to approve. */
1162
+ email?: string;
1163
+ /** Approval token returned by the [`register()`](#register) function. */
1164
+ token?: string;
1165
+ }
1166
+ /** @oneof */
1167
+ interface ApproveMemberRequestMemberIdentifierOneOf {
1168
+ /** ID of the member to approve. */
1169
+ _id?: string;
1170
+ /** Login email address of the member to approve. */
1171
+ email?: string;
1172
+ /**
1173
+ * <!--ONLY:VELO
1174
+ * Approval token returned by `register()`.
1175
+ * <!--END:ONLY:VELO-->
1176
+ */
1177
+ token?: string;
1178
+ }
1179
+ interface ApproveMemberResponse {
1180
+ /** Approval session token. */
1181
+ session?: Session;
1182
+ }
1183
+ interface Session {
1184
+ /** Session token when the current member is logged into the site. */
1185
+ token?: string | null;
1186
+ }
1187
+ interface BlockMemberRequest extends BlockMemberRequestMemberIdentifierOneOf {
1188
+ /** ID of the member to block. */
1189
+ _id?: string;
1190
+ /** Login email address of the member to block. */
1191
+ email?: string;
1192
+ /**
1193
+ * @internal
1194
+ * @internal */
1195
+ source?: Source;
1196
+ }
1197
+ /** @oneof */
1198
+ interface BlockMemberRequestMemberIdentifierOneOf {
1199
+ _id?: string;
1200
+ /** Login email address of the member to block. */
1201
+ email?: string;
1202
+ }
1203
+ declare enum Source {
1204
+ UNKNOWN = "UNKNOWN",
1205
+ HANDLING_SPAM = "HANDLING_SPAM"
1206
+ }
1207
+ interface BlockMemberResponse {
1208
+ }
1209
+ /** Registration options. */
1210
+ interface RegisterRequest {
1211
+ /** Login email address for the new site member. */
1212
+ email?: string;
1213
+ /**
1214
+ * Password the new site member will use to log in.
1215
+ *
1216
+ * Must be 4 to 15 ASCII-printable characters.
1217
+ */
1218
+ password?: string;
1219
+ /** Contact information for the registered member. */
1220
+ contactInfo?: MemberContactInfo;
1221
+ /**
1222
+ * @internal
1223
+ * @internal */
1224
+ dialogData?: DialogData;
1225
+ /**
1226
+ * Sets the privacy status of a new member upon registration.
1227
+ *
1228
+ * - `PUBLIC`: Member is visible to everyone.
1229
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
1230
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1231
+ */
1232
+ profilePrivacyStatus?: SiteMemberPrivacyStatus;
1233
+ /**
1234
+ * @internal
1235
+ * @internal */
1236
+ isOfflineRegistration?: boolean;
1237
+ /**
1238
+ * @internal
1239
+ * @internal */
1240
+ recaptchaToken?: string | null;
1241
+ /**
1242
+ * @internal
1243
+ * @internal */
1244
+ invisibleRecaptchaToken?: string | null;
1245
+ /**
1246
+ * @internal
1247
+ * @internal */
1248
+ emailVerification?: EmailVerification;
1249
+ /**
1250
+ * @internal
1251
+ * @internal */
1252
+ isMobile?: boolean | null;
1253
+ }
1254
+ interface MemberContactInfo {
1255
+ /** First name. */
1256
+ firstName?: string | null;
1257
+ /** Last name. */
1258
+ lastName?: string | null;
1259
+ /** Contact's profile picture. */
1260
+ picture?: string | null;
1261
+ /** Contact's email addresses. */
1262
+ emails?: string[];
1263
+ /** Contact's phone numbers. */
1264
+ phones?: string[];
1265
+ /** List of contact's labels. */
1266
+ labels?: string[];
1267
+ /**
1268
+ * @internal
1269
+ * @internal */
1270
+ locale?: string | null;
1271
+ /**
1272
+ * Any number of custom fields.
1273
+ * [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
1274
+ * are used to store additional information about your site's contacts.
1275
+ * When setting a custom field, use key:value pairs,
1276
+ * where the key matches the names defined in your site's
1277
+ * [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
1278
+ * You can only set values for custom fields that already exist in the Contacts application.
1279
+ */
1280
+ customFields?: CustomField$2[];
1281
+ }
1282
+ interface DialogData {
1283
+ visitorId?: string | null;
1284
+ appId?: string | null;
1285
+ initiator?: string | null;
1286
+ }
1287
+ interface EmailVerification {
1288
+ /** ID of the verification process. */
1289
+ verificationId?: string;
1290
+ /**
1291
+ * 6-digit code for verification. Code can be between 100000 and 999999.
1292
+ *
1293
+ */
1294
+ otp?: string;
1295
+ }
1296
+ interface RegisterResponse {
1297
+ /** Newly registered member. */
1298
+ member?: Member$2;
1299
+ /**
1300
+ * in case the site is open for registration, all members are automatically
1301
+ * approved. they will get a temporary token for obtaining a valid session
1302
+ */
1303
+ session?: Session;
1304
+ /**
1305
+ * in case the site requires members approval, the registered member
1306
+ * will be an applicant until he's approved. the token can be used as a member
1307
+ * identifier for approval using the `MembersService.Approve` API
1308
+ */
1309
+ approvalToken?: string | null;
1310
+ }
1311
+ interface LoginRequest {
1312
+ /** Login email address. */
1313
+ email?: string;
1314
+ /** Member password. */
1315
+ password?: string;
1316
+ /**
1317
+ * @internal
1318
+ * @internal */
1319
+ recaptchaToken?: string;
1320
+ /**
1321
+ * @internal
1322
+ * @internal */
1323
+ invisibleRecaptchaToken?: string;
1324
+ /**
1325
+ * @internal
1326
+ * @internal */
1327
+ emailVerification?: EmailVerification;
1328
+ /**
1329
+ * @internal
1330
+ * @internal */
1331
+ isMobile?: boolean | null;
1332
+ }
1333
+ /** Session token for logging the member in. */
1334
+ interface LoginResponse {
1335
+ /** Session token. */
1336
+ session?: Session;
1337
+ /** the member's details */
1338
+ member?: Member$2;
1339
+ }
1340
+ interface SendSetPasswordEmailRequest {
1341
+ /** Login email of the member whose password will be set. */
1342
+ email: string;
1343
+ /**
1344
+ * @internal
1345
+ * @internal
1346
+ * @deprecated
1347
+ */
1348
+ requestedByMember?: boolean;
1349
+ /**
1350
+ * Whether to hide the ignore this email message .
1351
+ *
1352
+ * If `true`, the email tells the member
1353
+ * they can safely ignore
1354
+ * if they did not request the password change.
1355
+ *
1356
+ * Default: `false`.
1357
+ */
1358
+ hideIgnoreMessage?: boolean;
1359
+ }
1360
+ interface SendSetPasswordEmailResponse {
1361
+ /** Indicates if the request was successfully received. */
1362
+ accepted?: boolean;
1363
+ }
1364
+ interface ChangeLoginEmailResponseNonNullableFields {
1365
+ member?: {
1366
+ _id: string;
1367
+ emailVerified: boolean;
1368
+ role: Role;
1369
+ profilePrivacyStatus: SiteMemberPrivacyStatus;
1370
+ status: SiteMemberStatus;
1371
+ emails: string[];
1372
+ phones: string[];
1373
+ addresses: Address$2[];
1374
+ labels: string[];
1375
+ customFields: {
1376
+ numValue: number;
1377
+ name: string;
1378
+ }[];
1379
+ picture: string;
1380
+ groups: {
1381
+ _id: string;
1382
+ name: string;
1383
+ type: string;
1384
+ }[];
1385
+ };
1386
+ }
1387
+ interface RegisterResponseNonNullableFields {
1388
+ member?: {
1389
+ _id: string;
1390
+ emailVerified: boolean;
1391
+ role: Role;
1392
+ profilePrivacyStatus: SiteMemberPrivacyStatus;
1393
+ status: SiteMemberStatus;
1394
+ emails: string[];
1395
+ phones: string[];
1396
+ addresses: Address$2[];
1397
+ labels: string[];
1398
+ customFields: {
1399
+ numValue: number;
1400
+ name: string;
1401
+ }[];
1402
+ picture: string;
1403
+ groups: {
1404
+ _id: string;
1405
+ name: string;
1406
+ type: string;
1407
+ }[];
1408
+ };
1409
+ }
1410
+ interface LoginResponseNonNullableFields {
1411
+ member?: {
1412
+ _id: string;
1413
+ emailVerified: boolean;
1414
+ role: Role;
1415
+ profilePrivacyStatus: SiteMemberPrivacyStatus;
1416
+ status: SiteMemberStatus;
1417
+ emails: string[];
1418
+ phones: string[];
1419
+ addresses: Address$2[];
1420
+ labels: string[];
1421
+ customFields: {
1422
+ numValue: number;
1423
+ name: string;
1424
+ }[];
1425
+ picture: string;
1426
+ groups: {
1427
+ _id: string;
1428
+ name: string;
1429
+ type: string;
1430
+ }[];
1431
+ };
1432
+ }
1433
+ interface SendSetPasswordEmailResponseNonNullableFields {
1434
+ accepted: boolean;
1435
+ }
1436
+
1437
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1438
+ getUrl: (context: any) => string;
1439
+ httpMethod: K;
1440
+ path: string;
1441
+ pathParams: M;
1442
+ __requestType: T;
1443
+ __originalRequestType: S;
1444
+ __responseType: Q;
1445
+ __originalResponseType: R;
1446
+ };
1447
+ declare function changeLoginEmail(): __PublicMethodMetaInfo$1<'PATCH', {
1448
+ id: string;
1449
+ }, ChangeLoginEmailRequest, ChangeLoginEmailRequest$1, ChangeLoginEmailResponse & ChangeLoginEmailResponseNonNullableFields, ChangeLoginEmailResponse$1 & ChangeLoginEmailResponseNonNullableFields$1>;
1450
+ declare function approve(): __PublicMethodMetaInfo$1<'POST', {}, ApproveMemberRequest, ApproveMemberRequest$1, ApproveMemberResponse, ApproveMemberResponse$1>;
1451
+ declare function block(): __PublicMethodMetaInfo$1<'POST', {}, BlockMemberRequest, BlockMemberRequest$1, BlockMemberResponse, BlockMemberResponse$1>;
1452
+ declare function register(): __PublicMethodMetaInfo$1<'POST', {}, RegisterRequest, RegisterRequest$1, RegisterResponse & RegisterResponseNonNullableFields, RegisterResponse$1 & RegisterResponseNonNullableFields$1>;
1453
+ declare function login(): __PublicMethodMetaInfo$1<'POST', {}, LoginRequest, LoginRequest$1, LoginResponse & LoginResponseNonNullableFields, LoginResponse$1 & LoginResponseNonNullableFields$1>;
1454
+ declare function sendSetPasswordEmail(): __PublicMethodMetaInfo$1<'POST', {}, SendSetPasswordEmailRequest, SendSetPasswordEmailRequest$1, SendSetPasswordEmailResponse & SendSetPasswordEmailResponseNonNullableFields, SendSetPasswordEmailResponse$1 & SendSetPasswordEmailResponseNonNullableFields$1>;
1455
+
1456
+ declare const meta$1_approve: typeof approve;
1457
+ declare const meta$1_block: typeof block;
1458
+ declare const meta$1_changeLoginEmail: typeof changeLoginEmail;
1459
+ declare const meta$1_login: typeof login;
1460
+ declare const meta$1_register: typeof register;
1461
+ declare const meta$1_sendSetPasswordEmail: typeof sendSetPasswordEmail;
1462
+ declare namespace meta$1 {
1463
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_approve as approve, meta$1_block as block, meta$1_changeLoginEmail as changeLoginEmail, meta$1_login as login, meta$1_register as register, meta$1_sendSetPasswordEmail as sendSetPasswordEmail };
1464
+ }
1465
+
1466
+ interface Member$1 {
1467
+ /**
1468
+ * Member ID.
1469
+ * @readonly
1470
+ */
1471
+ id?: string | null;
1472
+ /** Email used by the member to log in to the site. */
1473
+ loginEmail?: string | null;
1474
+ /**
1475
+ * Whether the email used by the member has been verified.
1476
+ * @readonly
1477
+ */
1478
+ loginEmailVerified?: boolean | null;
1479
+ /**
1480
+ * Member site access status.
1481
+ *
1482
+ * - `PENDING`: Member created and is waiting for approval by site owner.
1483
+ * - `APPROVED`: Member can log in to the site.
1484
+ * - `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.
1485
+ * - `BLOCKED`: Member is blocked and cannot log in to the site.
1486
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1487
+ * @readonly
1488
+ */
1489
+ status?: Status$1;
1490
+ /**
1491
+ * Contact ID.
1492
+ * @readonly
1493
+ */
1494
+ contactId?: string | null;
1495
+ /**
1496
+ * Member's contact information. Contact information is stored in the
1497
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
1498
+ *
1499
+ * The full set of contact data can be accessed and managed with the
1500
+ * [Contacts API](https://dev.wix.com/api/rest/contacts/contacts).
1501
+ */
1502
+ contact?: Contact$1;
1503
+ /** Profile display info. */
1504
+ profile?: Profile$1;
1505
+ /**
1506
+ * Member privacy status.
1507
+ *
1508
+ * - `PUBLIC`: Member is visible to everyone.
1509
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
1510
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1511
+ */
1512
+ privacyStatus?: PrivacyStatusStatus$1;
1513
+ /**
1514
+ * Member activity status.
1515
+ *
1516
+ * - `ACTIVE`: Member can write forum posts and blog comments.
1517
+ * - `MUTED`: Member cannot write forum posts or blog comments.
1518
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1519
+ * @readonly
1520
+ */
1521
+ activityStatus?: ActivityStatusStatus$1;
1522
+ /**
1523
+ * Date and time when the member was created.
1524
+ * @readonly
1525
+ */
1526
+ createdDate?: Date;
1527
+ /**
1528
+ * Date and time when the member was updated.
1529
+ * @readonly
1530
+ */
1531
+ updatedDate?: Date;
1532
+ /**
1533
+ * Date and time when the member last logged in to the site.
1534
+ * @readonly
1535
+ */
1536
+ lastLoginDate?: Date;
1537
+ }
1538
+ declare enum Status$1 {
1539
+ UNKNOWN = "UNKNOWN",
1540
+ PENDING = "PENDING",
1541
+ APPROVED = "APPROVED",
1542
+ BLOCKED = "BLOCKED",
1543
+ OFFLINE = "OFFLINE"
1544
+ }
1545
+ /** Contact info associated with the member. */
1546
+ interface Contact$1 {
1547
+ /**
1548
+ * Contact ID.
1549
+ *
1550
+ * > **Deprecation notice:**
1551
+ * > This property has been replaced with `member.contactId`
1552
+ * > and will be removed on June 11, 2021.
1553
+ * @readonly
1554
+ * @deprecated
1555
+ */
1556
+ contactId?: string | null;
1557
+ /** Contact's first name. */
1558
+ firstName?: string | null;
1559
+ /** Contact's last name. */
1560
+ lastName?: string | null;
1561
+ /** List of phone numbers. */
1562
+ phones?: string[] | null;
1563
+ /** List of email addresses. */
1564
+ emails?: string[] | null;
1565
+ /** List of street addresses. */
1566
+ addresses?: Address$1[];
1567
+ /**
1568
+ * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
1569
+ *
1570
+ * Example: `"2020-03-15"` for March 15, 2020.
1571
+ */
1572
+ birthdate?: string | null;
1573
+ /** Contact's company name. */
1574
+ company?: string | null;
1575
+ /** Contact's job title. */
1576
+ jobTitle?: string | null;
1577
+ /**
1578
+ * Custom fields,
1579
+ * where each key is the field key,
1580
+ * and each value is the field's value for the member.
1581
+ */
1582
+ customFields?: Record<string, CustomField$1>;
1583
+ }
1584
+ /** Street address. */
1585
+ interface Address$1 extends AddressStreetOneOf$1 {
1586
+ /** Street address object, with number and name in separate fields. */
1587
+ streetAddress?: StreetAddress$1;
1588
+ /** Main address line, usually street and number, as free text. */
1589
+ addressLine?: string | null;
1590
+ /**
1591
+ * Street address ID.
1592
+ * @readonly
1593
+ */
1594
+ id?: string | null;
1595
+ /**
1596
+ * Free text providing more detailed address information,
1597
+ * such as apartment, suite, or floor.
1598
+ */
1599
+ addressLine2?: string | null;
1600
+ /** City name. */
1601
+ city?: string | null;
1602
+ /**
1603
+ * Code for a subdivision (such as state, prefecture, or province) in an
1604
+ * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
1605
+ */
1606
+ subdivision?: string | null;
1607
+ /**
1608
+ * 2-letter country code in an
1609
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1610
+ */
1611
+ country?: string | null;
1612
+ /** Postal code. */
1613
+ postalCode?: string | null;
1614
+ }
1615
+ /** @oneof */
1616
+ interface AddressStreetOneOf$1 {
1617
+ /** Street address object, with number and name in separate fields. */
1618
+ streetAddress?: StreetAddress$1;
1619
+ /** Main address line, usually street and number, as free text. */
1620
+ addressLine?: string | null;
1621
+ }
1622
+ interface StreetAddress$1 {
1623
+ /** Street number. */
1624
+ number?: string;
1625
+ /** Street name. */
1626
+ name?: string;
1627
+ }
1628
+ interface CustomField$1 {
1629
+ /** Custom field name. */
1630
+ name?: string | null;
1631
+ /** Custom field value. */
1632
+ value?: any;
1633
+ }
1634
+ /** Member Profile */
1635
+ interface Profile$1 {
1636
+ /**
1637
+ * Name that identifies the member to other members.
1638
+ * Displayed on the member's profile page
1639
+ * and interactions in the forum or blog.
1640
+ */
1641
+ nickname?: string | null;
1642
+ /**
1643
+ * Slug that determines the member's profile page URL.
1644
+ * @readonly
1645
+ */
1646
+ slug?: string | null;
1647
+ /** Member's profile photo. */
1648
+ photo?: Image$1;
1649
+ /**
1650
+ * Member's cover photo,
1651
+ * used as a background picture in members profile page.
1652
+ *
1653
+ * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
1654
+ * When left empty, the values default to `0`.
1655
+ */
1656
+ cover?: Image$1;
1657
+ /**
1658
+ * Member title.
1659
+ *
1660
+ * Currently available through the API only.
1661
+ */
1662
+ title?: string | null;
1663
+ }
1664
+ interface Image$1 {
1665
+ /**
1666
+ * Wix Media image ID,
1667
+ * set when the member selects an image from Wix Media.
1668
+ */
1669
+ id?: string;
1670
+ /** Image URL. */
1671
+ url?: string;
1672
+ /** Original image width. */
1673
+ height?: number;
1674
+ /** Original image height. */
1675
+ width?: number;
1676
+ /**
1677
+ * X-axis offset.
1678
+ *
1679
+ * Default: `0`.
1680
+ */
1681
+ offsetX?: number | null;
1682
+ /**
1683
+ * Y-axis offset.
1684
+ *
1685
+ * Default: `0`.
1686
+ */
1687
+ offsetY?: number | null;
1688
+ }
1689
+ declare enum PrivacyStatusStatus$1 {
1690
+ UNKNOWN = "UNKNOWN",
1691
+ PRIVATE = "PRIVATE",
1692
+ PUBLIC = "PUBLIC"
1693
+ }
1694
+ declare enum ActivityStatusStatus$1 {
1695
+ UNKNOWN = "UNKNOWN",
1696
+ ACTIVE = "ACTIVE",
1697
+ MUTED = "MUTED"
1698
+ }
1699
+ interface UpdateMySlugRequest$1 {
1700
+ /** New slug. */
1701
+ slug: string;
1702
+ }
1703
+ interface UpdateMySlugResponse$1 {
1704
+ /** Updated member. */
1705
+ member?: Member$1;
1706
+ }
1707
+ interface JoinCommunityRequest$1 {
1708
+ }
1709
+ /** Member profile. */
1710
+ interface JoinCommunityResponse$1 {
1711
+ /** The updated member. */
1712
+ member?: Member$1;
1713
+ }
1714
+ interface LeaveCommunityRequest$1 {
1715
+ }
1716
+ /** Member profile. */
1717
+ interface LeaveCommunityResponse$1 {
1718
+ /** The updated member. */
1719
+ member?: Member$1;
1720
+ }
1721
+ interface GetMyMemberRequest$1 {
1722
+ /**
1723
+ * Predefined set of fields to return.
1724
+ *
1725
+ * - `"FULL"`: Returns all fields.
1726
+ * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
1727
+ *
1728
+ * > **Note:**
1729
+ * > When returning the `"PUBLIC"` fieldset,
1730
+ * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
1731
+ * > are returned as `"UNKNOWN"`.
1732
+ * @deprecated
1733
+ */
1734
+ fieldSet?: Set$1;
1735
+ /**
1736
+ * Predefined set of fields to return. One of:
1737
+ *
1738
+ * - `FULL`: Returns all fields.
1739
+ * - `PUBLIC`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
1740
+ * - `EXTENDED`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
1741
+ *
1742
+ * Default: `PUBLIC`.
1743
+ */
1744
+ fieldsets?: Set$1[];
1745
+ }
1746
+ declare enum Set$1 {
1747
+ /** Public properties of the entity */
1748
+ PUBLIC = "PUBLIC",
1749
+ /** Extended properties of the entity */
1750
+ EXTENDED = "EXTENDED",
1751
+ /** Full entity defined in the doc */
1752
+ FULL = "FULL"
1753
+ }
1754
+ /** Member profile. */
1755
+ interface GetMyMemberResponse$1 {
1756
+ /** The requested member. */
1757
+ member?: Member$1;
1758
+ }
1759
+ interface GetMemberRequest$1 {
1760
+ /** Member ID. */
1761
+ id: string;
1762
+ /**
1763
+ * Predefined set of fields to return.
1764
+ *
1765
+ * Defaults to `PUBLIC`.
1766
+ */
1767
+ fieldsets?: Set$1[];
1768
+ }
1769
+ interface GetMemberResponse$1 {
1770
+ /** The requested member. */
1771
+ member?: Member$1;
1772
+ }
1773
+ interface ListMembersRequest$1 {
1774
+ paging?: Paging$1;
1775
+ /**
1776
+ * Predefined sets of fields to return.
1777
+ *
1778
+ * Defaults to `PUBLIC`.
1779
+ */
1780
+ fieldsets?: Set$1[];
1781
+ sorting?: Sorting$1[];
1782
+ }
1783
+ interface Paging$1 {
1784
+ /** Number of items to load. */
1785
+ limit?: number | null;
1786
+ /** Number of items to skip in the current sort order. */
1787
+ offset?: number | null;
1788
+ }
1789
+ interface Sorting$1 {
1790
+ /** Name of the field to sort by. */
1791
+ fieldName?: string;
1792
+ /** Sort order. */
1793
+ order?: SortOrder$1;
1794
+ }
1795
+ declare enum SortOrder$1 {
1796
+ ASC = "ASC",
1797
+ DESC = "DESC"
1798
+ }
1799
+ interface ListMembersResponse$1 {
1800
+ /** List of members. */
1801
+ members?: Member$1[];
1802
+ /** Metadata for the paginated results. */
1803
+ metadata?: PagingMetadata$1;
1804
+ }
1805
+ interface PagingMetadata$1 {
1806
+ /** Number of items returned in the response. */
1807
+ count?: number | null;
1808
+ /** Offset that was requested. */
1809
+ offset?: number | null;
1810
+ /** Total number of items that match the query. */
1811
+ total?: number | null;
1812
+ /** Flag that indicates the server failed to calculate the `total` field. */
1813
+ tooManyToCount?: boolean | null;
1814
+ }
1815
+ interface QueryMembersRequest$1 {
1816
+ /** Query options. */
1817
+ query?: Query$1;
1818
+ /**
1819
+ * Predefined sets of fields to return.
1820
+ *
1821
+ * Defaults to `PUBLIC`.
1822
+ */
1823
+ fieldsets?: Set$1[];
1824
+ /** Plain text search. */
1825
+ search?: Search$1;
1826
+ }
1827
+ interface Query$1 {
1828
+ /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
1829
+ filter?: any;
1830
+ /** Limit number of results */
1831
+ paging?: Paging$1;
1832
+ /** Sort the results */
1833
+ sorting?: Sorting$1[];
1834
+ }
1835
+ /** Free text to match in searchable fields */
1836
+ interface Search$1 {
1837
+ /** Search term or expression */
1838
+ expression?: string | null;
1839
+ /**
1840
+ * Currently supported fields for search:
1841
+ *
1842
+ * - `loginEmail`
1843
+ * - `contact.firstName`
1844
+ * - `contact.lastName`
1845
+ * - `profile.title`
1846
+ * - `profile.nickname`
1847
+ * - `profile.slug`
1848
+ *
1849
+ * Default is `profile.nickname`
1850
+ */
1851
+ fields?: string[];
1852
+ }
1853
+ interface QueryMembersResponse$1 {
1854
+ /** List of members that met the query filter criteria. */
1855
+ members?: Member$1[];
1856
+ /** Metadata for the paginated results. */
1857
+ metadata?: PagingMetadata$1;
1858
+ }
1859
+ interface DeleteMemberRequest$1 {
1860
+ /** ID of the member to delete. */
1861
+ id: string;
1862
+ }
1863
+ interface DeleteMemberResponse$1 {
1864
+ }
1865
+ interface CreateMemberRequest$1 {
1866
+ /** Member to create. */
1867
+ member?: Member$1;
1868
+ }
1869
+ interface CreateMemberResponse$1 {
1870
+ /** New member. */
1871
+ member?: Member$1;
1872
+ }
1873
+ interface UpdateMemberRequest$1 {
1874
+ /** Member to update. */
1875
+ member?: Member$1;
1876
+ }
1877
+ interface UpdateMemberResponse$1 {
1878
+ member?: Member$1;
1879
+ }
1880
+ interface DeleteMemberPhonesRequest$1 {
1881
+ /** ID of the member whose phone numbers will be deleted. */
1882
+ id: string;
1883
+ }
1884
+ interface DeleteMemberPhonesResponse$1 {
1885
+ /** Updated member. */
1886
+ member?: Member$1;
1887
+ }
1888
+ interface DeleteMemberEmailsRequest$1 {
1889
+ /** ID of the member whose email addresses will be deleted. */
1890
+ id: string;
1891
+ }
1892
+ interface DeleteMemberEmailsResponse$1 {
1893
+ /** Updated member. */
1894
+ member?: Member$1;
1895
+ }
1896
+ interface DeleteMemberAddressesRequest$1 {
1897
+ /** ID of the member whose street addresses will be deleted. */
1898
+ id: string;
1899
+ }
1900
+ interface DeleteMemberAddressesResponse$1 {
1901
+ /** Updated member. */
1902
+ member?: Member$1;
1903
+ }
1904
+ interface UpdateMySlugResponseNonNullableFields$1 {
1905
+ member?: {
1906
+ status: Status$1;
1907
+ contact?: {
1908
+ addresses: {
1909
+ streetAddress?: {
1910
+ number: string;
1911
+ name: string;
1912
+ };
1913
+ }[];
1914
+ };
1915
+ profile?: {
1916
+ photo?: {
1917
+ id: string;
1918
+ url: string;
1919
+ height: number;
1920
+ width: number;
1921
+ };
1922
+ cover?: {
1923
+ id: string;
1924
+ url: string;
1925
+ height: number;
1926
+ width: number;
1927
+ };
1928
+ };
1929
+ privacyStatus: PrivacyStatusStatus$1;
1930
+ activityStatus: ActivityStatusStatus$1;
1931
+ };
1932
+ }
1933
+ interface JoinCommunityResponseNonNullableFields$1 {
1934
+ member?: {
1935
+ status: Status$1;
1936
+ contact?: {
1937
+ addresses: {
1938
+ streetAddress?: {
1939
+ number: string;
1940
+ name: string;
1941
+ };
1942
+ }[];
1943
+ };
1944
+ profile?: {
1945
+ photo?: {
1946
+ id: string;
1947
+ url: string;
1948
+ height: number;
1949
+ width: number;
1950
+ };
1951
+ cover?: {
1952
+ id: string;
1953
+ url: string;
1954
+ height: number;
1955
+ width: number;
1956
+ };
1957
+ };
1958
+ privacyStatus: PrivacyStatusStatus$1;
1959
+ activityStatus: ActivityStatusStatus$1;
1960
+ };
1961
+ }
1962
+ interface LeaveCommunityResponseNonNullableFields$1 {
1963
+ member?: {
1964
+ status: Status$1;
1965
+ contact?: {
1966
+ addresses: {
1967
+ streetAddress?: {
1968
+ number: string;
1969
+ name: string;
1970
+ };
1971
+ }[];
1972
+ };
1973
+ profile?: {
1974
+ photo?: {
1975
+ id: string;
1976
+ url: string;
1977
+ height: number;
1978
+ width: number;
1979
+ };
1980
+ cover?: {
1981
+ id: string;
1982
+ url: string;
1983
+ height: number;
1984
+ width: number;
1985
+ };
1986
+ };
1987
+ privacyStatus: PrivacyStatusStatus$1;
1988
+ activityStatus: ActivityStatusStatus$1;
1989
+ };
1990
+ }
1991
+ interface GetMyMemberResponseNonNullableFields$1 {
1992
+ member?: {
1993
+ status: Status$1;
1994
+ contact?: {
1995
+ addresses: {
1996
+ streetAddress?: {
1997
+ number: string;
1998
+ name: string;
1999
+ };
2000
+ }[];
2001
+ };
2002
+ profile?: {
2003
+ photo?: {
2004
+ id: string;
2005
+ url: string;
2006
+ height: number;
2007
+ width: number;
2008
+ };
2009
+ cover?: {
2010
+ id: string;
2011
+ url: string;
2012
+ height: number;
2013
+ width: number;
2014
+ };
2015
+ };
2016
+ privacyStatus: PrivacyStatusStatus$1;
2017
+ activityStatus: ActivityStatusStatus$1;
2018
+ };
2019
+ }
2020
+ interface GetMemberResponseNonNullableFields$1 {
2021
+ member?: {
2022
+ status: Status$1;
2023
+ contact?: {
2024
+ addresses: {
2025
+ streetAddress?: {
2026
+ number: string;
2027
+ name: string;
2028
+ };
2029
+ }[];
2030
+ };
2031
+ profile?: {
2032
+ photo?: {
2033
+ id: string;
2034
+ url: string;
2035
+ height: number;
2036
+ width: number;
2037
+ };
2038
+ cover?: {
2039
+ id: string;
2040
+ url: string;
2041
+ height: number;
2042
+ width: number;
2043
+ };
2044
+ };
2045
+ privacyStatus: PrivacyStatusStatus$1;
2046
+ activityStatus: ActivityStatusStatus$1;
2047
+ };
2048
+ }
2049
+ interface ListMembersResponseNonNullableFields$1 {
2050
+ members: {
2051
+ status: Status$1;
2052
+ contact?: {
2053
+ addresses: {
2054
+ streetAddress?: {
2055
+ number: string;
2056
+ name: string;
2057
+ };
2058
+ }[];
2059
+ };
2060
+ profile?: {
2061
+ photo?: {
2062
+ id: string;
2063
+ url: string;
2064
+ height: number;
2065
+ width: number;
2066
+ };
2067
+ cover?: {
2068
+ id: string;
2069
+ url: string;
2070
+ height: number;
2071
+ width: number;
2072
+ };
2073
+ };
2074
+ privacyStatus: PrivacyStatusStatus$1;
2075
+ activityStatus: ActivityStatusStatus$1;
2076
+ }[];
2077
+ }
2078
+ interface QueryMembersResponseNonNullableFields$1 {
2079
+ members: {
2080
+ status: Status$1;
2081
+ contact?: {
2082
+ addresses: {
2083
+ streetAddress?: {
2084
+ number: string;
2085
+ name: string;
2086
+ };
2087
+ }[];
2088
+ };
2089
+ profile?: {
2090
+ photo?: {
2091
+ id: string;
2092
+ url: string;
2093
+ height: number;
2094
+ width: number;
2095
+ };
2096
+ cover?: {
2097
+ id: string;
2098
+ url: string;
2099
+ height: number;
2100
+ width: number;
2101
+ };
2102
+ };
2103
+ privacyStatus: PrivacyStatusStatus$1;
2104
+ activityStatus: ActivityStatusStatus$1;
2105
+ }[];
2106
+ }
2107
+ interface CreateMemberResponseNonNullableFields$1 {
2108
+ member?: {
2109
+ status: Status$1;
2110
+ contact?: {
2111
+ addresses: {
2112
+ streetAddress?: {
2113
+ number: string;
2114
+ name: string;
2115
+ };
2116
+ }[];
2117
+ };
2118
+ profile?: {
2119
+ photo?: {
2120
+ id: string;
2121
+ url: string;
2122
+ height: number;
2123
+ width: number;
2124
+ };
2125
+ cover?: {
2126
+ id: string;
2127
+ url: string;
2128
+ height: number;
2129
+ width: number;
2130
+ };
2131
+ };
2132
+ privacyStatus: PrivacyStatusStatus$1;
2133
+ activityStatus: ActivityStatusStatus$1;
2134
+ };
2135
+ }
2136
+ interface UpdateMemberResponseNonNullableFields$1 {
2137
+ member?: {
2138
+ status: Status$1;
2139
+ contact?: {
2140
+ addresses: {
2141
+ streetAddress?: {
2142
+ number: string;
2143
+ name: string;
2144
+ };
2145
+ }[];
2146
+ };
2147
+ profile?: {
2148
+ photo?: {
2149
+ id: string;
2150
+ url: string;
2151
+ height: number;
2152
+ width: number;
2153
+ };
2154
+ cover?: {
2155
+ id: string;
2156
+ url: string;
2157
+ height: number;
2158
+ width: number;
2159
+ };
2160
+ };
2161
+ privacyStatus: PrivacyStatusStatus$1;
2162
+ activityStatus: ActivityStatusStatus$1;
2163
+ };
2164
+ }
2165
+ interface DeleteMemberPhonesResponseNonNullableFields$1 {
2166
+ member?: {
2167
+ status: Status$1;
2168
+ contact?: {
2169
+ addresses: {
2170
+ streetAddress?: {
2171
+ number: string;
2172
+ name: string;
2173
+ };
2174
+ }[];
2175
+ };
2176
+ profile?: {
2177
+ photo?: {
2178
+ id: string;
2179
+ url: string;
2180
+ height: number;
2181
+ width: number;
2182
+ };
2183
+ cover?: {
2184
+ id: string;
2185
+ url: string;
2186
+ height: number;
2187
+ width: number;
2188
+ };
2189
+ };
2190
+ privacyStatus: PrivacyStatusStatus$1;
2191
+ activityStatus: ActivityStatusStatus$1;
2192
+ };
2193
+ }
2194
+ interface DeleteMemberEmailsResponseNonNullableFields$1 {
2195
+ member?: {
2196
+ status: Status$1;
2197
+ contact?: {
2198
+ addresses: {
2199
+ streetAddress?: {
2200
+ number: string;
2201
+ name: string;
2202
+ };
2203
+ }[];
2204
+ };
2205
+ profile?: {
2206
+ photo?: {
2207
+ id: string;
2208
+ url: string;
2209
+ height: number;
2210
+ width: number;
2211
+ };
2212
+ cover?: {
2213
+ id: string;
2214
+ url: string;
2215
+ height: number;
2216
+ width: number;
2217
+ };
2218
+ };
2219
+ privacyStatus: PrivacyStatusStatus$1;
2220
+ activityStatus: ActivityStatusStatus$1;
2221
+ };
2222
+ }
2223
+ interface DeleteMemberAddressesResponseNonNullableFields$1 {
2224
+ member?: {
2225
+ status: Status$1;
2226
+ contact?: {
2227
+ addresses: {
2228
+ streetAddress?: {
2229
+ number: string;
2230
+ name: string;
2231
+ };
2232
+ }[];
2233
+ };
2234
+ profile?: {
2235
+ photo?: {
2236
+ id: string;
2237
+ url: string;
2238
+ height: number;
2239
+ width: number;
2240
+ };
2241
+ cover?: {
2242
+ id: string;
2243
+ url: string;
2244
+ height: number;
2245
+ width: number;
2246
+ };
2247
+ };
2248
+ privacyStatus: PrivacyStatusStatus$1;
2249
+ activityStatus: ActivityStatusStatus$1;
2250
+ };
2251
+ }
2252
+
2253
+ interface Member {
2254
+ /**
2255
+ * Member ID.
2256
+ * @readonly
2257
+ */
2258
+ _id?: string | null;
2259
+ /** Email used by the member to log in to the site. */
2260
+ loginEmail?: string | null;
2261
+ /**
2262
+ * Whether the email used by the member has been verified.
2263
+ * @readonly
2264
+ */
2265
+ loginEmailVerified?: boolean | null;
2266
+ /**
2267
+ * Member site access status.
2268
+ *
2269
+ * - `PENDING`: Member created and is waiting for approval by site owner.
2270
+ * - `APPROVED`: Member can log in to the site.
2271
+ * - `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.
2272
+ * - `BLOCKED`: Member is blocked and cannot log in to the site.
2273
+ * - `UNKNOWN`: Insufficient permissions to get the status.
2274
+ * @readonly
2275
+ */
2276
+ status?: Status;
2277
+ /**
2278
+ * Contact ID.
2279
+ * @readonly
2280
+ */
2281
+ contactId?: string | null;
2282
+ /**
2283
+ * Member's contact information. Contact information is stored in the
2284
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
2285
+ */
2286
+ contact?: Contact;
2287
+ /** Profile display info. */
2288
+ profile?: Profile;
2289
+ /**
2290
+ * Member privacy status.
2291
+ *
2292
+ * - `PUBLIC`: Member is visible to everyone.
2293
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
2294
+ * - `UNKNOWN`: Insufficient permissions to get the status.
2295
+ */
2296
+ privacyStatus?: PrivacyStatusStatus;
2297
+ /**
2298
+ * Member activity status.
2299
+ *
2300
+ * - `ACTIVE`: Member can write forum posts and blog comments.
2301
+ * - `MUTED`: Member cannot write forum posts or blog comments.
2302
+ * - `UNKNOWN`: Insufficient permissions to get the status.
2303
+ * @readonly
2304
+ */
2305
+ activityStatus?: ActivityStatusStatus;
2306
+ /**
2307
+ * Date and time when the member was created.
2308
+ * @readonly
2309
+ */
2310
+ _createdDate?: Date;
2311
+ /**
2312
+ * Date and time when the member was updated.
2313
+ * @readonly
2314
+ */
2315
+ _updatedDate?: Date;
2316
+ /**
2317
+ * Date and time when the member last logged in to the site.
2318
+ * @readonly
2319
+ */
2320
+ lastLoginDate?: Date;
2321
+ }
2322
+ declare enum Status {
2323
+ UNKNOWN = "UNKNOWN",
2324
+ PENDING = "PENDING",
2325
+ APPROVED = "APPROVED",
2326
+ BLOCKED = "BLOCKED",
2327
+ OFFLINE = "OFFLINE"
2328
+ }
2329
+ /** Contact info associated with the member. */
2330
+ interface Contact {
2331
+ /**
2332
+ * @internal
2333
+ * @internal
2334
+ * @readonly
2335
+ * @deprecated
2336
+ */
2337
+ contactId?: string | null;
2338
+ /** Contact's first name. */
2339
+ firstName?: string | null;
2340
+ /** Contact's last name. */
2341
+ lastName?: string | null;
2342
+ /** List of phone numbers. */
2343
+ phones?: string[] | null;
2344
+ /** List of email addresses. */
2345
+ emails?: string[] | null;
2346
+ /** List of street addresses. */
2347
+ addresses?: Address[];
2348
+ /**
2349
+ * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
2350
+ *
2351
+ * Example: `"2020-03-15"` for March 15, 2020.
2352
+ */
2353
+ birthdate?: string | null;
2354
+ /** Contact's company name. */
2355
+ company?: string | null;
2356
+ /** Contact's job title. */
2357
+ jobTitle?: string | null;
2358
+ /**
2359
+ * Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.
2360
+ *
2361
+ * > **Notes:**
2362
+ * > - Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.
2363
+ * > - When updating a member, `name` is ignored.
2364
+ */
2365
+ customFields?: Record<string, CustomField>;
2366
+ }
2367
+ /** Street address. */
2368
+ interface Address extends AddressStreetOneOf {
2369
+ /** Street address object, with number and name in separate fields. */
2370
+ streetAddress?: StreetAddress;
2371
+ /** Main address line, usually street and number, as free text. */
2372
+ addressLine?: string | null;
2373
+ /**
2374
+ * Street address ID.
2375
+ * @readonly
2376
+ */
2377
+ _id?: string | null;
2378
+ /**
2379
+ * Free text providing more detailed address information,
2380
+ * such as apartment, suite, or floor.
2381
+ */
2382
+ addressLine2?: string | null;
2383
+ /** City name. */
2384
+ city?: string | null;
2385
+ /**
2386
+ * Code for a subdivision (such as state, prefecture, or province) in an
2387
+ * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
2388
+ */
2389
+ subdivision?: string | null;
2390
+ /**
2391
+ * 2-letter country code in an
2392
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
2393
+ */
2394
+ country?: string | null;
2395
+ /** Postal code. */
2396
+ postalCode?: string | null;
2397
+ }
2398
+ /** @oneof */
2399
+ interface AddressStreetOneOf {
2400
+ /** Street address object, with number and name in separate fields. */
2401
+ streetAddress?: StreetAddress;
2402
+ /** Main address line, usually street and number, as free text. */
2403
+ addressLine?: string | null;
2404
+ }
2405
+ interface StreetAddress {
2406
+ /** Street number. */
2407
+ number?: string;
2408
+ /** Street name. */
2409
+ name?: string;
2410
+ }
2411
+ interface CustomField {
2412
+ /** Custom field name. */
2413
+ name?: string | null;
2414
+ /** Custom field value. */
2415
+ value?: any;
2416
+ }
2417
+ /** Member Profile */
2418
+ interface Profile {
2419
+ /**
2420
+ * Name that identifies the member to other members.
2421
+ * Displayed on the member's profile page
2422
+ * and interactions in the forum or blog.
2423
+ */
2424
+ nickname?: string | null;
2425
+ /**
2426
+ * Slug that determines the member's profile page URL.
2427
+ * @readonly
2428
+ */
2429
+ slug?: string | null;
2430
+ /** Member's profile photo. */
2431
+ photo?: Image;
2432
+ /**
2433
+ * Member's cover photo,
2434
+ * used as a background picture in members profile page.
2435
+ *
2436
+ * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
2437
+ * When left empty, the values default to `0`.
2438
+ */
2439
+ cover?: Image;
2440
+ /**
2441
+ * Member title.
2442
+ *
2443
+ * Currently available through the API only.
2444
+ */
2445
+ title?: string | null;
2446
+ }
2447
+ interface Image {
2448
+ /**
2449
+ * Wix Media image ID,
2450
+ * set when the member selects an image from Wix Media.
2451
+ */
2452
+ _id?: string;
2453
+ /** Image URL. */
2454
+ url?: string;
2455
+ /** Original image width. */
2456
+ height?: number;
2457
+ /** Original image height. */
2458
+ width?: number;
2459
+ /**
2460
+ * X-axis offset.
2461
+ *
2462
+ * Default: `0`.
2463
+ */
2464
+ offsetX?: number | null;
2465
+ /**
2466
+ * Y-axis offset.
2467
+ *
2468
+ * Default: `0`.
2469
+ */
2470
+ offsetY?: number | null;
2471
+ }
2472
+ declare enum PrivacyStatusStatus {
2473
+ UNKNOWN = "UNKNOWN",
2474
+ PRIVATE = "PRIVATE",
2475
+ PUBLIC = "PUBLIC"
2476
+ }
2477
+ declare enum ActivityStatusStatus {
2478
+ UNKNOWN = "UNKNOWN",
2479
+ ACTIVE = "ACTIVE",
2480
+ MUTED = "MUTED"
2481
+ }
2482
+ interface UpdateMySlugRequest {
2483
+ /** New slug. */
2484
+ slug: string;
2485
+ }
2486
+ interface UpdateMySlugResponse {
2487
+ /** Updated member. */
2488
+ member?: Member;
2489
+ }
2490
+ interface JoinCommunityRequest {
2491
+ }
2492
+ /** Member profile. */
2493
+ interface JoinCommunityResponse {
2494
+ /** The updated member. */
2495
+ member?: Member;
2496
+ }
2497
+ interface LeaveCommunityRequest {
2498
+ }
2499
+ /** Member profile. */
2500
+ interface LeaveCommunityResponse {
2501
+ /** The updated member. */
2502
+ member?: Member;
2503
+ }
2504
+ interface GetMyMemberRequest {
2505
+ /**
2506
+ * Predefined set of fields to return.
2507
+ *
2508
+ * - `"FULL"`: Returns all fields.
2509
+ * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
2510
+ *
2511
+ * > **Note:**
2512
+ * > When returning the `"PUBLIC"` fieldset,
2513
+ * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
2514
+ * > are returned as `"UNKNOWN"`.
2515
+ * @deprecated
2516
+ */
2517
+ fieldSet?: Set;
2518
+ /**
2519
+ * Predefined set of fields to return. One of:
2520
+ *
2521
+ * - `FULL`: Returns all fields.
2522
+ * - `PUBLIC`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
2523
+ * - `EXTENDED`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
2524
+ *
2525
+ * Default: `PUBLIC`.
2526
+ */
2527
+ fieldsets?: Set[];
2528
+ }
2529
+ declare enum Set {
2530
+ /** Public properties of the entity */
2531
+ PUBLIC = "PUBLIC",
2532
+ /** Extended properties of the entity */
2533
+ EXTENDED = "EXTENDED",
2534
+ /** Full entity defined in the doc */
2535
+ FULL = "FULL"
2536
+ }
2537
+ /** Member profile. */
2538
+ interface GetMyMemberResponse {
2539
+ /** The logged-in member. */
2540
+ member?: Member;
2541
+ }
2542
+ interface GetMemberRequest {
2543
+ /** Member ID. */
2544
+ _id: string;
2545
+ /**
2546
+ * Predefined set of fields to return. One of:
2547
+ * - `"FULL"`: Returns all fields.
2548
+ * - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
2549
+ * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
2550
+ *
2551
+ *
2552
+ */
2553
+ fieldsets?: Set[];
2554
+ }
2555
+ interface GetMemberResponse {
2556
+ /** The requested member. */
2557
+ member?: Member;
2558
+ }
2559
+ interface ListMembersRequest {
2560
+ paging?: Paging;
2561
+ /**
2562
+ * Predefined set of fields to return. One of:
2563
+ * - `"FULL"`: Returns all fields.
2564
+ * - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
2565
+ * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
2566
+ *
2567
+ * Default: `"PUBLIC"`.
2568
+ */
2569
+ fieldsets?: Set[];
2570
+ sorting?: Sorting[];
2571
+ }
2572
+ interface Paging {
2573
+ /** Number of items to load. */
2574
+ limit?: number | null;
2575
+ /** Number of items to skip in the current sort order. */
2576
+ offset?: number | null;
2577
+ }
2578
+ interface Sorting {
2579
+ /** Name of the field to sort by. */
2580
+ fieldName?: string;
2581
+ /** Sort order. */
2582
+ order?: SortOrder;
2583
+ }
2584
+ declare enum SortOrder {
2585
+ ASC = "ASC",
2586
+ DESC = "DESC"
2587
+ }
2588
+ interface ListMembersResponse {
2589
+ /** List of members. */
2590
+ members?: Member[];
2591
+ /** Metadata for the paginated results. */
2592
+ metadata?: PagingMetadata;
2593
+ }
2594
+ interface PagingMetadata {
2595
+ /** Number of items returned in the response. */
2596
+ count?: number | null;
2597
+ /** Offset that was requested. */
2598
+ offset?: number | null;
2599
+ /** Total number of items that match the query. */
2600
+ total?: number | null;
2601
+ /** Flag that indicates the server failed to calculate the `total` field. */
2602
+ tooManyToCount?: boolean | null;
2603
+ }
2604
+ interface QueryMembersRequest {
2605
+ /** Query options. */
2606
+ query?: Query;
2607
+ /**
2608
+ * Predefined sets of fields to return.
2609
+ *
2610
+ * Defaults to `PUBLIC`.
2611
+ */
2612
+ fieldsets?: Set[];
2613
+ /** Plain text search. */
2614
+ search?: Search;
2615
+ }
2616
+ interface Query {
2617
+ /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
2618
+ filter?: any;
2619
+ /** Limit number of results */
2620
+ paging?: Paging;
2621
+ /** Sort the results */
2622
+ sorting?: Sorting[];
2623
+ }
2624
+ /** Free text to match in searchable fields */
2625
+ interface Search {
2626
+ /** Search term or expression */
2627
+ expression?: string | null;
2628
+ /**
2629
+ * Currently supported fields for search:
2630
+ *
2631
+ * - `loginEmail`
2632
+ * - `contact.firstName`
2633
+ * - `contact.lastName`
2634
+ * - `profile.title`
2635
+ * - `profile.nickname`
2636
+ * - `profile.slug`
2637
+ *
2638
+ * Default is `profile.nickname`
2639
+ */
2640
+ fields?: string[];
2641
+ }
2642
+ interface QueryMembersResponse {
2643
+ /** List of members that met the query filter criteria. */
2644
+ members?: Member[];
2645
+ /** Metadata for the paginated results. */
2646
+ metadata?: PagingMetadata;
2647
+ }
2648
+ interface DeleteMemberRequest {
2649
+ /** ID of the member to delete. */
2650
+ _id: string;
2651
+ }
2652
+ interface DeleteMemberResponse {
2653
+ }
2654
+ interface CreateMemberRequest {
2655
+ /** Member to create. */
2656
+ member?: Member;
2657
+ }
2658
+ interface CreateMemberResponse {
2659
+ /** New member. */
2660
+ member?: Member;
2661
+ }
2662
+ interface UpdateMemberRequest {
2663
+ /** Member to update. */
2664
+ member?: Member;
2665
+ }
2666
+ interface UpdateMemberResponse {
2667
+ member?: Member;
2668
+ }
2669
+ interface DeleteMemberPhonesRequest {
2670
+ /** ID of the member whose phone numbers will be deleted. */
2671
+ _id: string;
2672
+ }
2673
+ interface DeleteMemberPhonesResponse {
2674
+ /** Updated member. */
2675
+ member?: Member;
2676
+ }
2677
+ interface DeleteMemberEmailsRequest {
2678
+ /** ID of the member whose email addresses will be deleted. */
2679
+ _id: string;
2680
+ }
2681
+ interface DeleteMemberEmailsResponse {
2682
+ /** Updated member. */
2683
+ member?: Member;
2684
+ }
2685
+ interface DeleteMemberAddressesRequest {
2686
+ /** ID of the member whose street addresses will be deleted. */
2687
+ _id: string;
2688
+ }
2689
+ interface DeleteMemberAddressesResponse {
2690
+ /** Updated member. */
2691
+ member?: Member;
2692
+ }
2693
+ interface UpdateMySlugResponseNonNullableFields {
2694
+ member?: {
2695
+ status: Status;
2696
+ contact?: {
2697
+ addresses: {
2698
+ streetAddress?: {
2699
+ number: string;
2700
+ name: string;
2701
+ };
2702
+ }[];
2703
+ };
2704
+ profile?: {
2705
+ photo?: {
2706
+ _id: string;
2707
+ url: string;
2708
+ height: number;
2709
+ width: number;
2710
+ };
2711
+ cover?: {
2712
+ _id: string;
2713
+ url: string;
2714
+ height: number;
2715
+ width: number;
2716
+ };
2717
+ };
2718
+ privacyStatus: PrivacyStatusStatus;
2719
+ activityStatus: ActivityStatusStatus;
2720
+ };
2721
+ }
2722
+ interface JoinCommunityResponseNonNullableFields {
2723
+ member?: {
2724
+ status: Status;
2725
+ contact?: {
2726
+ addresses: {
2727
+ streetAddress?: {
2728
+ number: string;
2729
+ name: string;
2730
+ };
2731
+ }[];
2732
+ };
2733
+ profile?: {
2734
+ photo?: {
2735
+ _id: string;
2736
+ url: string;
2737
+ height: number;
2738
+ width: number;
2739
+ };
2740
+ cover?: {
2741
+ _id: string;
2742
+ url: string;
2743
+ height: number;
2744
+ width: number;
2745
+ };
2746
+ };
2747
+ privacyStatus: PrivacyStatusStatus;
2748
+ activityStatus: ActivityStatusStatus;
2749
+ };
2750
+ }
2751
+ interface LeaveCommunityResponseNonNullableFields {
2752
+ member?: {
2753
+ status: Status;
2754
+ contact?: {
2755
+ addresses: {
2756
+ streetAddress?: {
2757
+ number: string;
2758
+ name: string;
2759
+ };
2760
+ }[];
2761
+ };
2762
+ profile?: {
2763
+ photo?: {
2764
+ _id: string;
2765
+ url: string;
2766
+ height: number;
2767
+ width: number;
2768
+ };
2769
+ cover?: {
2770
+ _id: string;
2771
+ url: string;
2772
+ height: number;
2773
+ width: number;
2774
+ };
2775
+ };
2776
+ privacyStatus: PrivacyStatusStatus;
2777
+ activityStatus: ActivityStatusStatus;
2778
+ };
2779
+ }
2780
+ interface GetMyMemberResponseNonNullableFields {
2781
+ member?: {
2782
+ status: Status;
2783
+ contact?: {
2784
+ addresses: {
2785
+ streetAddress?: {
2786
+ number: string;
2787
+ name: string;
2788
+ };
2789
+ }[];
2790
+ };
2791
+ profile?: {
2792
+ photo?: {
2793
+ _id: string;
2794
+ url: string;
2795
+ height: number;
2796
+ width: number;
2797
+ };
2798
+ cover?: {
2799
+ _id: string;
2800
+ url: string;
2801
+ height: number;
2802
+ width: number;
2803
+ };
2804
+ };
2805
+ privacyStatus: PrivacyStatusStatus;
2806
+ activityStatus: ActivityStatusStatus;
2807
+ };
2808
+ }
2809
+ interface GetMemberResponseNonNullableFields {
2810
+ member?: {
2811
+ status: Status;
2812
+ contact?: {
2813
+ addresses: {
2814
+ streetAddress?: {
2815
+ number: string;
2816
+ name: string;
2817
+ };
2818
+ }[];
2819
+ };
2820
+ profile?: {
2821
+ photo?: {
2822
+ _id: string;
2823
+ url: string;
2824
+ height: number;
2825
+ width: number;
2826
+ };
2827
+ cover?: {
2828
+ _id: string;
2829
+ url: string;
2830
+ height: number;
2831
+ width: number;
2832
+ };
2833
+ };
2834
+ privacyStatus: PrivacyStatusStatus;
2835
+ activityStatus: ActivityStatusStatus;
2836
+ };
2837
+ }
2838
+ interface ListMembersResponseNonNullableFields {
2839
+ members: {
2840
+ status: Status;
2841
+ contact?: {
2842
+ addresses: {
2843
+ streetAddress?: {
2844
+ number: string;
2845
+ name: string;
2846
+ };
2847
+ }[];
2848
+ };
2849
+ profile?: {
2850
+ photo?: {
2851
+ _id: string;
2852
+ url: string;
2853
+ height: number;
2854
+ width: number;
2855
+ };
2856
+ cover?: {
2857
+ _id: string;
2858
+ url: string;
2859
+ height: number;
2860
+ width: number;
2861
+ };
2862
+ };
2863
+ privacyStatus: PrivacyStatusStatus;
2864
+ activityStatus: ActivityStatusStatus;
2865
+ }[];
2866
+ }
2867
+ interface QueryMembersResponseNonNullableFields {
2868
+ members: {
2869
+ status: Status;
2870
+ contact?: {
2871
+ addresses: {
2872
+ streetAddress?: {
2873
+ number: string;
2874
+ name: string;
2875
+ };
2876
+ }[];
2877
+ };
2878
+ profile?: {
2879
+ photo?: {
2880
+ _id: string;
2881
+ url: string;
2882
+ height: number;
2883
+ width: number;
2884
+ };
2885
+ cover?: {
2886
+ _id: string;
2887
+ url: string;
2888
+ height: number;
2889
+ width: number;
2890
+ };
2891
+ };
2892
+ privacyStatus: PrivacyStatusStatus;
2893
+ activityStatus: ActivityStatusStatus;
2894
+ }[];
2895
+ }
2896
+ interface CreateMemberResponseNonNullableFields {
2897
+ member?: {
2898
+ status: Status;
2899
+ contact?: {
2900
+ addresses: {
2901
+ streetAddress?: {
2902
+ number: string;
2903
+ name: string;
2904
+ };
2905
+ }[];
2906
+ };
2907
+ profile?: {
2908
+ photo?: {
2909
+ _id: string;
2910
+ url: string;
2911
+ height: number;
2912
+ width: number;
2913
+ };
2914
+ cover?: {
2915
+ _id: string;
2916
+ url: string;
2917
+ height: number;
2918
+ width: number;
2919
+ };
2920
+ };
2921
+ privacyStatus: PrivacyStatusStatus;
2922
+ activityStatus: ActivityStatusStatus;
2923
+ };
2924
+ }
2925
+ interface UpdateMemberResponseNonNullableFields {
2926
+ member?: {
2927
+ status: Status;
2928
+ contact?: {
2929
+ addresses: {
2930
+ streetAddress?: {
2931
+ number: string;
2932
+ name: string;
2933
+ };
2934
+ }[];
2935
+ };
2936
+ profile?: {
2937
+ photo?: {
2938
+ _id: string;
2939
+ url: string;
2940
+ height: number;
2941
+ width: number;
2942
+ };
2943
+ cover?: {
2944
+ _id: string;
2945
+ url: string;
2946
+ height: number;
2947
+ width: number;
2948
+ };
2949
+ };
2950
+ privacyStatus: PrivacyStatusStatus;
2951
+ activityStatus: ActivityStatusStatus;
2952
+ };
2953
+ }
2954
+ interface DeleteMemberPhonesResponseNonNullableFields {
2955
+ member?: {
2956
+ status: Status;
2957
+ contact?: {
2958
+ addresses: {
2959
+ streetAddress?: {
2960
+ number: string;
2961
+ name: string;
2962
+ };
2963
+ }[];
2964
+ };
2965
+ profile?: {
2966
+ photo?: {
2967
+ _id: string;
2968
+ url: string;
2969
+ height: number;
2970
+ width: number;
2971
+ };
2972
+ cover?: {
2973
+ _id: string;
2974
+ url: string;
2975
+ height: number;
2976
+ width: number;
2977
+ };
2978
+ };
2979
+ privacyStatus: PrivacyStatusStatus;
2980
+ activityStatus: ActivityStatusStatus;
2981
+ };
2982
+ }
2983
+ interface DeleteMemberEmailsResponseNonNullableFields {
2984
+ member?: {
2985
+ status: Status;
2986
+ contact?: {
2987
+ addresses: {
2988
+ streetAddress?: {
2989
+ number: string;
2990
+ name: string;
2991
+ };
2992
+ }[];
2993
+ };
2994
+ profile?: {
2995
+ photo?: {
2996
+ _id: string;
2997
+ url: string;
2998
+ height: number;
2999
+ width: number;
3000
+ };
3001
+ cover?: {
3002
+ _id: string;
3003
+ url: string;
3004
+ height: number;
3005
+ width: number;
3006
+ };
3007
+ };
3008
+ privacyStatus: PrivacyStatusStatus;
3009
+ activityStatus: ActivityStatusStatus;
3010
+ };
3011
+ }
3012
+ interface DeleteMemberAddressesResponseNonNullableFields {
3013
+ member?: {
3014
+ status: Status;
3015
+ contact?: {
3016
+ addresses: {
3017
+ streetAddress?: {
3018
+ number: string;
3019
+ name: string;
3020
+ };
3021
+ }[];
3022
+ };
3023
+ profile?: {
3024
+ photo?: {
3025
+ _id: string;
3026
+ url: string;
3027
+ height: number;
3028
+ width: number;
3029
+ };
3030
+ cover?: {
3031
+ _id: string;
3032
+ url: string;
3033
+ height: number;
3034
+ width: number;
3035
+ };
3036
+ };
3037
+ privacyStatus: PrivacyStatusStatus;
3038
+ activityStatus: ActivityStatusStatus;
3039
+ };
3040
+ }
3041
+
3042
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3043
+ getUrl: (context: any) => string;
3044
+ httpMethod: K;
3045
+ path: string;
3046
+ pathParams: M;
3047
+ __requestType: T;
3048
+ __originalRequestType: S;
3049
+ __responseType: Q;
3050
+ __originalResponseType: R;
3051
+ };
3052
+ declare function updateCurrentMemberSlug(): __PublicMethodMetaInfo<'POST', {}, UpdateMySlugRequest, UpdateMySlugRequest$1, UpdateMySlugResponse & UpdateMySlugResponseNonNullableFields, UpdateMySlugResponse$1 & UpdateMySlugResponseNonNullableFields$1>;
3053
+ declare function joinCommunity(): __PublicMethodMetaInfo<'POST', {}, JoinCommunityRequest, JoinCommunityRequest$1, JoinCommunityResponse & JoinCommunityResponseNonNullableFields, JoinCommunityResponse$1 & JoinCommunityResponseNonNullableFields$1>;
3054
+ declare function leaveCommunity(): __PublicMethodMetaInfo<'POST', {}, LeaveCommunityRequest, LeaveCommunityRequest$1, LeaveCommunityResponse & LeaveCommunityResponseNonNullableFields, LeaveCommunityResponse$1 & LeaveCommunityResponseNonNullableFields$1>;
3055
+ declare function getCurrentMember(): __PublicMethodMetaInfo<'GET', {}, GetMyMemberRequest, GetMyMemberRequest$1, GetMyMemberResponse & GetMyMemberResponseNonNullableFields, GetMyMemberResponse$1 & GetMyMemberResponseNonNullableFields$1>;
3056
+ declare function getMember(): __PublicMethodMetaInfo<'GET', {
3057
+ id: string;
3058
+ }, GetMemberRequest, GetMemberRequest$1, GetMemberResponse & GetMemberResponseNonNullableFields, GetMemberResponse$1 & GetMemberResponseNonNullableFields$1>;
3059
+ declare function listMembers(): __PublicMethodMetaInfo<'GET', {}, ListMembersRequest, ListMembersRequest$1, ListMembersResponse & ListMembersResponseNonNullableFields, ListMembersResponse$1 & ListMembersResponseNonNullableFields$1>;
3060
+ declare function queryMembers(): __PublicMethodMetaInfo<'POST', {}, QueryMembersRequest, QueryMembersRequest$1, QueryMembersResponse & QueryMembersResponseNonNullableFields, QueryMembersResponse$1 & QueryMembersResponseNonNullableFields$1>;
3061
+ declare function deleteMember(): __PublicMethodMetaInfo<'DELETE', {
3062
+ id: string;
3063
+ }, DeleteMemberRequest, DeleteMemberRequest$1, DeleteMemberResponse, DeleteMemberResponse$1>;
3064
+ declare function createMember(): __PublicMethodMetaInfo<'POST', {}, CreateMemberRequest, CreateMemberRequest$1, CreateMemberResponse & CreateMemberResponseNonNullableFields, CreateMemberResponse$1 & CreateMemberResponseNonNullableFields$1>;
3065
+ declare function updateMember(): __PublicMethodMetaInfo<'PATCH', {
3066
+ memberId: string;
3067
+ }, UpdateMemberRequest, UpdateMemberRequest$1, UpdateMemberResponse & UpdateMemberResponseNonNullableFields, UpdateMemberResponse$1 & UpdateMemberResponseNonNullableFields$1>;
3068
+ declare function deleteMemberPhones(): __PublicMethodMetaInfo<'DELETE', {
3069
+ id: string;
3070
+ }, DeleteMemberPhonesRequest, DeleteMemberPhonesRequest$1, DeleteMemberPhonesResponse & DeleteMemberPhonesResponseNonNullableFields, DeleteMemberPhonesResponse$1 & DeleteMemberPhonesResponseNonNullableFields$1>;
3071
+ declare function deleteMemberEmails(): __PublicMethodMetaInfo<'DELETE', {
3072
+ id: string;
3073
+ }, DeleteMemberEmailsRequest, DeleteMemberEmailsRequest$1, DeleteMemberEmailsResponse & DeleteMemberEmailsResponseNonNullableFields, DeleteMemberEmailsResponse$1 & DeleteMemberEmailsResponseNonNullableFields$1>;
3074
+ declare function deleteMemberAddresses(): __PublicMethodMetaInfo<'DELETE', {
3075
+ id: string;
3076
+ }, DeleteMemberAddressesRequest, DeleteMemberAddressesRequest$1, DeleteMemberAddressesResponse & DeleteMemberAddressesResponseNonNullableFields, DeleteMemberAddressesResponse$1 & DeleteMemberAddressesResponseNonNullableFields$1>;
3077
+
3078
+ type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
3079
+ declare const meta_createMember: typeof createMember;
3080
+ declare const meta_deleteMember: typeof deleteMember;
3081
+ declare const meta_deleteMemberAddresses: typeof deleteMemberAddresses;
3082
+ declare const meta_deleteMemberEmails: typeof deleteMemberEmails;
3083
+ declare const meta_deleteMemberPhones: typeof deleteMemberPhones;
3084
+ declare const meta_getCurrentMember: typeof getCurrentMember;
3085
+ declare const meta_getMember: typeof getMember;
3086
+ declare const meta_joinCommunity: typeof joinCommunity;
3087
+ declare const meta_leaveCommunity: typeof leaveCommunity;
3088
+ declare const meta_listMembers: typeof listMembers;
3089
+ declare const meta_queryMembers: typeof queryMembers;
3090
+ declare const meta_updateCurrentMemberSlug: typeof updateCurrentMemberSlug;
3091
+ declare const meta_updateMember: typeof updateMember;
3092
+ declare namespace meta {
3093
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createMember as createMember, meta_deleteMember as deleteMember, meta_deleteMemberAddresses as deleteMemberAddresses, meta_deleteMemberEmails as deleteMemberEmails, meta_deleteMemberPhones as deleteMemberPhones, meta_getCurrentMember as getCurrentMember, meta_getMember as getMember, meta_joinCommunity as joinCommunity, meta_leaveCommunity as leaveCommunity, meta_listMembers as listMembers, meta_queryMembers as queryMembers, meta_updateCurrentMemberSlug as updateCurrentMemberSlug, meta_updateMember as updateMember };
3094
+ }
3095
+
3096
+ export { meta$1 as authentication, meta$2 as badges, meta as members };