@wix/auto_sdk_members_members 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/members-v1-member-members.types.d.ts +346 -80
- package/build/cjs/src/members-v1-member-members.types.js.map +1 -1
- package/build/cjs/src/members-v1-member-members.universal.d.ts +397 -85
- package/build/cjs/src/members-v1-member-members.universal.js +20 -0
- package/build/cjs/src/members-v1-member-members.universal.js.map +1 -1
- package/build/es/src/members-v1-member-members.types.d.ts +346 -80
- package/build/es/src/members-v1-member-members.types.js.map +1 -1
- package/build/es/src/members-v1-member-members.universal.d.ts +397 -85
- package/build/es/src/members-v1-member-members.universal.js +20 -0
- package/build/es/src/members-v1-member-members.universal.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.types.d.ts +346 -80
- package/build/internal/cjs/src/members-v1-member-members.types.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +398 -85
- package/build/internal/cjs/src/members-v1-member-members.universal.js +20 -0
- package/build/internal/cjs/src/members-v1-member-members.universal.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.types.d.ts +346 -80
- package/build/internal/es/src/members-v1-member-members.types.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.universal.d.ts +398 -85
- package/build/internal/es/src/members-v1-member-members.universal.js +20 -0
- package/build/internal/es/src/members-v1-member-members.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
export interface Member {
|
|
2
2
|
/**
|
|
3
3
|
* Member ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
7
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Email used by the member to log in to the site.
|
|
10
|
+
* @format EMAIL
|
|
11
|
+
*/
|
|
8
12
|
loginEmail?: string | null;
|
|
9
13
|
/**
|
|
10
14
|
* Whether the email used by the member has been verified.
|
|
@@ -18,6 +22,7 @@ export interface Member {
|
|
|
18
22
|
status?: Status;
|
|
19
23
|
/**
|
|
20
24
|
* Contact ID.
|
|
25
|
+
* @format GUID
|
|
21
26
|
* @readonly
|
|
22
27
|
*/
|
|
23
28
|
contactId?: string | null;
|
|
@@ -71,7 +76,10 @@ export interface Contact {
|
|
|
71
76
|
lastName?: string | null;
|
|
72
77
|
/** List of phone numbers. */
|
|
73
78
|
phones?: string[] | null;
|
|
74
|
-
/**
|
|
79
|
+
/**
|
|
80
|
+
* List of email addresses.
|
|
81
|
+
* @format EMAIL
|
|
82
|
+
*/
|
|
75
83
|
emails?: string[] | null;
|
|
76
84
|
/** List of street addresses. */
|
|
77
85
|
addresses?: Address[];
|
|
@@ -79,11 +87,18 @@ export interface Contact {
|
|
|
79
87
|
* Contact's birthdate, formatted as `"YYYY-MM-DD"`.
|
|
80
88
|
*
|
|
81
89
|
* Example: `"2020-03-15"` for March 15, 2020.
|
|
90
|
+
* @maxLength 100
|
|
82
91
|
*/
|
|
83
92
|
birthdate?: string | null;
|
|
84
|
-
/**
|
|
93
|
+
/**
|
|
94
|
+
* Contact's company name.
|
|
95
|
+
* @maxLength 100
|
|
96
|
+
*/
|
|
85
97
|
company?: string | null;
|
|
86
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* Contact's job title.
|
|
100
|
+
* @maxLength 100
|
|
101
|
+
*/
|
|
87
102
|
jobTitle?: string | null;
|
|
88
103
|
/**
|
|
89
104
|
* 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.
|
|
@@ -98,10 +113,14 @@ export interface Contact {
|
|
|
98
113
|
export interface Address extends AddressStreetOneOf {
|
|
99
114
|
/** Street address object, with number and name in separate fields. */
|
|
100
115
|
streetAddress?: StreetAddress;
|
|
101
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* Main address line, usually street and number, as free text.
|
|
118
|
+
* @maxLength 200
|
|
119
|
+
*/
|
|
102
120
|
addressLine?: string | null;
|
|
103
121
|
/**
|
|
104
122
|
* Street address ID.
|
|
123
|
+
* @format GUID
|
|
105
124
|
* @readonly
|
|
106
125
|
*/
|
|
107
126
|
_id?: string | null;
|
|
@@ -129,13 +148,22 @@ export interface Address extends AddressStreetOneOf {
|
|
|
129
148
|
export interface AddressStreetOneOf {
|
|
130
149
|
/** Street address object, with number and name in separate fields. */
|
|
131
150
|
streetAddress?: StreetAddress;
|
|
132
|
-
/**
|
|
151
|
+
/**
|
|
152
|
+
* Main address line, usually street and number, as free text.
|
|
153
|
+
* @maxLength 200
|
|
154
|
+
*/
|
|
133
155
|
addressLine?: string | null;
|
|
134
156
|
}
|
|
135
157
|
export interface StreetAddress {
|
|
136
|
-
/**
|
|
158
|
+
/**
|
|
159
|
+
* Street number.
|
|
160
|
+
* @maxLength 100
|
|
161
|
+
*/
|
|
137
162
|
number?: string;
|
|
138
|
-
/**
|
|
163
|
+
/**
|
|
164
|
+
* Street name.
|
|
165
|
+
* @maxLength 200
|
|
166
|
+
*/
|
|
139
167
|
name?: string;
|
|
140
168
|
}
|
|
141
169
|
export interface CustomField {
|
|
@@ -227,9 +255,15 @@ export interface ExtendedFields {
|
|
|
227
255
|
namespaces?: Record<string, Record<string, any>>;
|
|
228
256
|
}
|
|
229
257
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
230
|
-
/**
|
|
258
|
+
/**
|
|
259
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
260
|
+
* @format GUID
|
|
261
|
+
*/
|
|
231
262
|
metaSiteId?: string;
|
|
232
|
-
/**
|
|
263
|
+
/**
|
|
264
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
265
|
+
* @format GUID
|
|
266
|
+
*/
|
|
233
267
|
siteId?: string;
|
|
234
268
|
/** Invalidate by App */
|
|
235
269
|
app?: App;
|
|
@@ -239,7 +273,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
239
273
|
uri?: URI;
|
|
240
274
|
/** Invalidate by file (for media files such as PDFs) */
|
|
241
275
|
file?: File;
|
|
242
|
-
/**
|
|
276
|
+
/**
|
|
277
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
278
|
+
* @maxLength 256
|
|
279
|
+
*/
|
|
243
280
|
reason?: string | null;
|
|
244
281
|
/** Is local DS */
|
|
245
282
|
localDc?: boolean;
|
|
@@ -247,9 +284,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
247
284
|
}
|
|
248
285
|
/** @oneof */
|
|
249
286
|
export interface InvalidateCacheGetByOneOf {
|
|
250
|
-
/**
|
|
287
|
+
/**
|
|
288
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
289
|
+
* @format GUID
|
|
290
|
+
*/
|
|
251
291
|
metaSiteId?: string;
|
|
252
|
-
/**
|
|
292
|
+
/**
|
|
293
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
294
|
+
* @format GUID
|
|
295
|
+
*/
|
|
253
296
|
siteId?: string;
|
|
254
297
|
/** Invalidate by App */
|
|
255
298
|
app?: App;
|
|
@@ -261,31 +304,59 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
261
304
|
file?: File;
|
|
262
305
|
}
|
|
263
306
|
export interface App {
|
|
264
|
-
/**
|
|
307
|
+
/**
|
|
308
|
+
* The AppDefId
|
|
309
|
+
* @minLength 1
|
|
310
|
+
*/
|
|
265
311
|
appDefId?: string;
|
|
266
|
-
/**
|
|
312
|
+
/**
|
|
313
|
+
* The instance Id
|
|
314
|
+
* @format GUID
|
|
315
|
+
*/
|
|
267
316
|
instanceId?: string;
|
|
268
317
|
}
|
|
269
318
|
export interface Page {
|
|
270
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* the msid the page is on
|
|
321
|
+
* @format GUID
|
|
322
|
+
*/
|
|
271
323
|
metaSiteId?: string;
|
|
272
|
-
/**
|
|
324
|
+
/**
|
|
325
|
+
* Invalidate by Page ID
|
|
326
|
+
* @minLength 1
|
|
327
|
+
*/
|
|
273
328
|
pageId?: string;
|
|
274
329
|
}
|
|
275
330
|
export interface URI {
|
|
276
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* the msid the URI is on
|
|
333
|
+
* @format GUID
|
|
334
|
+
*/
|
|
277
335
|
metaSiteId?: string;
|
|
278
|
-
/**
|
|
336
|
+
/**
|
|
337
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
338
|
+
* @minLength 1
|
|
339
|
+
*/
|
|
279
340
|
uriPath?: string;
|
|
280
341
|
}
|
|
281
342
|
export interface File {
|
|
282
|
-
/**
|
|
343
|
+
/**
|
|
344
|
+
* the msid the file is related to
|
|
345
|
+
* @format GUID
|
|
346
|
+
*/
|
|
283
347
|
metaSiteId?: string;
|
|
284
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
350
|
+
* @minLength 1
|
|
351
|
+
* @maxLength 256
|
|
352
|
+
*/
|
|
285
353
|
fileName?: string;
|
|
286
354
|
}
|
|
287
355
|
export interface UpdateMySlugRequest {
|
|
288
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* New slug.
|
|
358
|
+
* @maxLength 255
|
|
359
|
+
*/
|
|
289
360
|
slug: string;
|
|
290
361
|
}
|
|
291
362
|
export interface UpdateMySlugResponse {
|
|
@@ -296,9 +367,15 @@ export interface SlugAlreadyExistsPayload {
|
|
|
296
367
|
slug?: string;
|
|
297
368
|
}
|
|
298
369
|
export interface UpdateMemberSlugRequest {
|
|
299
|
-
/**
|
|
370
|
+
/**
|
|
371
|
+
* Member ID.
|
|
372
|
+
* @format GUID
|
|
373
|
+
*/
|
|
300
374
|
_id: string;
|
|
301
|
-
/**
|
|
375
|
+
/**
|
|
376
|
+
* New slug.
|
|
377
|
+
* @maxLength 255
|
|
378
|
+
*/
|
|
302
379
|
slug: string;
|
|
303
380
|
}
|
|
304
381
|
export interface UpdateMemberSlugResponse {
|
|
@@ -315,6 +392,7 @@ export interface JoinCommunityResponse {
|
|
|
315
392
|
export interface MemberJoinedCommunity {
|
|
316
393
|
/**
|
|
317
394
|
* Member id who joined the community
|
|
395
|
+
* @format GUID
|
|
318
396
|
* @readonly
|
|
319
397
|
*/
|
|
320
398
|
memberId?: string;
|
|
@@ -329,6 +407,7 @@ export interface LeaveCommunityResponse {
|
|
|
329
407
|
export interface MemberLeftCommunity {
|
|
330
408
|
/**
|
|
331
409
|
* Member id who left the community
|
|
410
|
+
* @format GUID
|
|
332
411
|
* @readonly
|
|
333
412
|
*/
|
|
334
413
|
memberId?: string;
|
|
@@ -351,6 +430,7 @@ export interface GetMyMemberRequest {
|
|
|
351
430
|
* Predefined set of fields to return.
|
|
352
431
|
*
|
|
353
432
|
* Default: `PUBLIC`.
|
|
433
|
+
* @maxSize 3
|
|
354
434
|
*/
|
|
355
435
|
fieldsets?: Set[];
|
|
356
436
|
}
|
|
@@ -371,7 +451,10 @@ export interface GetMyMemberResponse {
|
|
|
371
451
|
member?: Member;
|
|
372
452
|
}
|
|
373
453
|
export interface GetMemberRequest {
|
|
374
|
-
/**
|
|
454
|
+
/**
|
|
455
|
+
* Member ID.
|
|
456
|
+
* @format GUID
|
|
457
|
+
*/
|
|
375
458
|
_id: string;
|
|
376
459
|
/**
|
|
377
460
|
* Predefined set of fields to return. One of:
|
|
@@ -380,6 +463,7 @@ export interface GetMemberRequest {
|
|
|
380
463
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
381
464
|
*
|
|
382
465
|
*
|
|
466
|
+
* @maxSize 3
|
|
383
467
|
*/
|
|
384
468
|
fieldsets?: Set[];
|
|
385
469
|
}
|
|
@@ -388,7 +472,10 @@ export interface GetMemberResponse {
|
|
|
388
472
|
member?: Member;
|
|
389
473
|
}
|
|
390
474
|
export interface MemberToMemberBlockedPayload {
|
|
391
|
-
/**
|
|
475
|
+
/**
|
|
476
|
+
* Member ID.
|
|
477
|
+
* @format GUID
|
|
478
|
+
*/
|
|
392
479
|
memberId?: string;
|
|
393
480
|
}
|
|
394
481
|
export interface ListMembersRequest {
|
|
@@ -400,6 +487,7 @@ export interface ListMembersRequest {
|
|
|
400
487
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
401
488
|
*
|
|
402
489
|
* Default: `"PUBLIC"`.
|
|
490
|
+
* @maxSize 3
|
|
403
491
|
*/
|
|
404
492
|
fieldsets?: Set[];
|
|
405
493
|
sorting?: Sorting[];
|
|
@@ -411,7 +499,10 @@ export interface Paging {
|
|
|
411
499
|
offset?: number | null;
|
|
412
500
|
}
|
|
413
501
|
export interface Sorting {
|
|
414
|
-
/**
|
|
502
|
+
/**
|
|
503
|
+
* Name of the field to sort by.
|
|
504
|
+
* @maxLength 512
|
|
505
|
+
*/
|
|
415
506
|
fieldName?: string;
|
|
416
507
|
/** Sort order. */
|
|
417
508
|
order?: SortOrder;
|
|
@@ -421,13 +512,17 @@ export declare enum SortOrder {
|
|
|
421
512
|
DESC = "DESC"
|
|
422
513
|
}
|
|
423
514
|
export interface CursorPaging {
|
|
424
|
-
/**
|
|
515
|
+
/**
|
|
516
|
+
* Maximum number of items to return in the results.
|
|
517
|
+
* @max 100
|
|
518
|
+
*/
|
|
425
519
|
limit?: number | null;
|
|
426
520
|
/**
|
|
427
521
|
* Pointer to the next or previous page in the list of results.
|
|
428
522
|
*
|
|
429
523
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
430
524
|
* Not relevant for the first request.
|
|
525
|
+
* @maxLength 16000
|
|
431
526
|
*/
|
|
432
527
|
cursor?: string | null;
|
|
433
528
|
}
|
|
@@ -461,9 +556,15 @@ export interface CursorPagingMetadata {
|
|
|
461
556
|
hasNext?: boolean | null;
|
|
462
557
|
}
|
|
463
558
|
export interface Cursors {
|
|
464
|
-
/**
|
|
559
|
+
/**
|
|
560
|
+
* Cursor string pointing to the next page in the list of results.
|
|
561
|
+
* @maxLength 16000
|
|
562
|
+
*/
|
|
465
563
|
next?: string | null;
|
|
466
|
-
/**
|
|
564
|
+
/**
|
|
565
|
+
* Cursor pointing to the previous page in the list of results.
|
|
566
|
+
* @maxLength 16000
|
|
567
|
+
*/
|
|
467
568
|
prev?: string | null;
|
|
468
569
|
}
|
|
469
570
|
export interface QueryMembersRequest {
|
|
@@ -473,6 +574,7 @@ export interface QueryMembersRequest {
|
|
|
473
574
|
* Predefined sets of fields to return.
|
|
474
575
|
*
|
|
475
576
|
* Default: `PUBLIC`.
|
|
577
|
+
* @maxSize 3
|
|
476
578
|
*/
|
|
477
579
|
fieldsets?: Set[];
|
|
478
580
|
/** Plain text search. */
|
|
@@ -488,7 +590,11 @@ export interface Query {
|
|
|
488
590
|
}
|
|
489
591
|
/** Free text to match in searchable fields */
|
|
490
592
|
export interface Search {
|
|
491
|
-
/**
|
|
593
|
+
/**
|
|
594
|
+
* Search term or expression.
|
|
595
|
+
* @minLength 1
|
|
596
|
+
* @maxLength 100
|
|
597
|
+
*/
|
|
492
598
|
expression?: string | null;
|
|
493
599
|
/**
|
|
494
600
|
* Currently supported fields for search:
|
|
@@ -501,6 +607,7 @@ export interface Search {
|
|
|
501
607
|
* - `profile.slug`
|
|
502
608
|
*
|
|
503
609
|
* Default: `profile.nickname`.
|
|
610
|
+
* @maxSize 4
|
|
504
611
|
*/
|
|
505
612
|
fields?: string[];
|
|
506
613
|
}
|
|
@@ -511,7 +618,10 @@ export interface QueryMembersResponse {
|
|
|
511
618
|
metadata?: PagingMetadata;
|
|
512
619
|
}
|
|
513
620
|
export interface MuteMemberRequest {
|
|
514
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* ID of the member to mute.
|
|
623
|
+
* @format GUID
|
|
624
|
+
*/
|
|
515
625
|
_id: string;
|
|
516
626
|
}
|
|
517
627
|
export interface MuteMemberResponse {
|
|
@@ -521,12 +631,16 @@ export interface MuteMemberResponse {
|
|
|
521
631
|
export interface MemberMuted {
|
|
522
632
|
/**
|
|
523
633
|
* Member id who got muted
|
|
634
|
+
* @format GUID
|
|
524
635
|
* @readonly
|
|
525
636
|
*/
|
|
526
637
|
memberId?: string;
|
|
527
638
|
}
|
|
528
639
|
export interface UnmuteMemberRequest {
|
|
529
|
-
/**
|
|
640
|
+
/**
|
|
641
|
+
* ID of the member to unmute.
|
|
642
|
+
* @format GUID
|
|
643
|
+
*/
|
|
530
644
|
_id: string;
|
|
531
645
|
}
|
|
532
646
|
export interface UnmuteMemberResponse {
|
|
@@ -536,12 +650,16 @@ export interface UnmuteMemberResponse {
|
|
|
536
650
|
export interface MemberUnmuted {
|
|
537
651
|
/**
|
|
538
652
|
* Member id who got unmuted
|
|
653
|
+
* @format GUID
|
|
539
654
|
* @readonly
|
|
540
655
|
*/
|
|
541
656
|
memberId?: string;
|
|
542
657
|
}
|
|
543
658
|
export interface ApproveMemberRequest {
|
|
544
|
-
/**
|
|
659
|
+
/**
|
|
660
|
+
* ID of the member to approve.
|
|
661
|
+
* @format GUID
|
|
662
|
+
*/
|
|
545
663
|
_id: string;
|
|
546
664
|
}
|
|
547
665
|
export interface ApproveMemberResponse {
|
|
@@ -551,12 +669,16 @@ export interface ApproveMemberResponse {
|
|
|
551
669
|
export interface MemberApproved {
|
|
552
670
|
/**
|
|
553
671
|
* Member id who got approved
|
|
672
|
+
* @format GUID
|
|
554
673
|
* @readonly
|
|
555
674
|
*/
|
|
556
675
|
memberId?: string;
|
|
557
676
|
}
|
|
558
677
|
export interface BlockMemberRequest {
|
|
559
|
-
/**
|
|
678
|
+
/**
|
|
679
|
+
* ID of a member to block.
|
|
680
|
+
* @format GUID
|
|
681
|
+
*/
|
|
560
682
|
_id: string;
|
|
561
683
|
}
|
|
562
684
|
export interface BlockMemberResponse {
|
|
@@ -566,24 +688,37 @@ export interface BlockMemberResponse {
|
|
|
566
688
|
export interface MemberBlocked {
|
|
567
689
|
/**
|
|
568
690
|
* Member id who got blocked
|
|
691
|
+
* @format GUID
|
|
569
692
|
* @readonly
|
|
570
693
|
*/
|
|
571
694
|
memberId?: string;
|
|
572
695
|
}
|
|
573
696
|
export interface MemberSelfBlockForbiddenPayload {
|
|
574
|
-
/**
|
|
697
|
+
/**
|
|
698
|
+
* Target's member ID.
|
|
699
|
+
* @format GUID
|
|
700
|
+
*/
|
|
575
701
|
memberId?: string;
|
|
576
702
|
}
|
|
577
703
|
export interface OwnerMemberBlockForbiddenPayload {
|
|
578
|
-
/**
|
|
704
|
+
/**
|
|
705
|
+
* Owner's member ID.
|
|
706
|
+
* @format GUID
|
|
707
|
+
*/
|
|
579
708
|
memberId?: string;
|
|
580
709
|
}
|
|
581
710
|
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
582
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Active subscription member ID.
|
|
713
|
+
* @format GUID
|
|
714
|
+
*/
|
|
583
715
|
memberId?: string;
|
|
584
716
|
}
|
|
585
717
|
export interface DisconnectMemberRequest {
|
|
586
|
-
/**
|
|
718
|
+
/**
|
|
719
|
+
* ID of a member to disconnect.
|
|
720
|
+
* @format GUID
|
|
721
|
+
*/
|
|
587
722
|
_id: string;
|
|
588
723
|
}
|
|
589
724
|
export interface DisconnectMemberResponse {
|
|
@@ -591,7 +726,10 @@ export interface DisconnectMemberResponse {
|
|
|
591
726
|
member?: Member;
|
|
592
727
|
}
|
|
593
728
|
export interface DeleteMemberRequest {
|
|
594
|
-
/**
|
|
729
|
+
/**
|
|
730
|
+
* ID of the member to delete.
|
|
731
|
+
* @format GUID
|
|
732
|
+
*/
|
|
595
733
|
_id: string;
|
|
596
734
|
}
|
|
597
735
|
export interface DeleteMemberResponse {
|
|
@@ -604,21 +742,35 @@ export interface ContentDeletionRequested {
|
|
|
604
742
|
member?: Member;
|
|
605
743
|
}
|
|
606
744
|
export interface OwnerOrContributorDeleteForbiddenPayload {
|
|
607
|
-
/**
|
|
745
|
+
/**
|
|
746
|
+
* Owner's or contributor's member ID.
|
|
747
|
+
* @format GUID
|
|
748
|
+
*/
|
|
608
749
|
memberId?: string;
|
|
609
750
|
}
|
|
610
751
|
export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
611
|
-
/**
|
|
752
|
+
/**
|
|
753
|
+
* Active subscription member ID.
|
|
754
|
+
* @format GUID
|
|
755
|
+
*/
|
|
612
756
|
memberId?: string;
|
|
613
757
|
}
|
|
614
758
|
export interface DeleteMyMemberRequest {
|
|
615
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* ID of a member receiving deleted member's content.
|
|
761
|
+
* @format GUID
|
|
762
|
+
*/
|
|
616
763
|
contentAssigneeId?: string | null;
|
|
617
764
|
}
|
|
618
765
|
export interface DeleteMyMemberResponse {
|
|
619
766
|
}
|
|
620
767
|
export interface BulkDeleteMembersRequest {
|
|
621
|
-
/**
|
|
768
|
+
/**
|
|
769
|
+
* IDs of members to be deleted.
|
|
770
|
+
* @minSize 1
|
|
771
|
+
* @maxSize 100
|
|
772
|
+
* @format GUID
|
|
773
|
+
*/
|
|
622
774
|
memberIds: string[];
|
|
623
775
|
}
|
|
624
776
|
export interface BulkDeleteMembersResponse {
|
|
@@ -628,7 +780,10 @@ export interface BulkDeleteMembersResponse {
|
|
|
628
780
|
bulkActionMetadata?: BulkActionMetadata;
|
|
629
781
|
}
|
|
630
782
|
export interface ItemMetadata {
|
|
631
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
785
|
+
* @maxLength 255
|
|
786
|
+
*/
|
|
632
787
|
_id?: string | null;
|
|
633
788
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
634
789
|
originalIndex?: number;
|
|
@@ -659,7 +814,10 @@ export interface BulkActionMetadata {
|
|
|
659
814
|
export interface BulkDeleteMembersByFilterRequest {
|
|
660
815
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
661
816
|
filter: any;
|
|
662
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* ID of a member receiving the deleted member's content.
|
|
819
|
+
* @format GUID
|
|
820
|
+
*/
|
|
663
821
|
contentAssigneeId?: string | null;
|
|
664
822
|
/** Plain text search. */
|
|
665
823
|
search?: Search;
|
|
@@ -714,7 +872,10 @@ export interface InvalidCustomFieldUrlPayload {
|
|
|
714
872
|
fields?: Record<string, string>;
|
|
715
873
|
}
|
|
716
874
|
export interface DeleteMemberPhonesRequest {
|
|
717
|
-
/**
|
|
875
|
+
/**
|
|
876
|
+
* ID of the member whose phone numbers will be deleted.
|
|
877
|
+
* @format GUID
|
|
878
|
+
*/
|
|
718
879
|
_id: string;
|
|
719
880
|
}
|
|
720
881
|
export interface DeleteMemberPhonesResponse {
|
|
@@ -722,7 +883,10 @@ export interface DeleteMemberPhonesResponse {
|
|
|
722
883
|
member?: Member;
|
|
723
884
|
}
|
|
724
885
|
export interface DeleteMemberEmailsRequest {
|
|
725
|
-
/**
|
|
886
|
+
/**
|
|
887
|
+
* ID of the member whose email addresses will be deleted.
|
|
888
|
+
* @format GUID
|
|
889
|
+
*/
|
|
726
890
|
_id: string;
|
|
727
891
|
}
|
|
728
892
|
export interface DeleteMemberEmailsResponse {
|
|
@@ -730,7 +894,10 @@ export interface DeleteMemberEmailsResponse {
|
|
|
730
894
|
member?: Member;
|
|
731
895
|
}
|
|
732
896
|
export interface DeleteMemberAddressesRequest {
|
|
733
|
-
/**
|
|
897
|
+
/**
|
|
898
|
+
* ID of the member whose street addresses will be deleted.
|
|
899
|
+
* @format GUID
|
|
900
|
+
*/
|
|
734
901
|
_id: string;
|
|
735
902
|
}
|
|
736
903
|
export interface DeleteMemberAddressesResponse {
|
|
@@ -840,7 +1007,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
840
1007
|
studioAssigned?: StudioAssigned;
|
|
841
1008
|
/** Emitted when Studio is detached. */
|
|
842
1009
|
studioUnassigned?: StudioUnassigned;
|
|
843
|
-
/**
|
|
1010
|
+
/**
|
|
1011
|
+
* A meta site id.
|
|
1012
|
+
* @format GUID
|
|
1013
|
+
*/
|
|
844
1014
|
metaSiteId?: string;
|
|
845
1015
|
/** A meta site version. Monotonically increasing. */
|
|
846
1016
|
version?: string;
|
|
@@ -849,6 +1019,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
849
1019
|
/**
|
|
850
1020
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
851
1021
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1022
|
+
* @maxSize 4000
|
|
852
1023
|
*/
|
|
853
1024
|
assets?: Asset[];
|
|
854
1025
|
}
|
|
@@ -886,9 +1057,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
886
1057
|
studioUnassigned?: StudioUnassigned;
|
|
887
1058
|
}
|
|
888
1059
|
export interface Asset {
|
|
889
|
-
/**
|
|
1060
|
+
/**
|
|
1061
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1062
|
+
* @maxLength 36
|
|
1063
|
+
*/
|
|
890
1064
|
appDefId?: string;
|
|
891
|
-
/**
|
|
1065
|
+
/**
|
|
1066
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
1067
|
+
* @maxLength 200
|
|
1068
|
+
*/
|
|
892
1069
|
instanceId?: string;
|
|
893
1070
|
/** An application state. */
|
|
894
1071
|
state?: State;
|
|
@@ -901,9 +1078,15 @@ export declare enum State {
|
|
|
901
1078
|
DEMO = "DEMO"
|
|
902
1079
|
}
|
|
903
1080
|
export interface SiteCreated {
|
|
904
|
-
/**
|
|
1081
|
+
/**
|
|
1082
|
+
* A template identifier (empty if not created from a template).
|
|
1083
|
+
* @maxLength 36
|
|
1084
|
+
*/
|
|
905
1085
|
originTemplateId?: string;
|
|
906
|
-
/**
|
|
1086
|
+
/**
|
|
1087
|
+
* An account id of the owner.
|
|
1088
|
+
* @format GUID
|
|
1089
|
+
*/
|
|
907
1090
|
ownerId?: string;
|
|
908
1091
|
/** A context in which meta site was created. */
|
|
909
1092
|
context?: SiteCreatedContext;
|
|
@@ -912,9 +1095,13 @@ export interface SiteCreated {
|
|
|
912
1095
|
*
|
|
913
1096
|
* In case of a creation from a template it's a template id.
|
|
914
1097
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1098
|
+
* @format GUID
|
|
915
1099
|
*/
|
|
916
1100
|
originMetaSiteId?: string | null;
|
|
917
|
-
/**
|
|
1101
|
+
/**
|
|
1102
|
+
* A meta site name (URL slug).
|
|
1103
|
+
* @maxLength 20
|
|
1104
|
+
*/
|
|
918
1105
|
siteName?: string;
|
|
919
1106
|
/** A namespace. */
|
|
920
1107
|
namespace?: Namespace;
|
|
@@ -1011,9 +1198,15 @@ export declare enum Namespace {
|
|
|
1011
1198
|
}
|
|
1012
1199
|
/** Site transferred to another user. */
|
|
1013
1200
|
export interface SiteTransferred {
|
|
1014
|
-
/**
|
|
1201
|
+
/**
|
|
1202
|
+
* A previous owner id (user that transfers meta site).
|
|
1203
|
+
* @format GUID
|
|
1204
|
+
*/
|
|
1015
1205
|
oldOwnerId?: string;
|
|
1016
|
-
/**
|
|
1206
|
+
/**
|
|
1207
|
+
* A new owner id (user that accepts meta site).
|
|
1208
|
+
* @format GUID
|
|
1209
|
+
*/
|
|
1017
1210
|
newOwnerId?: string;
|
|
1018
1211
|
}
|
|
1019
1212
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -1026,9 +1219,15 @@ export interface DeleteContext {
|
|
|
1026
1219
|
dateDeleted?: Date | null;
|
|
1027
1220
|
/** A status. */
|
|
1028
1221
|
deleteStatus?: DeleteStatus;
|
|
1029
|
-
/**
|
|
1222
|
+
/**
|
|
1223
|
+
* A reason (flow).
|
|
1224
|
+
* @maxLength 255
|
|
1225
|
+
*/
|
|
1030
1226
|
deleteOrigin?: string;
|
|
1031
|
-
/**
|
|
1227
|
+
/**
|
|
1228
|
+
* A service that deleted it.
|
|
1229
|
+
* @maxLength 255
|
|
1230
|
+
*/
|
|
1032
1231
|
initiatorId?: string | null;
|
|
1033
1232
|
}
|
|
1034
1233
|
export declare enum DeleteStatus {
|
|
@@ -1044,7 +1243,11 @@ export interface SiteUndeleted {
|
|
|
1044
1243
|
export interface SitePublished {
|
|
1045
1244
|
}
|
|
1046
1245
|
export interface SiteUnpublished {
|
|
1047
|
-
/**
|
|
1246
|
+
/**
|
|
1247
|
+
* A list of URLs previously associated with the meta site.
|
|
1248
|
+
* @maxLength 4000
|
|
1249
|
+
* @maxSize 10000
|
|
1250
|
+
*/
|
|
1048
1251
|
urls?: string[];
|
|
1049
1252
|
}
|
|
1050
1253
|
export interface SiteMarkedAsTemplate {
|
|
@@ -1067,30 +1270,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
1067
1270
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1068
1271
|
*/
|
|
1069
1272
|
export interface ServiceProvisioned {
|
|
1070
|
-
/**
|
|
1273
|
+
/**
|
|
1274
|
+
* Either UUID or EmbeddedServiceType.
|
|
1275
|
+
* @maxLength 36
|
|
1276
|
+
*/
|
|
1071
1277
|
appDefId?: string;
|
|
1072
|
-
/**
|
|
1278
|
+
/**
|
|
1279
|
+
* Not only UUID. Something here could be something weird.
|
|
1280
|
+
* @maxLength 36
|
|
1281
|
+
*/
|
|
1073
1282
|
instanceId?: string;
|
|
1074
|
-
/**
|
|
1283
|
+
/**
|
|
1284
|
+
* An instance id from which this instance is originated.
|
|
1285
|
+
* @maxLength 36
|
|
1286
|
+
*/
|
|
1075
1287
|
originInstanceId?: string;
|
|
1076
|
-
/**
|
|
1288
|
+
/**
|
|
1289
|
+
* A version.
|
|
1290
|
+
* @maxLength 500
|
|
1291
|
+
*/
|
|
1077
1292
|
version?: string | null;
|
|
1078
|
-
/**
|
|
1293
|
+
/**
|
|
1294
|
+
* The origin meta site id
|
|
1295
|
+
* @format GUID
|
|
1296
|
+
*/
|
|
1079
1297
|
originMetaSiteId?: string | null;
|
|
1080
1298
|
}
|
|
1081
1299
|
export interface ServiceRemoved {
|
|
1082
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* Either UUID or EmbeddedServiceType.
|
|
1302
|
+
* @maxLength 36
|
|
1303
|
+
*/
|
|
1083
1304
|
appDefId?: string;
|
|
1084
|
-
/**
|
|
1305
|
+
/**
|
|
1306
|
+
* Not only UUID. Something here could be something weird.
|
|
1307
|
+
* @maxLength 36
|
|
1308
|
+
*/
|
|
1085
1309
|
instanceId?: string;
|
|
1086
|
-
/**
|
|
1310
|
+
/**
|
|
1311
|
+
* A version.
|
|
1312
|
+
* @maxLength 500
|
|
1313
|
+
*/
|
|
1087
1314
|
version?: string | null;
|
|
1088
1315
|
}
|
|
1089
1316
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1090
1317
|
export interface SiteRenamed {
|
|
1091
|
-
/**
|
|
1318
|
+
/**
|
|
1319
|
+
* A new meta site name (URL slug).
|
|
1320
|
+
* @maxLength 20
|
|
1321
|
+
*/
|
|
1092
1322
|
newSiteName?: string;
|
|
1093
|
-
/**
|
|
1323
|
+
/**
|
|
1324
|
+
* A previous meta site name (URL slug).
|
|
1325
|
+
* @maxLength 255
|
|
1326
|
+
*/
|
|
1094
1327
|
oldSiteName?: string;
|
|
1095
1328
|
}
|
|
1096
1329
|
/**
|
|
@@ -1119,13 +1352,21 @@ export interface MemberOwnershipTransferred {
|
|
|
1119
1352
|
toMember?: Member;
|
|
1120
1353
|
}
|
|
1121
1354
|
export interface MemberIdChanged {
|
|
1355
|
+
/** @format GUID */
|
|
1122
1356
|
fromId?: string;
|
|
1357
|
+
/** @format GUID */
|
|
1123
1358
|
toId?: string;
|
|
1124
1359
|
}
|
|
1125
1360
|
export interface MessageEnvelope {
|
|
1126
|
-
/**
|
|
1361
|
+
/**
|
|
1362
|
+
* App instance ID.
|
|
1363
|
+
* @format GUID
|
|
1364
|
+
*/
|
|
1127
1365
|
instanceId?: string | null;
|
|
1128
|
-
/**
|
|
1366
|
+
/**
|
|
1367
|
+
* Event type.
|
|
1368
|
+
* @maxLength 150
|
|
1369
|
+
*/
|
|
1129
1370
|
eventType?: string;
|
|
1130
1371
|
/** The identification type and identity data. */
|
|
1131
1372
|
identity?: IdentificationData;
|
|
@@ -1133,26 +1374,50 @@ export interface MessageEnvelope {
|
|
|
1133
1374
|
data?: string;
|
|
1134
1375
|
}
|
|
1135
1376
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1136
|
-
/**
|
|
1377
|
+
/**
|
|
1378
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1379
|
+
* @format GUID
|
|
1380
|
+
*/
|
|
1137
1381
|
anonymousVisitorId?: string;
|
|
1138
|
-
/**
|
|
1382
|
+
/**
|
|
1383
|
+
* ID of a site visitor that has logged in to the site.
|
|
1384
|
+
* @format GUID
|
|
1385
|
+
*/
|
|
1139
1386
|
memberId?: string;
|
|
1140
|
-
/**
|
|
1387
|
+
/**
|
|
1388
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1389
|
+
* @format GUID
|
|
1390
|
+
*/
|
|
1141
1391
|
wixUserId?: string;
|
|
1142
|
-
/**
|
|
1392
|
+
/**
|
|
1393
|
+
* ID of an app.
|
|
1394
|
+
* @format GUID
|
|
1395
|
+
*/
|
|
1143
1396
|
appId?: string;
|
|
1144
1397
|
/** @readonly */
|
|
1145
1398
|
identityType?: WebhookIdentityType;
|
|
1146
1399
|
}
|
|
1147
1400
|
/** @oneof */
|
|
1148
1401
|
export interface IdentificationDataIdOneOf {
|
|
1149
|
-
/**
|
|
1402
|
+
/**
|
|
1403
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1404
|
+
* @format GUID
|
|
1405
|
+
*/
|
|
1150
1406
|
anonymousVisitorId?: string;
|
|
1151
|
-
/**
|
|
1407
|
+
/**
|
|
1408
|
+
* ID of a site visitor that has logged in to the site.
|
|
1409
|
+
* @format GUID
|
|
1410
|
+
*/
|
|
1152
1411
|
memberId?: string;
|
|
1153
|
-
/**
|
|
1412
|
+
/**
|
|
1413
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1414
|
+
* @format GUID
|
|
1415
|
+
*/
|
|
1154
1416
|
wixUserId?: string;
|
|
1155
|
-
/**
|
|
1417
|
+
/**
|
|
1418
|
+
* ID of an app.
|
|
1419
|
+
* @format GUID
|
|
1420
|
+
*/
|
|
1156
1421
|
appId?: string;
|
|
1157
1422
|
}
|
|
1158
1423
|
export declare enum WebhookIdentityType {
|
|
@@ -1274,9 +1539,15 @@ export interface DeleteMemberAddressesResponseNonNullableFields {
|
|
|
1274
1539
|
member?: MemberNonNullableFields;
|
|
1275
1540
|
}
|
|
1276
1541
|
export interface BaseEventMetadata {
|
|
1277
|
-
/**
|
|
1542
|
+
/**
|
|
1543
|
+
* App instance ID.
|
|
1544
|
+
* @format GUID
|
|
1545
|
+
*/
|
|
1278
1546
|
instanceId?: string | null;
|
|
1279
|
-
/**
|
|
1547
|
+
/**
|
|
1548
|
+
* Event type.
|
|
1549
|
+
* @maxLength 150
|
|
1550
|
+
*/
|
|
1280
1551
|
eventType?: string;
|
|
1281
1552
|
/** The identification type and identity data. */
|
|
1282
1553
|
identity?: IdentificationData;
|
|
@@ -1345,6 +1616,8 @@ export interface MemberCreatedEnvelope {
|
|
|
1345
1616
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1346
1617
|
* @permissionScope Read Members
|
|
1347
1618
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1619
|
+
* @permissionScope Set Up Automations
|
|
1620
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1348
1621
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1349
1622
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1350
1623
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1375,6 +1648,8 @@ export interface MemberDeletedEnvelope {
|
|
|
1375
1648
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1376
1649
|
* @permissionScope Read Members
|
|
1377
1650
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1651
|
+
* @permissionScope Set Up Automations
|
|
1652
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1378
1653
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1379
1654
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1380
1655
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1404,6 +1679,8 @@ export interface MemberUpdatedEnvelope {
|
|
|
1404
1679
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1405
1680
|
* @permissionScope Read Members
|
|
1406
1681
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1682
|
+
* @permissionScope Set Up Automations
|
|
1683
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1407
1684
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1408
1685
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1409
1686
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1437,6 +1714,8 @@ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope)
|
|
|
1437
1714
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1438
1715
|
* @permissionScope Manage Restaurants - all permissions
|
|
1439
1716
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1717
|
+
* @permissionScope Set Up Automations
|
|
1718
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1440
1719
|
* @applicableIdentity APP
|
|
1441
1720
|
* @applicableIdentity MEMBER
|
|
1442
1721
|
* @fqn com.wixpress.members.api.Members.UpdateMySlug
|
|
@@ -1462,6 +1741,8 @@ export declare function updateCurrentMemberSlug(slug: string): Promise<UpdateMyS
|
|
|
1462
1741
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1463
1742
|
* @permissionScope Manage Restaurants - all permissions
|
|
1464
1743
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1744
|
+
* @permissionScope Set Up Automations
|
|
1745
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1465
1746
|
* @applicableIdentity APP
|
|
1466
1747
|
* @applicableIdentity MEMBER
|
|
1467
1748
|
* @fqn com.wixpress.members.api.Members.UpdateMemberSlug
|
|
@@ -1532,6 +1813,8 @@ export declare function leaveCommunity(): Promise<LeaveCommunityResponse & Leave
|
|
|
1532
1813
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1533
1814
|
* @permissionScope Read Members
|
|
1534
1815
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1816
|
+
* @permissionScope Set Up Automations
|
|
1817
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1535
1818
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1536
1819
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1537
1820
|
* @applicableIdentity APP
|
|
@@ -1558,6 +1841,7 @@ export interface GetCurrentMemberOptions {
|
|
|
1558
1841
|
* Predefined set of fields to return.
|
|
1559
1842
|
*
|
|
1560
1843
|
* Default: `PUBLIC`.
|
|
1844
|
+
* @maxSize 3
|
|
1561
1845
|
*/
|
|
1562
1846
|
fieldsets?: Set[];
|
|
1563
1847
|
}
|
|
@@ -1587,6 +1871,8 @@ export interface GetCurrentMemberOptions {
|
|
|
1587
1871
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1588
1872
|
* @permissionScope Read Members
|
|
1589
1873
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1874
|
+
* @permissionScope Set Up Automations
|
|
1875
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1590
1876
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1591
1877
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1592
1878
|
* @applicableIdentity APP
|
|
@@ -1603,6 +1889,7 @@ export interface GetMemberOptions {
|
|
|
1603
1889
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1604
1890
|
*
|
|
1605
1891
|
* Default: `"PUBLIC"`.
|
|
1892
|
+
* @maxSize 3
|
|
1606
1893
|
*/
|
|
1607
1894
|
fieldsets?: Set[];
|
|
1608
1895
|
}
|
|
@@ -1630,6 +1917,8 @@ export interface GetMemberOptions {
|
|
|
1630
1917
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1631
1918
|
* @permissionScope Read Members
|
|
1632
1919
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1920
|
+
* @permissionScope Set Up Automations
|
|
1921
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1633
1922
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1634
1923
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1635
1924
|
* @applicableIdentity APP
|
|
@@ -1647,6 +1936,7 @@ export interface ListMembersOptions {
|
|
|
1647
1936
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1648
1937
|
*
|
|
1649
1938
|
* Default: `"PUBLIC"`.
|
|
1939
|
+
* @maxSize 3
|
|
1650
1940
|
*/
|
|
1651
1941
|
fieldsets?: Set[];
|
|
1652
1942
|
/** Sorting options. */
|
|
@@ -1689,6 +1979,8 @@ export interface ListMembersOptions {
|
|
|
1689
1979
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1690
1980
|
* @permissionScope Read Members
|
|
1691
1981
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1982
|
+
* @permissionScope Set Up Automations
|
|
1983
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1692
1984
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1693
1985
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1694
1986
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1705,6 +1997,7 @@ export interface QueryMembersOptions {
|
|
|
1705
1997
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1706
1998
|
*
|
|
1707
1999
|
* Default: `"PUBLIC"`.
|
|
2000
|
+
* @maxSize 3
|
|
1708
2001
|
*/
|
|
1709
2002
|
fieldsets?: Set[] | undefined;
|
|
1710
2003
|
/** Plain text search. */
|
|
@@ -1864,7 +2157,10 @@ export declare function deleteMember(_id: string): Promise<void>;
|
|
|
1864
2157
|
*/
|
|
1865
2158
|
export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
|
|
1866
2159
|
export interface DeleteMyMemberOptions {
|
|
1867
|
-
/**
|
|
2160
|
+
/**
|
|
2161
|
+
* ID of a member receiving deleted member's content.
|
|
2162
|
+
* @format GUID
|
|
2163
|
+
*/
|
|
1868
2164
|
contentAssigneeId?: string | null;
|
|
1869
2165
|
}
|
|
1870
2166
|
/**
|
|
@@ -1896,7 +2192,10 @@ export declare function bulkDeleteMembers(memberIds: string[]): Promise<BulkDele
|
|
|
1896
2192
|
*/
|
|
1897
2193
|
export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<BulkDeleteMembersByFilterResponse & BulkDeleteMembersByFilterResponseNonNullableFields>;
|
|
1898
2194
|
export interface BulkDeleteMembersByFilterOptions {
|
|
1899
|
-
/**
|
|
2195
|
+
/**
|
|
2196
|
+
* ID of a member receiving the deleted member's content.
|
|
2197
|
+
* @format GUID
|
|
2198
|
+
*/
|
|
1900
2199
|
contentAssigneeId?: string | null;
|
|
1901
2200
|
/** Plain text search. */
|
|
1902
2201
|
search?: Search;
|
|
@@ -1988,6 +2287,8 @@ export interface CreateMemberOptions {
|
|
|
1988
2287
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1989
2288
|
* @permissionScope Manage Restaurants - all permissions
|
|
1990
2289
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2290
|
+
* @permissionScope Set Up Automations
|
|
2291
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1991
2292
|
* @applicableIdentity APP
|
|
1992
2293
|
* @applicableIdentity MEMBER
|
|
1993
2294
|
* @returns Updated member.
|
|
@@ -1997,10 +2298,14 @@ export declare function updateMember(_id: string | null, member: UpdateMember):
|
|
|
1997
2298
|
export interface UpdateMember {
|
|
1998
2299
|
/**
|
|
1999
2300
|
* Member ID.
|
|
2301
|
+
* @format GUID
|
|
2000
2302
|
* @readonly
|
|
2001
2303
|
*/
|
|
2002
2304
|
_id?: string | null;
|
|
2003
|
-
/**
|
|
2305
|
+
/**
|
|
2306
|
+
* Email used by the member to log in to the site.
|
|
2307
|
+
* @format EMAIL
|
|
2308
|
+
*/
|
|
2004
2309
|
loginEmail?: string | null;
|
|
2005
2310
|
/**
|
|
2006
2311
|
* Whether the email used by the member has been verified.
|
|
@@ -2014,6 +2319,7 @@ export interface UpdateMember {
|
|
|
2014
2319
|
status?: Status;
|
|
2015
2320
|
/**
|
|
2016
2321
|
* Contact ID.
|
|
2322
|
+
* @format GUID
|
|
2017
2323
|
* @readonly
|
|
2018
2324
|
*/
|
|
2019
2325
|
contactId?: string | null;
|
|
@@ -2071,6 +2377,8 @@ export interface UpdateMember {
|
|
|
2071
2377
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2072
2378
|
* @permissionScope Manage Restaurants - all permissions
|
|
2073
2379
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2380
|
+
* @permissionScope Set Up Automations
|
|
2381
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2074
2382
|
* @applicableIdentity APP
|
|
2075
2383
|
* @applicableIdentity MEMBER
|
|
2076
2384
|
* @fqn com.wixpress.members.api.Members.DeleteMemberPhones
|
|
@@ -2103,6 +2411,8 @@ export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPho
|
|
|
2103
2411
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2104
2412
|
* @permissionScope Manage Restaurants - all permissions
|
|
2105
2413
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2414
|
+
* @permissionScope Set Up Automations
|
|
2415
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2106
2416
|
* @applicableIdentity APP
|
|
2107
2417
|
* @applicableIdentity MEMBER
|
|
2108
2418
|
* @fqn com.wixpress.members.api.Members.DeleteMemberEmails
|
|
@@ -2132,6 +2442,8 @@ export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEma
|
|
|
2132
2442
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2133
2443
|
* @permissionScope Manage Restaurants - all permissions
|
|
2134
2444
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2445
|
+
* @permissionScope Set Up Automations
|
|
2446
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2135
2447
|
* @applicableIdentity APP
|
|
2136
2448
|
* @applicableIdentity MEMBER
|
|
2137
2449
|
* @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
|