@wix/auto_sdk_members_members 1.0.52 → 1.0.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/build/{internal/cjs/src/members-v1-member-members.public.d.ts → index.d.mts} +70 -33
  2. package/build/{cjs/src/members-v1-member-members.public.d.ts → index.d.ts} +70 -33
  3. package/build/index.js +1800 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1740 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/{es/src/members-v1-member-members.public.d.ts → index.d.mts} +70 -33
  8. package/build/{es/src/members-v1-member-members.public.d.ts → internal/index.d.ts} +70 -33
  9. package/build/internal/index.js +1800 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1740 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{es/src/members-v1-member-members.types.d.ts → internal/members-v1-member-members.universal-CzPn3y3P.d.mts} +390 -162
  14. package/build/{cjs/src/members-v1-member-members.types.d.ts → internal/members-v1-member-members.universal-CzPn3y3P.d.ts} +390 -162
  15. package/build/internal/meta.d.mts +698 -0
  16. package/build/internal/meta.d.ts +698 -0
  17. package/build/internal/meta.js +1239 -0
  18. package/build/internal/meta.js.map +1 -0
  19. package/build/internal/meta.mjs +1189 -0
  20. package/build/internal/meta.mjs.map +1 -0
  21. package/build/{internal/cjs/src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-CzPn3y3P.d.mts} +390 -162
  22. package/build/{internal/es/src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-CzPn3y3P.d.ts} +390 -162
  23. package/build/meta.d.mts +698 -0
  24. package/build/meta.d.ts +698 -0
  25. package/build/meta.js +1239 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1189 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/members-v1-member-members.context.d.ts +0 -46
  40. package/build/cjs/src/members-v1-member-members.context.js +0 -59
  41. package/build/cjs/src/members-v1-member-members.context.js.map +0 -1
  42. package/build/cjs/src/members-v1-member-members.http.d.ts +0 -229
  43. package/build/cjs/src/members-v1-member-members.http.js +0 -959
  44. package/build/cjs/src/members-v1-member-members.http.js.map +0 -1
  45. package/build/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  46. package/build/cjs/src/members-v1-member-members.meta.js +0 -484
  47. package/build/cjs/src/members-v1-member-members.meta.js.map +0 -1
  48. package/build/cjs/src/members-v1-member-members.public.js +0 -198
  49. package/build/cjs/src/members-v1-member-members.public.js.map +0 -1
  50. package/build/cjs/src/members-v1-member-members.types.js +0 -174
  51. package/build/cjs/src/members-v1-member-members.types.js.map +0 -1
  52. package/build/cjs/src/members-v1-member-members.universal.d.ts +0 -2418
  53. package/build/cjs/src/members-v1-member-members.universal.js +0 -1365
  54. package/build/cjs/src/members-v1-member-members.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/members-v1-member-members.context.d.ts +0 -46
  65. package/build/es/src/members-v1-member-members.context.js +0 -46
  66. package/build/es/src/members-v1-member-members.context.js.map +0 -1
  67. package/build/es/src/members-v1-member-members.http.d.ts +0 -229
  68. package/build/es/src/members-v1-member-members.http.js +0 -932
  69. package/build/es/src/members-v1-member-members.http.js.map +0 -1
  70. package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
  71. package/build/es/src/members-v1-member-members.meta.js +0 -434
  72. package/build/es/src/members-v1-member-members.meta.js.map +0 -1
  73. package/build/es/src/members-v1-member-members.public.js +0 -161
  74. package/build/es/src/members-v1-member-members.public.js.map +0 -1
  75. package/build/es/src/members-v1-member-members.types.js +0 -171
  76. package/build/es/src/members-v1-member-members.types.js.map +0 -1
  77. package/build/es/src/members-v1-member-members.universal.d.ts +0 -2418
  78. package/build/es/src/members-v1-member-members.universal.js +0 -1315
  79. package/build/es/src/members-v1-member-members.universal.js.map +0 -1
  80. package/build/internal/cjs/index.d.ts +0 -1
  81. package/build/internal/cjs/index.js +0 -18
  82. package/build/internal/cjs/index.js.map +0 -1
  83. package/build/internal/cjs/index.typings.d.ts +0 -1
  84. package/build/internal/cjs/index.typings.js +0 -18
  85. package/build/internal/cjs/index.typings.js.map +0 -1
  86. package/build/internal/cjs/meta.d.ts +0 -1
  87. package/build/internal/cjs/meta.js +0 -18
  88. package/build/internal/cjs/meta.js.map +0 -1
  89. package/build/internal/cjs/src/members-v1-member-members.context.d.ts +0 -46
  90. package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
  91. package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
  92. package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
  93. package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
  94. package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
  95. package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  96. package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
  97. package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
  98. package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
  99. package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
  100. package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
  101. package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
  102. package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2418
  103. package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1365
  104. package/build/internal/cjs/src/members-v1-member-members.universal.js.map +0 -1
  105. package/build/internal/es/index.d.ts +0 -1
  106. package/build/internal/es/index.js +0 -2
  107. package/build/internal/es/index.js.map +0 -1
  108. package/build/internal/es/index.typings.d.ts +0 -1
  109. package/build/internal/es/index.typings.js +0 -2
  110. package/build/internal/es/index.typings.js.map +0 -1
  111. package/build/internal/es/meta.d.ts +0 -1
  112. package/build/internal/es/meta.js +0 -2
  113. package/build/internal/es/meta.js.map +0 -1
  114. package/build/internal/es/src/members-v1-member-members.context.d.ts +0 -46
  115. package/build/internal/es/src/members-v1-member-members.context.js +0 -46
  116. package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
  117. package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
  118. package/build/internal/es/src/members-v1-member-members.http.js +0 -932
  119. package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
  120. package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
  121. package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
  122. package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
  123. package/build/internal/es/src/members-v1-member-members.public.js +0 -161
  124. package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
  125. package/build/internal/es/src/members-v1-member-members.types.js +0 -171
  126. package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
  127. package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2418
  128. package/build/internal/es/src/members-v1-member-members.universal.js +0 -1315
  129. package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Member {
1
+ interface Member {
2
2
  /**
3
3
  * Member ID.
4
4
  * @format GUID
5
5
  * @readonly
6
6
  */
7
- id?: string | null;
7
+ _id?: string | null;
8
8
  /**
9
9
  * Email used by a member to log in to the site.
10
10
  * @format EMAIL
@@ -47,19 +47,19 @@ export interface Member {
47
47
  * Date and time when the member was created.
48
48
  * @readonly
49
49
  */
50
- createdDate?: Date | null;
50
+ _createdDate?: Date | null;
51
51
  /**
52
52
  * Date and time when the member was updated.
53
53
  * @readonly
54
54
  */
55
- updatedDate?: Date | null;
55
+ _updatedDate?: Date | null;
56
56
  /**
57
57
  * Date and time when the member last logged in to the site.
58
58
  * @readonly
59
59
  */
60
60
  lastLoginDate?: Date | null;
61
61
  }
62
- export declare enum Status {
62
+ declare enum Status {
63
63
  /** Insufficient permissions to get the status. */
64
64
  UNKNOWN = "UNKNOWN",
65
65
  /** Member is created and is waiting for approval by a Wix user. */
@@ -72,7 +72,7 @@ export declare enum Status {
72
72
  OFFLINE = "OFFLINE"
73
73
  }
74
74
  /** Contact info associated with the member. */
75
- export interface Contact {
75
+ interface Contact {
76
76
  /** Contact's first name. */
77
77
  firstName?: string | null;
78
78
  /** Contact's last name. */
@@ -104,14 +104,16 @@ export interface Contact {
104
104
  */
105
105
  jobTitle?: string | null;
106
106
  /**
107
- * Custom fields,
108
- * where each key is the field key,
109
- * and each value is the field's value for the member.
107
+ * 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.
108
+ *
109
+ * > **Notes:**
110
+ * > - Only custom fields added to the member profile in the dashboard are available through the Members API. Empty fields are not returned.
111
+ * > - When updating a member, `name` is ignored.
110
112
  */
111
113
  customFields?: Record<string, CustomField>;
112
114
  }
113
115
  /** Street address. */
114
- export interface Address extends AddressStreetOneOf {
116
+ interface Address extends AddressStreetOneOf {
115
117
  /** Street address object, with number and name in separate fields. */
116
118
  streetAddress?: StreetAddress;
117
119
  /**
@@ -124,7 +126,7 @@ export interface Address extends AddressStreetOneOf {
124
126
  * @format GUID
125
127
  * @readonly
126
128
  */
127
- id?: string | null;
129
+ _id?: string | null;
128
130
  /**
129
131
  * Free text providing more detailed address information,
130
132
  * such as apartment, suite, or floor.
@@ -146,7 +148,7 @@ export interface Address extends AddressStreetOneOf {
146
148
  postalCode?: string | null;
147
149
  }
148
150
  /** @oneof */
149
- export interface AddressStreetOneOf {
151
+ interface AddressStreetOneOf {
150
152
  /** Street address object, with number and name in separate fields. */
151
153
  streetAddress?: StreetAddress;
152
154
  /**
@@ -155,7 +157,7 @@ export interface AddressStreetOneOf {
155
157
  */
156
158
  addressLine?: string | null;
157
159
  }
158
- export interface StreetAddress {
160
+ interface StreetAddress {
159
161
  /**
160
162
  * Street number.
161
163
  * @maxLength 100
@@ -167,14 +169,14 @@ export interface StreetAddress {
167
169
  */
168
170
  name?: string;
169
171
  }
170
- export interface CustomField {
172
+ interface CustomField {
171
173
  /** Custom field name. */
172
174
  name?: string | null;
173
175
  /** Custom field value. */
174
176
  value?: any;
175
177
  }
176
178
  /** Member Profile */
177
- export interface Profile {
179
+ interface Profile {
178
180
  /**
179
181
  * Name that identifies the member to other members.
180
182
  * Displayed on the member's profile page
@@ -203,12 +205,12 @@ export interface Profile {
203
205
  */
204
206
  title?: string | null;
205
207
  }
206
- export interface Image {
208
+ interface Image {
207
209
  /**
208
210
  * Wix Media image ID,
209
211
  * set when the member selects an image from Wix Media.
210
212
  */
211
- id?: string;
213
+ _id?: string;
212
214
  /** Image URL. */
213
215
  url?: string;
214
216
  /** Original image width. */
@@ -228,7 +230,7 @@ export interface Image {
228
230
  */
229
231
  offsetY?: number | null;
230
232
  }
231
- export declare enum PrivacyStatusStatus {
233
+ declare enum PrivacyStatusStatus {
232
234
  /** Insufficient permissions to get the status. */
233
235
  UNKNOWN = "UNKNOWN",
234
236
  /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
@@ -236,7 +238,7 @@ export declare enum PrivacyStatusStatus {
236
238
  /** Member is visible to everyone. */
237
239
  PUBLIC = "PUBLIC"
238
240
  }
239
- export declare enum ActivityStatusStatus {
241
+ declare enum ActivityStatusStatus {
240
242
  /** Insufficient permissions to get the status. */
241
243
  UNKNOWN = "UNKNOWN",
242
244
  /** Member can write forum posts and blog comments. */
@@ -244,7 +246,7 @@ export declare enum ActivityStatusStatus {
244
246
  /** Member can't write forum posts or blog comments. */
245
247
  MUTED = "MUTED"
246
248
  }
247
- export interface ExtendedFields {
249
+ interface ExtendedFields {
248
250
  /**
249
251
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
250
252
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -255,7 +257,7 @@ export interface ExtendedFields {
255
257
  */
256
258
  namespaces?: Record<string, Record<string, any>>;
257
259
  }
258
- export interface InvalidateCache extends InvalidateCacheGetByOneOf {
260
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
259
261
  /**
260
262
  * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
261
263
  * @format GUID
@@ -284,7 +286,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
284
286
  hardPurge?: boolean;
285
287
  }
286
288
  /** @oneof */
287
- export interface InvalidateCacheGetByOneOf {
289
+ interface InvalidateCacheGetByOneOf {
288
290
  /**
289
291
  * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
290
292
  * @format GUID
@@ -304,7 +306,7 @@ export interface InvalidateCacheGetByOneOf {
304
306
  /** Invalidate by file (for media files such as PDFs) */
305
307
  file?: File;
306
308
  }
307
- export interface App {
309
+ interface App {
308
310
  /**
309
311
  * The AppDefId
310
312
  * @minLength 1
@@ -316,7 +318,7 @@ export interface App {
316
318
  */
317
319
  instanceId?: string;
318
320
  }
319
- export interface Page {
321
+ interface Page {
320
322
  /**
321
323
  * the msid the page is on
322
324
  * @format GUID
@@ -328,7 +330,7 @@ export interface Page {
328
330
  */
329
331
  pageId?: string;
330
332
  }
331
- export interface URI {
333
+ interface URI {
332
334
  /**
333
335
  * the msid the URI is on
334
336
  * @format GUID
@@ -340,7 +342,7 @@ export interface URI {
340
342
  */
341
343
  uriPath?: string;
342
344
  }
343
- export interface File {
345
+ interface File {
344
346
  /**
345
347
  * the msid the file is related to
346
348
  * @format GUID
@@ -353,44 +355,44 @@ export interface File {
353
355
  */
354
356
  fileName?: string;
355
357
  }
356
- export interface UpdateMySlugRequest {
358
+ interface UpdateMySlugRequest {
357
359
  /**
358
360
  * New slug.
359
361
  * @maxLength 255
360
362
  */
361
363
  slug: string;
362
364
  }
363
- export interface UpdateMySlugResponse {
365
+ interface UpdateMySlugResponse {
364
366
  /** Updated member. */
365
367
  member?: Member;
366
368
  }
367
- export interface SlugAlreadyExistsPayload {
369
+ interface SlugAlreadyExistsPayload {
368
370
  slug?: string;
369
371
  }
370
- export interface UpdateMemberSlugRequest {
372
+ interface UpdateMemberSlugRequest {
371
373
  /**
372
374
  * Member ID.
373
375
  * @format GUID
374
376
  */
375
- id: string;
377
+ _id: string;
376
378
  /**
377
379
  * New slug.
378
380
  * @maxLength 255
379
381
  */
380
382
  slug: string;
381
383
  }
382
- export interface UpdateMemberSlugResponse {
384
+ interface UpdateMemberSlugResponse {
383
385
  /** Updated member. */
384
386
  member?: Member;
385
387
  }
386
- export interface JoinCommunityRequest {
388
+ interface JoinCommunityRequest {
387
389
  }
388
390
  /** Member profile. */
389
- export interface JoinCommunityResponse {
391
+ interface JoinCommunityResponse {
390
392
  /** The updated member. */
391
393
  member?: Member;
392
394
  }
393
- export interface MemberJoinedCommunity {
395
+ interface MemberJoinedCommunity {
394
396
  /**
395
397
  * ID of the member who joined the community.
396
398
  * @format GUID
@@ -398,14 +400,14 @@ export interface MemberJoinedCommunity {
398
400
  */
399
401
  memberId?: string;
400
402
  }
401
- export interface LeaveCommunityRequest {
403
+ interface LeaveCommunityRequest {
402
404
  }
403
405
  /** Member profile. */
404
- export interface LeaveCommunityResponse {
406
+ interface LeaveCommunityResponse {
405
407
  /** The updated member. */
406
408
  member?: Member;
407
409
  }
408
- export interface MemberLeftCommunity {
410
+ interface MemberLeftCommunity {
409
411
  /**
410
412
  * ID of the site member who left the community.
411
413
  * @format GUID
@@ -413,7 +415,7 @@ export interface MemberLeftCommunity {
413
415
  */
414
416
  memberId?: string;
415
417
  }
416
- export interface GetMyMemberRequest {
418
+ interface GetMyMemberRequest {
417
419
  /**
418
420
  * Predefined set of fields to return.
419
421
  *
@@ -422,7 +424,7 @@ export interface GetMyMemberRequest {
422
424
  */
423
425
  fieldsets?: Set[];
424
426
  }
425
- export declare enum Set {
427
+ declare enum Set {
426
428
  /**
427
429
  * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
428
430
  * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
@@ -434,16 +436,16 @@ export declare enum Set {
434
436
  FULL = "FULL"
435
437
  }
436
438
  /** Member profile. */
437
- export interface GetMyMemberResponse {
439
+ interface GetMyMemberResponse {
438
440
  /** The retrieved member. */
439
441
  member?: Member;
440
442
  }
441
- export interface GetMemberRequest {
443
+ interface GetMemberRequest {
442
444
  /**
443
445
  * Member ID.
444
446
  * @format GUID
445
447
  */
446
- id: string;
448
+ _id: string;
447
449
  /**
448
450
  * Predefined set of fields to return.
449
451
  *
@@ -452,18 +454,18 @@ export interface GetMemberRequest {
452
454
  */
453
455
  fieldsets?: Set[];
454
456
  }
455
- export interface GetMemberResponse {
457
+ interface GetMemberResponse {
456
458
  /** The requested member. */
457
459
  member?: Member;
458
460
  }
459
- export interface MemberToMemberBlockedPayload {
461
+ interface MemberToMemberBlockedPayload {
460
462
  /**
461
463
  * Member ID.
462
464
  * @format GUID
463
465
  */
464
466
  memberId?: string;
465
467
  }
466
- export interface ListMembersRequest {
468
+ interface ListMembersRequest {
467
469
  paging?: Paging;
468
470
  /**
469
471
  * Predefined sets of fields to return.
@@ -474,13 +476,13 @@ export interface ListMembersRequest {
474
476
  fieldsets?: Set[];
475
477
  sorting?: Sorting[];
476
478
  }
477
- export interface Paging {
479
+ interface Paging {
478
480
  /** Number of items to load. */
479
481
  limit?: number | null;
480
482
  /** Number of items to skip in the current sort order. */
481
483
  offset?: number | null;
482
484
  }
483
- export interface Sorting {
485
+ interface Sorting {
484
486
  /**
485
487
  * Name of the field to sort by.
486
488
  * @maxLength 512
@@ -489,11 +491,11 @@ export interface Sorting {
489
491
  /** Sort order. */
490
492
  order?: SortOrder;
491
493
  }
492
- export declare enum SortOrder {
494
+ declare enum SortOrder {
493
495
  ASC = "ASC",
494
496
  DESC = "DESC"
495
497
  }
496
- export interface CursorPaging {
498
+ interface CursorPaging {
497
499
  /**
498
500
  * Maximum number of items to return in the results.
499
501
  * @max 100
@@ -508,13 +510,13 @@ export interface CursorPaging {
508
510
  */
509
511
  cursor?: string | null;
510
512
  }
511
- export interface ListMembersResponse {
513
+ interface ListMembersResponse {
512
514
  /** List of members. */
513
515
  members?: Member[];
514
516
  /** Metadata for the paginated results. */
515
517
  metadata?: PagingMetadata;
516
518
  }
517
- export interface PagingMetadata {
519
+ interface PagingMetadata {
518
520
  /** Number of items returned in the response. */
519
521
  count?: number | null;
520
522
  /** Offset that was requested. */
@@ -524,7 +526,7 @@ export interface PagingMetadata {
524
526
  /** Flag that indicates the server failed to calculate the `total` field. */
525
527
  tooManyToCount?: boolean | null;
526
528
  }
527
- export interface CursorPagingMetadata {
529
+ interface CursorPagingMetadata {
528
530
  /** Number of items returned in the response. */
529
531
  count?: number | null;
530
532
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -537,7 +539,7 @@ export interface CursorPagingMetadata {
537
539
  */
538
540
  hasNext?: boolean | null;
539
541
  }
540
- export interface Cursors {
542
+ interface Cursors {
541
543
  /**
542
544
  * Cursor string pointing to the next page in the list of results.
543
545
  * @maxLength 16000
@@ -549,7 +551,7 @@ export interface Cursors {
549
551
  */
550
552
  prev?: string | null;
551
553
  }
552
- export interface QueryMembersRequest {
554
+ interface QueryMembersRequest {
553
555
  /** Query options. */
554
556
  query?: Query;
555
557
  /**
@@ -562,7 +564,7 @@ export interface QueryMembersRequest {
562
564
  /** Plain text search. */
563
565
  search?: Search;
564
566
  }
565
- export interface Query {
567
+ interface Query {
566
568
  /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
567
569
  filter?: any;
568
570
  /** Limit number of results */
@@ -571,7 +573,7 @@ export interface Query {
571
573
  sorting?: Sorting[];
572
574
  }
573
575
  /** Free text to match in searchable fields */
574
- export interface Search {
576
+ interface Search {
575
577
  /**
576
578
  * Search term or expression.
577
579
  * @minLength 1
@@ -593,24 +595,24 @@ export interface Search {
593
595
  */
594
596
  fields?: string[];
595
597
  }
596
- export interface QueryMembersResponse {
598
+ interface QueryMembersResponse {
597
599
  /** List of members that met the query filter criteria. */
598
600
  members?: Member[];
599
601
  /** Metadata for the paginated results. */
600
602
  metadata?: PagingMetadata;
601
603
  }
602
- export interface MuteMemberRequest {
604
+ interface MuteMemberRequest {
603
605
  /**
604
606
  * ID of the member to mute.
605
607
  * @format GUID
606
608
  */
607
- id: string;
609
+ _id: string;
608
610
  }
609
- export interface MuteMemberResponse {
611
+ interface MuteMemberResponse {
610
612
  /** Muted member. */
611
613
  member?: Member;
612
614
  }
613
- export interface MemberMuted {
615
+ interface MemberMuted {
614
616
  /**
615
617
  * ID of the member who got muted.
616
618
  * @format GUID
@@ -618,18 +620,18 @@ export interface MemberMuted {
618
620
  */
619
621
  memberId?: string;
620
622
  }
621
- export interface UnmuteMemberRequest {
623
+ interface UnmuteMemberRequest {
622
624
  /**
623
625
  * ID of the member to unmute.
624
626
  * @format GUID
625
627
  */
626
- id: string;
628
+ _id: string;
627
629
  }
628
- export interface UnmuteMemberResponse {
630
+ interface UnmuteMemberResponse {
629
631
  /** Unmuted member. */
630
632
  member?: Member;
631
633
  }
632
- export interface MemberUnmuted {
634
+ interface MemberUnmuted {
633
635
  /**
634
636
  * ID of the member who got unmuted.
635
637
  * @format GUID
@@ -637,18 +639,18 @@ export interface MemberUnmuted {
637
639
  */
638
640
  memberId?: string;
639
641
  }
640
- export interface ApproveMemberRequest {
642
+ interface ApproveMemberRequest {
641
643
  /**
642
644
  * ID of the member to approve.
643
645
  * @format GUID
644
646
  */
645
- id: string;
647
+ _id: string;
646
648
  }
647
- export interface ApproveMemberResponse {
649
+ interface ApproveMemberResponse {
648
650
  /** Approved member. */
649
651
  member?: Member;
650
652
  }
651
- export interface MemberApproved {
653
+ interface MemberApproved {
652
654
  /**
653
655
  * ID of the member who got approved.
654
656
  * @format GUID
@@ -656,18 +658,18 @@ export interface MemberApproved {
656
658
  */
657
659
  memberId?: string;
658
660
  }
659
- export interface BlockMemberRequest {
661
+ interface BlockMemberRequest {
660
662
  /**
661
663
  * ID of a member to block.
662
664
  * @format GUID
663
665
  */
664
- id: string;
666
+ _id: string;
665
667
  }
666
- export interface BlockMemberResponse {
668
+ interface BlockMemberResponse {
667
669
  /** Blocked member. */
668
670
  member?: Member;
669
671
  }
670
- export interface MemberBlocked {
672
+ interface MemberBlocked {
671
673
  /**
672
674
  * ID of the member who got blocked.
673
675
  * @format GUID
@@ -675,78 +677,78 @@ export interface MemberBlocked {
675
677
  */
676
678
  memberId?: string;
677
679
  }
678
- export interface MemberSelfBlockForbiddenPayload {
680
+ interface MemberSelfBlockForbiddenPayload {
679
681
  /**
680
682
  * Target's member ID.
681
683
  * @format GUID
682
684
  */
683
685
  memberId?: string;
684
686
  }
685
- export interface OwnerMemberBlockForbiddenPayload {
687
+ interface OwnerMemberBlockForbiddenPayload {
686
688
  /**
687
689
  * Owner's member ID.
688
690
  * @format GUID
689
691
  */
690
692
  memberId?: string;
691
693
  }
692
- export interface ActiveSubscriptionMemberBlockForbiddenPayload {
694
+ interface ActiveSubscriptionMemberBlockForbiddenPayload {
693
695
  /**
694
696
  * Active subscription member ID.
695
697
  * @format GUID
696
698
  */
697
699
  memberId?: string;
698
700
  }
699
- export interface DisconnectMemberRequest {
701
+ interface DisconnectMemberRequest {
700
702
  /**
701
703
  * ID of a member to disconnect.
702
704
  * @format GUID
703
705
  */
704
- id: string;
706
+ _id: string;
705
707
  }
706
- export interface DisconnectMemberResponse {
708
+ interface DisconnectMemberResponse {
707
709
  /** Disconnected member. */
708
710
  member?: Member;
709
711
  }
710
- export interface DeleteMemberRequest {
712
+ interface DeleteMemberRequest {
711
713
  /**
712
714
  * ID of a member to delete.
713
715
  * @format GUID
714
716
  */
715
- id: string;
717
+ _id: string;
716
718
  }
717
- export interface DeleteMemberResponse {
719
+ interface DeleteMemberResponse {
718
720
  }
719
- export interface ContentReassignmentRequested {
721
+ interface ContentReassignmentRequested {
720
722
  fromMember?: Member;
721
723
  toMember?: Member;
722
724
  }
723
- export interface ContentDeletionRequested {
725
+ interface ContentDeletionRequested {
724
726
  member?: Member;
725
727
  }
726
- export interface OwnerOrContributorDeleteForbiddenPayload {
728
+ interface OwnerOrContributorDeleteForbiddenPayload {
727
729
  /**
728
730
  * Owner's or contributor's member ID.
729
731
  * @format GUID
730
732
  */
731
733
  memberId?: string;
732
734
  }
733
- export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
735
+ interface ActiveSubscriptionMemberDeleteForbiddenPayload {
734
736
  /**
735
737
  * Active subscription member ID.
736
738
  * @format GUID
737
739
  */
738
740
  memberId?: string;
739
741
  }
740
- export interface DeleteMyMemberRequest {
742
+ interface DeleteMyMemberRequest {
741
743
  /**
742
744
  * ID of a member receiving the deleted member's content.
743
745
  * @format GUID
744
746
  */
745
747
  contentAssigneeId?: string | null;
746
748
  }
747
- export interface DeleteMyMemberResponse {
749
+ interface DeleteMyMemberResponse {
748
750
  }
749
- export interface BulkDeleteMembersRequest {
751
+ interface BulkDeleteMembersRequest {
750
752
  /**
751
753
  * IDs of members to be deleted.
752
754
  * @minSize 1
@@ -755,18 +757,18 @@ export interface BulkDeleteMembersRequest {
755
757
  */
756
758
  memberIds: string[];
757
759
  }
758
- export interface BulkDeleteMembersResponse {
760
+ interface BulkDeleteMembersResponse {
759
761
  /** Result. */
760
762
  results?: BulkMemberResult[];
761
763
  /** Bulk action result metadata. */
762
764
  bulkActionMetadata?: BulkActionMetadata;
763
765
  }
764
- export interface ItemMetadata {
766
+ interface ItemMetadata {
765
767
  /**
766
768
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
767
769
  * @maxLength 255
768
770
  */
769
- id?: string | null;
771
+ _id?: string | null;
770
772
  /** Index of the item within the request array. Allows for correlation between request and response items. */
771
773
  originalIndex?: number;
772
774
  /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
@@ -774,7 +776,7 @@ export interface ItemMetadata {
774
776
  /** Details about the error in case of failure. */
775
777
  error?: ApplicationError;
776
778
  }
777
- export interface ApplicationError {
779
+ interface ApplicationError {
778
780
  /** Error code. */
779
781
  code?: string;
780
782
  /** Description of the error. */
@@ -782,10 +784,10 @@ export interface ApplicationError {
782
784
  /** Data related to the error. */
783
785
  data?: Record<string, any> | null;
784
786
  }
785
- export interface BulkMemberResult {
787
+ interface BulkMemberResult {
786
788
  itemMetadata?: ItemMetadata;
787
789
  }
788
- export interface BulkActionMetadata {
790
+ interface BulkActionMetadata {
789
791
  /** Number of items that were successfully processed. */
790
792
  totalSuccesses?: number;
791
793
  /** Number of items that couldn't be processed. */
@@ -793,7 +795,7 @@ export interface BulkActionMetadata {
793
795
  /** Number of failures without details because detailed failure threshold was exceeded. */
794
796
  undetailedFailures?: number;
795
797
  }
796
- export interface BulkDeleteMembersByFilterRequest {
798
+ interface BulkDeleteMembersByFilterRequest {
797
799
  /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
798
800
  filter: any;
799
801
  /**
@@ -804,91 +806,91 @@ export interface BulkDeleteMembersByFilterRequest {
804
806
  /** Plain text search. */
805
807
  search?: Search;
806
808
  }
807
- export interface BulkDeleteMembersByFilterResponse {
809
+ interface BulkDeleteMembersByFilterResponse {
808
810
  /**
809
811
  * Job ID.
810
812
  * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
811
813
  */
812
814
  jobId?: string;
813
815
  }
814
- export interface BulkApproveMembersRequest {
816
+ interface BulkApproveMembersRequest {
815
817
  /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
816
818
  filter: any;
817
819
  }
818
- export interface BulkApproveMembersResponse {
820
+ interface BulkApproveMembersResponse {
819
821
  /**
820
822
  * Job ID.
821
823
  * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
822
824
  */
823
825
  jobId?: string;
824
826
  }
825
- export interface BulkBlockMembersRequest {
827
+ interface BulkBlockMembersRequest {
826
828
  /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
827
829
  filter: any;
828
830
  }
829
- export interface BulkBlockMembersResponse {
831
+ interface BulkBlockMembersResponse {
830
832
  /**
831
833
  * Job ID.
832
834
  * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
833
835
  */
834
836
  jobId?: string;
835
837
  }
836
- export interface CreateMemberRequest {
838
+ interface CreateMemberRequest {
837
839
  /** Member to create. */
838
840
  member?: Member;
839
841
  }
840
- export interface CreateMemberResponse {
842
+ interface CreateMemberResponse {
841
843
  /** New member. */
842
844
  member?: Member;
843
845
  }
844
- export interface UpdateMemberRequest {
846
+ interface UpdateMemberRequest {
845
847
  /** Member info to update. */
846
848
  member?: Member;
847
849
  }
848
- export interface UpdateMemberResponse {
850
+ interface UpdateMemberResponse {
849
851
  /** Updated member. */
850
852
  member?: Member;
851
853
  }
852
- export interface InvalidCustomFieldUrlPayload {
854
+ interface InvalidCustomFieldUrlPayload {
853
855
  /** Custom field key and invalid URL. */
854
856
  fields?: Record<string, string>;
855
857
  }
856
- export interface DeleteMemberPhonesRequest {
858
+ interface DeleteMemberPhonesRequest {
857
859
  /**
858
860
  * ID of the member whose phone numbers will be deleted.
859
861
  * @format GUID
860
862
  */
861
- id: string;
863
+ _id: string;
862
864
  }
863
- export interface DeleteMemberPhonesResponse {
865
+ interface DeleteMemberPhonesResponse {
864
866
  /** Updated member. */
865
867
  member?: Member;
866
868
  }
867
- export interface DeleteMemberEmailsRequest {
869
+ interface DeleteMemberEmailsRequest {
868
870
  /**
869
871
  * ID of the member whose email addresses will be deleted.
870
872
  * @format GUID
871
873
  */
872
- id: string;
874
+ _id: string;
873
875
  }
874
- export interface DeleteMemberEmailsResponse {
876
+ interface DeleteMemberEmailsResponse {
875
877
  /** Updated member. */
876
878
  member?: Member;
877
879
  }
878
- export interface DeleteMemberAddressesRequest {
880
+ interface DeleteMemberAddressesRequest {
879
881
  /**
880
882
  * ID of the member whose street addresses will be deleted.
881
883
  * @format GUID
882
884
  */
883
- id: string;
885
+ _id: string;
884
886
  }
885
- export interface DeleteMemberAddressesResponse {
887
+ interface DeleteMemberAddressesResponse {
886
888
  /** Updated member. */
887
889
  member?: Member;
888
890
  }
889
- export interface Empty {
891
+ interface Empty {
890
892
  }
891
- export interface DomainEvent extends DomainEventBodyOneOf {
893
+ interface DomainEvent extends DomainEventBodyOneOf {
892
894
  createdEvent?: EntityCreatedEvent;
893
895
  updatedEvent?: EntityUpdatedEvent;
894
896
  deletedEvent?: EntityDeletedEvent;
@@ -897,7 +899,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
897
899
  * Unique event ID.
898
900
  * Allows clients to ignore duplicate webhooks.
899
901
  */
900
- id?: string;
902
+ _id?: string;
901
903
  /**
902
904
  * Assumes actions are also always typed to an entity_type
903
905
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -931,36 +933,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
931
933
  entityEventSequence?: string | null;
932
934
  }
933
935
  /** @oneof */
934
- export interface DomainEventBodyOneOf {
936
+ interface DomainEventBodyOneOf {
935
937
  createdEvent?: EntityCreatedEvent;
936
938
  updatedEvent?: EntityUpdatedEvent;
937
939
  deletedEvent?: EntityDeletedEvent;
938
940
  actionEvent?: ActionEvent;
939
941
  }
940
- export interface EntityCreatedEvent {
941
- entityAsJson?: string;
942
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
943
- restoreInfo?: RestoreInfo;
942
+ interface EntityCreatedEvent {
943
+ entity?: string;
944
944
  }
945
- export interface RestoreInfo {
945
+ interface RestoreInfo {
946
946
  deletedDate?: Date | null;
947
947
  }
948
- export interface EntityUpdatedEvent {
948
+ interface EntityUpdatedEvent {
949
949
  /**
950
950
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
951
951
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
952
952
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
953
953
  */
954
- currentEntityAsJson?: string;
954
+ currentEntity?: string;
955
955
  }
956
- export interface EntityDeletedEvent {
956
+ interface EntityDeletedEvent {
957
957
  /** Entity that was deleted */
958
- deletedEntityAsJson?: string | null;
958
+ deletedEntity?: string | null;
959
959
  }
960
- export interface ActionEvent {
961
- bodyAsJson?: string;
960
+ interface ActionEvent {
961
+ body?: string;
962
962
  }
963
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
963
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
964
964
  /** Emitted on a meta site creation. */
965
965
  siteCreated?: SiteCreated;
966
966
  /** Emitted on a meta site transfer completion. */
@@ -1018,7 +1018,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1018
1018
  assets?: Asset[];
1019
1019
  }
1020
1020
  /** @oneof */
1021
- export interface MetaSiteSpecialEventPayloadOneOf {
1021
+ interface MetaSiteSpecialEventPayloadOneOf {
1022
1022
  /** Emitted on a meta site creation. */
1023
1023
  siteCreated?: SiteCreated;
1024
1024
  /** Emitted on a meta site transfer completion. */
@@ -1060,7 +1060,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
1060
1060
  /** Site is marked as PurgedExternally */
1061
1061
  sitePurgedExternally?: SitePurgedExternally;
1062
1062
  }
1063
- export interface Asset {
1063
+ interface Asset {
1064
1064
  /**
1065
1065
  * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1066
1066
  * @maxLength 36
@@ -1074,14 +1074,14 @@ export interface Asset {
1074
1074
  /** An application state. */
1075
1075
  state?: State;
1076
1076
  }
1077
- export declare enum State {
1077
+ declare enum State {
1078
1078
  UNKNOWN = "UNKNOWN",
1079
1079
  ENABLED = "ENABLED",
1080
1080
  DISABLED = "DISABLED",
1081
1081
  PENDING = "PENDING",
1082
1082
  DEMO = "DEMO"
1083
1083
  }
1084
- export interface SiteCreated {
1084
+ interface SiteCreated {
1085
1085
  /**
1086
1086
  * A template identifier (empty if not created from a template).
1087
1087
  * @maxLength 36
@@ -1110,7 +1110,7 @@ export interface SiteCreated {
1110
1110
  /** A namespace. */
1111
1111
  namespace?: Namespace;
1112
1112
  }
1113
- export declare enum SiteCreatedContext {
1113
+ declare enum SiteCreatedContext {
1114
1114
  /** A valid option, we don't expose all reasons why site might be created. */
1115
1115
  OTHER = "OTHER",
1116
1116
  /** A meta site was created from template. */
@@ -1124,7 +1124,7 @@ export declare enum SiteCreatedContext {
1124
1124
  /** deprecated A meta site was created for Flash editor. */
1125
1125
  FLASH = "FLASH"
1126
1126
  }
1127
- export declare enum Namespace {
1127
+ declare enum Namespace {
1128
1128
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1129
1129
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1130
1130
  WIX = "WIX",
@@ -1207,7 +1207,7 @@ export declare enum Namespace {
1207
1207
  MIMIR = "MIMIR"
1208
1208
  }
1209
1209
  /** Site transferred to another user. */
1210
- export interface SiteTransferred {
1210
+ interface SiteTransferred {
1211
1211
  /**
1212
1212
  * A previous owner id (user that transfers meta site).
1213
1213
  * @format GUID
@@ -1220,11 +1220,11 @@ export interface SiteTransferred {
1220
1220
  newOwnerId?: string;
1221
1221
  }
1222
1222
  /** Soft deletion of the meta site. Could be restored. */
1223
- export interface SiteDeleted {
1223
+ interface SiteDeleted {
1224
1224
  /** A deletion context. */
1225
1225
  deleteContext?: DeleteContext;
1226
1226
  }
1227
- export interface DeleteContext {
1227
+ interface DeleteContext {
1228
1228
  /** When the meta site was deleted. */
1229
1229
  dateDeleted?: Date | null;
1230
1230
  /** A status. */
@@ -1240,7 +1240,7 @@ export interface DeleteContext {
1240
1240
  */
1241
1241
  initiatorId?: string | null;
1242
1242
  }
1243
- export declare enum DeleteStatus {
1243
+ declare enum DeleteStatus {
1244
1244
  UNKNOWN = "UNKNOWN",
1245
1245
  TRASH = "TRASH",
1246
1246
  DELETED = "DELETED",
@@ -1248,12 +1248,12 @@ export declare enum DeleteStatus {
1248
1248
  PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1249
1249
  }
1250
1250
  /** Restoration of the meta site. */
1251
- export interface SiteUndeleted {
1251
+ interface SiteUndeleted {
1252
1252
  }
1253
1253
  /** First publish of a meta site. Or subsequent publish after unpublish. */
1254
- export interface SitePublished {
1254
+ interface SitePublished {
1255
1255
  }
1256
- export interface SiteUnpublished {
1256
+ interface SiteUnpublished {
1257
1257
  /**
1258
1258
  * A list of URLs previously associated with the meta site.
1259
1259
  * @maxLength 4000
@@ -1261,9 +1261,9 @@ export interface SiteUnpublished {
1261
1261
  */
1262
1262
  urls?: string[];
1263
1263
  }
1264
- export interface SiteMarkedAsTemplate {
1264
+ interface SiteMarkedAsTemplate {
1265
1265
  }
1266
- export interface SiteMarkedAsWixSite {
1266
+ interface SiteMarkedAsWixSite {
1267
1267
  }
1268
1268
  /**
1269
1269
  * Represents a service provisioned a site.
@@ -1280,7 +1280,7 @@ export interface SiteMarkedAsWixSite {
1280
1280
  * changes made to the original template afterward.
1281
1281
  * To ensure this, the TPA on the template gets a new instance_id.
1282
1282
  */
1283
- export interface ServiceProvisioned {
1283
+ interface ServiceProvisioned {
1284
1284
  /**
1285
1285
  * Either UUID or EmbeddedServiceType.
1286
1286
  * @maxLength 36
@@ -1307,7 +1307,7 @@ export interface ServiceProvisioned {
1307
1307
  */
1308
1308
  originMetaSiteId?: string | null;
1309
1309
  }
1310
- export interface ServiceRemoved {
1310
+ interface ServiceRemoved {
1311
1311
  /**
1312
1312
  * Either UUID or EmbeddedServiceType.
1313
1313
  * @maxLength 36
@@ -1325,7 +1325,7 @@ export interface ServiceRemoved {
1325
1325
  version?: string | null;
1326
1326
  }
1327
1327
  /** Rename of the site. Meaning, free public url has been changed as well. */
1328
- export interface SiteRenamed {
1328
+ interface SiteRenamed {
1329
1329
  /**
1330
1330
  * A new meta site name (URL slug).
1331
1331
  * @maxLength 20
@@ -1342,21 +1342,21 @@ export interface SiteRenamed {
1342
1342
  *
1343
1343
  * Could not be restored. Therefore it's desirable to cleanup data.
1344
1344
  */
1345
- export interface SiteHardDeleted {
1345
+ interface SiteHardDeleted {
1346
1346
  /** A deletion context. */
1347
1347
  deleteContext?: DeleteContext;
1348
1348
  }
1349
- export interface NamespaceChanged {
1349
+ interface NamespaceChanged {
1350
1350
  /** A previous namespace. */
1351
1351
  oldNamespace?: Namespace;
1352
1352
  /** A new namespace. */
1353
1353
  newNamespace?: Namespace;
1354
1354
  }
1355
1355
  /** Assigned Studio editor */
1356
- export interface StudioAssigned {
1356
+ interface StudioAssigned {
1357
1357
  }
1358
1358
  /** Unassigned Studio editor */
1359
- export interface StudioUnassigned {
1359
+ interface StudioUnassigned {
1360
1360
  }
1361
1361
  /**
1362
1362
  * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
@@ -1366,13 +1366,13 @@ export interface StudioUnassigned {
1366
1366
  *
1367
1367
  * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1368
1368
  */
1369
- export interface SiteUrlChanged {
1369
+ interface SiteUrlChanged {
1370
1370
  }
1371
1371
  /**
1372
1372
  * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1373
1373
  * Consumed by other teams to remove relevant data.
1374
1374
  */
1375
- export interface SitePurgedExternally {
1375
+ interface SitePurgedExternally {
1376
1376
  /**
1377
1377
  * @maxLength 2048
1378
1378
  * @maxSize 100
@@ -1381,17 +1381,17 @@ export interface SitePurgedExternally {
1381
1381
  */
1382
1382
  appDefId?: string[];
1383
1383
  }
1384
- export interface MemberOwnershipTransferred {
1384
+ interface MemberOwnershipTransferred {
1385
1385
  fromMember?: Member;
1386
1386
  toMember?: Member;
1387
1387
  }
1388
- export interface MemberIdChanged {
1388
+ interface MemberIdChanged {
1389
1389
  /** @format GUID */
1390
1390
  fromId?: string;
1391
1391
  /** @format GUID */
1392
1392
  toId?: string;
1393
1393
  }
1394
- export interface MessageEnvelope {
1394
+ interface MessageEnvelope {
1395
1395
  /**
1396
1396
  * App instance ID.
1397
1397
  * @format GUID
@@ -1407,7 +1407,7 @@ export interface MessageEnvelope {
1407
1407
  /** Stringify payload. */
1408
1408
  data?: string;
1409
1409
  }
1410
- export interface IdentificationData extends IdentificationDataIdOneOf {
1410
+ interface IdentificationData extends IdentificationDataIdOneOf {
1411
1411
  /**
1412
1412
  * ID of a site visitor that has not logged in to the site.
1413
1413
  * @format GUID
@@ -1432,7 +1432,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1432
1432
  identityType?: WebhookIdentityType;
1433
1433
  }
1434
1434
  /** @oneof */
1435
- export interface IdentificationDataIdOneOf {
1435
+ interface IdentificationDataIdOneOf {
1436
1436
  /**
1437
1437
  * ID of a site visitor that has not logged in to the site.
1438
1438
  * @format GUID
@@ -1454,10 +1454,238 @@ export interface IdentificationDataIdOneOf {
1454
1454
  */
1455
1455
  appId?: string;
1456
1456
  }
1457
- export declare enum WebhookIdentityType {
1457
+ declare enum WebhookIdentityType {
1458
1458
  UNKNOWN = "UNKNOWN",
1459
1459
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1460
1460
  MEMBER = "MEMBER",
1461
1461
  WIX_USER = "WIX_USER",
1462
1462
  APP = "APP"
1463
1463
  }
1464
+ interface BaseEventMetadata {
1465
+ /**
1466
+ * App instance ID.
1467
+ * @format GUID
1468
+ */
1469
+ instanceId?: string | null;
1470
+ /**
1471
+ * Event type.
1472
+ * @maxLength 150
1473
+ */
1474
+ eventType?: string;
1475
+ /** The identification type and identity data. */
1476
+ identity?: IdentificationData;
1477
+ }
1478
+ interface EventMetadata extends BaseEventMetadata {
1479
+ /**
1480
+ * Unique event ID.
1481
+ * Allows clients to ignore duplicate webhooks.
1482
+ */
1483
+ _id?: string;
1484
+ /**
1485
+ * Assumes actions are also always typed to an entity_type
1486
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1487
+ */
1488
+ entityFqdn?: string;
1489
+ /**
1490
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1491
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1492
+ * Example: created/updated/deleted/started/completed/email_opened
1493
+ */
1494
+ slug?: string;
1495
+ /** ID of the entity associated with the event. */
1496
+ entityId?: string;
1497
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1498
+ eventTime?: Date | null;
1499
+ /**
1500
+ * Whether the event was triggered as a result of a privacy regulation application
1501
+ * (for example, GDPR).
1502
+ */
1503
+ triggeredByAnonymizeRequest?: boolean | null;
1504
+ /** If present, indicates the action that triggered the event. */
1505
+ originatedFrom?: string | null;
1506
+ /**
1507
+ * A sequence number defining the order of updates to the underlying entity.
1508
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1509
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1510
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1511
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1512
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1513
+ */
1514
+ entityEventSequence?: string | null;
1515
+ }
1516
+ interface MemberCreatedEnvelope {
1517
+ entity: Member;
1518
+ metadata: EventMetadata;
1519
+ }
1520
+ interface MemberDeletedEnvelope {
1521
+ metadata: EventMetadata;
1522
+ }
1523
+ interface MemberUpdatedEnvelope {
1524
+ entity: Member;
1525
+ metadata: EventMetadata;
1526
+ }
1527
+ interface GetCurrentMemberOptions {
1528
+ /**
1529
+ * Predefined set of fields to return.
1530
+ *
1531
+ * Default: `"PUBLIC"`.
1532
+ * @maxSize 3
1533
+ */
1534
+ fieldsets?: Set[];
1535
+ }
1536
+ interface GetMemberOptions {
1537
+ /**
1538
+ * Predefined set of fields to return.
1539
+ *
1540
+ * Defaults to `"PUBLIC"`.
1541
+ * @maxSize 3
1542
+ */
1543
+ fieldsets?: Set[];
1544
+ }
1545
+ interface ListMembersOptions {
1546
+ /** Paging options. */
1547
+ paging?: Paging;
1548
+ /**
1549
+ * Predefined sets of fields to return.
1550
+ *
1551
+ * Default: `"PUBLIC"`.
1552
+ * @maxSize 3
1553
+ */
1554
+ fieldsets?: Set[];
1555
+ /** Sorting options. */
1556
+ sorting?: Sorting[];
1557
+ }
1558
+ interface QueryMembersOptions {
1559
+ /**
1560
+ * Predefined sets of fields to return.
1561
+ *
1562
+ * Default: `"PUBLIC"`.
1563
+ * @maxSize 3
1564
+ */
1565
+ fieldsets?: Set[] | undefined;
1566
+ /** Plain text search. */
1567
+ search?: Search | undefined;
1568
+ }
1569
+ interface QueryOffsetResult {
1570
+ currentPage: number | undefined;
1571
+ totalPages: number | undefined;
1572
+ totalCount: number | undefined;
1573
+ hasNext: () => boolean;
1574
+ hasPrev: () => boolean;
1575
+ length: number;
1576
+ pageSize: number;
1577
+ }
1578
+ interface MembersQueryResult extends QueryOffsetResult {
1579
+ items: Member[];
1580
+ query: MembersQueryBuilder;
1581
+ next: () => Promise<MembersQueryResult>;
1582
+ prev: () => Promise<MembersQueryResult>;
1583
+ }
1584
+ interface MembersQueryBuilder {
1585
+ /** @param propertyName - Property whose value is compared with `value`.
1586
+ * @param value - Value to compare against.
1587
+ */
1588
+ eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1589
+ /** @param propertyName - Property whose value is compared with `value`.
1590
+ * @param value - Value to compare against.
1591
+ */
1592
+ ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1593
+ /** @param propertyName - Property whose value is compared with `string`.
1594
+ * @param string - String to compare against. Case-insensitive.
1595
+ */
1596
+ startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
1597
+ /** @param propertyName - Property whose value is compared with `values`.
1598
+ * @param values - List of values to compare against.
1599
+ */
1600
+ hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
1601
+ in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1602
+ exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
1603
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1604
+ limit: (limit: number) => MembersQueryBuilder;
1605
+ /** @param skip - Number of items to skip in the query results before returning the results. */
1606
+ skip: (skip: number) => MembersQueryBuilder;
1607
+ find: () => Promise<MembersQueryResult>;
1608
+ }
1609
+ interface DeleteMyMemberOptions {
1610
+ /**
1611
+ * ID of a member receiving the deleted member's content.
1612
+ * @format GUID
1613
+ */
1614
+ contentAssigneeId?: string | null;
1615
+ }
1616
+ interface BulkDeleteMembersByFilterOptions {
1617
+ /**
1618
+ * ID of a member receiving the deleted member's content.
1619
+ * @format GUID
1620
+ */
1621
+ contentAssigneeId?: string | null;
1622
+ /** Plain text search. */
1623
+ search?: Search;
1624
+ }
1625
+ interface CreateMemberOptions {
1626
+ /** Member to create. */
1627
+ member?: Member;
1628
+ }
1629
+ interface UpdateMember {
1630
+ /**
1631
+ * Member ID.
1632
+ * @format GUID
1633
+ * @readonly
1634
+ */
1635
+ _id?: string | null;
1636
+ /**
1637
+ * Email used by a member to log in to the site.
1638
+ * @format EMAIL
1639
+ */
1640
+ loginEmail?: string | null;
1641
+ /**
1642
+ * Whether the email used by a member has been verified.
1643
+ * @readonly
1644
+ */
1645
+ loginEmailVerified?: boolean | null;
1646
+ /**
1647
+ * Member site access status.
1648
+ * @readonly
1649
+ */
1650
+ status?: Status;
1651
+ /**
1652
+ * Contact ID.
1653
+ * @format GUID
1654
+ * @readonly
1655
+ */
1656
+ contactId?: string | null;
1657
+ /**
1658
+ * Member's contact information. Contact information is stored in the
1659
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
1660
+ *
1661
+ * The full set of contact data can be accessed and managed with the
1662
+ * Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
1663
+ */
1664
+ contact?: Contact;
1665
+ /** Profile display details. */
1666
+ profile?: Profile;
1667
+ /** Member privacy status. */
1668
+ privacyStatus?: PrivacyStatusStatus;
1669
+ /**
1670
+ * Member activity status.
1671
+ * @readonly
1672
+ */
1673
+ activityStatus?: ActivityStatusStatus;
1674
+ /**
1675
+ * Date and time when the member was created.
1676
+ * @readonly
1677
+ */
1678
+ _createdDate?: Date | null;
1679
+ /**
1680
+ * Date and time when the member was updated.
1681
+ * @readonly
1682
+ */
1683
+ _updatedDate?: Date | null;
1684
+ /**
1685
+ * Date and time when the member last logged in to the site.
1686
+ * @readonly
1687
+ */
1688
+ lastLoginDate?: Date | null;
1689
+ }
1690
+
1691
+ export { type SlugAlreadyExistsPayload as $, type ApproveMemberResponse as A, type BlockMemberResponse as B, type CreateMemberOptions as C, type DisconnectMemberResponse as D, type AddressStreetOneOf as E, type StreetAddress as F, type GetCurrentMemberOptions as G, type CustomField as H, type Profile as I, type JoinCommunityResponse as J, type Image as K, type LeaveCommunityResponse as L, type Member as M, Namespace as N, type ExtendedFields as O, PrivacyStatusStatus as P, type QueryMembersOptions as Q, type InvalidateCache as R, Status as S, type InvalidateCacheGetByOneOf as T, type UpdateMySlugResponse as U, type App as V, WebhookIdentityType as W, type Page as X, type URI as Y, type File as Z, type UpdateMySlugRequest as _, type UpdateMemberSlugResponse as a, type ActionEvent as a$, type UpdateMemberSlugRequest as a0, type JoinCommunityRequest as a1, type MemberJoinedCommunity as a2, type LeaveCommunityRequest as a3, type MemberLeftCommunity as a4, type GetMyMemberRequest as a5, type GetMemberRequest as a6, type GetMemberResponse as a7, type MemberToMemberBlockedPayload as a8, type ListMembersRequest as a9, type OwnerOrContributorDeleteForbiddenPayload as aA, type ActiveSubscriptionMemberDeleteForbiddenPayload as aB, type DeleteMyMemberRequest as aC, type DeleteMyMemberResponse as aD, type BulkDeleteMembersRequest as aE, type ItemMetadata as aF, type ApplicationError as aG, type BulkMemberResult as aH, type BulkActionMetadata as aI, type BulkDeleteMembersByFilterRequest as aJ, type BulkApproveMembersRequest as aK, type BulkBlockMembersRequest as aL, type CreateMemberRequest as aM, type CreateMemberResponse as aN, type UpdateMemberRequest as aO, type UpdateMemberResponse as aP, type InvalidCustomFieldUrlPayload as aQ, type DeleteMemberPhonesRequest as aR, type DeleteMemberEmailsRequest as aS, type DeleteMemberAddressesRequest as aT, type Empty as aU, type DomainEvent as aV, type DomainEventBodyOneOf as aW, type EntityCreatedEvent as aX, type RestoreInfo as aY, type EntityUpdatedEvent as aZ, type EntityDeletedEvent as a_, type Paging as aa, type Sorting as ab, type CursorPaging as ac, type PagingMetadata as ad, type CursorPagingMetadata as ae, type Cursors as af, type QueryMembersRequest as ag, type Query as ah, type Search as ai, type QueryMembersResponse as aj, type MuteMemberRequest as ak, type MemberMuted as al, type UnmuteMemberRequest as am, type MemberUnmuted as an, type ApproveMemberRequest as ao, type MemberApproved as ap, type BlockMemberRequest as aq, type MemberBlocked as ar, type MemberSelfBlockForbiddenPayload as as, type OwnerMemberBlockForbiddenPayload as at, type ActiveSubscriptionMemberBlockForbiddenPayload as au, type DisconnectMemberRequest as av, type DeleteMemberRequest as aw, type DeleteMemberResponse as ax, type ContentReassignmentRequested as ay, type ContentDeletionRequested as az, type GetMyMemberResponse as b, type MetaSiteSpecialEvent as b0, type MetaSiteSpecialEventPayloadOneOf as b1, type Asset as b2, type SiteCreated as b3, type SiteTransferred as b4, type SiteDeleted as b5, type DeleteContext as b6, type SiteUndeleted as b7, type SitePublished as b8, type SiteUnpublished as b9, type SiteMarkedAsTemplate as ba, type SiteMarkedAsWixSite as bb, type ServiceProvisioned as bc, type ServiceRemoved as bd, type SiteRenamed as be, type SiteHardDeleted as bf, type NamespaceChanged as bg, type StudioAssigned as bh, type StudioUnassigned as bi, type SiteUrlChanged as bj, type SitePurgedExternally as bk, type MemberOwnershipTransferred as bl, type MemberIdChanged as bm, type MessageEnvelope as bn, type IdentificationData as bo, type IdentificationDataIdOneOf as bp, type BaseEventMetadata as bq, type EventMetadata as br, type MemberCreatedEnvelope as bs, type MemberDeletedEnvelope as bt, type MemberUpdatedEnvelope as bu, type MembersQueryResult as bv, type GetMemberOptions as c, type ListMembersOptions as d, type ListMembersResponse as e, type MembersQueryBuilder as f, type MuteMemberResponse as g, type UnmuteMemberResponse as h, type DeleteMyMemberOptions as i, type BulkDeleteMembersResponse as j, type BulkDeleteMembersByFilterOptions as k, type BulkDeleteMembersByFilterResponse as l, type BulkApproveMembersResponse as m, type BulkBlockMembersResponse as n, type UpdateMember as o, type DeleteMemberPhonesResponse as p, type DeleteMemberEmailsResponse as q, type DeleteMemberAddressesResponse as r, ActivityStatusStatus as s, Set as t, SortOrder as u, State as v, SiteCreatedContext as w, DeleteStatus as x, type Contact as y, type Address as z };