@wix/auto_sdk_media-collections_media-collections 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/collections-v1-collection-media-collections.context.d.ts +21 -0
  11. package/build/cjs/src/collections-v1-collection-media-collections.context.js +33 -0
  12. package/build/cjs/src/collections-v1-collection-media-collections.context.js.map +1 -0
  13. package/build/cjs/src/collections-v1-collection-media-collections.http.d.ts +25 -0
  14. package/build/cjs/src/collections-v1-collection-media-collections.http.js +490 -0
  15. package/build/cjs/src/collections-v1-collection-media-collections.http.js.map +1 -0
  16. package/build/cjs/src/collections-v1-collection-media-collections.meta.d.ts +48 -0
  17. package/build/cjs/src/collections-v1-collection-media-collections.meta.js +278 -0
  18. package/build/cjs/src/collections-v1-collection-media-collections.meta.js.map +1 -0
  19. package/build/cjs/src/collections-v1-collection-media-collections.public.d.ts +104 -0
  20. package/build/cjs/src/collections-v1-collection-media-collections.public.js +123 -0
  21. package/build/cjs/src/collections-v1-collection-media-collections.public.js.map +1 -0
  22. package/build/cjs/src/collections-v1-collection-media-collections.types.d.ts +951 -0
  23. package/build/cjs/src/collections-v1-collection-media-collections.types.js +94 -0
  24. package/build/cjs/src/collections-v1-collection-media-collections.types.js.map +1 -0
  25. package/build/cjs/src/collections-v1-collection-media-collections.universal.d.ts +1210 -0
  26. package/build/cjs/src/collections-v1-collection-media-collections.universal.js +574 -0
  27. package/build/cjs/src/collections-v1-collection-media-collections.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/collections-v1-collection-media-collections.context.d.ts +21 -0
  39. package/build/es/src/collections-v1-collection-media-collections.context.js +21 -0
  40. package/build/es/src/collections-v1-collection-media-collections.context.js.map +1 -0
  41. package/build/es/src/collections-v1-collection-media-collections.http.d.ts +25 -0
  42. package/build/es/src/collections-v1-collection-media-collections.http.js +474 -0
  43. package/build/es/src/collections-v1-collection-media-collections.http.js.map +1 -0
  44. package/build/es/src/collections-v1-collection-media-collections.meta.d.ts +48 -0
  45. package/build/es/src/collections-v1-collection-media-collections.meta.js +239 -0
  46. package/build/es/src/collections-v1-collection-media-collections.meta.js.map +1 -0
  47. package/build/es/src/collections-v1-collection-media-collections.public.d.ts +104 -0
  48. package/build/es/src/collections-v1-collection-media-collections.public.js +98 -0
  49. package/build/es/src/collections-v1-collection-media-collections.public.js.map +1 -0
  50. package/build/es/src/collections-v1-collection-media-collections.types.d.ts +951 -0
  51. package/build/es/src/collections-v1-collection-media-collections.types.js +91 -0
  52. package/build/es/src/collections-v1-collection-media-collections.types.js.map +1 -0
  53. package/build/es/src/collections-v1-collection-media-collections.universal.d.ts +1210 -0
  54. package/build/es/src/collections-v1-collection-media-collections.universal.js +535 -0
  55. package/build/es/src/collections-v1-collection-media-collections.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.d.ts +21 -0
  66. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js +33 -0
  67. package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js.map +1 -0
  68. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.d.ts +25 -0
  69. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js +490 -0
  70. package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js.map +1 -0
  71. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.d.ts +48 -0
  72. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js +278 -0
  73. package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js.map +1 -0
  74. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.d.ts +104 -0
  75. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js +123 -0
  76. package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js.map +1 -0
  77. package/build/internal/cjs/src/collections-v1-collection-media-collections.types.d.ts +951 -0
  78. package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js +94 -0
  79. package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js.map +1 -0
  80. package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts +1210 -0
  81. package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js +574 -0
  82. package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/collections-v1-collection-media-collections.context.d.ts +21 -0
  93. package/build/internal/es/src/collections-v1-collection-media-collections.context.js +21 -0
  94. package/build/internal/es/src/collections-v1-collection-media-collections.context.js.map +1 -0
  95. package/build/internal/es/src/collections-v1-collection-media-collections.http.d.ts +25 -0
  96. package/build/internal/es/src/collections-v1-collection-media-collections.http.js +474 -0
  97. package/build/internal/es/src/collections-v1-collection-media-collections.http.js.map +1 -0
  98. package/build/internal/es/src/collections-v1-collection-media-collections.meta.d.ts +48 -0
  99. package/build/internal/es/src/collections-v1-collection-media-collections.meta.js +239 -0
  100. package/build/internal/es/src/collections-v1-collection-media-collections.meta.js.map +1 -0
  101. package/build/internal/es/src/collections-v1-collection-media-collections.public.d.ts +104 -0
  102. package/build/internal/es/src/collections-v1-collection-media-collections.public.js +98 -0
  103. package/build/internal/es/src/collections-v1-collection-media-collections.public.js.map +1 -0
  104. package/build/internal/es/src/collections-v1-collection-media-collections.types.d.ts +951 -0
  105. package/build/internal/es/src/collections-v1-collection-media-collections.types.js +91 -0
  106. package/build/internal/es/src/collections-v1-collection-media-collections.types.js.map +1 -0
  107. package/build/internal/es/src/collections-v1-collection-media-collections.universal.d.ts +1210 -0
  108. package/build/internal/es/src/collections-v1-collection-media-collections.universal.js +535 -0
  109. package/build/internal/es/src/collections-v1-collection-media-collections.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,951 @@
1
+ export interface MediaCollection {
2
+ /**
3
+ * Collection id
4
+ * @readonly
5
+ */
6
+ id?: string;
7
+ /** Collection name */
8
+ name?: string;
9
+ description?: string | null;
10
+ /**
11
+ * total count of MediaCollection members
12
+ * @readonly
13
+ */
14
+ membersCount?: number;
15
+ /**
16
+ * the member who created the MediaCollection
17
+ * @readonly
18
+ */
19
+ creator?: CollectionMember;
20
+ /**
21
+ * when MediaCollection was created
22
+ * @readonly
23
+ */
24
+ createdDate?: Date | null;
25
+ /** Items in the collection */
26
+ items?: MediaCollectionItem[];
27
+ /**
28
+ * total count of items
29
+ * @readonly
30
+ */
31
+ itemsCount?: number;
32
+ /** Privacy settings */
33
+ privacySettings?: PrivacySettings;
34
+ /** If true, the collection is locked and should not be updated */
35
+ locked?: boolean;
36
+ }
37
+ export interface CollectionMember {
38
+ /**
39
+ * Member id
40
+ * @readonly
41
+ */
42
+ memberId?: string;
43
+ /** Member nickname */
44
+ nickname?: string | null;
45
+ /** Member slug */
46
+ slug?: string | null;
47
+ /** Member photo url */
48
+ photoUrl?: string | null;
49
+ }
50
+ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
51
+ /** Photo metadata */
52
+ photoMetadata?: PhotoMetadata;
53
+ /** Video metadata */
54
+ videoMetadata?: VideoMetadata;
55
+ /** Text metadata */
56
+ textMetadata?: TextMetadata;
57
+ /**
58
+ * item id
59
+ * @readonly
60
+ */
61
+ id?: string | null;
62
+ /** item url for photos or video */
63
+ mediaUrl?: string | null;
64
+ /** if not present in an update it mean the item will be added as currentTimestamp */
65
+ sortOrder?: number | null;
66
+ /** item's original filename */
67
+ name?: string | null;
68
+ /** item's title */
69
+ title?: string | null;
70
+ /** item's description */
71
+ description?: string | null;
72
+ /** a link from the item to something else */
73
+ link?: Link;
74
+ /** item type: text, photo or video */
75
+ dataType?: DataType;
76
+ /**
77
+ * When the item was added to the collection
78
+ * @readonly
79
+ */
80
+ addedDate?: Date | null;
81
+ /**
82
+ * When the item was last updated
83
+ * @readonly
84
+ */
85
+ updatedDate?: Date | null;
86
+ /** The owner of the media */
87
+ mediaOwner?: MediaOwner;
88
+ /** Tags for media */
89
+ tags?: string[];
90
+ /** Token for media */
91
+ token?: string | null;
92
+ /** Gallery id */
93
+ galleryId?: string;
94
+ }
95
+ /** @oneof */
96
+ export interface MediaCollectionItemMetadataOneOf {
97
+ /** Photo metadata */
98
+ photoMetadata?: PhotoMetadata;
99
+ /** Video metadata */
100
+ videoMetadata?: VideoMetadata;
101
+ /** Text metadata */
102
+ textMetadata?: TextMetadata;
103
+ }
104
+ export interface Link {
105
+ type?: Type;
106
+ /** Link text */
107
+ text?: string | null;
108
+ /** Link url */
109
+ url?: string | null;
110
+ /** Link target */
111
+ target?: string | null;
112
+ /** Data on how to construct the link from wix editor inputs */
113
+ wixLinkData?: WixLink;
114
+ }
115
+ export declare enum Type {
116
+ /** Undefined */
117
+ Undefined = "Undefined",
118
+ /** external link */
119
+ External = "External",
120
+ /** link to wix pages */
121
+ Internal = "Internal"
122
+ }
123
+ /** The link object generated by panels in the editor and used by applications in Wix */
124
+ export interface WixLink extends WixLinkLinkOneOf {
125
+ /** External link type */
126
+ external?: ExternalLink;
127
+ /** Page link type */
128
+ page?: PageLink;
129
+ /** Anchor link type */
130
+ anchor?: AnchorLink;
131
+ /** Dynamic page link type */
132
+ dynamicPage?: DynamicPageLink;
133
+ /** Document link type */
134
+ document?: DocumentLink;
135
+ /** Email link type */
136
+ email?: EmailLink;
137
+ /** Phone link type */
138
+ phone?: PhoneLink;
139
+ /** Address link type */
140
+ address?: AddressLink;
141
+ /** WhatsApp link type */
142
+ whatsApp?: WhatsAppLink;
143
+ /** TPA link type */
144
+ tpaPage?: TpaPageLink;
145
+ }
146
+ /** @oneof */
147
+ export interface WixLinkLinkOneOf {
148
+ /** External link type */
149
+ external?: ExternalLink;
150
+ /** Page link type */
151
+ page?: PageLink;
152
+ /** Anchor link type */
153
+ anchor?: AnchorLink;
154
+ /** Dynamic page link type */
155
+ dynamicPage?: DynamicPageLink;
156
+ /** Document link type */
157
+ document?: DocumentLink;
158
+ /** Email link type */
159
+ email?: EmailLink;
160
+ /** Phone link type */
161
+ phone?: PhoneLink;
162
+ /** Address link type */
163
+ address?: AddressLink;
164
+ /** WhatsApp link type */
165
+ whatsApp?: WhatsAppLink;
166
+ /** TPA link type */
167
+ tpaPage?: TpaPageLink;
168
+ }
169
+ export interface ExternalLink {
170
+ /** The url of the page */
171
+ url?: string;
172
+ /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
173
+ target?: string | null;
174
+ }
175
+ /**
176
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
177
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
178
+ * Following are the accepted 'rel' types by Wix applications.
179
+ */
180
+ export declare enum LinkRel {
181
+ /** default (not implemented) */
182
+ unknown_link_rel = "unknown_link_rel",
183
+ /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
184
+ nofollow = "nofollow",
185
+ /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
186
+ noopener = "noopener",
187
+ /** No Referer header will be included. Additionally, has the same effect as noopener. */
188
+ noreferrer = "noreferrer",
189
+ /** Indicates a link that resulted from advertisements or paid placements. */
190
+ sponsored = "sponsored"
191
+ }
192
+ export interface PageLink {
193
+ /** The page id we want from the site */
194
+ pageId?: string;
195
+ /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
196
+ target?: string | null;
197
+ /** rel of link */
198
+ rel?: LinkRel[];
199
+ }
200
+ export interface AnchorLink {
201
+ /** The name of the anchor */
202
+ anchorName?: string;
203
+ /** The data id (from the JSON page) of the anchor that should be used */
204
+ anchorDataId?: string;
205
+ /** The page id we want from the site */
206
+ pageId?: string;
207
+ /** rel of link */
208
+ rel?: LinkRel[];
209
+ }
210
+ export interface DynamicPageLink {
211
+ /** The router that handles this link */
212
+ routerId?: string;
213
+ /** The path data we'd like */
214
+ innerRoute?: string;
215
+ /** The data id (from the JSON page) of the anchor that should be used */
216
+ anchorDataId?: string | null;
217
+ /** rel of link */
218
+ rel?: LinkRel[];
219
+ }
220
+ export interface DocumentLink {
221
+ /** The id of the document */
222
+ docId?: string;
223
+ /** The name of the document for download purposes */
224
+ name?: string | null;
225
+ /** If this document can be indexed by scrapers, default is false */
226
+ indexable?: boolean;
227
+ }
228
+ export interface EmailLink {
229
+ /** The email we will be sending a message to */
230
+ recipient?: string;
231
+ /** The subject of the email */
232
+ subject?: string | null;
233
+ /** The body of the email */
234
+ body?: string | null;
235
+ }
236
+ export interface PhoneLink {
237
+ /** The phone number we want to link to */
238
+ phoneNumber?: string;
239
+ }
240
+ export interface AddressLink {
241
+ /** An address that we can link to */
242
+ address?: string;
243
+ }
244
+ export interface WhatsAppLink {
245
+ /** The whatsApp phone number we want to connect with */
246
+ phoneNumber?: string;
247
+ }
248
+ /** Link to a TPA page */
249
+ export interface TpaPageLink {
250
+ /** Type of item (e.g. 'wix.stores.sub_pages.product') */
251
+ itemTypeIdentifier?: string;
252
+ /** Id of linked item */
253
+ itemId?: string;
254
+ /** Id of linked page */
255
+ pageId?: string;
256
+ /** Id of app being linked to (AppDefId) */
257
+ appDefinitionId?: string;
258
+ /** The relativepath of linked page */
259
+ path?: string;
260
+ /** rel of link */
261
+ rel?: LinkRel[];
262
+ }
263
+ export declare enum DataType {
264
+ Undefined = "Undefined",
265
+ Photo = "Photo",
266
+ Video = "Video",
267
+ Text = "Text"
268
+ }
269
+ export interface PhotoMetadata {
270
+ /** Photo width */
271
+ width?: number | null;
272
+ /** Photo height */
273
+ height?: number | null;
274
+ /** The focal point of the image */
275
+ focalPoint?: Point;
276
+ /** aka Exchangeable image file format */
277
+ exif?: Record<string, any> | null;
278
+ /** the image quality */
279
+ quality?: number | null;
280
+ /** photo sharpening */
281
+ unsharpMasking?: UnsharpMasking;
282
+ /** id in WixMedia */
283
+ mediaId?: string | null;
284
+ }
285
+ export interface Point {
286
+ /** x coordinate */
287
+ x?: number;
288
+ /** y coordinate */
289
+ y?: number;
290
+ }
291
+ export interface UnsharpMasking {
292
+ /** number controls the amount of contrast that is added at the edges. */
293
+ amount?: number | null;
294
+ /** number in pixels. The size of the edges to be enhanced */
295
+ radius?: number | null;
296
+ /** The minimal level of brightness change that will be sharpened */
297
+ threshold?: number | null;
298
+ }
299
+ export interface VideoMetadata {
300
+ /** Video width */
301
+ width?: number | null;
302
+ /** Video height */
303
+ height?: number | null;
304
+ /** Video duration in milliseconds */
305
+ duration?: string | null;
306
+ /** Video source */
307
+ source?: Source;
308
+ /** Video posters */
309
+ posters?: Thumbnail[];
310
+ /** Video resolutions */
311
+ resolutions?: Resolution[];
312
+ /** External source's representation for this video's id */
313
+ externalId?: string | null;
314
+ }
315
+ export declare enum Source {
316
+ /** Undefined */
317
+ Undefined = "Undefined",
318
+ /** Youtube */
319
+ Youtube = "Youtube",
320
+ /** Vimeo */
321
+ Vimeo = "Vimeo",
322
+ /** Custom */
323
+ Custom = "Custom"
324
+ }
325
+ export interface Thumbnail {
326
+ /** Thumbnail url */
327
+ url?: string | null;
328
+ /** Thumbnail width */
329
+ width?: number | null;
330
+ /** Thumbnail height */
331
+ height?: number | null;
332
+ /** Is this the default thumbnail */
333
+ default?: boolean | null;
334
+ /** The focal point of the image */
335
+ focalPoint?: Point;
336
+ }
337
+ export interface Resolution {
338
+ /** eg 720p, 1024p etc */
339
+ videoMode?: string | null;
340
+ /** Video width */
341
+ width?: number | null;
342
+ /** Video height */
343
+ height?: number | null;
344
+ /** Map representing the file format (eg mp4) to the url. In case of an external source the format can be youtube, vimeo, etc. */
345
+ urls?: Record<string, string>;
346
+ }
347
+ export interface TextMetadata {
348
+ /** text data */
349
+ html?: string | null;
350
+ /** css style info for container */
351
+ style?: Record<string, any> | null;
352
+ /** populated via progallery app only (ck editor format) */
353
+ editorHtml?: string | null;
354
+ /** the wix editor's font Id used to display the text data */
355
+ editorFontId?: string | null;
356
+ }
357
+ export declare enum MediaOwner {
358
+ /** Undefined */
359
+ Undefined = "Undefined",
360
+ /** Wix */
361
+ Wix = "Wix",
362
+ /** DeviantArt */
363
+ DeviantArt = "DeviantArt",
364
+ /** Custom */
365
+ Custom = "Custom"
366
+ }
367
+ export declare enum PrivacySettings {
368
+ /** Undefined */
369
+ Undefined = "Undefined",
370
+ /** Public */
371
+ Public = "Public",
372
+ /** Secret */
373
+ Secret = "Secret"
374
+ }
375
+ export interface PermanentSiteDeletedResponse {
376
+ requestId?: string;
377
+ uniqueServiceIdentifier?: string;
378
+ status?: Status;
379
+ /** @readonly */
380
+ createdDate?: Date | null;
381
+ }
382
+ export declare enum Status {
383
+ UNKNOWN = "UNKNOWN",
384
+ HANDLED = "HANDLED",
385
+ NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
386
+ }
387
+ export interface Empty {
388
+ }
389
+ export interface DomainEvent extends DomainEventBodyOneOf {
390
+ createdEvent?: EntityCreatedEvent;
391
+ updatedEvent?: EntityUpdatedEvent;
392
+ deletedEvent?: EntityDeletedEvent;
393
+ actionEvent?: ActionEvent;
394
+ /**
395
+ * Unique event ID.
396
+ * Allows clients to ignore duplicate webhooks.
397
+ */
398
+ id?: string;
399
+ /**
400
+ * Assumes actions are also always typed to an entity_type
401
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
402
+ */
403
+ entityFqdn?: string;
404
+ /**
405
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
406
+ * This is although the created/updated/deleted notion is duplication of the oneof types
407
+ * Example: created/updated/deleted/started/completed/email_opened
408
+ */
409
+ slug?: string;
410
+ /** ID of the entity associated with the event. */
411
+ entityId?: string;
412
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
413
+ eventTime?: Date | null;
414
+ /**
415
+ * Whether the event was triggered as a result of a privacy regulation application
416
+ * (for example, GDPR).
417
+ */
418
+ triggeredByAnonymizeRequest?: boolean | null;
419
+ /** If present, indicates the action that triggered the event. */
420
+ originatedFrom?: string | null;
421
+ /**
422
+ * A sequence number defining the order of updates to the underlying entity.
423
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
424
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
425
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
426
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
427
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
428
+ */
429
+ entityEventSequence?: string | null;
430
+ }
431
+ /** @oneof */
432
+ export interface DomainEventBodyOneOf {
433
+ createdEvent?: EntityCreatedEvent;
434
+ updatedEvent?: EntityUpdatedEvent;
435
+ deletedEvent?: EntityDeletedEvent;
436
+ actionEvent?: ActionEvent;
437
+ }
438
+ export interface EntityCreatedEvent {
439
+ entityAsJson?: string;
440
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
441
+ restoreInfo?: RestoreInfo;
442
+ }
443
+ export interface RestoreInfo {
444
+ deletedDate?: Date | null;
445
+ }
446
+ export interface EntityUpdatedEvent {
447
+ /**
448
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
449
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
450
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
451
+ */
452
+ currentEntityAsJson?: string;
453
+ }
454
+ export interface EntityDeletedEvent {
455
+ /** Entity that was deleted */
456
+ deletedEntityAsJson?: string | null;
457
+ }
458
+ export interface ActionEvent {
459
+ bodyAsJson?: string;
460
+ }
461
+ export interface MessageEnvelope {
462
+ /** App instance ID. */
463
+ instanceId?: string | null;
464
+ /** Event type. */
465
+ eventType?: string;
466
+ /** The identification type and identity data. */
467
+ identity?: IdentificationData;
468
+ /** Stringify payload. */
469
+ data?: string;
470
+ }
471
+ export interface IdentificationData extends IdentificationDataIdOneOf {
472
+ /** ID of a site visitor that has not logged in to the site. */
473
+ anonymousVisitorId?: string;
474
+ /** ID of a site visitor that has logged in to the site. */
475
+ memberId?: string;
476
+ /** ID of a Wix user (site owner, contributor, etc.). */
477
+ wixUserId?: string;
478
+ /** ID of an app. */
479
+ appId?: string;
480
+ /** @readonly */
481
+ identityType?: WebhookIdentityType;
482
+ }
483
+ /** @oneof */
484
+ export interface IdentificationDataIdOneOf {
485
+ /** ID of a site visitor that has not logged in to the site. */
486
+ anonymousVisitorId?: string;
487
+ /** ID of a site visitor that has logged in to the site. */
488
+ memberId?: string;
489
+ /** ID of a Wix user (site owner, contributor, etc.). */
490
+ wixUserId?: string;
491
+ /** ID of an app. */
492
+ appId?: string;
493
+ }
494
+ export declare enum WebhookIdentityType {
495
+ UNKNOWN = "UNKNOWN",
496
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
497
+ MEMBER = "MEMBER",
498
+ WIX_USER = "WIX_USER",
499
+ APP = "APP"
500
+ }
501
+ export interface CollectionEvent extends CollectionEventEventTypeOneOf {
502
+ /** Collection created */
503
+ collectionCreated?: CollectionCreated;
504
+ /** Items added to collection */
505
+ itemsAddedToCollection?: ItemsAddedToCollection;
506
+ /** Items removed from collection */
507
+ itemsRemovedFromCollection?: ItemsRemovedFromCollection;
508
+ /** Member joined to collection */
509
+ memberJoinedToCollection?: MemberJoinedToCollection;
510
+ /** Member left collection */
511
+ memberLeftCollection?: MemberLeftCollection;
512
+ }
513
+ /** @oneof */
514
+ export interface CollectionEventEventTypeOneOf {
515
+ /** Collection created */
516
+ collectionCreated?: CollectionCreated;
517
+ /** Items added to collection */
518
+ itemsAddedToCollection?: ItemsAddedToCollection;
519
+ /** Items removed from collection */
520
+ itemsRemovedFromCollection?: ItemsRemovedFromCollection;
521
+ /** Member joined to collection */
522
+ memberJoinedToCollection?: MemberJoinedToCollection;
523
+ /** Member left collection */
524
+ memberLeftCollection?: MemberLeftCollection;
525
+ }
526
+ export interface CollectionItemId {
527
+ /** Id of the gallery in ProGallery */
528
+ galleryId?: string;
529
+ /** Id of the item in ProGallery */
530
+ itemId?: string;
531
+ }
532
+ export interface CollectionCreated {
533
+ /** Collection id */
534
+ id?: string;
535
+ /** Collection name */
536
+ name?: string;
537
+ /** Collection description */
538
+ description?: string | null;
539
+ /** Id of the member who created the collection */
540
+ creatorMemberId?: string;
541
+ /** When the collection was created */
542
+ createdDate?: Date | null;
543
+ /** Privacy settings */
544
+ privacySettings?: PrivacySettings;
545
+ }
546
+ export interface ItemsAddedToCollection {
547
+ /** Id of the collection */
548
+ collectionId?: string;
549
+ /** Id of the member who added items */
550
+ addedByMember?: string;
551
+ /** Ids of the items that were added */
552
+ collectionItemIds?: CollectionItemId[];
553
+ /** When the items were added */
554
+ addedDate?: Date | null;
555
+ }
556
+ export interface ItemsRemovedFromCollection {
557
+ /** Id of the collection */
558
+ collectionId?: string;
559
+ /** Id of the member who removed items */
560
+ removedByMember?: string;
561
+ /** Ids of the items that were removed */
562
+ itemIds?: string[];
563
+ /** When the items were removed */
564
+ removedDate?: Date | null;
565
+ }
566
+ export interface MemberJoinedToCollection {
567
+ /** Id of the collection */
568
+ collectionId?: string;
569
+ /** Id of the member who joined */
570
+ memberId?: string;
571
+ /** When the member was joined */
572
+ joinedDate?: Date | null;
573
+ }
574
+ export interface MemberLeftCollection {
575
+ /** Id of the collection */
576
+ collectionId?: string;
577
+ /** Id of the member who left */
578
+ memberId?: string;
579
+ /** When the member left */
580
+ leftDate?: Date | null;
581
+ }
582
+ export interface GetMediaCollectionRequest {
583
+ /** Collection id */
584
+ mediaCollectionId: string;
585
+ /** number of items to skip in the current sort order, default is 0 */
586
+ offset?: number | null;
587
+ /** The amount of items per response, default is 50 */
588
+ limit?: number | null;
589
+ }
590
+ export interface GetMediaCollectionResponse {
591
+ /** The collection */
592
+ mediaCollection?: MediaCollection;
593
+ /** The member's status in the collection */
594
+ memberStatus?: MemberStatus;
595
+ }
596
+ export declare enum MemberStatus {
597
+ /** Undefined */
598
+ UNDEFINED = "UNDEFINED",
599
+ /** Not a member */
600
+ NOT_MEMBER = "NOT_MEMBER",
601
+ /** Member */
602
+ MEMBER = "MEMBER",
603
+ /** Admin */
604
+ ADMIN = "ADMIN"
605
+ }
606
+ export interface ListCollectionsForItemRequest {
607
+ /** Gallery id */
608
+ galleryId?: string;
609
+ /** Item id */
610
+ itemId: string;
611
+ }
612
+ export interface ListCollectionsForItemResponse {
613
+ /** The collections that the item belongs to */
614
+ itemInCollections?: ItemInCollection[];
615
+ }
616
+ export interface ItemInCollection {
617
+ /** Collection id */
618
+ mediaCollectionId?: string;
619
+ /** Collection name */
620
+ name?: string;
621
+ /** Is the item in the collection */
622
+ isItemInCollection?: boolean;
623
+ /** Is the collection locked */
624
+ isLocked?: boolean;
625
+ /** Member's role in the collection */
626
+ role?: MemberStatus;
627
+ /** Total count of items in the collection */
628
+ totalItemsCount?: number | null;
629
+ /** The first item in the collection */
630
+ firstItem?: MediaCollectionItem;
631
+ /** The creator's nickname */
632
+ creatorNickname?: string | null;
633
+ }
634
+ export interface GetCollectionItemRequest {
635
+ /** Collection id */
636
+ mediaCollectionId: string;
637
+ /** Item id */
638
+ itemId: string;
639
+ }
640
+ export interface GetCollectionItemResponse {
641
+ /** The item */
642
+ item?: MediaCollectionItem;
643
+ }
644
+ export interface ListMediaCollectionsRequest {
645
+ /** the amount of collections per response, default is 1000 */
646
+ limit?: number | null;
647
+ /** number of collections to skip in the current sort order, default is 0 */
648
+ offset?: number | null;
649
+ /**
650
+ * If empty, no filter will be applied
651
+ * Else, will return only collections that the member has those roles on them. Currently supporting: MEMBER, ADMIN.
652
+ */
653
+ filterByRoles?: FilterByRoles;
654
+ }
655
+ export interface FilterByRoles {
656
+ roles?: MemberStatus[];
657
+ }
658
+ export interface ListMediaCollectionsResponse {
659
+ /** The collections and the member's role in them */
660
+ collectionsStatus?: CollectionAndStatus[];
661
+ /**
662
+ * total count of MediaCollection members
663
+ * @readonly
664
+ */
665
+ totalCollectionsCount?: number | null;
666
+ }
667
+ export interface CollectionAndStatus {
668
+ /** The Media Collection */
669
+ mediaCollection?: MediaCollection;
670
+ /** The member's status in the collection */
671
+ memberStatus?: MemberStatus;
672
+ }
673
+ export interface CreateMediaCollectionRequest {
674
+ /** Name of the collection */
675
+ name: string;
676
+ /** Description of the collection */
677
+ description?: string | null;
678
+ /** Privacy settings of the collection */
679
+ privacySettings?: PrivacySettings;
680
+ /** Items to add to the collection */
681
+ items?: AddItem[];
682
+ }
683
+ export interface AddItem {
684
+ /** Gallery id */
685
+ galleryId?: string;
686
+ /** Item id */
687
+ itemId?: string;
688
+ /** Order index of the item */
689
+ orderIndex?: number | null;
690
+ }
691
+ export interface CreateMediaCollectionResponse {
692
+ /** id of the collection that was created */
693
+ mediaCollectionId?: string;
694
+ }
695
+ export interface PartiallyUpdateMediaCollectionRequest {
696
+ /** Collection to update */
697
+ mediaCollection: MediaCollection;
698
+ /**
699
+ * fields to update
700
+ * supported fields: name, description, privacy_settings
701
+ */
702
+ fieldMask: string[];
703
+ }
704
+ export interface PartiallyUpdateMediaCollectionResponse {
705
+ }
706
+ export interface UpdateCollectionLockRequest {
707
+ /** Collection to lock */
708
+ mediaCollectionId?: string;
709
+ /** Lock status */
710
+ locked?: boolean;
711
+ }
712
+ export interface UpdateCollectionLockResponse {
713
+ }
714
+ export interface DeleteMediaCollectionRequest {
715
+ /** the collection to delete */
716
+ mediaCollectionId: string;
717
+ }
718
+ export interface DeleteMediaCollectionResponse {
719
+ }
720
+ export interface ListCollectionMembersRequest {
721
+ /** the collection to get its members */
722
+ mediaCollectionId: string;
723
+ /** Filter the members by their role in the collection */
724
+ filterBy?: FilterBy;
725
+ }
726
+ export interface FilterBy {
727
+ /** Member's status in the collection */
728
+ memberStatus?: MemberStatus;
729
+ }
730
+ export interface ListCollectionMembersResponse {
731
+ /** The collection's members and their roles */
732
+ membersRoles?: MemberAndStatus[];
733
+ }
734
+ export interface MemberAndStatus {
735
+ /** The member */
736
+ member?: CollectionMember;
737
+ /** The member's role in the collection */
738
+ memberStatus?: MemberStatus;
739
+ }
740
+ export interface AddItemsRequest {
741
+ /** Collection to add items */
742
+ mediaCollectionId: string;
743
+ /** Items to add */
744
+ items?: AddItem[];
745
+ }
746
+ export interface AddItemsResponse {
747
+ }
748
+ export interface RemoveItemsRequest {
749
+ /** Collection to remove items from */
750
+ mediaCollectionId: string;
751
+ /** Items to remove */
752
+ itemsIds?: string[];
753
+ }
754
+ export interface RemoveItemsResponse {
755
+ }
756
+ export interface UpdateItemsRequest {
757
+ /** Collection to update items */
758
+ mediaCollectionId?: string;
759
+ items?: UpdateItem[];
760
+ }
761
+ export interface UpdateItem {
762
+ /** Item to update */
763
+ itemId?: string;
764
+ /** New order index of the item */
765
+ orderIndex?: number;
766
+ }
767
+ export interface UpdateItemsResponse {
768
+ }
769
+ export interface JoinToCollectionRequest {
770
+ /** Collection to join */
771
+ mediaCollectionId: string;
772
+ }
773
+ export interface JoinToCollectionResponse {
774
+ }
775
+ export interface RemoveMemberFromCollectionRequest {
776
+ /** Collection the member will be removed from being a member */
777
+ mediaCollectionId?: string;
778
+ /** Member id to remove from the collection */
779
+ memberId?: string;
780
+ }
781
+ export interface RemoveMemberFromCollectionResponse {
782
+ }
783
+ export interface LeaveCollectionRequest {
784
+ /** Collection the member will be leaving */
785
+ mediaCollectionId: string;
786
+ }
787
+ export interface LeaveCollectionResponse {
788
+ }
789
+ export interface ListCollectionItemsRequest {
790
+ /** Collection to get its items */
791
+ mediaCollectionId: string;
792
+ }
793
+ export interface ListCollectionItemsResponse {
794
+ /** The collection's items */
795
+ collectionItems?: CollectionItem[];
796
+ }
797
+ export interface CollectionItem {
798
+ /** Gallery id */
799
+ galleryId?: string;
800
+ /** Item id */
801
+ itemId?: string;
802
+ /** Order index of the item */
803
+ orderIndex?: number | null;
804
+ /** Date the item was added to the collection */
805
+ addedDate?: Date | null;
806
+ }
807
+ export interface ListAllItemsBelongToCollectionRequest {
808
+ }
809
+ export interface ListAllItemsBelongToCollectionResponse {
810
+ /** List of the item ids that belong to one or more collection */
811
+ itemIds?: string[];
812
+ }
813
+ interface CollectionMemberNonNullableFields {
814
+ memberId: string;
815
+ }
816
+ interface PointNonNullableFields {
817
+ x: number;
818
+ y: number;
819
+ }
820
+ interface PhotoMetadataNonNullableFields {
821
+ focalPoint?: PointNonNullableFields;
822
+ }
823
+ interface ThumbnailNonNullableFields {
824
+ focalPoint?: PointNonNullableFields;
825
+ }
826
+ interface VideoMetadataNonNullableFields {
827
+ source: Source;
828
+ posters: ThumbnailNonNullableFields[];
829
+ }
830
+ interface ExternalLinkNonNullableFields {
831
+ url: string;
832
+ rel: LinkRel[];
833
+ }
834
+ interface PageLinkNonNullableFields {
835
+ pageId: string;
836
+ rel: LinkRel[];
837
+ }
838
+ interface AnchorLinkNonNullableFields {
839
+ anchorName: string;
840
+ anchorDataId: string;
841
+ pageId: string;
842
+ rel: LinkRel[];
843
+ }
844
+ interface DynamicPageLinkNonNullableFields {
845
+ routerId: string;
846
+ innerRoute: string;
847
+ rel: LinkRel[];
848
+ }
849
+ interface DocumentLinkNonNullableFields {
850
+ docId: string;
851
+ indexable: boolean;
852
+ }
853
+ interface EmailLinkNonNullableFields {
854
+ recipient: string;
855
+ }
856
+ interface PhoneLinkNonNullableFields {
857
+ phoneNumber: string;
858
+ }
859
+ interface AddressLinkNonNullableFields {
860
+ address: string;
861
+ }
862
+ interface WhatsAppLinkNonNullableFields {
863
+ phoneNumber: string;
864
+ }
865
+ interface TpaPageLinkNonNullableFields {
866
+ itemTypeIdentifier: string;
867
+ itemId: string;
868
+ pageId: string;
869
+ appDefinitionId: string;
870
+ path: string;
871
+ rel: LinkRel[];
872
+ }
873
+ interface WixLinkNonNullableFields {
874
+ external?: ExternalLinkNonNullableFields;
875
+ page?: PageLinkNonNullableFields;
876
+ anchor?: AnchorLinkNonNullableFields;
877
+ dynamicPage?: DynamicPageLinkNonNullableFields;
878
+ document?: DocumentLinkNonNullableFields;
879
+ email?: EmailLinkNonNullableFields;
880
+ phone?: PhoneLinkNonNullableFields;
881
+ address?: AddressLinkNonNullableFields;
882
+ whatsApp?: WhatsAppLinkNonNullableFields;
883
+ tpaPage?: TpaPageLinkNonNullableFields;
884
+ }
885
+ interface LinkNonNullableFields {
886
+ type: Type;
887
+ wixLinkData?: WixLinkNonNullableFields;
888
+ }
889
+ interface MediaCollectionItemNonNullableFields {
890
+ photoMetadata?: PhotoMetadataNonNullableFields;
891
+ videoMetadata?: VideoMetadataNonNullableFields;
892
+ link?: LinkNonNullableFields;
893
+ dataType: DataType;
894
+ secure: boolean;
895
+ mediaOwner: MediaOwner;
896
+ tags: string[];
897
+ galleryId: string;
898
+ }
899
+ interface MediaCollectionNonNullableFields {
900
+ id: string;
901
+ name: string;
902
+ membersCount: number;
903
+ creator?: CollectionMemberNonNullableFields;
904
+ items: MediaCollectionItemNonNullableFields[];
905
+ itemsCount: number;
906
+ privacySettings: PrivacySettings;
907
+ locked: boolean;
908
+ }
909
+ export interface GetMediaCollectionResponseNonNullableFields {
910
+ mediaCollection?: MediaCollectionNonNullableFields;
911
+ memberStatus: MemberStatus;
912
+ }
913
+ interface ItemInCollectionNonNullableFields {
914
+ mediaCollectionId: string;
915
+ name: string;
916
+ isItemInCollection: boolean;
917
+ isLocked: boolean;
918
+ role: MemberStatus;
919
+ firstItem?: MediaCollectionItemNonNullableFields;
920
+ }
921
+ export interface ListCollectionsForItemResponseNonNullableFields {
922
+ itemInCollections: ItemInCollectionNonNullableFields[];
923
+ }
924
+ export interface GetCollectionItemResponseNonNullableFields {
925
+ item?: MediaCollectionItemNonNullableFields;
926
+ }
927
+ interface CollectionAndStatusNonNullableFields {
928
+ mediaCollection?: MediaCollectionNonNullableFields;
929
+ memberStatus: MemberStatus;
930
+ }
931
+ export interface ListMediaCollectionsResponseNonNullableFields {
932
+ collectionsStatus: CollectionAndStatusNonNullableFields[];
933
+ }
934
+ export interface CreateMediaCollectionResponseNonNullableFields {
935
+ mediaCollectionId: string;
936
+ }
937
+ interface MemberAndStatusNonNullableFields {
938
+ member?: CollectionMemberNonNullableFields;
939
+ memberStatus: MemberStatus;
940
+ }
941
+ export interface ListCollectionMembersResponseNonNullableFields {
942
+ membersRoles: MemberAndStatusNonNullableFields[];
943
+ }
944
+ interface CollectionItemNonNullableFields {
945
+ galleryId: string;
946
+ itemId: string;
947
+ }
948
+ export interface ListCollectionItemsResponseNonNullableFields {
949
+ collectionItems: CollectionItemNonNullableFields[];
950
+ }
951
+ export {};