@wix/members 1.0.11 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +2 -1
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/src/badges-v3-badge.universal.d.ts +12 -0
  5. package/build/cjs/src/badges-v3-badge.universal.js +12 -0
  6. package/build/cjs/src/badges-v3-badge.universal.js.map +1 -1
  7. package/build/cjs/src/members-v1-member.http.d.ts +167 -0
  8. package/build/cjs/src/members-v1-member.http.js +494 -0
  9. package/build/cjs/src/members-v1-member.http.js.map +1 -0
  10. package/build/cjs/src/members-v1-member.public.d.ts +17 -0
  11. package/build/cjs/src/members-v1-member.public.js +76 -0
  12. package/build/cjs/src/members-v1-member.public.js.map +1 -0
  13. package/build/cjs/src/members-v1-member.types.d.ts +931 -0
  14. package/build/cjs/src/members-v1-member.types.js +121 -0
  15. package/build/cjs/src/members-v1-member.types.js.map +1 -0
  16. package/build/cjs/src/members-v1-member.universal.d.ts +1379 -0
  17. package/build/cjs/src/members-v1-member.universal.js +842 -0
  18. package/build/cjs/src/members-v1-member.universal.js.map +1 -0
  19. package/build/es/index.d.ts +1 -0
  20. package/build/es/index.js +1 -0
  21. package/build/es/index.js.map +1 -1
  22. package/build/es/src/badges-v3-badge.universal.d.ts +12 -0
  23. package/build/es/src/badges-v3-badge.universal.js +12 -0
  24. package/build/es/src/badges-v3-badge.universal.js.map +1 -1
  25. package/build/es/src/members-v1-member.http.d.ts +167 -0
  26. package/build/es/src/members-v1-member.http.js +481 -0
  27. package/build/es/src/members-v1-member.http.js.map +1 -0
  28. package/build/es/src/members-v1-member.public.d.ts +17 -0
  29. package/build/es/src/members-v1-member.public.js +54 -0
  30. package/build/es/src/members-v1-member.public.js.map +1 -0
  31. package/build/es/src/members-v1-member.types.d.ts +931 -0
  32. package/build/es/src/members-v1-member.types.js +118 -0
  33. package/build/es/src/members-v1-member.types.js.map +1 -0
  34. package/build/es/src/members-v1-member.universal.d.ts +1379 -0
  35. package/build/es/src/members-v1-member.universal.js +810 -0
  36. package/build/es/src/members-v1-member.universal.js.map +1 -0
  37. package/package.json +2 -2
@@ -0,0 +1,1379 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ export interface Member {
8
+ /**
9
+ * Member ID.
10
+ * @readonly
11
+ */
12
+ _id?: string | null;
13
+ /** Email used by the member to log in to the site. */
14
+ loginEmail?: string | null;
15
+ /**
16
+ * Member site access status.
17
+ * <!--ONLY:REST-->
18
+ * - `PENDING`: Member created and is waiting for approval by site owner.
19
+ * - `APPROVED`: Member can log in to the site.
20
+ * - `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.
21
+ * - `BLOCKED`: Member is blocked and cannot log in to the site.
22
+ * - `UNKNOWN`: Insufficient permissions to get the status.
23
+ * <!--END:ONLY:REST-->
24
+ *
25
+ * <!--ONLY:VELO
26
+ * One of:
27
+ *
28
+ * - `"PENDING"`: Member created and is waiting for approval by site owner.
29
+ * - `"APPROVED"`: Member can log in to the site.
30
+ * - `"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.
31
+ * - `"BLOCKED"`: Member is blocked and cannot log in to the site.
32
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
33
+ * <!--END:ONLY:VELO-->
34
+ * @readonly
35
+ */
36
+ status?: Status;
37
+ /**
38
+ * Contact ID.
39
+ * @readonly
40
+ */
41
+ contactId?: string | null;
42
+ /**
43
+ * Member's contact information. Contact information is stored in the
44
+ * [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).
45
+ *
46
+ * <!--ONLY:REST-->
47
+ * The full set of contact data can be accessed and managed with the
48
+ * [Contacts API](https://dev.wix.com/api/rest/contacts/contacts).
49
+ * <!--END:ONLY:REST-->
50
+ */
51
+ contact?: Contact;
52
+ /** Profile display info. */
53
+ profile?: Profile;
54
+ /**
55
+ * Member privacy status.
56
+ *
57
+ * <!--ONLY:REST-->
58
+ * - `PUBLIC`: Member is visible to everyone.
59
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
60
+ * - `UNKNOWN`: Insufficient permissions to get the status.
61
+ * <!--END:ONLY:REST-->
62
+ *
63
+ * <!--ONLY:VELO
64
+ * One of:
65
+ *
66
+ * - `"PUBLIC"`: Member is visible to everyone.
67
+ * - `"PRIVATE"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
68
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
69
+ * <!--END:ONLY:VELO-->
70
+ */
71
+ privacyStatus?: PrivacyStatusStatus;
72
+ /**
73
+ * Member activity status.
74
+ *
75
+ * <!--ONLY:REST-->
76
+ * - `ACTIVE`: Member can write forum posts and blog comments.
77
+ * - `MUTED`: Member cannot write forum posts or blog comments.
78
+ * - `UNKNOWN`: Insufficient permissions to get the status.
79
+ * <!--END:ONLY:REST-->
80
+ *
81
+ * <!--ONLY:VELO
82
+ * One of:
83
+ *
84
+ * - `"ACTIVE"`: Member can write forum posts and blog comments.
85
+ * - `"MUTED"`: Member cannot write forum posts or blog comments.
86
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
87
+ * <!--END:ONLY:VELO-->
88
+ * @readonly
89
+ */
90
+ activityStatus?: ActivityStatusStatus;
91
+ /**
92
+ * Date and time when the member was created.
93
+ * @readonly
94
+ */
95
+ _createdDate?: Date;
96
+ /**
97
+ * Date and time when the member was updated.
98
+ * @readonly
99
+ */
100
+ _updatedDate?: Date;
101
+ /**
102
+ * Date and time when the member last logged in to the site.
103
+ * @readonly
104
+ */
105
+ lastLoginDate?: Date;
106
+ }
107
+ export declare enum Status {
108
+ UNKNOWN = "UNKNOWN",
109
+ PENDING = "PENDING",
110
+ APPROVED = "APPROVED",
111
+ BLOCKED = "BLOCKED",
112
+ OFFLINE = "OFFLINE"
113
+ }
114
+ /** Contact info associated with the member. */
115
+ export interface Contact {
116
+ /**
117
+ * Contact ID.
118
+ *
119
+ * > **Deprecation notice:**
120
+ * > This property has been replaced with `member.contactId`
121
+ * > and will be removed on June 11, 2021.
122
+ * @readonly
123
+ */
124
+ contactId?: string | null;
125
+ /** Contact's first name. */
126
+ firstName?: string | null;
127
+ /** Contact's last name. */
128
+ lastName?: string | null;
129
+ /** List of phone numbers. */
130
+ phones?: string[] | null;
131
+ /** List of email addresses. */
132
+ emails?: string[] | null;
133
+ /** List of street addresses. */
134
+ addresses?: Address[];
135
+ /**
136
+ * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
137
+ *
138
+ * Example: `"2020-03-15"` for March 15, 2020.
139
+ */
140
+ birthdate?: string | null;
141
+ /** Contact's company name. */
142
+ company?: string | null;
143
+ /** Contact's job title. */
144
+ jobTitle?: string | null;
145
+ /**
146
+ * Custom fields,
147
+ * where each key is the field key,
148
+ * and each value is the field's value for the member.
149
+ */
150
+ customFields?: Record<string, CustomField>;
151
+ }
152
+ /** Street address. */
153
+ export interface Address extends AddressStreetOneOf {
154
+ /** Street address object, with number and name in separate fields. */
155
+ streetAddress?: StreetAddress;
156
+ /** Main address line, usually street and number, as free text. */
157
+ addressLine?: string | null;
158
+ /**
159
+ * Street address ID.
160
+ * @readonly
161
+ */
162
+ _id?: string | null;
163
+ /**
164
+ * Free text providing more detailed address information,
165
+ * such as apartment, suite, or floor.
166
+ */
167
+ addressLine2?: string | null;
168
+ /** City name. */
169
+ city?: string | null;
170
+ /**
171
+ * Code for a subdivision (such as state, prefecture, or province) in an
172
+ * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
173
+ */
174
+ subdivision?: string | null;
175
+ /**
176
+ * 2-letter country code in an
177
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
178
+ */
179
+ country?: string | null;
180
+ /** Postal code. */
181
+ postalCode?: string | null;
182
+ }
183
+ /** @oneof */
184
+ export interface AddressStreetOneOf {
185
+ /** Street address object, with number and name in separate fields. */
186
+ streetAddress?: StreetAddress;
187
+ /** Main address line, usually street and number, as free text. */
188
+ addressLine?: string | null;
189
+ }
190
+ export interface StreetAddress {
191
+ /** Street number. */
192
+ number?: string;
193
+ /** Street name. */
194
+ name?: string;
195
+ }
196
+ export interface CustomField {
197
+ /** Custom field name. */
198
+ name?: string | null;
199
+ /** Custom field value. */
200
+ value?: any;
201
+ }
202
+ /** Member Profile */
203
+ export interface Profile {
204
+ /**
205
+ * Name that identifies the member to other members.
206
+ * Displayed on the member's profile page
207
+ * and interactions in the forum or blog.
208
+ */
209
+ nickname?: string | null;
210
+ /**
211
+ * Slug that determines the member's profile page URL.
212
+ * @readonly
213
+ */
214
+ slug?: string | null;
215
+ /** Member's profile photo. */
216
+ photo?: Image;
217
+ /**
218
+ * Member's cover photo,
219
+ * used as a background picture in members profile page.
220
+ *
221
+ * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
222
+ * When left empty, the values default to `0`.
223
+ */
224
+ cover?: Image;
225
+ /**
226
+ * Member title.
227
+ *
228
+ * <!--ONLY:REST-->
229
+ * Currently available through the API only.
230
+ * <!--END:ONLY:REST-->
231
+ */
232
+ title?: string | null;
233
+ }
234
+ export interface Image {
235
+ /**
236
+ * Wix Media image ID,
237
+ * set when the member selects an image from Wix Media.
238
+ */
239
+ _id?: string;
240
+ /** Image URL. */
241
+ url?: string;
242
+ /** Original image width. */
243
+ height?: number;
244
+ /** Original image height. */
245
+ width?: number;
246
+ /**
247
+ * X-axis offset.
248
+ *
249
+ * Defaults to `0`.
250
+ */
251
+ offsetX?: number | null;
252
+ /**
253
+ * Y-axis offset.
254
+ *
255
+ * Defaults to `0`.
256
+ */
257
+ offsetY?: number | null;
258
+ }
259
+ export declare enum PrivacyStatusStatus {
260
+ UNKNOWN = "UNKNOWN",
261
+ PRIVATE = "PRIVATE",
262
+ PUBLIC = "PUBLIC"
263
+ }
264
+ export declare enum ActivityStatusStatus {
265
+ UNKNOWN = "UNKNOWN",
266
+ ACTIVE = "ACTIVE",
267
+ MUTED = "MUTED"
268
+ }
269
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
270
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
271
+ metaSiteId?: string;
272
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
273
+ siteId?: string;
274
+ /** Invalidate by App */
275
+ app?: App;
276
+ /** Invalidate by page id */
277
+ page?: Page;
278
+ /** Invalidate by URI path */
279
+ uri?: URI;
280
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
281
+ reason?: string | null;
282
+ /** Is local DS */
283
+ localDc?: boolean;
284
+ }
285
+ /** @oneof */
286
+ export interface InvalidateCacheGetByOneOf {
287
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
288
+ metaSiteId?: string;
289
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
290
+ siteId?: string;
291
+ /** Invalidate by App */
292
+ app?: App;
293
+ /** Invalidate by page id */
294
+ page?: Page;
295
+ /** Invalidate by URI path */
296
+ uri?: URI;
297
+ }
298
+ export interface App {
299
+ /** The AppDefId */
300
+ appDefId?: string;
301
+ /** The instance Id */
302
+ instanceId?: string;
303
+ }
304
+ export interface Page {
305
+ /** the msid the page is on */
306
+ metaSiteId?: string;
307
+ /** Invalidate by Page ID */
308
+ pageId?: string;
309
+ }
310
+ export interface URI {
311
+ /** the msid the URI is on */
312
+ metaSiteId?: string;
313
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
314
+ uriPath?: string;
315
+ }
316
+ export interface UpdateMySlugRequest {
317
+ /** New slug. */
318
+ slug?: string;
319
+ }
320
+ export interface UpdateMySlugResponse {
321
+ /** Updated member. */
322
+ member?: Member;
323
+ }
324
+ export interface SlugAlreadyExistsPayload {
325
+ slug?: string;
326
+ }
327
+ export interface UpdateMemberSlugRequest {
328
+ /** ID of the member whose slug will be updated. */
329
+ _id?: string;
330
+ /** New slug. */
331
+ slug?: string;
332
+ }
333
+ export interface UpdateMemberSlugResponse {
334
+ /** Updated member. */
335
+ member?: Member;
336
+ }
337
+ export interface JoinCommunityRequest {
338
+ }
339
+ /** Member profile. */
340
+ export interface JoinCommunityResponse {
341
+ /** The updated member. */
342
+ member?: Member;
343
+ }
344
+ export interface MemberJoinedCommunity {
345
+ /**
346
+ * Member id who joined the community
347
+ * @readonly
348
+ */
349
+ memberId?: string;
350
+ }
351
+ export interface LeaveCommunityRequest {
352
+ }
353
+ /** Member profile. */
354
+ export interface LeaveCommunityResponse {
355
+ /** The updated member. */
356
+ member?: Member;
357
+ }
358
+ export interface MemberLeftCommunity {
359
+ /**
360
+ * Member id who left the community
361
+ * @readonly
362
+ */
363
+ memberId?: string;
364
+ }
365
+ export interface GetMyMemberRequest {
366
+ /**
367
+ * Predefined set of fields to return.
368
+ *
369
+ * <!--ONLY:VELO
370
+ * One of:
371
+ *
372
+ * - `"FULL"`: Returns all fields.
373
+ * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
374
+ *
375
+ * > **Note:**
376
+ * > When returning the `"PUBLIC"` fieldset,
377
+ * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
378
+ * > are returned as `"UNKNOWN"`.
379
+ * <!--END:ONLY:VELO-->
380
+ */
381
+ fieldSet?: Set;
382
+ fieldsets?: Set[];
383
+ }
384
+ export declare enum Set {
385
+ /** Public properties of the entity */
386
+ PUBLIC = "PUBLIC",
387
+ /** Extended properties of the entity */
388
+ EXTENDED = "EXTENDED",
389
+ /** Full entity defined in the doc */
390
+ FULL = "FULL"
391
+ }
392
+ /** Member profile. */
393
+ export interface GetMyMemberResponse {
394
+ /** The requested member. */
395
+ member?: Member;
396
+ }
397
+ export interface GetMemberRequest {
398
+ /** Member ID. */
399
+ _id: string;
400
+ /**
401
+ * Predefined set of fields to return.
402
+ *
403
+ * Defaults to `PUBLIC`.
404
+ *
405
+ * __Deprecated.__ Use `fieldsets` instead.
406
+ * This property will be removed on March 31, 2023.
407
+ */
408
+ fieldSet?: Set;
409
+ /**
410
+ * Predefined set of fields to return.
411
+ *
412
+ * Defaults to `PUBLIC`.
413
+ */
414
+ fieldsets?: Set[];
415
+ }
416
+ export interface GetMemberResponse {
417
+ /** The requested member. */
418
+ member?: Member;
419
+ }
420
+ export interface MemberToMemberBlockedPayload {
421
+ /** Member ID. */
422
+ memberId?: string;
423
+ }
424
+ export interface ListMembersRequest {
425
+ paging?: Paging;
426
+ /**
427
+ * Predefined sets of fields to return.
428
+ *
429
+ * Defaults to `PUBLIC`.
430
+ *
431
+ * __Deprecated.__ Use `fieldsets` instead.
432
+ * This property will be removed on March 31, 2023.
433
+ */
434
+ fieldSet?: Set;
435
+ /**
436
+ * Predefined sets of fields to return.
437
+ *
438
+ * Defaults to `PUBLIC`.
439
+ */
440
+ fieldsets?: Set[];
441
+ sorting?: Sorting[];
442
+ }
443
+ export interface Paging {
444
+ /** Number of items to load. */
445
+ limit?: number | null;
446
+ /** Number of items to skip in the current sort order. */
447
+ offset?: number | null;
448
+ }
449
+ export interface Sorting {
450
+ /** Name of the field to sort by. */
451
+ fieldName?: string;
452
+ /** Sort order. */
453
+ order?: SortOrder;
454
+ }
455
+ export declare enum SortOrder {
456
+ ASC = "ASC",
457
+ DESC = "DESC"
458
+ }
459
+ export interface ListMembersResponse {
460
+ /** List of members. */
461
+ members?: Member[];
462
+ /** Metadata for the paginated results. */
463
+ metadata?: PagingMetadata;
464
+ }
465
+ export interface PagingMetadata {
466
+ /** Number of items returned in the response. */
467
+ count?: number | null;
468
+ /** Offset that was requested. */
469
+ offset?: number | null;
470
+ /** Total number of items that match the query. */
471
+ total?: number | null;
472
+ /** Flag that indicates the server failed to calculate the `total` field. */
473
+ tooManyToCount?: boolean | null;
474
+ }
475
+ export interface QueryMembersRequest {
476
+ /** Query options. */
477
+ query?: Query;
478
+ /**
479
+ * Predefined sets of fields to return.
480
+ *
481
+ * Defaults to `PUBLIC`.
482
+ *
483
+ * __Deprecated.__ Use `fieldsets` instead.
484
+ * This property will be removed on March 31, 2023.
485
+ */
486
+ fieldSet?: Set;
487
+ /**
488
+ * Predefined sets of fields to return.
489
+ *
490
+ * Defaults to `PUBLIC`.
491
+ */
492
+ fieldsets?: Set[];
493
+ /**
494
+ * Plain text search.
495
+ * Supported properties:
496
+ * `profile.nickname`
497
+ */
498
+ search?: string | null;
499
+ }
500
+ export interface Query {
501
+ /** 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) */
502
+ filter?: any;
503
+ /** Limit number of results */
504
+ paging?: Paging;
505
+ /** Sort the results */
506
+ sorting?: Sorting[];
507
+ }
508
+ export interface QueryMembersResponse {
509
+ /** List of members that met the query filter criteria. */
510
+ members?: Member[];
511
+ /** Metadata for the paginated results. */
512
+ metadata?: PagingMetadata;
513
+ }
514
+ export interface MuteMemberRequest {
515
+ _id?: string;
516
+ }
517
+ export interface MuteMemberResponse {
518
+ member?: Member;
519
+ }
520
+ export interface MemberMuted {
521
+ /**
522
+ * Member id who got muted
523
+ * @readonly
524
+ */
525
+ memberId?: string;
526
+ }
527
+ export interface UnmuteMemberRequest {
528
+ _id?: string;
529
+ }
530
+ export interface UnmuteMemberResponse {
531
+ member?: Member;
532
+ }
533
+ export interface MemberUnmuted {
534
+ /**
535
+ * Member id who got unmuted
536
+ * @readonly
537
+ */
538
+ memberId?: string;
539
+ }
540
+ export interface ApproveMemberRequest {
541
+ _id?: string;
542
+ }
543
+ export interface ApproveMemberResponse {
544
+ member?: Member;
545
+ }
546
+ export interface MemberApproved {
547
+ /**
548
+ * Member id who got approved
549
+ * @readonly
550
+ */
551
+ memberId?: string;
552
+ }
553
+ export interface BlockMemberRequest {
554
+ _id?: string;
555
+ }
556
+ export interface BlockMemberResponse {
557
+ member?: Member;
558
+ }
559
+ export interface MemberBlocked {
560
+ /**
561
+ * Member id who got blocked
562
+ * @readonly
563
+ */
564
+ memberId?: string;
565
+ }
566
+ export interface MemberSelfBlockForbiddenPayload {
567
+ /** Target's member ID. */
568
+ memberId?: string;
569
+ }
570
+ export interface OwnerMemberBlockForbiddenPayload {
571
+ /** Owner's member ID. */
572
+ memberId?: string;
573
+ }
574
+ export interface ActiveSubscriptionMemberBlockForbiddenPayload {
575
+ /** Active subscription member ID. */
576
+ memberId?: string;
577
+ }
578
+ export interface DisconnectMemberRequest {
579
+ _id?: string;
580
+ }
581
+ export interface DisconnectMemberResponse {
582
+ member?: Member;
583
+ }
584
+ export interface DeleteMemberRequest {
585
+ /** ID of the member to delete. */
586
+ _id: string;
587
+ }
588
+ export interface DeleteMemberResponse {
589
+ }
590
+ export interface ContentReassignmentRequested {
591
+ fromMember?: Member;
592
+ toMember?: Member;
593
+ }
594
+ export interface ContentDeletionRequested {
595
+ member?: Member;
596
+ }
597
+ export interface DeleteMyMemberRequest {
598
+ /** ID of a member receiving deleted member's content */
599
+ contentAssigneeId?: string | null;
600
+ }
601
+ export interface DeleteMyMemberResponse {
602
+ }
603
+ export interface BulkDeleteMembersRequest {
604
+ /** 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) */
605
+ filter?: any;
606
+ /** ID of a member receiving deleted members' content. */
607
+ contentAssigneeId?: string | null;
608
+ }
609
+ export interface BulkDeleteMembersResponse {
610
+ /** Token to be used to query an "async jobs service" */
611
+ jobId?: string;
612
+ }
613
+ export interface BulkApproveMembersRequest {
614
+ /** 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) */
615
+ filter?: any;
616
+ }
617
+ export interface BulkApproveMembersResponse {
618
+ /** Token to be used to query an "async jobs service" */
619
+ jobId?: string;
620
+ }
621
+ export interface BulkBlockMembersRequest {
622
+ /** 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) */
623
+ filter?: any;
624
+ }
625
+ export interface BulkBlockMembersResponse {
626
+ /** Token to be used to query an "async jobs service" */
627
+ jobId?: string;
628
+ }
629
+ export interface CreateMemberRequest {
630
+ /** Member to create. */
631
+ member: Member;
632
+ }
633
+ export interface CreateMemberResponse {
634
+ /** New member. */
635
+ member?: Member;
636
+ }
637
+ export interface UpdateMemberRequest {
638
+ /** Member details to update. */
639
+ member?: Member;
640
+ }
641
+ export interface UpdateMemberResponse {
642
+ member?: Member;
643
+ }
644
+ export interface DeleteMemberPhonesRequest {
645
+ /** ID of the member whose phone numbers will be deleted. */
646
+ _id: string;
647
+ }
648
+ export interface DeleteMemberPhonesResponse {
649
+ /** Updated member. */
650
+ member?: Member;
651
+ }
652
+ export interface DeleteMemberEmailsRequest {
653
+ /** ID of the member whose email addresses will be deleted. */
654
+ _id: string;
655
+ }
656
+ export interface DeleteMemberEmailsResponse {
657
+ /** Updated member. */
658
+ member?: Member;
659
+ }
660
+ export interface DeleteMemberAddressesRequest {
661
+ /** ID of the member whose street addresses will be deleted. */
662
+ _id: string;
663
+ }
664
+ export interface DeleteMemberAddressesResponse {
665
+ /** Updated member. */
666
+ member?: Member;
667
+ }
668
+ export interface Empty {
669
+ }
670
+ export interface DomainEvent extends DomainEventBodyOneOf {
671
+ createdEvent?: EntityCreatedEvent;
672
+ updatedEvent?: EntityUpdatedEvent;
673
+ deletedEvent?: EntityDeletedEvent;
674
+ actionEvent?: ActionEvent;
675
+ extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
676
+ /** random GUID so clients can tell if event was already handled */
677
+ _id?: string;
678
+ /**
679
+ * Assumes actions are also always typed to an entity_type
680
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
681
+ */
682
+ entityFqdn?: string;
683
+ /**
684
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
685
+ * This is although the created/updated/deleted notion is duplication of the oneof types
686
+ * Example: created/updated/deleted/started/completed/email_opened
687
+ */
688
+ slug?: string;
689
+ /**
690
+ * Assuming that all messages including Actions have id
691
+ * Example: The id of the specific order, the id of a specific campaign
692
+ */
693
+ entityId?: string;
694
+ /** The time of the event. Useful if there was a delay in dispatching */
695
+ eventTime?: Date;
696
+ /**
697
+ * A field that should be set if this event was triggered by an anonymize request.
698
+ * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
699
+ * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
700
+ */
701
+ triggeredByAnonymizeRequest?: boolean | null;
702
+ /** If present, indicates the action that triggered the event. */
703
+ originatedFrom?: string | null;
704
+ /**
705
+ * A sequence number defining the order of updates to the underlying entity.
706
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
707
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
708
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
709
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
710
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
711
+ */
712
+ entityEventSequence?: string | null;
713
+ }
714
+ /** @oneof */
715
+ export interface DomainEventBodyOneOf {
716
+ createdEvent?: EntityCreatedEvent;
717
+ updatedEvent?: EntityUpdatedEvent;
718
+ deletedEvent?: EntityDeletedEvent;
719
+ actionEvent?: ActionEvent;
720
+ extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
721
+ }
722
+ export interface EntityCreatedEvent {
723
+ entityAsJson?: string;
724
+ }
725
+ export interface EntityUpdatedEvent {
726
+ /**
727
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
728
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
729
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
730
+ */
731
+ currentEntityAsJson?: string;
732
+ }
733
+ export interface EntityDeletedEvent {
734
+ }
735
+ export interface ActionEvent {
736
+ bodyAsJson?: string;
737
+ }
738
+ export interface ExtendedFieldsUpdatedEvent {
739
+ currentEntityAsJson?: string;
740
+ }
741
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
742
+ siteCreated?: SiteCreated;
743
+ siteTransferred?: SiteTransferred;
744
+ siteDeleted?: SiteDeleted;
745
+ siteUndeleted?: SiteUndeleted;
746
+ sitePublished?: SitePublished;
747
+ siteUnpublished?: SiteUnpublished;
748
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
749
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
750
+ serviceProvisioned?: ServiceProvisioned;
751
+ serviceRemoved?: ServiceRemoved;
752
+ siteRenamedPayload?: SiteRenamed;
753
+ hardDeleted?: SiteHardDeleted;
754
+ namespaceChanged?: NamespaceChanged;
755
+ metaSiteId?: string;
756
+ version?: string;
757
+ timestamp?: string;
758
+ assets?: Asset[];
759
+ }
760
+ /** @oneof */
761
+ export interface MetaSiteSpecialEventPayloadOneOf {
762
+ siteCreated?: SiteCreated;
763
+ siteTransferred?: SiteTransferred;
764
+ siteDeleted?: SiteDeleted;
765
+ siteUndeleted?: SiteUndeleted;
766
+ sitePublished?: SitePublished;
767
+ siteUnpublished?: SiteUnpublished;
768
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
769
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
770
+ serviceProvisioned?: ServiceProvisioned;
771
+ serviceRemoved?: ServiceRemoved;
772
+ siteRenamedPayload?: SiteRenamed;
773
+ hardDeleted?: SiteHardDeleted;
774
+ namespaceChanged?: NamespaceChanged;
775
+ }
776
+ export interface Asset {
777
+ appDefId?: string;
778
+ instanceId?: string;
779
+ state?: State;
780
+ }
781
+ export declare enum State {
782
+ UNKNOWN = "UNKNOWN",
783
+ ENABLED = "ENABLED",
784
+ DISABLED = "DISABLED",
785
+ PENDING = "PENDING",
786
+ DEMO = "DEMO"
787
+ }
788
+ export interface SiteCreated {
789
+ originTemplateId?: string;
790
+ ownerId?: string;
791
+ context?: SiteCreatedContext;
792
+ /**
793
+ * A meta site id from which this site was created.
794
+ *
795
+ * In case of a creation from a template it's a template id.
796
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
797
+ */
798
+ originMetaSiteId?: string | null;
799
+ siteName?: string;
800
+ namespace?: Namespace;
801
+ }
802
+ export declare enum SiteCreatedContext {
803
+ /** A valid option, we don't expose all reasons why site might be created. */
804
+ OTHER = "OTHER",
805
+ /** A meta site was created from template. */
806
+ FROM_TEMPLATE = "FROM_TEMPLATE",
807
+ /** A meta site was created by copying of the transfferred meta site. */
808
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
809
+ /** A copy of existing meta site. */
810
+ DUPLICATE = "DUPLICATE",
811
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
812
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
813
+ /** deprecated A meta site was created for Flash editor. */
814
+ FLASH = "FLASH"
815
+ }
816
+ export declare enum Namespace {
817
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
818
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
819
+ WIX = "WIX",
820
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
821
+ SHOUT_OUT = "SHOUT_OUT",
822
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
823
+ ALBUMS = "ALBUMS",
824
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
825
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
826
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
827
+ HOTELS = "HOTELS",
828
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
829
+ CLUBS = "CLUBS",
830
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
831
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
832
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
833
+ DEV_SITE = "DEV_SITE",
834
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
835
+ LOGOS = "LOGOS",
836
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
837
+ VIDEO_MAKER = "VIDEO_MAKER",
838
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
839
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
840
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
841
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
842
+ /**
843
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
844
+ *
845
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
846
+ */
847
+ HTML_DRAFT = "HTML_DRAFT",
848
+ /**
849
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
850
+ * Will be accessible from Site List and will not have a website app.
851
+ * Once the user attaches a site, the site will become a regular wixsite.
852
+ */
853
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
854
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
855
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
856
+ /** It is to be used in the Business First efforts. */
857
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
858
+ /** Bookings business flow with no site. */
859
+ ANYWHERE = "ANYWHERE",
860
+ /** Namespace for Headless Backoffice with no editor */
861
+ HEADLESS = "HEADLESS",
862
+ /**
863
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
864
+ * The site will be used for account level CSM feature for enterprise
865
+ */
866
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS"
867
+ }
868
+ /** Site transferred to another user. */
869
+ export interface SiteTransferred {
870
+ /** A previous owner id (user that transfers meta site). */
871
+ oldOwnerId?: string;
872
+ /** A new owner id (user that accepts meta site). */
873
+ newOwnerId?: string;
874
+ }
875
+ /** Soft deletion of the meta site. Could be restored. */
876
+ export interface SiteDeleted {
877
+ deleteContext?: DeleteContext;
878
+ }
879
+ export interface DeleteContext {
880
+ dateDeleted?: Date;
881
+ deleteStatus?: DeleteStatus;
882
+ deleteOrigin?: string;
883
+ initiatorId?: string | null;
884
+ }
885
+ export declare enum DeleteStatus {
886
+ UNKNOWN = "UNKNOWN",
887
+ TRASH = "TRASH",
888
+ DELETED = "DELETED",
889
+ PENDING_PURGE = "PENDING_PURGE"
890
+ }
891
+ /** Restoration of the meta site. */
892
+ export interface SiteUndeleted {
893
+ }
894
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
895
+ export interface SitePublished {
896
+ }
897
+ export interface SiteUnpublished {
898
+ urls?: string[];
899
+ }
900
+ export interface SiteMarkedAsTemplate {
901
+ }
902
+ export interface SiteMarkedAsWixSite {
903
+ }
904
+ export interface ServiceProvisioned {
905
+ /** Either UUID or EmbeddedServiceType. */
906
+ appDefId?: string;
907
+ /** Not only UUID. Something here could be something weird. */
908
+ instanceId?: string;
909
+ originInstanceId?: string;
910
+ version?: string | null;
911
+ }
912
+ export interface ServiceRemoved {
913
+ appDefId?: string;
914
+ instanceId?: string;
915
+ version?: string | null;
916
+ }
917
+ /** Rename of the site. Meaning, free public url has been changed as well. */
918
+ export interface SiteRenamed {
919
+ newSiteName?: string;
920
+ oldSiteName?: string;
921
+ }
922
+ /**
923
+ * Hard deletion of the meta site.
924
+ *
925
+ * Could not be restored. Therefore it's desirable to cleanup data.
926
+ */
927
+ export interface SiteHardDeleted {
928
+ deleteContext?: DeleteContext;
929
+ }
930
+ export interface NamespaceChanged {
931
+ oldNamespace?: Namespace;
932
+ newNamespace?: Namespace;
933
+ }
934
+ export interface MemberOwnershipTransferred {
935
+ fromMember?: Member;
936
+ toMember?: Member;
937
+ }
938
+ /**
939
+ * Retrieves the currently logged-in member.
940
+ *
941
+ * <!--ONLY:VELO
942
+ * This function returns a Promise that resolves to a member object.
943
+ *
944
+ * > **Note:**
945
+ * > This function replaces the deprecated
946
+ * > `wixUsersBackend.currentUser`.
947
+ * > The deprecated object will continue to work, but it will not receive updates.
948
+ * > To keep any existing code compatible with future changes, see the
949
+ * > [migration instructions](.wix-users-backend/currentuser#wix-users-backend_currentuser_migration-instructions).
950
+ * <!--END:ONLY:VELO-->
951
+ * @public
952
+ * @documentationMaturity preview
953
+ * @returns Member profile.
954
+ */
955
+ export declare function getMyMember(options?: GetMyMemberOptions): Promise<GetMyMemberResponse>;
956
+ export interface GetMyMemberOptions {
957
+ /**
958
+ * Predefined set of fields to return.
959
+ *
960
+ * <!--ONLY:VELO
961
+ * One of:
962
+ *
963
+ * - `"FULL"`: Returns all fields.
964
+ * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
965
+ *
966
+ * > **Note:**
967
+ * > When returning the `"PUBLIC"` fieldset,
968
+ * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
969
+ * > are returned as `"UNKNOWN"`.
970
+ * <!--END:ONLY:VELO-->
971
+ */
972
+ fieldSet?: Set;
973
+ fieldsets?: Set[];
974
+ }
975
+ /**
976
+ * Retrieves a member by ID.
977
+ *
978
+ * - `PUBLIC` fieldset returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
979
+ * - `EXTENDED` fieldset returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
980
+ * - `FULL` fieldset returns all fields.
981
+ * @param _id - Member ID.
982
+ * @public
983
+ * @documentationMaturity preview
984
+ * @requiredField _id
985
+ * @returns The requested member.
986
+ */
987
+ export declare function getMember(_id: string, options?: GetMemberOptions): Promise<Member>;
988
+ export interface GetMemberOptions {
989
+ /**
990
+ * Predefined set of fields to return.
991
+ *
992
+ * Defaults to `PUBLIC`.
993
+ *
994
+ * __Deprecated.__ Use `fieldsets` instead.
995
+ * This property will be removed on March 31, 2023.
996
+ */
997
+ fieldSet?: Set;
998
+ /**
999
+ * Predefined set of fields to return.
1000
+ *
1001
+ * Defaults to `PUBLIC`.
1002
+ */
1003
+ fieldsets?: Set[];
1004
+ }
1005
+ /**
1006
+ * Lists site members, given the provided paging and fieldsets.
1007
+ *
1008
+ * - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
1009
+ * - `FULL` fieldset returns all fields.
1010
+ * @public
1011
+ * @documentationMaturity preview
1012
+ */
1013
+ export declare function listMembers(options?: ListMembersOptions): Promise<ListMembersResponse>;
1014
+ export interface ListMembersOptions {
1015
+ paging?: Paging;
1016
+ /**
1017
+ * Predefined sets of fields to return.
1018
+ *
1019
+ * Defaults to `PUBLIC`.
1020
+ *
1021
+ * __Deprecated.__ Use `fieldsets` instead.
1022
+ * This property will be removed on March 31, 2023.
1023
+ */
1024
+ fieldSet?: Set;
1025
+ /**
1026
+ * Predefined sets of fields to return.
1027
+ *
1028
+ * Defaults to `PUBLIC`.
1029
+ */
1030
+ fieldsets?: Set[];
1031
+ sorting?: Sorting[];
1032
+ }
1033
+ /**
1034
+ * Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging.
1035
+ *
1036
+ * - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
1037
+ * - `FULL` fieldset returns all fields.
1038
+ *
1039
+ * Currently supported fields for filtering:
1040
+ *
1041
+ * - `id`
1042
+ * - `profile.nickname`
1043
+ * - `profile.slug`
1044
+ * - `contact.firstName`
1045
+ * - `contact.lastName`
1046
+ * - `privacyStatus`
1047
+ * - `loginEmail`
1048
+ * - `createdDate`
1049
+ * - `status`
1050
+ * - `userId`
1051
+ *
1052
+ * Currently supported fields for sorting:
1053
+ *
1054
+ * - `profile.nickname`
1055
+ * - `contact.firstName`
1056
+ * - `contact.lastName`
1057
+ * - `createdDate`
1058
+ * - `lastLoginDate`
1059
+ * @public
1060
+ * @documentationMaturity preview
1061
+ */
1062
+ export declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
1063
+ export interface QueryMembersOptions {
1064
+ /**
1065
+ * Predefined sets of fields to return.
1066
+ *
1067
+ * Defaults to `PUBLIC`.
1068
+ *
1069
+ * __Deprecated.__ Use `fieldsets` instead.
1070
+ * This property will be removed on March 31, 2023.
1071
+ */
1072
+ fieldSet?: Set | undefined;
1073
+ /**
1074
+ * Predefined sets of fields to return.
1075
+ *
1076
+ * Defaults to `PUBLIC`.
1077
+ */
1078
+ fieldsets?: Set[] | undefined;
1079
+ /**
1080
+ * Plain text search.
1081
+ * Supported properties:
1082
+ * `profile.nickname`
1083
+ */
1084
+ search?: string | null | undefined;
1085
+ }
1086
+ interface QueryOffsetResult {
1087
+ currentPage: number;
1088
+ totalPages: number;
1089
+ totalCount: number;
1090
+ hasNext: () => boolean;
1091
+ hasPrev: () => boolean;
1092
+ length: number;
1093
+ pageSize: number;
1094
+ }
1095
+ export interface MembersQueryResult extends QueryOffsetResult {
1096
+ items: Member[];
1097
+ query: MembersQueryBuilder;
1098
+ next: () => Promise<MembersQueryResult>;
1099
+ prev: () => Promise<MembersQueryResult>;
1100
+ }
1101
+ export interface MembersQueryBuilder {
1102
+ /** @param propertyName - Property whose value is compared with `value`.
1103
+ * @param value - Value to compare against.
1104
+ * @documentationMaturity preview
1105
+ */
1106
+ eq: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id' | 'privacyStatus', value: any) => MembersQueryBuilder;
1107
+ /** @param propertyName - Property whose value is compared with `value`.
1108
+ * @param value - Value to compare against.
1109
+ * @documentationMaturity preview
1110
+ */
1111
+ ne: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id' | 'privacyStatus', value: any) => MembersQueryBuilder;
1112
+ /** @param propertyName - Property whose value is compared with `string`.
1113
+ * @param string - String to compare against. Case-insensitive.
1114
+ * @documentationMaturity preview
1115
+ */
1116
+ startsWith: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id', value: string) => MembersQueryBuilder;
1117
+ /** @param propertyName - Property whose value is compared with `values`.
1118
+ * @param values - List of values to compare against.
1119
+ * @documentationMaturity preview
1120
+ */
1121
+ hasSome: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
1122
+ /** @documentationMaturity preview */
1123
+ in: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id' | 'privacyStatus', value: any) => MembersQueryBuilder;
1124
+ /** @documentationMaturity preview */
1125
+ exists: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'contact.addresses.id' | 'profile.nickname' | 'profile.slug' | 'profile.photo.id' | 'profile.cover.id' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
1126
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1127
+ * @documentationMaturity preview
1128
+ */
1129
+ ascending: (...propertyNames: Array<string>) => MembersQueryBuilder;
1130
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1131
+ * @documentationMaturity preview
1132
+ */
1133
+ descending: (...propertyNames: Array<string>) => MembersQueryBuilder;
1134
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1135
+ * @documentationMaturity preview
1136
+ */
1137
+ limit: (limit: number) => MembersQueryBuilder;
1138
+ /** @param skip - Number of items to skip in the query results before returning the results.
1139
+ * @documentationMaturity preview
1140
+ */
1141
+ skip: (skip: number) => MembersQueryBuilder;
1142
+ /** @documentationMaturity preview */
1143
+ find: () => Promise<MembersQueryResult>;
1144
+ }
1145
+ /**
1146
+ * Deletes a member.
1147
+ *
1148
+ * <!--ONLY:VELO
1149
+ * This function returns a Promise that resolves to a member object
1150
+ * when the specified member is deleted.
1151
+ *
1152
+ * > **Note:**
1153
+ * > This function replaces the deprecated
1154
+ * > `wix-users-backend.deleteUser()`.
1155
+ * > The deprecated function will continue to work, but it will not receive updates.
1156
+ * > To keep any existing code compatible with future changes, see the
1157
+ * > [migration instructions](.wix-users-backend/deleteuser#migration-instructions).
1158
+ * <!--END:ONLY:VELO-->
1159
+ * @param _id - ID of the member to delete.
1160
+ * @public
1161
+ * @documentationMaturity preview
1162
+ * @requiredField _id
1163
+ */
1164
+ export declare function deleteMember(_id: string): Promise<void>;
1165
+ /**
1166
+ * Creates a site member.
1167
+ *
1168
+ * <!--ONLY:REST-->
1169
+ * After creation, you can use
1170
+ * [Send Set Password Email](https://dev.wix.com/api/rest/members/member-authentication/send-set-password-email)
1171
+ * to email the member with a link to set their password.
1172
+ * The member can log in to the site
1173
+ * when they set their password for the first time.
1174
+ *
1175
+ * > **Note:**
1176
+ * > When creating multiple members,
1177
+ * > set your requests at least 1 second apart to keep below rate limits.
1178
+ * <!--END:ONLY:REST-->
1179
+ * @param member - Member to create.
1180
+ * @public
1181
+ * @documentationMaturity preview
1182
+ * @requiredField member
1183
+ * @requiredField member.loginEmail
1184
+ */
1185
+ export declare function createMember(member: Member): Promise<CreateMemberResponse>;
1186
+ /**
1187
+ * Updates a member's properties.
1188
+ *
1189
+ * <!--ONLY:REST-->
1190
+ * To clear a field's value, set an empty value with an empty string `""`.
1191
+ *
1192
+ * To clear the member's addresses, emails, or phone numbers,
1193
+ * use these endpoints:
1194
+ *
1195
+ * - To clear `contact.addresses`, use [`Delete Member Addresses`](https://dev.wix.com/api/rest/members/members/delete-member-addresses).
1196
+ * - To clear `contact.emails`, use [`Delete Member Emails`](https://dev.wix.com/api/rest/members/members/delete-member-emails).
1197
+ * - To clear `contact.phones`, use [`Delete Member Phones`](https://dev.wix.com/api/rest/members/members/delete-member-phones).
1198
+ * <!--END:ONLY:REST-->
1199
+ *
1200
+ * <!--ONLY:VELO
1201
+ * This function returns a Promise that resolves to a member object
1202
+ * when the specified member is updated.
1203
+ *
1204
+ * > **Note:**
1205
+ * > This function replaces the deprecated
1206
+ * > `wixUsersBackend.updateUserFields()`.
1207
+ * > The deprecated function will continue to work, but it will not receive updates.
1208
+ * > To keep any existing code compatible with future changes, see the
1209
+ * > [migration instructions](.wix-users-backend/updateuserfields#migration-instructions).
1210
+ *
1211
+ * Only the requested fields are updated.
1212
+ *
1213
+ * To clear the member's addresses, emails, or phone numbers,
1214
+ * use these functions:
1215
+ *
1216
+ * - To clear `contact.addresses`, use [`deleteMemberAddresses()`](.wix-members-backend/members-obj/deletememberaddresses).
1217
+ * - To clear `contact.emails`, use [`deleteMemberEmails()`](.wix-members-backend/members-obj/deletememberemails).
1218
+ * - To clear `contact.phones`, use [`deleteMemberPhones()`](.wix-members-backend/members-obj/deletememberphones).
1219
+ * <!--END:ONLY:VELO-->
1220
+ * @param _id - Member ID.
1221
+ * @public
1222
+ * @documentationMaturity preview
1223
+ * @requiredField _id
1224
+ */
1225
+ export declare function updateMember(_id: string | null, options?: UpdateMemberOptions): Promise<Member>;
1226
+ export interface UpdateMemberOptions {
1227
+ member: {
1228
+ /**
1229
+ * Member ID.
1230
+ * @readonly
1231
+ */
1232
+ _id?: string | null;
1233
+ /** Email used by the member to log in to the site. */
1234
+ loginEmail?: string | null;
1235
+ /**
1236
+ * Member site access status.
1237
+ * <!--ONLY:REST-->
1238
+ * - `PENDING`: Member created and is waiting for approval by site owner.
1239
+ * - `APPROVED`: Member can log in to the site.
1240
+ * - `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.
1241
+ * - `BLOCKED`: Member is blocked and cannot log in to the site.
1242
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1243
+ * <!--END:ONLY:REST-->
1244
+ *
1245
+ * <!--ONLY:VELO
1246
+ * One of:
1247
+ *
1248
+ * - `"PENDING"`: Member created and is waiting for approval by site owner.
1249
+ * - `"APPROVED"`: Member can log in to the site.
1250
+ * - `"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.
1251
+ * - `"BLOCKED"`: Member is blocked and cannot log in to the site.
1252
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
1253
+ * <!--END:ONLY:VELO-->
1254
+ * @readonly
1255
+ */
1256
+ status?: Status;
1257
+ /**
1258
+ * Contact ID.
1259
+ * @readonly
1260
+ */
1261
+ contactId?: string | null;
1262
+ /**
1263
+ * Member's contact information. Contact information is stored in the
1264
+ * [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).
1265
+ *
1266
+ * <!--ONLY:REST-->
1267
+ * The full set of contact data can be accessed and managed with the
1268
+ * [Contacts API](https://dev.wix.com/api/rest/contacts/contacts).
1269
+ * <!--END:ONLY:REST-->
1270
+ */
1271
+ contact?: Contact;
1272
+ /** Profile display info. */
1273
+ profile?: Profile;
1274
+ /**
1275
+ * Member privacy status.
1276
+ *
1277
+ * <!--ONLY:REST-->
1278
+ * - `PUBLIC`: Member is visible to everyone.
1279
+ * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
1280
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1281
+ * <!--END:ONLY:REST-->
1282
+ *
1283
+ * <!--ONLY:VELO
1284
+ * One of:
1285
+ *
1286
+ * - `"PUBLIC"`: Member is visible to everyone.
1287
+ * - `"PRIVATE"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
1288
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
1289
+ * <!--END:ONLY:VELO-->
1290
+ */
1291
+ privacyStatus?: PrivacyStatusStatus;
1292
+ /**
1293
+ * Member activity status.
1294
+ *
1295
+ * <!--ONLY:REST-->
1296
+ * - `ACTIVE`: Member can write forum posts and blog comments.
1297
+ * - `MUTED`: Member cannot write forum posts or blog comments.
1298
+ * - `UNKNOWN`: Insufficient permissions to get the status.
1299
+ * <!--END:ONLY:REST-->
1300
+ *
1301
+ * <!--ONLY:VELO
1302
+ * One of:
1303
+ *
1304
+ * - `"ACTIVE"`: Member can write forum posts and blog comments.
1305
+ * - `"MUTED"`: Member cannot write forum posts or blog comments.
1306
+ * - `"UNKNOWN"`: Insufficient permissions to get the status.
1307
+ * <!--END:ONLY:VELO-->
1308
+ * @readonly
1309
+ */
1310
+ activityStatus?: ActivityStatusStatus;
1311
+ /**
1312
+ * Date and time when the member was created.
1313
+ * @readonly
1314
+ */
1315
+ _createdDate?: Date;
1316
+ /**
1317
+ * Date and time when the member was updated.
1318
+ * @readonly
1319
+ */
1320
+ _updatedDate?: Date;
1321
+ /**
1322
+ * Date and time when the member last logged in to the site.
1323
+ * @readonly
1324
+ */
1325
+ lastLoginDate?: Date;
1326
+ };
1327
+ }
1328
+ /**
1329
+ * Clears a member's phone numbers.
1330
+ *
1331
+ * <!--ONLY:VELO
1332
+ * This function returns a Promise that resolves to a member object
1333
+ * when the specified member's phone numbers are cleared.
1334
+ *
1335
+ * `deleteMemberPhones()` clears the `phones` array under the `contact` property.
1336
+ * <!--END:ONLY:VELO-->
1337
+ * @param _id - ID of the member whose phone numbers will be deleted.
1338
+ * @public
1339
+ * @documentationMaturity preview
1340
+ * @requiredField _id
1341
+ */
1342
+ export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPhonesResponse>;
1343
+ /**
1344
+ * Clears a member's email addresses.
1345
+ *
1346
+ * <!--ONLY:VELO
1347
+ * This function returns a Promise that resolves to a member object
1348
+ * when the specified member's email addresses are cleared.
1349
+ *
1350
+ * `deleteMemberEmails()` clears the `emails` array under the `contact` property.
1351
+ * Other member
1352
+ * [`updatedMember()`](.wix-members-backend/members-obj/updatemember)
1353
+ *
1354
+ * > **Note:**
1355
+ * > The member can still log in with their `loginEmail`,
1356
+ * > which is not cleared when this function is called.
1357
+ * <!--END:ONLY:VELO-->
1358
+ * @param _id - ID of the member whose email addresses will be deleted.
1359
+ * @public
1360
+ * @documentationMaturity preview
1361
+ * @requiredField _id
1362
+ */
1363
+ export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEmailsResponse>;
1364
+ /**
1365
+ * Deletes a member's street addresses.
1366
+ *
1367
+ * <!--ONLY:VELO
1368
+ * This function returns a Promise that resolves to a member object
1369
+ * when the specified member's addresses are cleared.
1370
+ * <!--END:ONLY:VELO-->
1371
+ *
1372
+ * `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
1373
+ * @param _id - ID of the member whose street addresses will be deleted.
1374
+ * @public
1375
+ * @documentationMaturity preview
1376
+ * @requiredField _id
1377
+ */
1378
+ export declare function deleteMemberAddresses(_id: string): Promise<DeleteMemberAddressesResponse>;
1379
+ export {};