@wix/auto_sdk_media-collections_media-collections 1.0.3 → 1.0.5

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 (130) hide show
  1. package/build/{internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.mts} +280 -388
  2. package/build/{internal/es/src/collections-v1-collection-media-collections.universal.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +280 -388
  3. package/build/index.d.mts +120 -0
  4. package/build/index.d.ts +120 -0
  5. package/build/index.js +1151 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1105 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/collections-v1-collection-media-collections.universal.d.ts → internal/collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.mts} +280 -388
  10. package/build/{es/src/collections-v1-collection-media-collections.universal.d.ts → internal/collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +280 -388
  11. package/build/internal/index.d.mts +120 -0
  12. package/build/internal/index.d.ts +120 -0
  13. package/build/internal/index.js +1151 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1105 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/{es/src/collections-v1-collection-media-collections.types.d.ts → internal/meta.d.mts} +145 -408
  18. package/build/internal/{cjs/src/collections-v1-collection-media-collections.types.d.ts → meta.d.ts} +145 -408
  19. package/build/internal/meta.js +783 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +744 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{cjs/src/collections-v1-collection-media-collections.types.d.ts → meta.d.mts} +145 -408
  24. package/build/{internal/es/src/collections-v1-collection-media-collections.types.d.ts → meta.d.ts} +145 -408
  25. package/build/meta.js +783 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +744 -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/collections-v1-collection-media-collections.context.d.ts +0 -21
  40. package/build/cjs/src/collections-v1-collection-media-collections.context.js +0 -33
  41. package/build/cjs/src/collections-v1-collection-media-collections.context.js.map +0 -1
  42. package/build/cjs/src/collections-v1-collection-media-collections.http.d.ts +0 -25
  43. package/build/cjs/src/collections-v1-collection-media-collections.http.js +0 -490
  44. package/build/cjs/src/collections-v1-collection-media-collections.http.js.map +0 -1
  45. package/build/cjs/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
  46. package/build/cjs/src/collections-v1-collection-media-collections.meta.js +0 -278
  47. package/build/cjs/src/collections-v1-collection-media-collections.meta.js.map +0 -1
  48. package/build/cjs/src/collections-v1-collection-media-collections.public.d.ts +0 -104
  49. package/build/cjs/src/collections-v1-collection-media-collections.public.js +0 -123
  50. package/build/cjs/src/collections-v1-collection-media-collections.public.js.map +0 -1
  51. package/build/cjs/src/collections-v1-collection-media-collections.types.js +0 -94
  52. package/build/cjs/src/collections-v1-collection-media-collections.types.js.map +0 -1
  53. package/build/cjs/src/collections-v1-collection-media-collections.universal.js +0 -574
  54. package/build/cjs/src/collections-v1-collection-media-collections.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/package.json +0 -3
  65. package/build/es/src/collections-v1-collection-media-collections.context.d.ts +0 -21
  66. package/build/es/src/collections-v1-collection-media-collections.context.js +0 -21
  67. package/build/es/src/collections-v1-collection-media-collections.context.js.map +0 -1
  68. package/build/es/src/collections-v1-collection-media-collections.http.d.ts +0 -25
  69. package/build/es/src/collections-v1-collection-media-collections.http.js +0 -474
  70. package/build/es/src/collections-v1-collection-media-collections.http.js.map +0 -1
  71. package/build/es/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
  72. package/build/es/src/collections-v1-collection-media-collections.meta.js +0 -239
  73. package/build/es/src/collections-v1-collection-media-collections.meta.js.map +0 -1
  74. package/build/es/src/collections-v1-collection-media-collections.public.d.ts +0 -104
  75. package/build/es/src/collections-v1-collection-media-collections.public.js +0 -98
  76. package/build/es/src/collections-v1-collection-media-collections.public.js.map +0 -1
  77. package/build/es/src/collections-v1-collection-media-collections.types.js +0 -91
  78. package/build/es/src/collections-v1-collection-media-collections.types.js.map +0 -1
  79. package/build/es/src/collections-v1-collection-media-collections.universal.js +0 -535
  80. package/build/es/src/collections-v1-collection-media-collections.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.d.ts +0 -21
  91. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js +0 -33
  92. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js.map +0 -1
  93. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.d.ts +0 -25
  94. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js +0 -490
  95. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js.map +0 -1
  96. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
  97. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js +0 -278
  98. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js.map +0 -1
  99. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.d.ts +0 -104
  100. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js +0 -123
  101. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js.map +0 -1
  102. package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js +0 -94
  103. package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js.map +0 -1
  104. package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js +0 -574
  105. package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/collections-v1-collection-media-collections.context.d.ts +0 -21
  116. package/build/internal/es/src/collections-v1-collection-media-collections.context.js +0 -21
  117. package/build/internal/es/src/collections-v1-collection-media-collections.context.js.map +0 -1
  118. package/build/internal/es/src/collections-v1-collection-media-collections.http.d.ts +0 -25
  119. package/build/internal/es/src/collections-v1-collection-media-collections.http.js +0 -474
  120. package/build/internal/es/src/collections-v1-collection-media-collections.http.js.map +0 -1
  121. package/build/internal/es/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
  122. package/build/internal/es/src/collections-v1-collection-media-collections.meta.js +0 -239
  123. package/build/internal/es/src/collections-v1-collection-media-collections.meta.js.map +0 -1
  124. package/build/internal/es/src/collections-v1-collection-media-collections.public.d.ts +0 -104
  125. package/build/internal/es/src/collections-v1-collection-media-collections.public.js +0 -98
  126. package/build/internal/es/src/collections-v1-collection-media-collections.public.js.map +0 -1
  127. package/build/internal/es/src/collections-v1-collection-media-collections.types.js +0 -91
  128. package/build/internal/es/src/collections-v1-collection-media-collections.types.js.map +0 -1
  129. package/build/internal/es/src/collections-v1-collection-media-collections.universal.js +0 -535
  130. package/build/internal/es/src/collections-v1-collection-media-collections.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface MediaCollection {
1
+ interface MediaCollection {
3
2
  /**
4
3
  * Collection id
5
4
  * @readonly
@@ -36,11 +35,11 @@ export interface MediaCollection {
36
35
  */
37
36
  itemsCount?: number;
38
37
  /** Privacy settings */
39
- privacySettings?: PrivacySettings;
38
+ privacySettings?: PrivacySettingsWithLiterals;
40
39
  /** If true, the collection is locked and should not be updated */
41
40
  locked?: boolean;
42
41
  }
43
- export interface CollectionMember {
42
+ interface CollectionMember {
44
43
  /**
45
44
  * Member id
46
45
  * @readonly
@@ -63,7 +62,7 @@ export interface CollectionMember {
63
62
  */
64
63
  photoUrl?: string | null;
65
64
  }
66
- export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
65
+ interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
67
66
  /** Photo metadata */
68
67
  photoMetadata?: PhotoMetadata;
69
68
  /** Video metadata */
@@ -89,7 +88,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
89
88
  /** a link from the item to something else */
90
89
  link?: Link;
91
90
  /** item type: text, photo or video */
92
- dataType?: DataType;
91
+ dataType?: DataTypeWithLiterals;
93
92
  /**
94
93
  * When the item was added to the collection
95
94
  * @readonly
@@ -101,7 +100,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
101
100
  */
102
101
  _updatedDate?: Date | null;
103
102
  /** The owner of the media */
104
- mediaOwner?: MediaOwner;
103
+ mediaOwner?: MediaOwnerWithLiterals;
105
104
  /** Tags for media */
106
105
  tags?: string[];
107
106
  /** Token for media */
@@ -110,7 +109,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
110
109
  galleryId?: string;
111
110
  }
112
111
  /** @oneof */
113
- export interface MediaCollectionItemMetadataOneOf {
112
+ interface MediaCollectionItemMetadataOneOf {
114
113
  /** Photo metadata */
115
114
  photoMetadata?: PhotoMetadata;
116
115
  /** Video metadata */
@@ -118,8 +117,8 @@ export interface MediaCollectionItemMetadataOneOf {
118
117
  /** Text metadata */
119
118
  textMetadata?: TextMetadata;
120
119
  }
121
- export interface Link {
122
- type?: Type;
120
+ interface Link {
121
+ type?: TypeWithLiterals;
123
122
  /** Link text */
124
123
  text?: string | null;
125
124
  /** Link url */
@@ -129,7 +128,7 @@ export interface Link {
129
128
  /** Data on how to construct the link from wix editor inputs */
130
129
  wixLinkData?: WixLink;
131
130
  }
132
- export declare enum Type {
131
+ declare enum Type {
133
132
  /** Undefined */
134
133
  Undefined = "Undefined",
135
134
  /** external link */
@@ -137,8 +136,10 @@ export declare enum Type {
137
136
  /** link to wix pages */
138
137
  Internal = "Internal"
139
138
  }
139
+ /** @enumType */
140
+ type TypeWithLiterals = Type | 'Undefined' | 'External' | 'Internal';
140
141
  /** The link object generated by panels in the editor and used by applications in Wix */
141
- export interface WixLink extends WixLinkLinkOneOf {
142
+ interface WixLink extends WixLinkLinkOneOf {
142
143
  /** External link type */
143
144
  external?: ExternalLink;
144
145
  /** Page link type */
@@ -161,7 +162,7 @@ export interface WixLink extends WixLinkLinkOneOf {
161
162
  tpaPage?: TpaPageLink;
162
163
  }
163
164
  /** @oneof */
164
- export interface WixLinkLinkOneOf {
165
+ interface WixLinkLinkOneOf {
165
166
  /** External link type */
166
167
  external?: ExternalLink;
167
168
  /** Page link type */
@@ -183,7 +184,7 @@ export interface WixLinkLinkOneOf {
183
184
  /** TPA link type */
184
185
  tpaPage?: TpaPageLink;
185
186
  }
186
- export interface ExternalLink {
187
+ interface ExternalLink {
187
188
  /**
188
189
  * The url of the page
189
190
  * @format WEB_URL
@@ -197,7 +198,7 @@ export interface ExternalLink {
197
198
  * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
198
199
  * Following are the accepted 'rel' types by Wix applications.
199
200
  */
200
- export declare enum LinkRel {
201
+ declare enum LinkRel {
201
202
  /** default (not implemented) */
202
203
  unknown_link_rel = "unknown_link_rel",
203
204
  /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
@@ -209,7 +210,9 @@ export declare enum LinkRel {
209
210
  /** Indicates a link that resulted from advertisements or paid placements. */
210
211
  sponsored = "sponsored"
211
212
  }
212
- export interface PageLink {
213
+ /** @enumType */
214
+ type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
215
+ interface PageLink {
213
216
  /** The page id we want from the site */
214
217
  pageId?: string;
215
218
  /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
@@ -218,9 +221,9 @@ export interface PageLink {
218
221
  * rel of link
219
222
  * @maxSize 20
220
223
  */
221
- rel?: LinkRel[];
224
+ rel?: LinkRelWithLiterals[];
222
225
  }
223
- export interface AnchorLink {
226
+ interface AnchorLink {
224
227
  /** The name of the anchor */
225
228
  anchorName?: string;
226
229
  /** The data id (from the JSON page) of the anchor that should be used */
@@ -231,9 +234,9 @@ export interface AnchorLink {
231
234
  * rel of link
232
235
  * @maxSize 20
233
236
  */
234
- rel?: LinkRel[];
237
+ rel?: LinkRelWithLiterals[];
235
238
  }
236
- export interface DynamicPageLink {
239
+ interface DynamicPageLink {
237
240
  /** The router that handles this link */
238
241
  routerId?: string;
239
242
  /** The path data we'd like */
@@ -244,9 +247,9 @@ export interface DynamicPageLink {
244
247
  * rel of link
245
248
  * @maxSize 20
246
249
  */
247
- rel?: LinkRel[];
250
+ rel?: LinkRelWithLiterals[];
248
251
  }
249
- export interface DocumentLink {
252
+ interface DocumentLink {
250
253
  /** The id of the document */
251
254
  docId?: string;
252
255
  /** The name of the document for download purposes */
@@ -254,7 +257,7 @@ export interface DocumentLink {
254
257
  /** If this document can be indexed by scrapers, default is false */
255
258
  indexable?: boolean;
256
259
  }
257
- export interface EmailLink {
260
+ interface EmailLink {
258
261
  /**
259
262
  * The email we will be sending a message to
260
263
  * @format EMAIL
@@ -265,7 +268,7 @@ export interface EmailLink {
265
268
  /** The body of the email */
266
269
  body?: string | null;
267
270
  }
268
- export interface PhoneLink {
271
+ interface PhoneLink {
269
272
  /**
270
273
  * The phone number we want to link to
271
274
  * @format PHONE
@@ -273,11 +276,11 @@ export interface PhoneLink {
273
276
  */
274
277
  phoneNumber?: string;
275
278
  }
276
- export interface AddressLink {
279
+ interface AddressLink {
277
280
  /** An address that we can link to */
278
281
  address?: string;
279
282
  }
280
- export interface WhatsAppLink {
283
+ interface WhatsAppLink {
281
284
  /**
282
285
  * The whatsApp phone number we want to connect with
283
286
  * @format PHONE
@@ -285,7 +288,7 @@ export interface WhatsAppLink {
285
288
  phoneNumber?: string;
286
289
  }
287
290
  /** Link to a TPA page */
288
- export interface TpaPageLink {
291
+ interface TpaPageLink {
289
292
  /** Type of item (e.g. 'wix.stores.sub_pages.product') */
290
293
  itemTypeIdentifier?: string;
291
294
  /** Id of linked item */
@@ -300,15 +303,17 @@ export interface TpaPageLink {
300
303
  * rel of link
301
304
  * @maxSize 20
302
305
  */
303
- rel?: LinkRel[];
306
+ rel?: LinkRelWithLiterals[];
304
307
  }
305
- export declare enum DataType {
308
+ declare enum DataType {
306
309
  Undefined = "Undefined",
307
310
  Photo = "Photo",
308
311
  Video = "Video",
309
312
  Text = "Text"
310
313
  }
311
- export interface PhotoMetadata {
314
+ /** @enumType */
315
+ type DataTypeWithLiterals = DataType | 'Undefined' | 'Photo' | 'Video' | 'Text';
316
+ interface PhotoMetadata {
312
317
  /** Photo width */
313
318
  width?: number | null;
314
319
  /** Photo height */
@@ -328,13 +333,13 @@ export interface PhotoMetadata {
328
333
  /** id in WixMedia */
329
334
  mediaId?: string | null;
330
335
  }
331
- export interface Point {
336
+ interface Point {
332
337
  /** x coordinate */
333
338
  x?: number;
334
339
  /** y coordinate */
335
340
  y?: number;
336
341
  }
337
- export interface UnsharpMasking {
342
+ interface UnsharpMasking {
338
343
  /**
339
344
  * number controls the amount of contrast that is added at the edges.
340
345
  * @max 5
@@ -348,7 +353,7 @@ export interface UnsharpMasking {
348
353
  */
349
354
  threshold?: number | null;
350
355
  }
351
- export interface VideoMetadata {
356
+ interface VideoMetadata {
352
357
  /** Video width */
353
358
  width?: number | null;
354
359
  /** Video height */
@@ -356,7 +361,7 @@ export interface VideoMetadata {
356
361
  /** Video duration in milliseconds */
357
362
  duration?: string | null;
358
363
  /** Video source */
359
- source?: Source;
364
+ source?: SourceWithLiterals;
360
365
  /** Video posters */
361
366
  posters?: Thumbnail[];
362
367
  /** Video resolutions */
@@ -364,7 +369,7 @@ export interface VideoMetadata {
364
369
  /** External source's representation for this video's id */
365
370
  externalId?: string | null;
366
371
  }
367
- export declare enum Source {
372
+ declare enum Source {
368
373
  /** Undefined */
369
374
  Undefined = "Undefined",
370
375
  /** Youtube */
@@ -374,7 +379,9 @@ export declare enum Source {
374
379
  /** Custom */
375
380
  Custom = "Custom"
376
381
  }
377
- export interface Thumbnail {
382
+ /** @enumType */
383
+ type SourceWithLiterals = Source | 'Undefined' | 'Youtube' | 'Vimeo' | 'Custom';
384
+ interface Thumbnail {
378
385
  /** Thumbnail url */
379
386
  url?: string | null;
380
387
  /** Thumbnail width */
@@ -386,7 +393,7 @@ export interface Thumbnail {
386
393
  /** The focal point of the image */
387
394
  focalPoint?: Point;
388
395
  }
389
- export interface Resolution {
396
+ interface Resolution {
390
397
  /** eg 720p, 1024p etc */
391
398
  videoMode?: string | null;
392
399
  /** Video width */
@@ -396,7 +403,7 @@ export interface Resolution {
396
403
  /** Map representing the file format (eg mp4) to the url. In case of an external source the format can be youtube, vimeo, etc. */
397
404
  urls?: Record<string, string>;
398
405
  }
399
- export interface TextMetadata {
406
+ interface TextMetadata {
400
407
  /** text data */
401
408
  html?: string | null;
402
409
  /** css style info for container */
@@ -406,7 +413,7 @@ export interface TextMetadata {
406
413
  /** the wix editor's font Id used to display the text data */
407
414
  editorFontId?: string | null;
408
415
  }
409
- export declare enum MediaOwner {
416
+ declare enum MediaOwner {
410
417
  /** Undefined */
411
418
  Undefined = "Undefined",
412
419
  /** Wix */
@@ -416,7 +423,9 @@ export declare enum MediaOwner {
416
423
  /** Custom */
417
424
  Custom = "Custom"
418
425
  }
419
- export declare enum PrivacySettings {
426
+ /** @enumType */
427
+ type MediaOwnerWithLiterals = MediaOwner | 'Undefined' | 'Wix' | 'DeviantArt' | 'Custom';
428
+ declare enum PrivacySettings {
420
429
  /** Undefined */
421
430
  Undefined = "Undefined",
422
431
  /** Public */
@@ -424,154 +433,9 @@ export declare enum PrivacySettings {
424
433
  /** Secret */
425
434
  Secret = "Secret"
426
435
  }
427
- export interface PermanentSiteDeletedResponse {
428
- /** @format GUID */
429
- requestId?: string;
430
- uniqueServiceIdentifier?: string;
431
- status?: Status;
432
- /** @readonly */
433
- _createdDate?: Date | null;
434
- }
435
- export declare enum Status {
436
- UNKNOWN = "UNKNOWN",
437
- HANDLED = "HANDLED",
438
- NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
439
- }
440
- export interface Empty {
441
- }
442
- export interface DomainEvent extends DomainEventBodyOneOf {
443
- createdEvent?: EntityCreatedEvent;
444
- updatedEvent?: EntityUpdatedEvent;
445
- deletedEvent?: EntityDeletedEvent;
446
- actionEvent?: ActionEvent;
447
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
448
- _id?: string;
449
- /**
450
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
451
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
452
- */
453
- entityFqdn?: string;
454
- /**
455
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
456
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
457
- */
458
- slug?: string;
459
- /** ID of the entity associated with the event. */
460
- entityId?: string;
461
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
462
- eventTime?: Date | null;
463
- /**
464
- * Whether the event was triggered as a result of a privacy regulation application
465
- * (for example, GDPR).
466
- */
467
- triggeredByAnonymizeRequest?: boolean | null;
468
- /** If present, indicates the action that triggered the event. */
469
- originatedFrom?: string | null;
470
- /**
471
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
472
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
473
- */
474
- entityEventSequence?: string | null;
475
- }
476
- /** @oneof */
477
- export interface DomainEventBodyOneOf {
478
- createdEvent?: EntityCreatedEvent;
479
- updatedEvent?: EntityUpdatedEvent;
480
- deletedEvent?: EntityDeletedEvent;
481
- actionEvent?: ActionEvent;
482
- }
483
- export interface EntityCreatedEvent {
484
- entity?: string;
485
- }
486
- export interface RestoreInfo {
487
- deletedDate?: Date | null;
488
- }
489
- export interface EntityUpdatedEvent {
490
- /**
491
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
492
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
493
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
494
- */
495
- currentEntity?: string;
496
- }
497
- export interface EntityDeletedEvent {
498
- /** Entity that was deleted. */
499
- deletedEntity?: string | null;
500
- }
501
- export interface ActionEvent {
502
- body?: string;
503
- }
504
- export interface MessageEnvelope {
505
- /**
506
- * App instance ID.
507
- * @format GUID
508
- */
509
- instanceId?: string | null;
510
- /**
511
- * Event type.
512
- * @maxLength 150
513
- */
514
- eventType?: string;
515
- /** The identification type and identity data. */
516
- identity?: IdentificationData;
517
- /** Stringify payload. */
518
- data?: string;
519
- }
520
- export interface IdentificationData extends IdentificationDataIdOneOf {
521
- /**
522
- * ID of a site visitor that has not logged in to the site.
523
- * @format GUID
524
- */
525
- anonymousVisitorId?: string;
526
- /**
527
- * ID of a site visitor that has logged in to the site.
528
- * @format GUID
529
- */
530
- memberId?: string;
531
- /**
532
- * ID of a Wix user (site owner, contributor, etc.).
533
- * @format GUID
534
- */
535
- wixUserId?: string;
536
- /**
537
- * ID of an app.
538
- * @format GUID
539
- */
540
- appId?: string;
541
- /** @readonly */
542
- identityType?: WebhookIdentityType;
543
- }
544
- /** @oneof */
545
- export interface IdentificationDataIdOneOf {
546
- /**
547
- * ID of a site visitor that has not logged in to the site.
548
- * @format GUID
549
- */
550
- anonymousVisitorId?: string;
551
- /**
552
- * ID of a site visitor that has logged in to the site.
553
- * @format GUID
554
- */
555
- memberId?: string;
556
- /**
557
- * ID of a Wix user (site owner, contributor, etc.).
558
- * @format GUID
559
- */
560
- wixUserId?: string;
561
- /**
562
- * ID of an app.
563
- * @format GUID
564
- */
565
- appId?: string;
566
- }
567
- export declare enum WebhookIdentityType {
568
- UNKNOWN = "UNKNOWN",
569
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
570
- MEMBER = "MEMBER",
571
- WIX_USER = "WIX_USER",
572
- APP = "APP"
573
- }
574
- export interface CollectionEvent extends CollectionEventEventTypeOneOf {
436
+ /** @enumType */
437
+ type PrivacySettingsWithLiterals = PrivacySettings | 'Undefined' | 'Public' | 'Secret';
438
+ interface CollectionEvent extends CollectionEventEventTypeOneOf {
575
439
  /** Collection created */
576
440
  collectionCreated?: CollectionCreated;
577
441
  /** Items added to collection */
@@ -584,7 +448,7 @@ export interface CollectionEvent extends CollectionEventEventTypeOneOf {
584
448
  memberLeftCollection?: MemberLeftCollection;
585
449
  }
586
450
  /** @oneof */
587
- export interface CollectionEventEventTypeOneOf {
451
+ interface CollectionEventEventTypeOneOf {
588
452
  /** Collection created */
589
453
  collectionCreated?: CollectionCreated;
590
454
  /** Items added to collection */
@@ -596,7 +460,7 @@ export interface CollectionEventEventTypeOneOf {
596
460
  /** Member left collection */
597
461
  memberLeftCollection?: MemberLeftCollection;
598
462
  }
599
- export interface CollectionItemId {
463
+ interface CollectionItemId {
600
464
  /**
601
465
  * Id of the gallery in ProGallery
602
466
  * @format GUID
@@ -608,7 +472,7 @@ export interface CollectionItemId {
608
472
  */
609
473
  itemId?: string;
610
474
  }
611
- export interface CollectionCreated {
475
+ interface CollectionCreated {
612
476
  /**
613
477
  * Collection id
614
478
  * @format GUID
@@ -632,9 +496,9 @@ export interface CollectionCreated {
632
496
  /** When the collection was created */
633
497
  _createdDate?: Date | null;
634
498
  /** Privacy settings */
635
- privacySettings?: PrivacySettings;
499
+ privacySettings?: PrivacySettingsWithLiterals;
636
500
  }
637
- export interface ItemsAddedToCollection {
501
+ interface ItemsAddedToCollection {
638
502
  /**
639
503
  * Id of the collection
640
504
  * @format GUID
@@ -650,7 +514,7 @@ export interface ItemsAddedToCollection {
650
514
  /** When the items were added */
651
515
  addedDate?: Date | null;
652
516
  }
653
- export interface ItemsRemovedFromCollection {
517
+ interface ItemsRemovedFromCollection {
654
518
  /**
655
519
  * Id of the collection
656
520
  * @format GUID
@@ -669,7 +533,7 @@ export interface ItemsRemovedFromCollection {
669
533
  /** When the items were removed */
670
534
  removedDate?: Date | null;
671
535
  }
672
- export interface MemberJoinedToCollection {
536
+ interface MemberJoinedToCollection {
673
537
  /**
674
538
  * Id of the collection
675
539
  * @format GUID
@@ -683,7 +547,7 @@ export interface MemberJoinedToCollection {
683
547
  /** When the member was joined */
684
548
  joinedDate?: Date | null;
685
549
  }
686
- export interface MemberLeftCollection {
550
+ interface MemberLeftCollection {
687
551
  /**
688
552
  * Id of the collection
689
553
  * @format GUID
@@ -697,7 +561,71 @@ export interface MemberLeftCollection {
697
561
  /** When the member left */
698
562
  leftDate?: Date | null;
699
563
  }
700
- export interface GetMediaCollectionRequest {
564
+ interface DomainEvent extends DomainEventBodyOneOf {
565
+ createdEvent?: EntityCreatedEvent;
566
+ updatedEvent?: EntityUpdatedEvent;
567
+ deletedEvent?: EntityDeletedEvent;
568
+ actionEvent?: ActionEvent;
569
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
570
+ _id?: string;
571
+ /**
572
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
573
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
574
+ */
575
+ entityFqdn?: string;
576
+ /**
577
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
578
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
579
+ */
580
+ slug?: string;
581
+ /** ID of the entity associated with the event. */
582
+ entityId?: string;
583
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
584
+ eventTime?: Date | null;
585
+ /**
586
+ * Whether the event was triggered as a result of a privacy regulation application
587
+ * (for example, GDPR).
588
+ */
589
+ triggeredByAnonymizeRequest?: boolean | null;
590
+ /** If present, indicates the action that triggered the event. */
591
+ originatedFrom?: string | null;
592
+ /**
593
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
594
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
595
+ */
596
+ entityEventSequence?: string | null;
597
+ }
598
+ /** @oneof */
599
+ interface DomainEventBodyOneOf {
600
+ createdEvent?: EntityCreatedEvent;
601
+ updatedEvent?: EntityUpdatedEvent;
602
+ deletedEvent?: EntityDeletedEvent;
603
+ actionEvent?: ActionEvent;
604
+ }
605
+ interface EntityCreatedEvent {
606
+ entity?: string;
607
+ }
608
+ interface RestoreInfo {
609
+ deletedDate?: Date | null;
610
+ }
611
+ interface EntityUpdatedEvent {
612
+ /**
613
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
614
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
615
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
616
+ */
617
+ currentEntity?: string;
618
+ }
619
+ interface EntityDeletedEvent {
620
+ /** Entity that was deleted. */
621
+ deletedEntity?: string | null;
622
+ }
623
+ interface ActionEvent {
624
+ body?: string;
625
+ }
626
+ interface Empty {
627
+ }
628
+ interface GetMediaCollectionRequest {
701
629
  /**
702
630
  * Collection id
703
631
  * @format GUID
@@ -712,13 +640,13 @@ export interface GetMediaCollectionRequest {
712
640
  */
713
641
  limit?: number | null;
714
642
  }
715
- export interface GetMediaCollectionResponse {
643
+ interface GetMediaCollectionResponse {
716
644
  /** The collection */
717
645
  mediaCollection?: MediaCollection;
718
646
  /** The member's status in the collection */
719
- memberStatus?: MemberStatus;
647
+ memberStatus?: MemberStatusWithLiterals;
720
648
  }
721
- export declare enum MemberStatus {
649
+ declare enum MemberStatus {
722
650
  /** Undefined */
723
651
  UNDEFINED = "UNDEFINED",
724
652
  /** Not a member */
@@ -728,7 +656,9 @@ export declare enum MemberStatus {
728
656
  /** Admin */
729
657
  ADMIN = "ADMIN"
730
658
  }
731
- export interface ListCollectionsForItemRequest {
659
+ /** @enumType */
660
+ type MemberStatusWithLiterals = MemberStatus | 'UNDEFINED' | 'NOT_MEMBER' | 'MEMBER' | 'ADMIN';
661
+ interface ListCollectionsForItemRequest {
732
662
  /**
733
663
  * Gallery id
734
664
  * @format GUID
@@ -740,11 +670,11 @@ export interface ListCollectionsForItemRequest {
740
670
  */
741
671
  itemId: string;
742
672
  }
743
- export interface ListCollectionsForItemResponse {
673
+ interface ListCollectionsForItemResponse {
744
674
  /** The collections that the item belongs to */
745
675
  itemInCollections?: ItemInCollection[];
746
676
  }
747
- export interface ItemInCollection {
677
+ interface ItemInCollection {
748
678
  /**
749
679
  * Collection id
750
680
  * @format GUID
@@ -761,7 +691,7 @@ export interface ItemInCollection {
761
691
  /** Is the collection locked */
762
692
  isLocked?: boolean;
763
693
  /** Member's role in the collection */
764
- role?: MemberStatus;
694
+ role?: MemberStatusWithLiterals;
765
695
  /** Total count of items in the collection */
766
696
  totalItemsCount?: number | null;
767
697
  /** The first item in the collection */
@@ -772,7 +702,7 @@ export interface ItemInCollection {
772
702
  */
773
703
  creatorNickname?: string | null;
774
704
  }
775
- export interface GetCollectionItemRequest {
705
+ interface GetCollectionItemRequest {
776
706
  /**
777
707
  * Collection id
778
708
  * @format GUID
@@ -784,11 +714,11 @@ export interface GetCollectionItemRequest {
784
714
  */
785
715
  itemId: string;
786
716
  }
787
- export interface GetCollectionItemResponse {
717
+ interface GetCollectionItemResponse {
788
718
  /** The item */
789
719
  item?: MediaCollectionItem;
790
720
  }
791
- export interface ListMediaCollectionsRequest {
721
+ interface ListMediaCollectionsRequest {
792
722
  /**
793
723
  * the amount of collections per response, default is 1000
794
724
  * @min 1
@@ -803,10 +733,10 @@ export interface ListMediaCollectionsRequest {
803
733
  */
804
734
  filterByRoles?: FilterByRoles;
805
735
  }
806
- export interface FilterByRoles {
807
- roles?: MemberStatus[];
736
+ interface FilterByRoles {
737
+ roles?: MemberStatusWithLiterals[];
808
738
  }
809
- export interface ListMediaCollectionsResponse {
739
+ interface ListMediaCollectionsResponse {
810
740
  /** The collections and the member's role in them */
811
741
  collectionsStatus?: CollectionAndStatus[];
812
742
  /**
@@ -815,13 +745,13 @@ export interface ListMediaCollectionsResponse {
815
745
  */
816
746
  totalCollectionsCount?: number | null;
817
747
  }
818
- export interface CollectionAndStatus {
748
+ interface CollectionAndStatus {
819
749
  /** The Media Collection */
820
750
  mediaCollection?: MediaCollection;
821
751
  /** The member's status in the collection */
822
- memberStatus?: MemberStatus;
752
+ memberStatus?: MemberStatusWithLiterals;
823
753
  }
824
- export interface CreateMediaCollectionRequest {
754
+ interface CreateMediaCollectionRequest {
825
755
  /**
826
756
  * Name of the collection
827
757
  * @minLength 1
@@ -834,11 +764,11 @@ export interface CreateMediaCollectionRequest {
834
764
  */
835
765
  description?: string | null;
836
766
  /** Privacy settings of the collection */
837
- privacySettings?: PrivacySettings;
767
+ privacySettings?: PrivacySettingsWithLiterals;
838
768
  /** Items to add to the collection */
839
769
  items?: AddItem[];
840
770
  }
841
- export interface AddItem {
771
+ interface AddItem {
842
772
  /**
843
773
  * Gallery id
844
774
  * @format GUID
@@ -852,14 +782,14 @@ export interface AddItem {
852
782
  /** Order index of the item */
853
783
  orderIndex?: number | null;
854
784
  }
855
- export interface CreateMediaCollectionResponse {
785
+ interface CreateMediaCollectionResponse {
856
786
  /**
857
787
  * id of the collection that was created
858
788
  * @format GUID
859
789
  */
860
790
  mediaCollectionId?: string;
861
791
  }
862
- export interface PartiallyUpdateMediaCollectionRequest {
792
+ interface PartiallyUpdateMediaCollectionRequest {
863
793
  /** Collection to update */
864
794
  mediaCollection: MediaCollection;
865
795
  /**
@@ -868,9 +798,9 @@ export interface PartiallyUpdateMediaCollectionRequest {
868
798
  */
869
799
  fieldMask: string[];
870
800
  }
871
- export interface PartiallyUpdateMediaCollectionResponse {
801
+ interface PartiallyUpdateMediaCollectionResponse {
872
802
  }
873
- export interface UpdateCollectionLockRequest {
803
+ interface UpdateCollectionLockRequest {
874
804
  /**
875
805
  * Collection to lock
876
806
  * @format GUID
@@ -879,18 +809,18 @@ export interface UpdateCollectionLockRequest {
879
809
  /** Lock status */
880
810
  locked?: boolean;
881
811
  }
882
- export interface UpdateCollectionLockResponse {
812
+ interface UpdateCollectionLockResponse {
883
813
  }
884
- export interface DeleteMediaCollectionRequest {
814
+ interface DeleteMediaCollectionRequest {
885
815
  /**
886
816
  * the collection to delete
887
817
  * @format GUID
888
818
  */
889
819
  mediaCollectionId: string;
890
820
  }
891
- export interface DeleteMediaCollectionResponse {
821
+ interface DeleteMediaCollectionResponse {
892
822
  }
893
- export interface ListCollectionMembersRequest {
823
+ interface ListCollectionMembersRequest {
894
824
  /**
895
825
  * the collection to get its members
896
826
  * @format GUID
@@ -899,21 +829,21 @@ export interface ListCollectionMembersRequest {
899
829
  /** Filter the members by their role in the collection */
900
830
  filterBy?: FilterBy;
901
831
  }
902
- export interface FilterBy {
832
+ interface FilterBy {
903
833
  /** Member's status in the collection */
904
- memberStatus?: MemberStatus;
834
+ memberStatus?: MemberStatusWithLiterals;
905
835
  }
906
- export interface ListCollectionMembersResponse {
836
+ interface ListCollectionMembersResponse {
907
837
  /** The collection's members and their roles */
908
838
  membersRoles?: MemberAndStatus[];
909
839
  }
910
- export interface MemberAndStatus {
840
+ interface MemberAndStatus {
911
841
  /** The member */
912
842
  member?: CollectionMember;
913
843
  /** The member's role in the collection */
914
- memberStatus?: MemberStatus;
844
+ memberStatus?: MemberStatusWithLiterals;
915
845
  }
916
- export interface AddItemsRequest {
846
+ interface AddItemsRequest {
917
847
  /**
918
848
  * Collection to add items
919
849
  * @format GUID
@@ -922,9 +852,9 @@ export interface AddItemsRequest {
922
852
  /** Items to add */
923
853
  items?: AddItem[];
924
854
  }
925
- export interface AddItemsResponse {
855
+ interface AddItemsResponse {
926
856
  }
927
- export interface RemoveItemsRequest {
857
+ interface RemoveItemsRequest {
928
858
  /**
929
859
  * Collection to remove items from
930
860
  * @format GUID
@@ -936,9 +866,9 @@ export interface RemoveItemsRequest {
936
866
  */
937
867
  itemsIds?: string[];
938
868
  }
939
- export interface RemoveItemsResponse {
869
+ interface RemoveItemsResponse {
940
870
  }
941
- export interface UpdateItemsRequest {
871
+ interface UpdateItemsRequest {
942
872
  /**
943
873
  * Collection to update items
944
874
  * @format GUID
@@ -946,7 +876,7 @@ export interface UpdateItemsRequest {
946
876
  mediaCollectionId?: string;
947
877
  items?: UpdateItem[];
948
878
  }
949
- export interface UpdateItem {
879
+ interface UpdateItem {
950
880
  /**
951
881
  * Item to update
952
882
  * @format GUID
@@ -955,18 +885,18 @@ export interface UpdateItem {
955
885
  /** New order index of the item */
956
886
  orderIndex?: number;
957
887
  }
958
- export interface UpdateItemsResponse {
888
+ interface UpdateItemsResponse {
959
889
  }
960
- export interface JoinToCollectionRequest {
890
+ interface JoinToCollectionRequest {
961
891
  /**
962
892
  * Collection to join
963
893
  * @format GUID
964
894
  */
965
895
  mediaCollectionId: string;
966
896
  }
967
- export interface JoinToCollectionResponse {
897
+ interface JoinToCollectionResponse {
968
898
  }
969
- export interface RemoveMemberFromCollectionRequest {
899
+ interface RemoveMemberFromCollectionRequest {
970
900
  /**
971
901
  * Collection the member will be removed from being a member
972
902
  * @format GUID
@@ -978,29 +908,29 @@ export interface RemoveMemberFromCollectionRequest {
978
908
  */
979
909
  memberId?: string;
980
910
  }
981
- export interface RemoveMemberFromCollectionResponse {
911
+ interface RemoveMemberFromCollectionResponse {
982
912
  }
983
- export interface LeaveCollectionRequest {
913
+ interface LeaveCollectionRequest {
984
914
  /**
985
915
  * Collection the member will be leaving
986
916
  * @format GUID
987
917
  */
988
918
  mediaCollectionId: string;
989
919
  }
990
- export interface LeaveCollectionResponse {
920
+ interface LeaveCollectionResponse {
991
921
  }
992
- export interface ListCollectionItemsRequest {
922
+ interface ListCollectionItemsRequest {
993
923
  /**
994
924
  * Collection to get its items
995
925
  * @format GUID
996
926
  */
997
927
  mediaCollectionId: string;
998
928
  }
999
- export interface ListCollectionItemsResponse {
929
+ interface ListCollectionItemsResponse {
1000
930
  /** The collection's items */
1001
931
  collectionItems?: CollectionItem[];
1002
932
  }
1003
- export interface CollectionItem {
933
+ interface CollectionItem {
1004
934
  /**
1005
935
  * Gallery id
1006
936
  * @format GUID
@@ -1016,16 +946,16 @@ export interface CollectionItem {
1016
946
  /** Date the item was added to the collection */
1017
947
  addedDate?: Date | null;
1018
948
  }
1019
- export interface ListAllItemsBelongToCollectionRequest {
949
+ interface ListAllItemsBelongToCollectionRequest {
1020
950
  }
1021
- export interface ListAllItemsBelongToCollectionResponse {
951
+ interface ListAllItemsBelongToCollectionResponse {
1022
952
  /**
1023
953
  * List of the item ids that belong to one or more collection
1024
954
  * @format GUID
1025
955
  */
1026
956
  itemIds?: string[];
1027
957
  }
1028
- export interface BaseEventMetadata {
958
+ interface MessageEnvelope {
1029
959
  /**
1030
960
  * App instance ID.
1031
961
  * @format GUID
@@ -1038,8 +968,95 @@ export interface BaseEventMetadata {
1038
968
  eventType?: string;
1039
969
  /** The identification type and identity data. */
1040
970
  identity?: IdentificationData;
971
+ /** Stringify payload. */
972
+ data?: string;
973
+ }
974
+ interface IdentificationData extends IdentificationDataIdOneOf {
975
+ /**
976
+ * ID of a site visitor that has not logged in to the site.
977
+ * @format GUID
978
+ */
979
+ anonymousVisitorId?: string;
980
+ /**
981
+ * ID of a site visitor that has logged in to the site.
982
+ * @format GUID
983
+ */
984
+ memberId?: string;
985
+ /**
986
+ * ID of a Wix user (site owner, contributor, etc.).
987
+ * @format GUID
988
+ */
989
+ wixUserId?: string;
990
+ /**
991
+ * ID of an app.
992
+ * @format GUID
993
+ */
994
+ appId?: string;
995
+ /** @readonly */
996
+ identityType?: WebhookIdentityTypeWithLiterals;
1041
997
  }
1042
- export interface EventMetadata extends BaseEventMetadata {
998
+ /** @oneof */
999
+ interface IdentificationDataIdOneOf {
1000
+ /**
1001
+ * ID of a site visitor that has not logged in to the site.
1002
+ * @format GUID
1003
+ */
1004
+ anonymousVisitorId?: string;
1005
+ /**
1006
+ * ID of a site visitor that has logged in to the site.
1007
+ * @format GUID
1008
+ */
1009
+ memberId?: string;
1010
+ /**
1011
+ * ID of a Wix user (site owner, contributor, etc.).
1012
+ * @format GUID
1013
+ */
1014
+ wixUserId?: string;
1015
+ /**
1016
+ * ID of an app.
1017
+ * @format GUID
1018
+ */
1019
+ appId?: string;
1020
+ }
1021
+ declare enum WebhookIdentityType {
1022
+ UNKNOWN = "UNKNOWN",
1023
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1024
+ MEMBER = "MEMBER",
1025
+ WIX_USER = "WIX_USER",
1026
+ APP = "APP"
1027
+ }
1028
+ /** @enumType */
1029
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1030
+ interface PermanentSiteDeletedResponse {
1031
+ /** @format GUID */
1032
+ requestId?: string;
1033
+ uniqueServiceIdentifier?: string;
1034
+ status?: StatusWithLiterals;
1035
+ /** @readonly */
1036
+ _createdDate?: Date | null;
1037
+ }
1038
+ declare enum Status {
1039
+ UNKNOWN = "UNKNOWN",
1040
+ HANDLED = "HANDLED",
1041
+ NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
1042
+ }
1043
+ /** @enumType */
1044
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'HANDLED' | 'NOTHING_TO_HANDLE';
1045
+ interface BaseEventMetadata {
1046
+ /**
1047
+ * App instance ID.
1048
+ * @format GUID
1049
+ */
1050
+ instanceId?: string | null;
1051
+ /**
1052
+ * Event type.
1053
+ * @maxLength 150
1054
+ */
1055
+ eventType?: string;
1056
+ /** The identification type and identity data. */
1057
+ identity?: IdentificationData;
1058
+ }
1059
+ interface EventMetadata extends BaseEventMetadata {
1043
1060
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1044
1061
  _id?: string;
1045
1062
  /**
@@ -1069,29 +1086,11 @@ export interface EventMetadata extends BaseEventMetadata {
1069
1086
  */
1070
1087
  entityEventSequence?: string | null;
1071
1088
  }
1072
- export interface CollectionCreatedEnvelope {
1089
+ interface CollectionCreatedEnvelope {
1073
1090
  entity: MediaCollection;
1074
1091
  metadata: EventMetadata;
1075
1092
  }
1076
- /** @webhook
1077
- * @eventType wix.collections.collection_created
1078
- * @serviceIdentifier com.wixpress.exposure.mediacollections.MediaCollectionsService
1079
- * @slug created
1080
- * @documentationMaturity preview
1081
- */
1082
- export declare function onCollectionCreated(handler: (event: CollectionCreatedEnvelope) => void | Promise<void>): void;
1083
- type CollectionNonNullablePaths = `_id` | `name` | `membersCount` | `creator.memberId` | `items` | `items.${number}.photoMetadata.focalPoint.x` | `items.${number}.photoMetadata.focalPoint.y` | `items.${number}.videoMetadata.source` | `items.${number}.link.type` | `items.${number}.link.wixLinkData.external.url` | `items.${number}.link.wixLinkData.page.pageId` | `items.${number}.link.wixLinkData.anchor.anchorName` | `items.${number}.link.wixLinkData.anchor.anchorDataId` | `items.${number}.link.wixLinkData.anchor.pageId` | `items.${number}.link.wixLinkData.dynamicPage.routerId` | `items.${number}.link.wixLinkData.dynamicPage.innerRoute` | `items.${number}.link.wixLinkData.document.docId` | `items.${number}.link.wixLinkData.document.indexable` | `items.${number}.link.wixLinkData.email.recipient` | `items.${number}.link.wixLinkData.phone.phoneNumber` | `items.${number}.link.wixLinkData.address.address` | `items.${number}.link.wixLinkData.whatsApp.phoneNumber` | `items.${number}.link.wixLinkData.tpaPage.itemTypeIdentifier` | `items.${number}.link.wixLinkData.tpaPage.itemId` | `items.${number}.link.wixLinkData.tpaPage.pageId` | `items.${number}.link.wixLinkData.tpaPage.appDefinitionId` | `items.${number}.link.wixLinkData.tpaPage.path` | `items.${number}.dataType` | `items.${number}.mediaOwner` | `items.${number}.galleryId` | `itemsCount` | `privacySettings` | `locked`;
1084
- /**
1085
- * Get a specific collection by its id
1086
- * @param mediaCollectionId - Collection id
1087
- * @public
1088
- * @documentationMaturity preview
1089
- * @requiredField mediaCollectionId
1090
- * @returns The collection
1091
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.Get
1092
- */
1093
- export declare function get(mediaCollectionId: string, options?: GetOptions): Promise<NonNullablePaths<MediaCollection, CollectionNonNullablePaths>>;
1094
- export interface GetOptions {
1093
+ interface GetOptions {
1095
1094
  /** number of items to skip in the current sort order, default is 0 */
1096
1095
  offset?: number | null;
1097
1096
  /**
@@ -1101,33 +1100,14 @@ export interface GetOptions {
1101
1100
  */
1102
1101
  limit?: number | null;
1103
1102
  }
1104
- /**
1105
- * List all collections that the member has a role in them
1106
- * @param itemId - Item id
1107
- * @public
1108
- * @documentationMaturity preview
1109
- * @requiredField itemId
1110
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionsForItem
1111
- */
1112
- export declare function listCollectionsForItem(itemId: string, options?: ListCollectionsForItemOptions): Promise<NonNullablePaths<ListCollectionsForItemResponse, `itemInCollections` | `itemInCollections.${number}.mediaCollectionId` | `itemInCollections.${number}.name` | `itemInCollections.${number}.isItemInCollection` | `itemInCollections.${number}.isLocked` | `itemInCollections.${number}.role` | `itemInCollections.${number}.firstItem.photoMetadata.focalPoint.x` | `itemInCollections.${number}.firstItem.photoMetadata.focalPoint.y` | `itemInCollections.${number}.firstItem.videoMetadata.source` | `itemInCollections.${number}.firstItem.link.type` | `itemInCollections.${number}.firstItem.link.wixLinkData.external.url` | `itemInCollections.${number}.firstItem.link.wixLinkData.page.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.anchorName` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.anchorDataId` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.dynamicPage.routerId` | `itemInCollections.${number}.firstItem.link.wixLinkData.dynamicPage.innerRoute` | `itemInCollections.${number}.firstItem.link.wixLinkData.document.docId` | `itemInCollections.${number}.firstItem.link.wixLinkData.document.indexable` | `itemInCollections.${number}.firstItem.link.wixLinkData.email.recipient` | `itemInCollections.${number}.firstItem.link.wixLinkData.phone.phoneNumber` | `itemInCollections.${number}.firstItem.link.wixLinkData.address.address` | `itemInCollections.${number}.firstItem.link.wixLinkData.whatsApp.phoneNumber` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.itemTypeIdentifier` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.itemId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.appDefinitionId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.path` | `itemInCollections.${number}.firstItem.dataType` | `itemInCollections.${number}.firstItem.mediaOwner` | `itemInCollections.${number}.firstItem.galleryId`>>;
1113
- export interface ListCollectionsForItemOptions {
1103
+ interface ListCollectionsForItemOptions {
1114
1104
  /**
1115
1105
  * Gallery id
1116
1106
  * @format GUID
1117
1107
  */
1118
1108
  galleryId?: string;
1119
1109
  }
1120
- /**
1121
- * Get a specific item from a collection
1122
- * @public
1123
- * @documentationMaturity preview
1124
- * @requiredField identifiers
1125
- * @requiredField identifiers.itemId
1126
- * @requiredField identifiers.mediaCollectionId
1127
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.GetCollectionItem
1128
- */
1129
- export declare function getCollectionItem(identifiers: NonNullablePaths<GetCollectionItemIdentifiers, `itemId` | `mediaCollectionId`>): Promise<NonNullablePaths<GetCollectionItemResponse, `item.photoMetadata.focalPoint.x` | `item.photoMetadata.focalPoint.y` | `item.videoMetadata.source` | `item.videoMetadata.posters` | `item.videoMetadata.resolutions` | `item.link.type` | `item.link.wixLinkData.external.url` | `item.link.wixLinkData.page.pageId` | `item.link.wixLinkData.page.rel` | `item.link.wixLinkData.anchor.anchorName` | `item.link.wixLinkData.anchor.anchorDataId` | `item.link.wixLinkData.anchor.pageId` | `item.link.wixLinkData.anchor.rel` | `item.link.wixLinkData.dynamicPage.routerId` | `item.link.wixLinkData.dynamicPage.innerRoute` | `item.link.wixLinkData.dynamicPage.rel` | `item.link.wixLinkData.document.docId` | `item.link.wixLinkData.document.indexable` | `item.link.wixLinkData.email.recipient` | `item.link.wixLinkData.phone.phoneNumber` | `item.link.wixLinkData.address.address` | `item.link.wixLinkData.whatsApp.phoneNumber` | `item.link.wixLinkData.tpaPage.itemTypeIdentifier` | `item.link.wixLinkData.tpaPage.itemId` | `item.link.wixLinkData.tpaPage.pageId` | `item.link.wixLinkData.tpaPage.appDefinitionId` | `item.link.wixLinkData.tpaPage.path` | `item.link.wixLinkData.tpaPage.rel` | `item.dataType` | `item.mediaOwner` | `item.tags` | `item.galleryId`>>;
1130
- export interface GetCollectionItemIdentifiers {
1110
+ interface GetCollectionItemIdentifiers {
1131
1111
  /**
1132
1112
  * Collection id
1133
1113
  * @format GUID
@@ -1139,16 +1119,7 @@ export interface GetCollectionItemIdentifiers {
1139
1119
  */
1140
1120
  itemId: string;
1141
1121
  }
1142
- /**
1143
- * List all collections that the item belongs to
1144
- * @public
1145
- * @documentationMaturity preview
1146
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.List
1147
- */
1148
- export declare function list(options?: ListOptions): Promise<NonNullablePaths<ListMediaCollectionsResponse, `collectionsStatus` | {
1149
- [P in CollectionNonNullablePaths]: `collectionsStatus.${number}.mediaCollection.${P}`;
1150
- }[CollectionNonNullablePaths] | `collectionsStatus.${number}.memberStatus`>>;
1151
- export interface ListOptions {
1122
+ interface ListOptions {
1152
1123
  /**
1153
1124
  * the amount of collections per response, default is 1000
1154
1125
  * @min 1
@@ -1163,39 +1134,18 @@ export interface ListOptions {
1163
1134
  */
1164
1135
  filterByRoles?: FilterByRoles;
1165
1136
  }
1166
- /**
1167
- * Create a new collection
1168
- * @param name - Name of the collection
1169
- * @public
1170
- * @documentationMaturity preview
1171
- * @requiredField name
1172
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.Create
1173
- */
1174
- export declare function create(name: string, options?: CreateOptions): Promise<NonNullablePaths<CreateMediaCollectionResponse, `mediaCollectionId`>>;
1175
- export interface CreateOptions {
1137
+ interface CreateOptions {
1176
1138
  /**
1177
1139
  * Description of the collection
1178
1140
  * @maxLength 500
1179
1141
  */
1180
1142
  description?: string | null;
1181
1143
  /** Privacy settings of the collection */
1182
- privacySettings?: PrivacySettings;
1144
+ privacySettings?: PrivacySettingsWithLiterals;
1183
1145
  /** Items to add to the collection */
1184
1146
  items?: AddItem[];
1185
1147
  }
1186
- /**
1187
- * Update a collection
1188
- * @param _id - Collection id
1189
- * @public
1190
- * @documentationMaturity preview
1191
- * @requiredField _id
1192
- * @requiredField mediaCollection
1193
- * @requiredField options
1194
- * @requiredField options.fieldMask
1195
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.PartiallyUpdate
1196
- */
1197
- export declare function partiallyUpdate(_id: string, mediaCollection: PartiallyUpdateMediaCollection, options: NonNullablePaths<PartiallyUpdateOptions, `fieldMask`>): Promise<void>;
1198
- export interface PartiallyUpdateMediaCollection {
1148
+ interface PartiallyUpdateMediaCollection {
1199
1149
  /**
1200
1150
  * Collection id
1201
1151
  * @readonly
@@ -1232,89 +1182,31 @@ export interface PartiallyUpdateMediaCollection {
1232
1182
  */
1233
1183
  itemsCount?: number;
1234
1184
  /** Privacy settings */
1235
- privacySettings?: PrivacySettings;
1185
+ privacySettings?: PrivacySettingsWithLiterals;
1236
1186
  /** If true, the collection is locked and should not be updated */
1237
1187
  locked?: boolean;
1238
1188
  }
1239
- export interface PartiallyUpdateOptions {
1189
+ interface PartiallyUpdateOptions {
1240
1190
  /**
1241
1191
  * fields to update
1242
1192
  * supported fields: name, description, privacy_settings
1243
1193
  */
1244
1194
  fieldMask: string[];
1245
1195
  }
1246
- /**
1247
- * Delete a collection
1248
- * @param mediaCollectionId - the collection to delete
1249
- * @public
1250
- * @documentationMaturity preview
1251
- * @requiredField mediaCollectionId
1252
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService._delete
1253
- */
1254
- export declare function _delete(mediaCollectionId: string): Promise<void>;
1255
- /**
1256
- * List all members of a collection
1257
- * @param mediaCollectionId - the collection to get its members
1258
- * @public
1259
- * @documentationMaturity preview
1260
- * @requiredField mediaCollectionId
1261
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionMembers
1262
- */
1263
- export declare function listCollectionMembers(mediaCollectionId: string, options?: ListCollectionMembersOptions): Promise<NonNullablePaths<ListCollectionMembersResponse, `membersRoles` | `membersRoles.${number}.member.memberId` | `membersRoles.${number}.memberStatus`>>;
1264
- export interface ListCollectionMembersOptions {
1196
+ interface ListCollectionMembersOptions {
1265
1197
  /** Filter the members by their role in the collection */
1266
1198
  filterBy?: FilterBy;
1267
1199
  }
1268
- /**
1269
- * Add items to a collection
1270
- * @param mediaCollectionId - Collection to add items
1271
- * @public
1272
- * @documentationMaturity preview
1273
- * @requiredField mediaCollectionId
1274
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.AddItems
1275
- */
1276
- export declare function addItems(mediaCollectionId: string, options?: AddItemsOptions): Promise<void>;
1277
- export interface AddItemsOptions {
1200
+ interface AddItemsOptions {
1278
1201
  /** Items to add */
1279
1202
  items?: AddItem[];
1280
1203
  }
1281
- /**
1282
- * Remove items from a collection
1283
- * @param mediaCollectionId - Collection to remove items from
1284
- * @public
1285
- * @documentationMaturity preview
1286
- * @requiredField mediaCollectionId
1287
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.RemoveItems
1288
- */
1289
- export declare function removeItems(mediaCollectionId: string, options?: RemoveItemsOptions): Promise<void>;
1290
- export interface RemoveItemsOptions {
1204
+ interface RemoveItemsOptions {
1291
1205
  /**
1292
1206
  * Items to remove
1293
1207
  * @format GUID
1294
1208
  */
1295
1209
  itemsIds?: string[];
1296
1210
  }
1297
- /**
1298
- * Join to a collection
1299
- * @param mediaCollectionId - Collection to join
1300
- * @public
1301
- * @documentationMaturity preview
1302
- * @requiredField mediaCollectionId
1303
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.JoinToCollection
1304
- */
1305
- export declare function joinToCollection(mediaCollectionId: string): Promise<void>;
1306
- /** @param mediaCollectionId - Collection the member will be leaving
1307
- * @public
1308
- * @documentationMaturity preview
1309
- * @requiredField mediaCollectionId
1310
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.LeaveCollection
1311
- */
1312
- export declare function leaveCollection(mediaCollectionId: string): Promise<void>;
1313
- /** @param mediaCollectionId - Collection to get its items
1314
- * @public
1315
- * @documentationMaturity preview
1316
- * @requiredField mediaCollectionId
1317
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionItems
1318
- */
1319
- export declare function listCollectionItems(mediaCollectionId: string): Promise<NonNullablePaths<ListCollectionItemsResponse, `collectionItems` | `collectionItems.${number}.galleryId` | `collectionItems.${number}.itemId`>>;
1320
- export {};
1211
+
1212
+ export { type CollectionCreated as $, type AddItemsOptions as A, type EmailLink as B, type CreateOptions as C, DataType as D, type ExternalLink as E, type PhoneLink as F, type GetOptions as G, type AddressLink as H, type WhatsAppLink as I, type TpaPageLink as J, type PhotoMetadata as K, type ListCollectionsForItemOptions as L, type MediaCollection as M, type Point as N, type Thumbnail as O, type PartiallyUpdateMediaCollection as P, type Resolution as Q, type RemoveItemsOptions as R, Source as S, Type as T, type UnsharpMasking as U, type VideoMetadata as V, WebhookIdentityType as W, type TextMetadata as X, type CollectionEvent as Y, type CollectionEventEventTypeOneOf as Z, type CollectionItemId as _, type ListCollectionsForItemResponse as a, type ItemsAddedToCollection as a0, type ItemsRemovedFromCollection as a1, type MemberJoinedToCollection as a2, type MemberLeftCollection as a3, type DomainEvent as a4, type DomainEventBodyOneOf as a5, type EntityCreatedEvent as a6, type RestoreInfo as a7, type EntityUpdatedEvent as a8, type EntityDeletedEvent as a9, type UpdateItem as aA, type UpdateItemsResponse as aB, type JoinToCollectionRequest as aC, type JoinToCollectionResponse as aD, type RemoveMemberFromCollectionRequest as aE, type RemoveMemberFromCollectionResponse as aF, type LeaveCollectionRequest as aG, type LeaveCollectionResponse as aH, type ListCollectionItemsRequest as aI, type CollectionItem as aJ, type ListAllItemsBelongToCollectionRequest as aK, type ListAllItemsBelongToCollectionResponse as aL, type MessageEnvelope as aM, type IdentificationData as aN, type IdentificationDataIdOneOf as aO, type PermanentSiteDeletedResponse as aP, type BaseEventMetadata as aQ, type EventMetadata as aR, type ActionEvent as aa, type Empty as ab, type GetMediaCollectionRequest as ac, type GetMediaCollectionResponse as ad, type ListCollectionsForItemRequest as ae, type ItemInCollection as af, type GetCollectionItemRequest as ag, type ListMediaCollectionsRequest as ah, type FilterByRoles as ai, type CollectionAndStatus as aj, type CreateMediaCollectionRequest as ak, type AddItem as al, type PartiallyUpdateMediaCollectionRequest as am, type PartiallyUpdateMediaCollectionResponse as an, type UpdateCollectionLockRequest as ao, type UpdateCollectionLockResponse as ap, type DeleteMediaCollectionRequest as aq, type DeleteMediaCollectionResponse as ar, type ListCollectionMembersRequest as as, type FilterBy as at, type MemberAndStatus as au, type AddItemsRequest as av, type AddItemsResponse as aw, type RemoveItemsRequest as ax, type RemoveItemsResponse as ay, type UpdateItemsRequest as az, type GetCollectionItemIdentifiers as b, type GetCollectionItemResponse as c, type ListOptions as d, type ListMediaCollectionsResponse as e, type CreateMediaCollectionResponse as f, type PartiallyUpdateOptions as g, type ListCollectionMembersOptions as h, type ListCollectionMembersResponse as i, type ListCollectionItemsResponse as j, type CollectionCreatedEnvelope as k, LinkRel as l, MediaOwner as m, PrivacySettings as n, MemberStatus as o, Status as p, type CollectionMember as q, type MediaCollectionItem as r, type MediaCollectionItemMetadataOneOf as s, type Link as t, type WixLink as u, type WixLinkLinkOneOf as v, type PageLink as w, type AnchorLink as x, type DynamicPageLink as y, type DocumentLink as z };