@wix/auto_sdk_members_members 1.0.1 → 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 +409 -86
- package/build/cjs/src/members-v1-member-members.universal.js +32 -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 +409 -86
- package/build/es/src/members-v1-member-members.universal.js +32 -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 +410 -86
- package/build/internal/cjs/src/members-v1-member-members.universal.js +32 -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 +410 -86
- package/build/internal/es/src/members-v1-member-members.universal.js +32 -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;
|
|
@@ -74,6 +79,7 @@ export interface Contact {
|
|
|
74
79
|
* > **Deprecation notice:**
|
|
75
80
|
* > This property has been replaced with `member.contactId`
|
|
76
81
|
* > and will be removed on June 11, 2021.
|
|
82
|
+
* @format GUID
|
|
77
83
|
* @readonly
|
|
78
84
|
* @deprecated
|
|
79
85
|
*/
|
|
@@ -84,7 +90,10 @@ export interface Contact {
|
|
|
84
90
|
lastName?: string | null;
|
|
85
91
|
/** List of phone numbers. */
|
|
86
92
|
phones?: string[] | null;
|
|
87
|
-
/**
|
|
93
|
+
/**
|
|
94
|
+
* List of email addresses.
|
|
95
|
+
* @format EMAIL
|
|
96
|
+
*/
|
|
88
97
|
emails?: string[] | null;
|
|
89
98
|
/** List of street addresses. */
|
|
90
99
|
addresses?: Address[];
|
|
@@ -92,11 +101,18 @@ export interface Contact {
|
|
|
92
101
|
* Contact's birthdate, formatted as `"YYYY-MM-DD"`.
|
|
93
102
|
*
|
|
94
103
|
* Example: `"2020-03-15"` for March 15, 2020.
|
|
104
|
+
* @maxLength 100
|
|
95
105
|
*/
|
|
96
106
|
birthdate?: string | null;
|
|
97
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* Contact's company name.
|
|
109
|
+
* @maxLength 100
|
|
110
|
+
*/
|
|
98
111
|
company?: string | null;
|
|
99
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* Contact's job title.
|
|
114
|
+
* @maxLength 100
|
|
115
|
+
*/
|
|
100
116
|
jobTitle?: string | null;
|
|
101
117
|
/**
|
|
102
118
|
* Custom fields,
|
|
@@ -109,10 +125,14 @@ export interface Contact {
|
|
|
109
125
|
export interface Address extends AddressStreetOneOf {
|
|
110
126
|
/** Street address object, with number and name in separate fields. */
|
|
111
127
|
streetAddress?: StreetAddress;
|
|
112
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* Main address line, usually street and number, as free text.
|
|
130
|
+
* @maxLength 200
|
|
131
|
+
*/
|
|
113
132
|
addressLine?: string | null;
|
|
114
133
|
/**
|
|
115
134
|
* Street address ID.
|
|
135
|
+
* @format GUID
|
|
116
136
|
* @readonly
|
|
117
137
|
*/
|
|
118
138
|
id?: string | null;
|
|
@@ -140,13 +160,22 @@ export interface Address extends AddressStreetOneOf {
|
|
|
140
160
|
export interface AddressStreetOneOf {
|
|
141
161
|
/** Street address object, with number and name in separate fields. */
|
|
142
162
|
streetAddress?: StreetAddress;
|
|
143
|
-
/**
|
|
163
|
+
/**
|
|
164
|
+
* Main address line, usually street and number, as free text.
|
|
165
|
+
* @maxLength 200
|
|
166
|
+
*/
|
|
144
167
|
addressLine?: string | null;
|
|
145
168
|
}
|
|
146
169
|
export interface StreetAddress {
|
|
147
|
-
/**
|
|
170
|
+
/**
|
|
171
|
+
* Street number.
|
|
172
|
+
* @maxLength 100
|
|
173
|
+
*/
|
|
148
174
|
number?: string;
|
|
149
|
-
/**
|
|
175
|
+
/**
|
|
176
|
+
* Street name.
|
|
177
|
+
* @maxLength 200
|
|
178
|
+
*/
|
|
150
179
|
name?: string;
|
|
151
180
|
}
|
|
152
181
|
export interface CustomField {
|
|
@@ -238,9 +267,15 @@ export interface ExtendedFields {
|
|
|
238
267
|
namespaces?: Record<string, Record<string, any>>;
|
|
239
268
|
}
|
|
240
269
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
241
|
-
/**
|
|
270
|
+
/**
|
|
271
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
272
|
+
* @format GUID
|
|
273
|
+
*/
|
|
242
274
|
metaSiteId?: string;
|
|
243
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
277
|
+
* @format GUID
|
|
278
|
+
*/
|
|
244
279
|
siteId?: string;
|
|
245
280
|
/** Invalidate by App */
|
|
246
281
|
app?: App;
|
|
@@ -250,7 +285,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
250
285
|
uri?: URI;
|
|
251
286
|
/** Invalidate by file (for media files such as PDFs) */
|
|
252
287
|
file?: File;
|
|
253
|
-
/**
|
|
288
|
+
/**
|
|
289
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
290
|
+
* @maxLength 256
|
|
291
|
+
*/
|
|
254
292
|
reason?: string | null;
|
|
255
293
|
/** Is local DS */
|
|
256
294
|
localDc?: boolean;
|
|
@@ -258,9 +296,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
258
296
|
}
|
|
259
297
|
/** @oneof */
|
|
260
298
|
export interface InvalidateCacheGetByOneOf {
|
|
261
|
-
/**
|
|
299
|
+
/**
|
|
300
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
301
|
+
* @format GUID
|
|
302
|
+
*/
|
|
262
303
|
metaSiteId?: string;
|
|
263
|
-
/**
|
|
304
|
+
/**
|
|
305
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
306
|
+
* @format GUID
|
|
307
|
+
*/
|
|
264
308
|
siteId?: string;
|
|
265
309
|
/** Invalidate by App */
|
|
266
310
|
app?: App;
|
|
@@ -272,31 +316,59 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
272
316
|
file?: File;
|
|
273
317
|
}
|
|
274
318
|
export interface App {
|
|
275
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* The AppDefId
|
|
321
|
+
* @minLength 1
|
|
322
|
+
*/
|
|
276
323
|
appDefId?: string;
|
|
277
|
-
/**
|
|
324
|
+
/**
|
|
325
|
+
* The instance Id
|
|
326
|
+
* @format GUID
|
|
327
|
+
*/
|
|
278
328
|
instanceId?: string;
|
|
279
329
|
}
|
|
280
330
|
export interface Page {
|
|
281
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* the msid the page is on
|
|
333
|
+
* @format GUID
|
|
334
|
+
*/
|
|
282
335
|
metaSiteId?: string;
|
|
283
|
-
/**
|
|
336
|
+
/**
|
|
337
|
+
* Invalidate by Page ID
|
|
338
|
+
* @minLength 1
|
|
339
|
+
*/
|
|
284
340
|
pageId?: string;
|
|
285
341
|
}
|
|
286
342
|
export interface URI {
|
|
287
|
-
/**
|
|
343
|
+
/**
|
|
344
|
+
* the msid the URI is on
|
|
345
|
+
* @format GUID
|
|
346
|
+
*/
|
|
288
347
|
metaSiteId?: string;
|
|
289
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
350
|
+
* @minLength 1
|
|
351
|
+
*/
|
|
290
352
|
uriPath?: string;
|
|
291
353
|
}
|
|
292
354
|
export interface File {
|
|
293
|
-
/**
|
|
355
|
+
/**
|
|
356
|
+
* the msid the file is related to
|
|
357
|
+
* @format GUID
|
|
358
|
+
*/
|
|
294
359
|
metaSiteId?: string;
|
|
295
|
-
/**
|
|
360
|
+
/**
|
|
361
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
362
|
+
* @minLength 1
|
|
363
|
+
* @maxLength 256
|
|
364
|
+
*/
|
|
296
365
|
fileName?: string;
|
|
297
366
|
}
|
|
298
367
|
export interface UpdateMySlugRequest {
|
|
299
|
-
/**
|
|
368
|
+
/**
|
|
369
|
+
* New slug.
|
|
370
|
+
* @maxLength 255
|
|
371
|
+
*/
|
|
300
372
|
slug: string;
|
|
301
373
|
}
|
|
302
374
|
export interface UpdateMySlugResponse {
|
|
@@ -307,9 +379,15 @@ export interface SlugAlreadyExistsPayload {
|
|
|
307
379
|
slug?: string;
|
|
308
380
|
}
|
|
309
381
|
export interface UpdateMemberSlugRequest {
|
|
310
|
-
/**
|
|
382
|
+
/**
|
|
383
|
+
* Member ID.
|
|
384
|
+
* @format GUID
|
|
385
|
+
*/
|
|
311
386
|
id: string;
|
|
312
|
-
/**
|
|
387
|
+
/**
|
|
388
|
+
* New slug.
|
|
389
|
+
* @maxLength 255
|
|
390
|
+
*/
|
|
313
391
|
slug: string;
|
|
314
392
|
}
|
|
315
393
|
export interface UpdateMemberSlugResponse {
|
|
@@ -326,6 +404,7 @@ export interface JoinCommunityResponse {
|
|
|
326
404
|
export interface MemberJoinedCommunity {
|
|
327
405
|
/**
|
|
328
406
|
* Member id who joined the community
|
|
407
|
+
* @format GUID
|
|
329
408
|
* @readonly
|
|
330
409
|
*/
|
|
331
410
|
memberId?: string;
|
|
@@ -340,6 +419,7 @@ export interface LeaveCommunityResponse {
|
|
|
340
419
|
export interface MemberLeftCommunity {
|
|
341
420
|
/**
|
|
342
421
|
* Member id who left the community
|
|
422
|
+
* @format GUID
|
|
343
423
|
* @readonly
|
|
344
424
|
*/
|
|
345
425
|
memberId?: string;
|
|
@@ -362,6 +442,7 @@ export interface GetMyMemberRequest {
|
|
|
362
442
|
* Predefined set of fields to return.
|
|
363
443
|
*
|
|
364
444
|
* Default: `PUBLIC`.
|
|
445
|
+
* @maxSize 3
|
|
365
446
|
*/
|
|
366
447
|
fieldsets?: Set[];
|
|
367
448
|
}
|
|
@@ -382,12 +463,16 @@ export interface GetMyMemberResponse {
|
|
|
382
463
|
member?: Member;
|
|
383
464
|
}
|
|
384
465
|
export interface GetMemberRequest {
|
|
385
|
-
/**
|
|
466
|
+
/**
|
|
467
|
+
* Member ID.
|
|
468
|
+
* @format GUID
|
|
469
|
+
*/
|
|
386
470
|
id: string;
|
|
387
471
|
/**
|
|
388
472
|
* Predefined set of fields to return.
|
|
389
473
|
*
|
|
390
474
|
* Defaults to `PUBLIC`.
|
|
475
|
+
* @maxSize 3
|
|
391
476
|
*/
|
|
392
477
|
fieldsets?: Set[];
|
|
393
478
|
}
|
|
@@ -396,7 +481,10 @@ export interface GetMemberResponse {
|
|
|
396
481
|
member?: Member;
|
|
397
482
|
}
|
|
398
483
|
export interface MemberToMemberBlockedPayload {
|
|
399
|
-
/**
|
|
484
|
+
/**
|
|
485
|
+
* Member ID.
|
|
486
|
+
* @format GUID
|
|
487
|
+
*/
|
|
400
488
|
memberId?: string;
|
|
401
489
|
}
|
|
402
490
|
export interface ListMembersRequest {
|
|
@@ -405,6 +493,7 @@ export interface ListMembersRequest {
|
|
|
405
493
|
* Predefined sets of fields to return.
|
|
406
494
|
*
|
|
407
495
|
* Default: `PUBLIC`.
|
|
496
|
+
* @maxSize 3
|
|
408
497
|
*/
|
|
409
498
|
fieldsets?: Set[];
|
|
410
499
|
sorting?: Sorting[];
|
|
@@ -416,7 +505,10 @@ export interface Paging {
|
|
|
416
505
|
offset?: number | null;
|
|
417
506
|
}
|
|
418
507
|
export interface Sorting {
|
|
419
|
-
/**
|
|
508
|
+
/**
|
|
509
|
+
* Name of the field to sort by.
|
|
510
|
+
* @maxLength 512
|
|
511
|
+
*/
|
|
420
512
|
fieldName?: string;
|
|
421
513
|
/** Sort order. */
|
|
422
514
|
order?: SortOrder;
|
|
@@ -426,13 +518,17 @@ export declare enum SortOrder {
|
|
|
426
518
|
DESC = "DESC"
|
|
427
519
|
}
|
|
428
520
|
export interface CursorPaging {
|
|
429
|
-
/**
|
|
521
|
+
/**
|
|
522
|
+
* Maximum number of items to return in the results.
|
|
523
|
+
* @max 100
|
|
524
|
+
*/
|
|
430
525
|
limit?: number | null;
|
|
431
526
|
/**
|
|
432
527
|
* Pointer to the next or previous page in the list of results.
|
|
433
528
|
*
|
|
434
529
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
435
530
|
* Not relevant for the first request.
|
|
531
|
+
* @maxLength 16000
|
|
436
532
|
*/
|
|
437
533
|
cursor?: string | null;
|
|
438
534
|
}
|
|
@@ -466,9 +562,15 @@ export interface CursorPagingMetadata {
|
|
|
466
562
|
hasNext?: boolean | null;
|
|
467
563
|
}
|
|
468
564
|
export interface Cursors {
|
|
469
|
-
/**
|
|
565
|
+
/**
|
|
566
|
+
* Cursor string pointing to the next page in the list of results.
|
|
567
|
+
* @maxLength 16000
|
|
568
|
+
*/
|
|
470
569
|
next?: string | null;
|
|
471
|
-
/**
|
|
570
|
+
/**
|
|
571
|
+
* Cursor pointing to the previous page in the list of results.
|
|
572
|
+
* @maxLength 16000
|
|
573
|
+
*/
|
|
472
574
|
prev?: string | null;
|
|
473
575
|
}
|
|
474
576
|
export interface QueryMembersRequest {
|
|
@@ -478,6 +580,7 @@ export interface QueryMembersRequest {
|
|
|
478
580
|
* Predefined sets of fields to return.
|
|
479
581
|
*
|
|
480
582
|
* Default: `PUBLIC`.
|
|
583
|
+
* @maxSize 3
|
|
481
584
|
*/
|
|
482
585
|
fieldsets?: Set[];
|
|
483
586
|
/** Plain text search. */
|
|
@@ -493,7 +596,11 @@ export interface Query {
|
|
|
493
596
|
}
|
|
494
597
|
/** Free text to match in searchable fields */
|
|
495
598
|
export interface Search {
|
|
496
|
-
/**
|
|
599
|
+
/**
|
|
600
|
+
* Search term or expression.
|
|
601
|
+
* @minLength 1
|
|
602
|
+
* @maxLength 100
|
|
603
|
+
*/
|
|
497
604
|
expression?: string | null;
|
|
498
605
|
/**
|
|
499
606
|
* Currently supported fields for search:
|
|
@@ -506,6 +613,7 @@ export interface Search {
|
|
|
506
613
|
* - `profile.slug`
|
|
507
614
|
*
|
|
508
615
|
* Default: `profile.nickname`.
|
|
616
|
+
* @maxSize 4
|
|
509
617
|
*/
|
|
510
618
|
fields?: string[];
|
|
511
619
|
}
|
|
@@ -516,7 +624,10 @@ export interface QueryMembersResponse {
|
|
|
516
624
|
metadata?: PagingMetadata;
|
|
517
625
|
}
|
|
518
626
|
export interface MuteMemberRequest {
|
|
519
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* ID of the member to mute.
|
|
629
|
+
* @format GUID
|
|
630
|
+
*/
|
|
520
631
|
id: string;
|
|
521
632
|
}
|
|
522
633
|
export interface MuteMemberResponse {
|
|
@@ -526,12 +637,16 @@ export interface MuteMemberResponse {
|
|
|
526
637
|
export interface MemberMuted {
|
|
527
638
|
/**
|
|
528
639
|
* Member id who got muted
|
|
640
|
+
* @format GUID
|
|
529
641
|
* @readonly
|
|
530
642
|
*/
|
|
531
643
|
memberId?: string;
|
|
532
644
|
}
|
|
533
645
|
export interface UnmuteMemberRequest {
|
|
534
|
-
/**
|
|
646
|
+
/**
|
|
647
|
+
* ID of the member to unmute.
|
|
648
|
+
* @format GUID
|
|
649
|
+
*/
|
|
535
650
|
id: string;
|
|
536
651
|
}
|
|
537
652
|
export interface UnmuteMemberResponse {
|
|
@@ -541,12 +656,16 @@ export interface UnmuteMemberResponse {
|
|
|
541
656
|
export interface MemberUnmuted {
|
|
542
657
|
/**
|
|
543
658
|
* Member id who got unmuted
|
|
659
|
+
* @format GUID
|
|
544
660
|
* @readonly
|
|
545
661
|
*/
|
|
546
662
|
memberId?: string;
|
|
547
663
|
}
|
|
548
664
|
export interface ApproveMemberRequest {
|
|
549
|
-
/**
|
|
665
|
+
/**
|
|
666
|
+
* ID of the member to approve.
|
|
667
|
+
* @format GUID
|
|
668
|
+
*/
|
|
550
669
|
id: string;
|
|
551
670
|
}
|
|
552
671
|
export interface ApproveMemberResponse {
|
|
@@ -556,12 +675,16 @@ export interface ApproveMemberResponse {
|
|
|
556
675
|
export interface MemberApproved {
|
|
557
676
|
/**
|
|
558
677
|
* Member id who got approved
|
|
678
|
+
* @format GUID
|
|
559
679
|
* @readonly
|
|
560
680
|
*/
|
|
561
681
|
memberId?: string;
|
|
562
682
|
}
|
|
563
683
|
export interface BlockMemberRequest {
|
|
564
|
-
/**
|
|
684
|
+
/**
|
|
685
|
+
* ID of a member to block.
|
|
686
|
+
* @format GUID
|
|
687
|
+
*/
|
|
565
688
|
id: string;
|
|
566
689
|
}
|
|
567
690
|
export interface BlockMemberResponse {
|
|
@@ -571,24 +694,37 @@ export interface BlockMemberResponse {
|
|
|
571
694
|
export interface MemberBlocked {
|
|
572
695
|
/**
|
|
573
696
|
* Member id who got blocked
|
|
697
|
+
* @format GUID
|
|
574
698
|
* @readonly
|
|
575
699
|
*/
|
|
576
700
|
memberId?: string;
|
|
577
701
|
}
|
|
578
702
|
export interface MemberSelfBlockForbiddenPayload {
|
|
579
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* Target's member ID.
|
|
705
|
+
* @format GUID
|
|
706
|
+
*/
|
|
580
707
|
memberId?: string;
|
|
581
708
|
}
|
|
582
709
|
export interface OwnerMemberBlockForbiddenPayload {
|
|
583
|
-
/**
|
|
710
|
+
/**
|
|
711
|
+
* Owner's member ID.
|
|
712
|
+
* @format GUID
|
|
713
|
+
*/
|
|
584
714
|
memberId?: string;
|
|
585
715
|
}
|
|
586
716
|
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
587
|
-
/**
|
|
717
|
+
/**
|
|
718
|
+
* Active subscription member ID.
|
|
719
|
+
* @format GUID
|
|
720
|
+
*/
|
|
588
721
|
memberId?: string;
|
|
589
722
|
}
|
|
590
723
|
export interface DisconnectMemberRequest {
|
|
591
|
-
/**
|
|
724
|
+
/**
|
|
725
|
+
* ID of a member to disconnect.
|
|
726
|
+
* @format GUID
|
|
727
|
+
*/
|
|
592
728
|
id: string;
|
|
593
729
|
}
|
|
594
730
|
export interface DisconnectMemberResponse {
|
|
@@ -596,7 +732,10 @@ export interface DisconnectMemberResponse {
|
|
|
596
732
|
member?: Member;
|
|
597
733
|
}
|
|
598
734
|
export interface DeleteMemberRequest {
|
|
599
|
-
/**
|
|
735
|
+
/**
|
|
736
|
+
* ID of the member to delete.
|
|
737
|
+
* @format GUID
|
|
738
|
+
*/
|
|
600
739
|
id: string;
|
|
601
740
|
}
|
|
602
741
|
export interface DeleteMemberResponse {
|
|
@@ -609,21 +748,35 @@ export interface ContentDeletionRequested {
|
|
|
609
748
|
member?: Member;
|
|
610
749
|
}
|
|
611
750
|
export interface OwnerOrContributorDeleteForbiddenPayload {
|
|
612
|
-
/**
|
|
751
|
+
/**
|
|
752
|
+
* Owner's or contributor's member ID.
|
|
753
|
+
* @format GUID
|
|
754
|
+
*/
|
|
613
755
|
memberId?: string;
|
|
614
756
|
}
|
|
615
757
|
export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
616
|
-
/**
|
|
758
|
+
/**
|
|
759
|
+
* Active subscription member ID.
|
|
760
|
+
* @format GUID
|
|
761
|
+
*/
|
|
617
762
|
memberId?: string;
|
|
618
763
|
}
|
|
619
764
|
export interface DeleteMyMemberRequest {
|
|
620
|
-
/**
|
|
765
|
+
/**
|
|
766
|
+
* ID of a member receiving deleted member's content.
|
|
767
|
+
* @format GUID
|
|
768
|
+
*/
|
|
621
769
|
contentAssigneeId?: string | null;
|
|
622
770
|
}
|
|
623
771
|
export interface DeleteMyMemberResponse {
|
|
624
772
|
}
|
|
625
773
|
export interface BulkDeleteMembersRequest {
|
|
626
|
-
/**
|
|
774
|
+
/**
|
|
775
|
+
* IDs of members to be deleted.
|
|
776
|
+
* @minSize 1
|
|
777
|
+
* @maxSize 100
|
|
778
|
+
* @format GUID
|
|
779
|
+
*/
|
|
627
780
|
memberIds: string[];
|
|
628
781
|
}
|
|
629
782
|
export interface BulkDeleteMembersResponse {
|
|
@@ -633,7 +786,10 @@ export interface BulkDeleteMembersResponse {
|
|
|
633
786
|
bulkActionMetadata?: BulkActionMetadata;
|
|
634
787
|
}
|
|
635
788
|
export interface ItemMetadata {
|
|
636
|
-
/**
|
|
789
|
+
/**
|
|
790
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
791
|
+
* @maxLength 255
|
|
792
|
+
*/
|
|
637
793
|
id?: string | null;
|
|
638
794
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
639
795
|
originalIndex?: number;
|
|
@@ -664,7 +820,10 @@ export interface BulkActionMetadata {
|
|
|
664
820
|
export interface BulkDeleteMembersByFilterRequest {
|
|
665
821
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
666
822
|
filter: any;
|
|
667
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* ID of a member receiving the deleted member's content.
|
|
825
|
+
* @format GUID
|
|
826
|
+
*/
|
|
668
827
|
contentAssigneeId?: string | null;
|
|
669
828
|
/** Plain text search. */
|
|
670
829
|
search?: Search;
|
|
@@ -719,7 +878,10 @@ export interface InvalidCustomFieldUrlPayload {
|
|
|
719
878
|
fields?: Record<string, string>;
|
|
720
879
|
}
|
|
721
880
|
export interface DeleteMemberPhonesRequest {
|
|
722
|
-
/**
|
|
881
|
+
/**
|
|
882
|
+
* ID of the member whose phone numbers will be deleted.
|
|
883
|
+
* @format GUID
|
|
884
|
+
*/
|
|
723
885
|
id: string;
|
|
724
886
|
}
|
|
725
887
|
export interface DeleteMemberPhonesResponse {
|
|
@@ -727,7 +889,10 @@ export interface DeleteMemberPhonesResponse {
|
|
|
727
889
|
member?: Member;
|
|
728
890
|
}
|
|
729
891
|
export interface DeleteMemberEmailsRequest {
|
|
730
|
-
/**
|
|
892
|
+
/**
|
|
893
|
+
* ID of the member whose email addresses will be deleted.
|
|
894
|
+
* @format GUID
|
|
895
|
+
*/
|
|
731
896
|
id: string;
|
|
732
897
|
}
|
|
733
898
|
export interface DeleteMemberEmailsResponse {
|
|
@@ -735,7 +900,10 @@ export interface DeleteMemberEmailsResponse {
|
|
|
735
900
|
member?: Member;
|
|
736
901
|
}
|
|
737
902
|
export interface DeleteMemberAddressesRequest {
|
|
738
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* ID of the member whose street addresses will be deleted.
|
|
905
|
+
* @format GUID
|
|
906
|
+
*/
|
|
739
907
|
id: string;
|
|
740
908
|
}
|
|
741
909
|
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 {
|