@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;
|
|
@@ -68,6 +73,7 @@ export interface Contact {
|
|
|
68
73
|
/**
|
|
69
74
|
* @internal
|
|
70
75
|
* @internal
|
|
76
|
+
* @format GUID
|
|
71
77
|
* @readonly
|
|
72
78
|
* @deprecated
|
|
73
79
|
*/
|
|
@@ -78,7 +84,10 @@ export interface Contact {
|
|
|
78
84
|
lastName?: string | null;
|
|
79
85
|
/** List of phone numbers. */
|
|
80
86
|
phones?: string[] | null;
|
|
81
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* List of email addresses.
|
|
89
|
+
* @format EMAIL
|
|
90
|
+
*/
|
|
82
91
|
emails?: string[] | null;
|
|
83
92
|
/** List of street addresses. */
|
|
84
93
|
addresses?: Address[];
|
|
@@ -86,11 +95,18 @@ export interface Contact {
|
|
|
86
95
|
* Contact's birthdate, formatted as `"YYYY-MM-DD"`.
|
|
87
96
|
*
|
|
88
97
|
* Example: `"2020-03-15"` for March 15, 2020.
|
|
98
|
+
* @maxLength 100
|
|
89
99
|
*/
|
|
90
100
|
birthdate?: string | null;
|
|
91
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* Contact's company name.
|
|
103
|
+
* @maxLength 100
|
|
104
|
+
*/
|
|
92
105
|
company?: string | null;
|
|
93
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* Contact's job title.
|
|
108
|
+
* @maxLength 100
|
|
109
|
+
*/
|
|
94
110
|
jobTitle?: string | null;
|
|
95
111
|
/**
|
|
96
112
|
* 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.
|
|
@@ -105,10 +121,14 @@ export interface Contact {
|
|
|
105
121
|
export interface Address extends AddressStreetOneOf {
|
|
106
122
|
/** Street address object, with number and name in separate fields. */
|
|
107
123
|
streetAddress?: StreetAddress;
|
|
108
|
-
/**
|
|
124
|
+
/**
|
|
125
|
+
* Main address line, usually street and number, as free text.
|
|
126
|
+
* @maxLength 200
|
|
127
|
+
*/
|
|
109
128
|
addressLine?: string | null;
|
|
110
129
|
/**
|
|
111
130
|
* Street address ID.
|
|
131
|
+
* @format GUID
|
|
112
132
|
* @readonly
|
|
113
133
|
*/
|
|
114
134
|
_id?: string | null;
|
|
@@ -136,13 +156,22 @@ export interface Address extends AddressStreetOneOf {
|
|
|
136
156
|
export interface AddressStreetOneOf {
|
|
137
157
|
/** Street address object, with number and name in separate fields. */
|
|
138
158
|
streetAddress?: StreetAddress;
|
|
139
|
-
/**
|
|
159
|
+
/**
|
|
160
|
+
* Main address line, usually street and number, as free text.
|
|
161
|
+
* @maxLength 200
|
|
162
|
+
*/
|
|
140
163
|
addressLine?: string | null;
|
|
141
164
|
}
|
|
142
165
|
export interface StreetAddress {
|
|
143
|
-
/**
|
|
166
|
+
/**
|
|
167
|
+
* Street number.
|
|
168
|
+
* @maxLength 100
|
|
169
|
+
*/
|
|
144
170
|
number?: string;
|
|
145
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* Street name.
|
|
173
|
+
* @maxLength 200
|
|
174
|
+
*/
|
|
146
175
|
name?: string;
|
|
147
176
|
}
|
|
148
177
|
export interface CustomField {
|
|
@@ -234,9 +263,15 @@ export interface ExtendedFields {
|
|
|
234
263
|
namespaces?: Record<string, Record<string, any>>;
|
|
235
264
|
}
|
|
236
265
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
237
|
-
/**
|
|
266
|
+
/**
|
|
267
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
268
|
+
* @format GUID
|
|
269
|
+
*/
|
|
238
270
|
metaSiteId?: string;
|
|
239
|
-
/**
|
|
271
|
+
/**
|
|
272
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
273
|
+
* @format GUID
|
|
274
|
+
*/
|
|
240
275
|
siteId?: string;
|
|
241
276
|
/** Invalidate by App */
|
|
242
277
|
app?: App;
|
|
@@ -246,7 +281,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
246
281
|
uri?: URI;
|
|
247
282
|
/** Invalidate by file (for media files such as PDFs) */
|
|
248
283
|
file?: File;
|
|
249
|
-
/**
|
|
284
|
+
/**
|
|
285
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
286
|
+
* @maxLength 256
|
|
287
|
+
*/
|
|
250
288
|
reason?: string | null;
|
|
251
289
|
/** Is local DS */
|
|
252
290
|
localDc?: boolean;
|
|
@@ -254,9 +292,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
254
292
|
}
|
|
255
293
|
/** @oneof */
|
|
256
294
|
export interface InvalidateCacheGetByOneOf {
|
|
257
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
297
|
+
* @format GUID
|
|
298
|
+
*/
|
|
258
299
|
metaSiteId?: string;
|
|
259
|
-
/**
|
|
300
|
+
/**
|
|
301
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
302
|
+
* @format GUID
|
|
303
|
+
*/
|
|
260
304
|
siteId?: string;
|
|
261
305
|
/** Invalidate by App */
|
|
262
306
|
app?: App;
|
|
@@ -268,31 +312,59 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
268
312
|
file?: File;
|
|
269
313
|
}
|
|
270
314
|
export interface App {
|
|
271
|
-
/**
|
|
315
|
+
/**
|
|
316
|
+
* The AppDefId
|
|
317
|
+
* @minLength 1
|
|
318
|
+
*/
|
|
272
319
|
appDefId?: string;
|
|
273
|
-
/**
|
|
320
|
+
/**
|
|
321
|
+
* The instance Id
|
|
322
|
+
* @format GUID
|
|
323
|
+
*/
|
|
274
324
|
instanceId?: string;
|
|
275
325
|
}
|
|
276
326
|
export interface Page {
|
|
277
|
-
/**
|
|
327
|
+
/**
|
|
328
|
+
* the msid the page is on
|
|
329
|
+
* @format GUID
|
|
330
|
+
*/
|
|
278
331
|
metaSiteId?: string;
|
|
279
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Invalidate by Page ID
|
|
334
|
+
* @minLength 1
|
|
335
|
+
*/
|
|
280
336
|
pageId?: string;
|
|
281
337
|
}
|
|
282
338
|
export interface URI {
|
|
283
|
-
/**
|
|
339
|
+
/**
|
|
340
|
+
* the msid the URI is on
|
|
341
|
+
* @format GUID
|
|
342
|
+
*/
|
|
284
343
|
metaSiteId?: string;
|
|
285
|
-
/**
|
|
344
|
+
/**
|
|
345
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
346
|
+
* @minLength 1
|
|
347
|
+
*/
|
|
286
348
|
uriPath?: string;
|
|
287
349
|
}
|
|
288
350
|
export interface File {
|
|
289
|
-
/**
|
|
351
|
+
/**
|
|
352
|
+
* the msid the file is related to
|
|
353
|
+
* @format GUID
|
|
354
|
+
*/
|
|
290
355
|
metaSiteId?: string;
|
|
291
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
358
|
+
* @minLength 1
|
|
359
|
+
* @maxLength 256
|
|
360
|
+
*/
|
|
292
361
|
fileName?: string;
|
|
293
362
|
}
|
|
294
363
|
export interface UpdateMySlugRequest {
|
|
295
|
-
/**
|
|
364
|
+
/**
|
|
365
|
+
* New slug.
|
|
366
|
+
* @maxLength 255
|
|
367
|
+
*/
|
|
296
368
|
slug: string;
|
|
297
369
|
}
|
|
298
370
|
export interface UpdateMySlugResponse {
|
|
@@ -303,9 +375,15 @@ export interface SlugAlreadyExistsPayload {
|
|
|
303
375
|
slug?: string;
|
|
304
376
|
}
|
|
305
377
|
export interface UpdateMemberSlugRequest {
|
|
306
|
-
/**
|
|
378
|
+
/**
|
|
379
|
+
* Member ID.
|
|
380
|
+
* @format GUID
|
|
381
|
+
*/
|
|
307
382
|
_id: string;
|
|
308
|
-
/**
|
|
383
|
+
/**
|
|
384
|
+
* New slug.
|
|
385
|
+
* @maxLength 255
|
|
386
|
+
*/
|
|
309
387
|
slug: string;
|
|
310
388
|
}
|
|
311
389
|
export interface UpdateMemberSlugResponse {
|
|
@@ -322,6 +400,7 @@ export interface JoinCommunityResponse {
|
|
|
322
400
|
export interface MemberJoinedCommunity {
|
|
323
401
|
/**
|
|
324
402
|
* Member id who joined the community
|
|
403
|
+
* @format GUID
|
|
325
404
|
* @readonly
|
|
326
405
|
*/
|
|
327
406
|
memberId?: string;
|
|
@@ -336,6 +415,7 @@ export interface LeaveCommunityResponse {
|
|
|
336
415
|
export interface MemberLeftCommunity {
|
|
337
416
|
/**
|
|
338
417
|
* Member id who left the community
|
|
418
|
+
* @format GUID
|
|
339
419
|
* @readonly
|
|
340
420
|
*/
|
|
341
421
|
memberId?: string;
|
|
@@ -358,6 +438,7 @@ export interface GetMyMemberRequest {
|
|
|
358
438
|
* Predefined set of fields to return.
|
|
359
439
|
*
|
|
360
440
|
* Default: `PUBLIC`.
|
|
441
|
+
* @maxSize 3
|
|
361
442
|
*/
|
|
362
443
|
fieldsets?: Set[];
|
|
363
444
|
}
|
|
@@ -378,7 +459,10 @@ export interface GetMyMemberResponse {
|
|
|
378
459
|
member?: Member;
|
|
379
460
|
}
|
|
380
461
|
export interface GetMemberRequest {
|
|
381
|
-
/**
|
|
462
|
+
/**
|
|
463
|
+
* Member ID.
|
|
464
|
+
* @format GUID
|
|
465
|
+
*/
|
|
382
466
|
_id: string;
|
|
383
467
|
/**
|
|
384
468
|
* Predefined set of fields to return. One of:
|
|
@@ -387,6 +471,7 @@ export interface GetMemberRequest {
|
|
|
387
471
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
388
472
|
*
|
|
389
473
|
*
|
|
474
|
+
* @maxSize 3
|
|
390
475
|
*/
|
|
391
476
|
fieldsets?: Set[];
|
|
392
477
|
}
|
|
@@ -395,7 +480,10 @@ export interface GetMemberResponse {
|
|
|
395
480
|
member?: Member;
|
|
396
481
|
}
|
|
397
482
|
export interface MemberToMemberBlockedPayload {
|
|
398
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* Member ID.
|
|
485
|
+
* @format GUID
|
|
486
|
+
*/
|
|
399
487
|
memberId?: string;
|
|
400
488
|
}
|
|
401
489
|
export interface ListMembersRequest {
|
|
@@ -407,6 +495,7 @@ export interface ListMembersRequest {
|
|
|
407
495
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
408
496
|
*
|
|
409
497
|
* Default: `"PUBLIC"`.
|
|
498
|
+
* @maxSize 3
|
|
410
499
|
*/
|
|
411
500
|
fieldsets?: Set[];
|
|
412
501
|
sorting?: Sorting[];
|
|
@@ -418,7 +507,10 @@ export interface Paging {
|
|
|
418
507
|
offset?: number | null;
|
|
419
508
|
}
|
|
420
509
|
export interface Sorting {
|
|
421
|
-
/**
|
|
510
|
+
/**
|
|
511
|
+
* Name of the field to sort by.
|
|
512
|
+
* @maxLength 512
|
|
513
|
+
*/
|
|
422
514
|
fieldName?: string;
|
|
423
515
|
/** Sort order. */
|
|
424
516
|
order?: SortOrder;
|
|
@@ -428,13 +520,17 @@ export declare enum SortOrder {
|
|
|
428
520
|
DESC = "DESC"
|
|
429
521
|
}
|
|
430
522
|
export interface CursorPaging {
|
|
431
|
-
/**
|
|
523
|
+
/**
|
|
524
|
+
* Maximum number of items to return in the results.
|
|
525
|
+
* @max 100
|
|
526
|
+
*/
|
|
432
527
|
limit?: number | null;
|
|
433
528
|
/**
|
|
434
529
|
* Pointer to the next or previous page in the list of results.
|
|
435
530
|
*
|
|
436
531
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
437
532
|
* Not relevant for the first request.
|
|
533
|
+
* @maxLength 16000
|
|
438
534
|
*/
|
|
439
535
|
cursor?: string | null;
|
|
440
536
|
}
|
|
@@ -468,9 +564,15 @@ export interface CursorPagingMetadata {
|
|
|
468
564
|
hasNext?: boolean | null;
|
|
469
565
|
}
|
|
470
566
|
export interface Cursors {
|
|
471
|
-
/**
|
|
567
|
+
/**
|
|
568
|
+
* Cursor string pointing to the next page in the list of results.
|
|
569
|
+
* @maxLength 16000
|
|
570
|
+
*/
|
|
472
571
|
next?: string | null;
|
|
473
|
-
/**
|
|
572
|
+
/**
|
|
573
|
+
* Cursor pointing to the previous page in the list of results.
|
|
574
|
+
* @maxLength 16000
|
|
575
|
+
*/
|
|
474
576
|
prev?: string | null;
|
|
475
577
|
}
|
|
476
578
|
export interface QueryMembersRequest {
|
|
@@ -480,6 +582,7 @@ export interface QueryMembersRequest {
|
|
|
480
582
|
* Predefined sets of fields to return.
|
|
481
583
|
*
|
|
482
584
|
* Default: `PUBLIC`.
|
|
585
|
+
* @maxSize 3
|
|
483
586
|
*/
|
|
484
587
|
fieldsets?: Set[];
|
|
485
588
|
/** Plain text search. */
|
|
@@ -495,7 +598,11 @@ export interface Query {
|
|
|
495
598
|
}
|
|
496
599
|
/** Free text to match in searchable fields */
|
|
497
600
|
export interface Search {
|
|
498
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* Search term or expression.
|
|
603
|
+
* @minLength 1
|
|
604
|
+
* @maxLength 100
|
|
605
|
+
*/
|
|
499
606
|
expression?: string | null;
|
|
500
607
|
/**
|
|
501
608
|
* Currently supported fields for search:
|
|
@@ -508,6 +615,7 @@ export interface Search {
|
|
|
508
615
|
* - `profile.slug`
|
|
509
616
|
*
|
|
510
617
|
* Default: `profile.nickname`.
|
|
618
|
+
* @maxSize 4
|
|
511
619
|
*/
|
|
512
620
|
fields?: string[];
|
|
513
621
|
}
|
|
@@ -518,7 +626,10 @@ export interface QueryMembersResponse {
|
|
|
518
626
|
metadata?: PagingMetadata;
|
|
519
627
|
}
|
|
520
628
|
export interface MuteMemberRequest {
|
|
521
|
-
/**
|
|
629
|
+
/**
|
|
630
|
+
* ID of the member to mute.
|
|
631
|
+
* @format GUID
|
|
632
|
+
*/
|
|
522
633
|
_id: string;
|
|
523
634
|
}
|
|
524
635
|
export interface MuteMemberResponse {
|
|
@@ -528,12 +639,16 @@ export interface MuteMemberResponse {
|
|
|
528
639
|
export interface MemberMuted {
|
|
529
640
|
/**
|
|
530
641
|
* Member id who got muted
|
|
642
|
+
* @format GUID
|
|
531
643
|
* @readonly
|
|
532
644
|
*/
|
|
533
645
|
memberId?: string;
|
|
534
646
|
}
|
|
535
647
|
export interface UnmuteMemberRequest {
|
|
536
|
-
/**
|
|
648
|
+
/**
|
|
649
|
+
* ID of the member to unmute.
|
|
650
|
+
* @format GUID
|
|
651
|
+
*/
|
|
537
652
|
_id: string;
|
|
538
653
|
}
|
|
539
654
|
export interface UnmuteMemberResponse {
|
|
@@ -543,12 +658,16 @@ export interface UnmuteMemberResponse {
|
|
|
543
658
|
export interface MemberUnmuted {
|
|
544
659
|
/**
|
|
545
660
|
* Member id who got unmuted
|
|
661
|
+
* @format GUID
|
|
546
662
|
* @readonly
|
|
547
663
|
*/
|
|
548
664
|
memberId?: string;
|
|
549
665
|
}
|
|
550
666
|
export interface ApproveMemberRequest {
|
|
551
|
-
/**
|
|
667
|
+
/**
|
|
668
|
+
* ID of the member to approve.
|
|
669
|
+
* @format GUID
|
|
670
|
+
*/
|
|
552
671
|
_id: string;
|
|
553
672
|
}
|
|
554
673
|
export interface ApproveMemberResponse {
|
|
@@ -558,12 +677,16 @@ export interface ApproveMemberResponse {
|
|
|
558
677
|
export interface MemberApproved {
|
|
559
678
|
/**
|
|
560
679
|
* Member id who got approved
|
|
680
|
+
* @format GUID
|
|
561
681
|
* @readonly
|
|
562
682
|
*/
|
|
563
683
|
memberId?: string;
|
|
564
684
|
}
|
|
565
685
|
export interface BlockMemberRequest {
|
|
566
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* ID of a member to block.
|
|
688
|
+
* @format GUID
|
|
689
|
+
*/
|
|
567
690
|
_id: string;
|
|
568
691
|
}
|
|
569
692
|
export interface BlockMemberResponse {
|
|
@@ -573,24 +696,37 @@ export interface BlockMemberResponse {
|
|
|
573
696
|
export interface MemberBlocked {
|
|
574
697
|
/**
|
|
575
698
|
* Member id who got blocked
|
|
699
|
+
* @format GUID
|
|
576
700
|
* @readonly
|
|
577
701
|
*/
|
|
578
702
|
memberId?: string;
|
|
579
703
|
}
|
|
580
704
|
export interface MemberSelfBlockForbiddenPayload {
|
|
581
|
-
/**
|
|
705
|
+
/**
|
|
706
|
+
* Target's member ID.
|
|
707
|
+
* @format GUID
|
|
708
|
+
*/
|
|
582
709
|
memberId?: string;
|
|
583
710
|
}
|
|
584
711
|
export interface OwnerMemberBlockForbiddenPayload {
|
|
585
|
-
/**
|
|
712
|
+
/**
|
|
713
|
+
* Owner's member ID.
|
|
714
|
+
* @format GUID
|
|
715
|
+
*/
|
|
586
716
|
memberId?: string;
|
|
587
717
|
}
|
|
588
718
|
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
589
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* Active subscription member ID.
|
|
721
|
+
* @format GUID
|
|
722
|
+
*/
|
|
590
723
|
memberId?: string;
|
|
591
724
|
}
|
|
592
725
|
export interface DisconnectMemberRequest {
|
|
593
|
-
/**
|
|
726
|
+
/**
|
|
727
|
+
* ID of a member to disconnect.
|
|
728
|
+
* @format GUID
|
|
729
|
+
*/
|
|
594
730
|
_id: string;
|
|
595
731
|
}
|
|
596
732
|
export interface DisconnectMemberResponse {
|
|
@@ -598,7 +734,10 @@ export interface DisconnectMemberResponse {
|
|
|
598
734
|
member?: Member;
|
|
599
735
|
}
|
|
600
736
|
export interface DeleteMemberRequest {
|
|
601
|
-
/**
|
|
737
|
+
/**
|
|
738
|
+
* ID of the member to delete.
|
|
739
|
+
* @format GUID
|
|
740
|
+
*/
|
|
602
741
|
_id: string;
|
|
603
742
|
}
|
|
604
743
|
export interface DeleteMemberResponse {
|
|
@@ -611,21 +750,35 @@ export interface ContentDeletionRequested {
|
|
|
611
750
|
member?: Member;
|
|
612
751
|
}
|
|
613
752
|
export interface OwnerOrContributorDeleteForbiddenPayload {
|
|
614
|
-
/**
|
|
753
|
+
/**
|
|
754
|
+
* Owner's or contributor's member ID.
|
|
755
|
+
* @format GUID
|
|
756
|
+
*/
|
|
615
757
|
memberId?: string;
|
|
616
758
|
}
|
|
617
759
|
export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
618
|
-
/**
|
|
760
|
+
/**
|
|
761
|
+
* Active subscription member ID.
|
|
762
|
+
* @format GUID
|
|
763
|
+
*/
|
|
619
764
|
memberId?: string;
|
|
620
765
|
}
|
|
621
766
|
export interface DeleteMyMemberRequest {
|
|
622
|
-
/**
|
|
767
|
+
/**
|
|
768
|
+
* ID of a member receiving deleted member's content.
|
|
769
|
+
* @format GUID
|
|
770
|
+
*/
|
|
623
771
|
contentAssigneeId?: string | null;
|
|
624
772
|
}
|
|
625
773
|
export interface DeleteMyMemberResponse {
|
|
626
774
|
}
|
|
627
775
|
export interface BulkDeleteMembersRequest {
|
|
628
|
-
/**
|
|
776
|
+
/**
|
|
777
|
+
* IDs of members to be deleted.
|
|
778
|
+
* @minSize 1
|
|
779
|
+
* @maxSize 100
|
|
780
|
+
* @format GUID
|
|
781
|
+
*/
|
|
629
782
|
memberIds: string[];
|
|
630
783
|
}
|
|
631
784
|
export interface BulkDeleteMembersResponse {
|
|
@@ -635,7 +788,10 @@ export interface BulkDeleteMembersResponse {
|
|
|
635
788
|
bulkActionMetadata?: BulkActionMetadata;
|
|
636
789
|
}
|
|
637
790
|
export interface ItemMetadata {
|
|
638
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
793
|
+
* @maxLength 255
|
|
794
|
+
*/
|
|
639
795
|
_id?: string | null;
|
|
640
796
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
641
797
|
originalIndex?: number;
|
|
@@ -666,7 +822,10 @@ export interface BulkActionMetadata {
|
|
|
666
822
|
export interface BulkDeleteMembersByFilterRequest {
|
|
667
823
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
668
824
|
filter: any;
|
|
669
|
-
/**
|
|
825
|
+
/**
|
|
826
|
+
* ID of a member receiving the deleted member's content.
|
|
827
|
+
* @format GUID
|
|
828
|
+
*/
|
|
670
829
|
contentAssigneeId?: string | null;
|
|
671
830
|
/** Plain text search. */
|
|
672
831
|
search?: Search;
|
|
@@ -721,7 +880,10 @@ export interface InvalidCustomFieldUrlPayload {
|
|
|
721
880
|
fields?: Record<string, string>;
|
|
722
881
|
}
|
|
723
882
|
export interface DeleteMemberPhonesRequest {
|
|
724
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* ID of the member whose phone numbers will be deleted.
|
|
885
|
+
* @format GUID
|
|
886
|
+
*/
|
|
725
887
|
_id: string;
|
|
726
888
|
}
|
|
727
889
|
export interface DeleteMemberPhonesResponse {
|
|
@@ -729,7 +891,10 @@ export interface DeleteMemberPhonesResponse {
|
|
|
729
891
|
member?: Member;
|
|
730
892
|
}
|
|
731
893
|
export interface DeleteMemberEmailsRequest {
|
|
732
|
-
/**
|
|
894
|
+
/**
|
|
895
|
+
* ID of the member whose email addresses will be deleted.
|
|
896
|
+
* @format GUID
|
|
897
|
+
*/
|
|
733
898
|
_id: string;
|
|
734
899
|
}
|
|
735
900
|
export interface DeleteMemberEmailsResponse {
|
|
@@ -737,7 +902,10 @@ export interface DeleteMemberEmailsResponse {
|
|
|
737
902
|
member?: Member;
|
|
738
903
|
}
|
|
739
904
|
export interface DeleteMemberAddressesRequest {
|
|
740
|
-
/**
|
|
905
|
+
/**
|
|
906
|
+
* ID of the member whose street addresses will be deleted.
|
|
907
|
+
* @format GUID
|
|
908
|
+
*/
|
|
741
909
|
_id: string;
|
|
742
910
|
}
|
|
743
911
|
export interface DeleteMemberAddressesResponse {
|
|
@@ -847,7 +1015,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
847
1015
|
studioAssigned?: StudioAssigned;
|
|
848
1016
|
/** Emitted when Studio is detached. */
|
|
849
1017
|
studioUnassigned?: StudioUnassigned;
|
|
850
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* A meta site id.
|
|
1020
|
+
* @format GUID
|
|
1021
|
+
*/
|
|
851
1022
|
metaSiteId?: string;
|
|
852
1023
|
/** A meta site version. Monotonically increasing. */
|
|
853
1024
|
version?: string;
|
|
@@ -856,6 +1027,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
856
1027
|
/**
|
|
857
1028
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
858
1029
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1030
|
+
* @maxSize 4000
|
|
859
1031
|
*/
|
|
860
1032
|
assets?: Asset[];
|
|
861
1033
|
}
|
|
@@ -893,9 +1065,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
893
1065
|
studioUnassigned?: StudioUnassigned;
|
|
894
1066
|
}
|
|
895
1067
|
export interface Asset {
|
|
896
|
-
/**
|
|
1068
|
+
/**
|
|
1069
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1070
|
+
* @maxLength 36
|
|
1071
|
+
*/
|
|
897
1072
|
appDefId?: string;
|
|
898
|
-
/**
|
|
1073
|
+
/**
|
|
1074
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
1075
|
+
* @maxLength 200
|
|
1076
|
+
*/
|
|
899
1077
|
instanceId?: string;
|
|
900
1078
|
/** An application state. */
|
|
901
1079
|
state?: State;
|
|
@@ -908,9 +1086,15 @@ export declare enum State {
|
|
|
908
1086
|
DEMO = "DEMO"
|
|
909
1087
|
}
|
|
910
1088
|
export interface SiteCreated {
|
|
911
|
-
/**
|
|
1089
|
+
/**
|
|
1090
|
+
* A template identifier (empty if not created from a template).
|
|
1091
|
+
* @maxLength 36
|
|
1092
|
+
*/
|
|
912
1093
|
originTemplateId?: string;
|
|
913
|
-
/**
|
|
1094
|
+
/**
|
|
1095
|
+
* An account id of the owner.
|
|
1096
|
+
* @format GUID
|
|
1097
|
+
*/
|
|
914
1098
|
ownerId?: string;
|
|
915
1099
|
/** A context in which meta site was created. */
|
|
916
1100
|
context?: SiteCreatedContext;
|
|
@@ -919,9 +1103,13 @@ export interface SiteCreated {
|
|
|
919
1103
|
*
|
|
920
1104
|
* In case of a creation from a template it's a template id.
|
|
921
1105
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1106
|
+
* @format GUID
|
|
922
1107
|
*/
|
|
923
1108
|
originMetaSiteId?: string | null;
|
|
924
|
-
/**
|
|
1109
|
+
/**
|
|
1110
|
+
* A meta site name (URL slug).
|
|
1111
|
+
* @maxLength 20
|
|
1112
|
+
*/
|
|
925
1113
|
siteName?: string;
|
|
926
1114
|
/** A namespace. */
|
|
927
1115
|
namespace?: Namespace;
|
|
@@ -1018,9 +1206,15 @@ export declare enum Namespace {
|
|
|
1018
1206
|
}
|
|
1019
1207
|
/** Site transferred to another user. */
|
|
1020
1208
|
export interface SiteTransferred {
|
|
1021
|
-
/**
|
|
1209
|
+
/**
|
|
1210
|
+
* A previous owner id (user that transfers meta site).
|
|
1211
|
+
* @format GUID
|
|
1212
|
+
*/
|
|
1022
1213
|
oldOwnerId?: string;
|
|
1023
|
-
/**
|
|
1214
|
+
/**
|
|
1215
|
+
* A new owner id (user that accepts meta site).
|
|
1216
|
+
* @format GUID
|
|
1217
|
+
*/
|
|
1024
1218
|
newOwnerId?: string;
|
|
1025
1219
|
}
|
|
1026
1220
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -1033,9 +1227,15 @@ export interface DeleteContext {
|
|
|
1033
1227
|
dateDeleted?: Date | null;
|
|
1034
1228
|
/** A status. */
|
|
1035
1229
|
deleteStatus?: DeleteStatus;
|
|
1036
|
-
/**
|
|
1230
|
+
/**
|
|
1231
|
+
* A reason (flow).
|
|
1232
|
+
* @maxLength 255
|
|
1233
|
+
*/
|
|
1037
1234
|
deleteOrigin?: string;
|
|
1038
|
-
/**
|
|
1235
|
+
/**
|
|
1236
|
+
* A service that deleted it.
|
|
1237
|
+
* @maxLength 255
|
|
1238
|
+
*/
|
|
1039
1239
|
initiatorId?: string | null;
|
|
1040
1240
|
}
|
|
1041
1241
|
export declare enum DeleteStatus {
|
|
@@ -1051,7 +1251,11 @@ export interface SiteUndeleted {
|
|
|
1051
1251
|
export interface SitePublished {
|
|
1052
1252
|
}
|
|
1053
1253
|
export interface SiteUnpublished {
|
|
1054
|
-
/**
|
|
1254
|
+
/**
|
|
1255
|
+
* A list of URLs previously associated with the meta site.
|
|
1256
|
+
* @maxLength 4000
|
|
1257
|
+
* @maxSize 10000
|
|
1258
|
+
*/
|
|
1055
1259
|
urls?: string[];
|
|
1056
1260
|
}
|
|
1057
1261
|
export interface SiteMarkedAsTemplate {
|
|
@@ -1074,30 +1278,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
1074
1278
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1075
1279
|
*/
|
|
1076
1280
|
export interface ServiceProvisioned {
|
|
1077
|
-
/**
|
|
1281
|
+
/**
|
|
1282
|
+
* Either UUID or EmbeddedServiceType.
|
|
1283
|
+
* @maxLength 36
|
|
1284
|
+
*/
|
|
1078
1285
|
appDefId?: string;
|
|
1079
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* Not only UUID. Something here could be something weird.
|
|
1288
|
+
* @maxLength 36
|
|
1289
|
+
*/
|
|
1080
1290
|
instanceId?: string;
|
|
1081
|
-
/**
|
|
1291
|
+
/**
|
|
1292
|
+
* An instance id from which this instance is originated.
|
|
1293
|
+
* @maxLength 36
|
|
1294
|
+
*/
|
|
1082
1295
|
originInstanceId?: string;
|
|
1083
|
-
/**
|
|
1296
|
+
/**
|
|
1297
|
+
* A version.
|
|
1298
|
+
* @maxLength 500
|
|
1299
|
+
*/
|
|
1084
1300
|
version?: string | null;
|
|
1085
|
-
/**
|
|
1301
|
+
/**
|
|
1302
|
+
* The origin meta site id
|
|
1303
|
+
* @format GUID
|
|
1304
|
+
*/
|
|
1086
1305
|
originMetaSiteId?: string | null;
|
|
1087
1306
|
}
|
|
1088
1307
|
export interface ServiceRemoved {
|
|
1089
|
-
/**
|
|
1308
|
+
/**
|
|
1309
|
+
* Either UUID or EmbeddedServiceType.
|
|
1310
|
+
* @maxLength 36
|
|
1311
|
+
*/
|
|
1090
1312
|
appDefId?: string;
|
|
1091
|
-
/**
|
|
1313
|
+
/**
|
|
1314
|
+
* Not only UUID. Something here could be something weird.
|
|
1315
|
+
* @maxLength 36
|
|
1316
|
+
*/
|
|
1092
1317
|
instanceId?: string;
|
|
1093
|
-
/**
|
|
1318
|
+
/**
|
|
1319
|
+
* A version.
|
|
1320
|
+
* @maxLength 500
|
|
1321
|
+
*/
|
|
1094
1322
|
version?: string | null;
|
|
1095
1323
|
}
|
|
1096
1324
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1097
1325
|
export interface SiteRenamed {
|
|
1098
|
-
/**
|
|
1326
|
+
/**
|
|
1327
|
+
* A new meta site name (URL slug).
|
|
1328
|
+
* @maxLength 20
|
|
1329
|
+
*/
|
|
1099
1330
|
newSiteName?: string;
|
|
1100
|
-
/**
|
|
1331
|
+
/**
|
|
1332
|
+
* A previous meta site name (URL slug).
|
|
1333
|
+
* @maxLength 255
|
|
1334
|
+
*/
|
|
1101
1335
|
oldSiteName?: string;
|
|
1102
1336
|
}
|
|
1103
1337
|
/**
|
|
@@ -1126,13 +1360,21 @@ export interface MemberOwnershipTransferred {
|
|
|
1126
1360
|
toMember?: Member;
|
|
1127
1361
|
}
|
|
1128
1362
|
export interface MemberIdChanged {
|
|
1363
|
+
/** @format GUID */
|
|
1129
1364
|
fromId?: string;
|
|
1365
|
+
/** @format GUID */
|
|
1130
1366
|
toId?: string;
|
|
1131
1367
|
}
|
|
1132
1368
|
export interface MessageEnvelope {
|
|
1133
|
-
/**
|
|
1369
|
+
/**
|
|
1370
|
+
* App instance ID.
|
|
1371
|
+
* @format GUID
|
|
1372
|
+
*/
|
|
1134
1373
|
instanceId?: string | null;
|
|
1135
|
-
/**
|
|
1374
|
+
/**
|
|
1375
|
+
* Event type.
|
|
1376
|
+
* @maxLength 150
|
|
1377
|
+
*/
|
|
1136
1378
|
eventType?: string;
|
|
1137
1379
|
/** The identification type and identity data. */
|
|
1138
1380
|
identity?: IdentificationData;
|
|
@@ -1140,26 +1382,50 @@ export interface MessageEnvelope {
|
|
|
1140
1382
|
data?: string;
|
|
1141
1383
|
}
|
|
1142
1384
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1143
|
-
/**
|
|
1385
|
+
/**
|
|
1386
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1387
|
+
* @format GUID
|
|
1388
|
+
*/
|
|
1144
1389
|
anonymousVisitorId?: string;
|
|
1145
|
-
/**
|
|
1390
|
+
/**
|
|
1391
|
+
* ID of a site visitor that has logged in to the site.
|
|
1392
|
+
* @format GUID
|
|
1393
|
+
*/
|
|
1146
1394
|
memberId?: string;
|
|
1147
|
-
/**
|
|
1395
|
+
/**
|
|
1396
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1397
|
+
* @format GUID
|
|
1398
|
+
*/
|
|
1148
1399
|
wixUserId?: string;
|
|
1149
|
-
/**
|
|
1400
|
+
/**
|
|
1401
|
+
* ID of an app.
|
|
1402
|
+
* @format GUID
|
|
1403
|
+
*/
|
|
1150
1404
|
appId?: string;
|
|
1151
1405
|
/** @readonly */
|
|
1152
1406
|
identityType?: WebhookIdentityType;
|
|
1153
1407
|
}
|
|
1154
1408
|
/** @oneof */
|
|
1155
1409
|
export interface IdentificationDataIdOneOf {
|
|
1156
|
-
/**
|
|
1410
|
+
/**
|
|
1411
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1412
|
+
* @format GUID
|
|
1413
|
+
*/
|
|
1157
1414
|
anonymousVisitorId?: string;
|
|
1158
|
-
/**
|
|
1415
|
+
/**
|
|
1416
|
+
* ID of a site visitor that has logged in to the site.
|
|
1417
|
+
* @format GUID
|
|
1418
|
+
*/
|
|
1159
1419
|
memberId?: string;
|
|
1160
|
-
/**
|
|
1420
|
+
/**
|
|
1421
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1422
|
+
* @format GUID
|
|
1423
|
+
*/
|
|
1161
1424
|
wixUserId?: string;
|
|
1162
|
-
/**
|
|
1425
|
+
/**
|
|
1426
|
+
* ID of an app.
|
|
1427
|
+
* @format GUID
|
|
1428
|
+
*/
|
|
1163
1429
|
appId?: string;
|
|
1164
1430
|
}
|
|
1165
1431
|
export declare enum WebhookIdentityType {
|
|
@@ -1281,9 +1547,15 @@ export interface DeleteMemberAddressesResponseNonNullableFields {
|
|
|
1281
1547
|
member?: MemberNonNullableFields;
|
|
1282
1548
|
}
|
|
1283
1549
|
export interface BaseEventMetadata {
|
|
1284
|
-
/**
|
|
1550
|
+
/**
|
|
1551
|
+
* App instance ID.
|
|
1552
|
+
* @format GUID
|
|
1553
|
+
*/
|
|
1285
1554
|
instanceId?: string | null;
|
|
1286
|
-
/**
|
|
1555
|
+
/**
|
|
1556
|
+
* Event type.
|
|
1557
|
+
* @maxLength 150
|
|
1558
|
+
*/
|
|
1287
1559
|
eventType?: string;
|
|
1288
1560
|
/** The identification type and identity data. */
|
|
1289
1561
|
identity?: IdentificationData;
|
|
@@ -1352,6 +1624,8 @@ export interface MemberCreatedEnvelope {
|
|
|
1352
1624
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1353
1625
|
* @permissionScope Read Members
|
|
1354
1626
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1627
|
+
* @permissionScope Set Up Automations
|
|
1628
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1355
1629
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1356
1630
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1357
1631
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1382,6 +1656,8 @@ export interface MemberDeletedEnvelope {
|
|
|
1382
1656
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1383
1657
|
* @permissionScope Read Members
|
|
1384
1658
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1659
|
+
* @permissionScope Set Up Automations
|
|
1660
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1385
1661
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1386
1662
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1387
1663
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1411,6 +1687,8 @@ export interface MemberUpdatedEnvelope {
|
|
|
1411
1687
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1412
1688
|
* @permissionScope Read Members
|
|
1413
1689
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1690
|
+
* @permissionScope Set Up Automations
|
|
1691
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1414
1692
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1415
1693
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1416
1694
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1444,6 +1722,8 @@ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope)
|
|
|
1444
1722
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1445
1723
|
* @permissionScope Manage Restaurants - all permissions
|
|
1446
1724
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1725
|
+
* @permissionScope Set Up Automations
|
|
1726
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1447
1727
|
* @applicableIdentity APP
|
|
1448
1728
|
* @applicableIdentity MEMBER
|
|
1449
1729
|
* @fqn com.wixpress.members.api.Members.UpdateMySlug
|
|
@@ -1469,6 +1749,8 @@ export declare function updateCurrentMemberSlug(slug: string): Promise<UpdateMyS
|
|
|
1469
1749
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1470
1750
|
* @permissionScope Manage Restaurants - all permissions
|
|
1471
1751
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1752
|
+
* @permissionScope Set Up Automations
|
|
1753
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1472
1754
|
* @applicableIdentity APP
|
|
1473
1755
|
* @applicableIdentity MEMBER
|
|
1474
1756
|
* @fqn com.wixpress.members.api.Members.UpdateMemberSlug
|
|
@@ -1539,6 +1821,8 @@ export declare function leaveCommunity(): Promise<LeaveCommunityResponse & Leave
|
|
|
1539
1821
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1540
1822
|
* @permissionScope Read Members
|
|
1541
1823
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1824
|
+
* @permissionScope Set Up Automations
|
|
1825
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1542
1826
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1543
1827
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1544
1828
|
* @applicableIdentity APP
|
|
@@ -1565,6 +1849,7 @@ export interface GetCurrentMemberOptions {
|
|
|
1565
1849
|
* Predefined set of fields to return.
|
|
1566
1850
|
*
|
|
1567
1851
|
* Default: `PUBLIC`.
|
|
1852
|
+
* @maxSize 3
|
|
1568
1853
|
*/
|
|
1569
1854
|
fieldsets?: Set[];
|
|
1570
1855
|
}
|
|
@@ -1594,6 +1879,8 @@ export interface GetCurrentMemberOptions {
|
|
|
1594
1879
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1595
1880
|
* @permissionScope Read Members
|
|
1596
1881
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1882
|
+
* @permissionScope Set Up Automations
|
|
1883
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1597
1884
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1598
1885
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1599
1886
|
* @applicableIdentity APP
|
|
@@ -1610,6 +1897,7 @@ export interface GetMemberOptions {
|
|
|
1610
1897
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1611
1898
|
*
|
|
1612
1899
|
* Default: `"PUBLIC"`.
|
|
1900
|
+
* @maxSize 3
|
|
1613
1901
|
*/
|
|
1614
1902
|
fieldsets?: Set[];
|
|
1615
1903
|
}
|
|
@@ -1637,6 +1925,8 @@ export interface GetMemberOptions {
|
|
|
1637
1925
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1638
1926
|
* @permissionScope Read Members
|
|
1639
1927
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1928
|
+
* @permissionScope Set Up Automations
|
|
1929
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1640
1930
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1641
1931
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1642
1932
|
* @applicableIdentity APP
|
|
@@ -1654,6 +1944,7 @@ export interface ListMembersOptions {
|
|
|
1654
1944
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1655
1945
|
*
|
|
1656
1946
|
* Default: `"PUBLIC"`.
|
|
1947
|
+
* @maxSize 3
|
|
1657
1948
|
*/
|
|
1658
1949
|
fieldsets?: Set[];
|
|
1659
1950
|
/** Sorting options. */
|
|
@@ -1696,6 +1987,8 @@ export interface ListMembersOptions {
|
|
|
1696
1987
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1697
1988
|
* @permissionScope Read Members
|
|
1698
1989
|
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1990
|
+
* @permissionScope Set Up Automations
|
|
1991
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1699
1992
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
1700
1993
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1701
1994
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -1712,6 +2005,7 @@ export interface QueryMembersOptions {
|
|
|
1712
2005
|
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1713
2006
|
*
|
|
1714
2007
|
* Default: `"PUBLIC"`.
|
|
2008
|
+
* @maxSize 3
|
|
1715
2009
|
*/
|
|
1716
2010
|
fieldsets?: Set[] | undefined;
|
|
1717
2011
|
/** Plain text search. */
|
|
@@ -1871,7 +2165,10 @@ export declare function deleteMember(_id: string): Promise<void>;
|
|
|
1871
2165
|
*/
|
|
1872
2166
|
export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
|
|
1873
2167
|
export interface DeleteMyMemberOptions {
|
|
1874
|
-
/**
|
|
2168
|
+
/**
|
|
2169
|
+
* ID of a member receiving deleted member's content.
|
|
2170
|
+
* @format GUID
|
|
2171
|
+
*/
|
|
1875
2172
|
contentAssigneeId?: string | null;
|
|
1876
2173
|
}
|
|
1877
2174
|
/**
|
|
@@ -1903,7 +2200,10 @@ export declare function bulkDeleteMembers(memberIds: string[]): Promise<BulkDele
|
|
|
1903
2200
|
*/
|
|
1904
2201
|
export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<BulkDeleteMembersByFilterResponse & BulkDeleteMembersByFilterResponseNonNullableFields>;
|
|
1905
2202
|
export interface BulkDeleteMembersByFilterOptions {
|
|
1906
|
-
/**
|
|
2203
|
+
/**
|
|
2204
|
+
* ID of a member receiving the deleted member's content.
|
|
2205
|
+
* @format GUID
|
|
2206
|
+
*/
|
|
1907
2207
|
contentAssigneeId?: string | null;
|
|
1908
2208
|
/** Plain text search. */
|
|
1909
2209
|
search?: Search;
|
|
@@ -1995,6 +2295,8 @@ export interface CreateMemberOptions {
|
|
|
1995
2295
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1996
2296
|
* @permissionScope Manage Restaurants - all permissions
|
|
1997
2297
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2298
|
+
* @permissionScope Set Up Automations
|
|
2299
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1998
2300
|
* @applicableIdentity APP
|
|
1999
2301
|
* @applicableIdentity MEMBER
|
|
2000
2302
|
* @returns Updated member.
|
|
@@ -2004,10 +2306,14 @@ export declare function updateMember(_id: string | null, member: UpdateMember):
|
|
|
2004
2306
|
export interface UpdateMember {
|
|
2005
2307
|
/**
|
|
2006
2308
|
* Member ID.
|
|
2309
|
+
* @format GUID
|
|
2007
2310
|
* @readonly
|
|
2008
2311
|
*/
|
|
2009
2312
|
_id?: string | null;
|
|
2010
|
-
/**
|
|
2313
|
+
/**
|
|
2314
|
+
* Email used by the member to log in to the site.
|
|
2315
|
+
* @format EMAIL
|
|
2316
|
+
*/
|
|
2011
2317
|
loginEmail?: string | null;
|
|
2012
2318
|
/**
|
|
2013
2319
|
* Whether the email used by the member has been verified.
|
|
@@ -2021,6 +2327,7 @@ export interface UpdateMember {
|
|
|
2021
2327
|
status?: Status;
|
|
2022
2328
|
/**
|
|
2023
2329
|
* Contact ID.
|
|
2330
|
+
* @format GUID
|
|
2024
2331
|
* @readonly
|
|
2025
2332
|
*/
|
|
2026
2333
|
contactId?: string | null;
|
|
@@ -2078,6 +2385,8 @@ export interface UpdateMember {
|
|
|
2078
2385
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2079
2386
|
* @permissionScope Manage Restaurants - all permissions
|
|
2080
2387
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2388
|
+
* @permissionScope Set Up Automations
|
|
2389
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2081
2390
|
* @applicableIdentity APP
|
|
2082
2391
|
* @applicableIdentity MEMBER
|
|
2083
2392
|
* @fqn com.wixpress.members.api.Members.DeleteMemberPhones
|
|
@@ -2110,6 +2419,8 @@ export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPho
|
|
|
2110
2419
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2111
2420
|
* @permissionScope Manage Restaurants - all permissions
|
|
2112
2421
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2422
|
+
* @permissionScope Set Up Automations
|
|
2423
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2113
2424
|
* @applicableIdentity APP
|
|
2114
2425
|
* @applicableIdentity MEMBER
|
|
2115
2426
|
* @fqn com.wixpress.members.api.Members.DeleteMemberEmails
|
|
@@ -2139,6 +2450,8 @@ export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEma
|
|
|
2139
2450
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2140
2451
|
* @permissionScope Manage Restaurants - all permissions
|
|
2141
2452
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2453
|
+
* @permissionScope Set Up Automations
|
|
2454
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2142
2455
|
* @applicableIdentity APP
|
|
2143
2456
|
* @applicableIdentity MEMBER
|
|
2144
2457
|
* @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
|