@wix/auto_sdk_pro-gallery_pro-gallery 1.0.8 → 1.0.9

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 (134) hide show
  1. package/build/index.d.mts +213 -0
  2. package/build/index.d.ts +213 -0
  3. package/build/index.js +1834 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1784 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +213 -0
  8. package/build/internal/index.d.ts +213 -0
  9. package/build/internal/index.js +1834 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1784 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/internal/meta.d.mts +498 -0
  14. package/build/internal/meta.d.ts +498 -0
  15. package/build/internal/meta.js +1054 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +1016 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/{es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts → internal/pro-gallery-v2-gallery-pro-gallery.universal-KXp1KG3k.d.mts} +438 -516
  20. package/build/{cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts → internal/pro-gallery-v2-gallery-pro-gallery.universal-KXp1KG3k.d.ts} +438 -516
  21. package/build/meta.d.mts +498 -0
  22. package/build/meta.d.ts +498 -0
  23. package/build/meta.js +1054 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +1016 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/{internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts → pro-gallery-v2-gallery-pro-gallery.universal-KXp1KG3k.d.mts} +438 -516
  28. package/build/{internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts → pro-gallery-v2-gallery-pro-gallery.universal-KXp1KG3k.d.ts} +438 -516
  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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +0 -56
  40. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +0 -69
  41. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +0 -1
  42. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +0 -90
  43. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +0 -875
  44. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +0 -1
  45. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +0 -47
  46. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js +0 -256
  47. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +0 -1
  48. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +0 -167
  49. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js +0 -309
  50. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +0 -1
  51. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +0 -103
  52. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +0 -1
  53. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +0 -1830
  54. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +0 -850
  55. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +0 -56
  67. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +0 -56
  68. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +0 -1
  69. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +0 -90
  70. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +0 -860
  71. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +0 -1
  72. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +0 -47
  73. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js +0 -218
  74. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +0 -1
  75. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +0 -167
  76. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.js +0 -284
  77. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +0 -1
  78. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +0 -100
  79. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +0 -1
  80. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +0 -1830
  81. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +0 -812
  82. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +0 -56
  93. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +0 -69
  94. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +0 -1
  95. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +0 -90
  96. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +0 -875
  97. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +0 -1
  98. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +0 -47
  99. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js +0 -256
  100. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +0 -1
  101. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +0 -167
  102. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js +0 -309
  103. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +0 -1
  104. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +0 -103
  105. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +0 -1
  106. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +0 -1830
  107. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +0 -850
  108. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +0 -56
  119. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +0 -56
  120. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +0 -1
  121. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +0 -90
  122. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +0 -860
  123. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +0 -1
  124. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +0 -47
  125. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js +0 -218
  126. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +0 -1
  127. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +0 -167
  128. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.js +0 -284
  129. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +0 -1
  130. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +0 -100
  131. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +0 -1
  132. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +0 -1830
  133. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +0 -812
  134. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Gallery {
1
+ interface Gallery {
2
2
  /**
3
3
  * Gallery ID.
4
4
  * @readonly
5
5
  * @format GUID
6
6
  */
7
- id?: string | null;
7
+ _id?: string | null;
8
8
  /** Gallery name. */
9
9
  name?: string | null;
10
10
  /**
@@ -24,9 +24,9 @@ export interface Gallery {
24
24
  * Date and time the gallery was created.
25
25
  * @readonly
26
26
  */
27
- createdDate?: Date | null;
27
+ _createdDate?: Date | null;
28
28
  }
29
- export interface Item extends ItemMetadataOneOf {
29
+ interface Item extends ItemMetadataOneOf {
30
30
  /** Details about the image. */
31
31
  image?: Image;
32
32
  /** Details about the video. */
@@ -38,7 +38,7 @@ export interface Item extends ItemMetadataOneOf {
38
38
  * @readonly
39
39
  * @format GUID
40
40
  */
41
- id?: string | null;
41
+ _id?: string | null;
42
42
  /**
43
43
  * Index that determines which position a media item is displayed in the gallery. <br />
44
44
  *
@@ -62,17 +62,17 @@ export interface Item extends ItemMetadataOneOf {
62
62
  * Date and time the item was created.
63
63
  * @readonly
64
64
  */
65
- createdDate?: Date | null;
65
+ _createdDate?: Date | null;
66
66
  /**
67
67
  * Date and time the item was last updated.
68
68
  * @readonly
69
69
  */
70
- updatedDate?: Date | null;
70
+ _updatedDate?: Date | null;
71
71
  /** Item tags. */
72
72
  tags?: Tags;
73
73
  }
74
74
  /** @oneof */
75
- export interface ItemMetadataOneOf {
75
+ interface ItemMetadataOneOf {
76
76
  /** Details about the image. */
77
77
  image?: Image;
78
78
  /** Details about the video. */
@@ -80,23 +80,21 @@ export interface ItemMetadataOneOf {
80
80
  /** Details about the text file. */
81
81
  text?: Text;
82
82
  }
83
- export interface Link {
83
+ interface Link {
84
84
  /** Display text of the link. */
85
85
  text?: string | null;
86
86
  /** Target URL of the link. */
87
87
  url?: string | null;
88
88
  }
89
- export declare enum LinkType {
89
+ declare enum LinkType {
90
90
  UNDEFINED = "UNDEFINED",
91
91
  /** External link. */
92
92
  EXTERNAL = "EXTERNAL",
93
93
  /** For internal usage using wixLinkData. */
94
94
  INTERNAL = "INTERNAL"
95
95
  }
96
- /** @enumType */
97
- export type LinkTypeWithLiterals = LinkType | 'UNDEFINED' | 'EXTERNAL' | 'INTERNAL';
98
96
  /** The link object generated by panels in the editor and used by applications in Wix */
99
- export interface WixLink extends WixLinkLinkOneOf {
97
+ interface WixLink extends WixLinkLinkOneOf {
100
98
  /** External link type */
101
99
  external?: ExternalLink;
102
100
  /** Page link type */
@@ -119,7 +117,7 @@ export interface WixLink extends WixLinkLinkOneOf {
119
117
  tpaPage?: TpaPageLink;
120
118
  }
121
119
  /** @oneof */
122
- export interface WixLinkLinkOneOf {
120
+ interface WixLinkLinkOneOf {
123
121
  /** External link type */
124
122
  external?: ExternalLink;
125
123
  /** Page link type */
@@ -141,7 +139,7 @@ export interface WixLinkLinkOneOf {
141
139
  /** TPA link type */
142
140
  tpaPage?: TpaPageLink;
143
141
  }
144
- export interface ExternalLink {
142
+ interface ExternalLink {
145
143
  /**
146
144
  * The url of the page
147
145
  * @format WEB_URL
@@ -155,7 +153,7 @@ export interface ExternalLink {
155
153
  * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
156
154
  * Following are the accepted 'rel' types by Wix applications.
157
155
  */
158
- export declare enum LinkRel {
156
+ declare enum LinkRel {
159
157
  /** default (not implemented) */
160
158
  unknown_link_rel = "unknown_link_rel",
161
159
  /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
@@ -168,8 +166,8 @@ export declare enum LinkRel {
168
166
  sponsored = "sponsored"
169
167
  }
170
168
  /** @enumType */
171
- export type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
172
- export interface PageLink {
169
+ type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
170
+ interface PageLink {
173
171
  /** The page id we want from the site */
174
172
  pageId?: string;
175
173
  /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
@@ -180,7 +178,7 @@ export interface PageLink {
180
178
  */
181
179
  rel?: LinkRelWithLiterals[];
182
180
  }
183
- export interface AnchorLink {
181
+ interface AnchorLink {
184
182
  /** The name of the anchor */
185
183
  anchorName?: string;
186
184
  /** The data id (from the JSON page) of the anchor that should be used */
@@ -193,7 +191,7 @@ export interface AnchorLink {
193
191
  */
194
192
  rel?: LinkRelWithLiterals[];
195
193
  }
196
- export interface DynamicPageLink {
194
+ interface DynamicPageLink {
197
195
  /** The router that handles this link */
198
196
  routerId?: string;
199
197
  /** The path data we'd like */
@@ -206,7 +204,7 @@ export interface DynamicPageLink {
206
204
  */
207
205
  rel?: LinkRelWithLiterals[];
208
206
  }
209
- export interface DocumentLink {
207
+ interface DocumentLink {
210
208
  /** The id of the document */
211
209
  docId?: string;
212
210
  /** The name of the document for download purposes */
@@ -214,7 +212,7 @@ export interface DocumentLink {
214
212
  /** If this document can be indexed by scrapers, default is false */
215
213
  indexable?: boolean;
216
214
  }
217
- export interface EmailLink {
215
+ interface EmailLink {
218
216
  /**
219
217
  * The email we will be sending a message to
220
218
  * @format EMAIL
@@ -225,7 +223,7 @@ export interface EmailLink {
225
223
  /** The body of the email */
226
224
  body?: string | null;
227
225
  }
228
- export interface PhoneLink {
226
+ interface PhoneLink {
229
227
  /**
230
228
  * The phone number we want to link to
231
229
  * @format PHONE
@@ -233,11 +231,11 @@ export interface PhoneLink {
233
231
  */
234
232
  phoneNumber?: string;
235
233
  }
236
- export interface AddressLink {
234
+ interface AddressLink {
237
235
  /** An address that we can link to */
238
236
  address?: string;
239
237
  }
240
- export interface WhatsAppLink {
238
+ interface WhatsAppLink {
241
239
  /**
242
240
  * The whatsApp phone number we want to connect with
243
241
  * @format PHONE
@@ -245,7 +243,7 @@ export interface WhatsAppLink {
245
243
  phoneNumber?: string;
246
244
  }
247
245
  /** Link to a TPA page */
248
- export interface TpaPageLink {
246
+ interface TpaPageLink {
249
247
  /** Type of item (e.g. 'wix.stores.sub_pages.product') */
250
248
  itemTypeIdentifier?: string;
251
249
  /** Id of linked item */
@@ -262,17 +260,17 @@ export interface TpaPageLink {
262
260
  */
263
261
  rel?: LinkRelWithLiterals[];
264
262
  }
265
- export declare enum Type {
263
+ declare enum Type {
266
264
  UNDEFINED = "UNDEFINED",
267
265
  IMAGE = "IMAGE",
268
266
  VIDEO = "VIDEO",
269
267
  TEXT = "TEXT"
270
268
  }
271
269
  /** @enumType */
272
- export type TypeWithLiterals = Type | 'UNDEFINED' | 'IMAGE' | 'VIDEO' | 'TEXT';
273
- export interface Image {
274
- /** Information about the Wix Media image. */
275
- imageInfo?: CommonImage;
270
+ type TypeWithLiterals = Type | 'UNDEFINED' | 'IMAGE' | 'VIDEO' | 'TEXT';
271
+ interface Image {
272
+ /** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
273
+ imageInfo?: string;
276
274
  /** Focal point of the image. */
277
275
  focalPoint?: Point;
278
276
  /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
@@ -289,37 +287,18 @@ export interface Image {
289
287
  /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
290
288
  unsharpMasking?: UnsharpMasking;
291
289
  }
292
- export declare enum ImageType {
290
+ declare enum ImageType {
293
291
  UNDEFINED = "UNDEFINED",
294
292
  WIX_MEDIA = "WIX_MEDIA",
295
293
  EXTERNAL = "EXTERNAL"
296
294
  }
297
- /** @enumType */
298
- export type ImageTypeWithLiterals = ImageType | 'UNDEFINED' | 'WIX_MEDIA' | 'EXTERNAL';
299
- export interface CommonImage {
300
- /** *Required.** WixMedia image ID. */
301
- id?: string;
302
- /**
303
- * Image URL.
304
- * @readonly
305
- */
306
- url?: string;
307
- /** *Required.** Original image height. */
308
- height?: number;
309
- /** *Required.** Original image width. */
310
- width?: number;
311
- /** Image alt text. */
312
- altText?: string | null;
313
- /** Image filename. */
314
- filename?: string | null;
315
- }
316
- export interface Point {
295
+ interface Point {
317
296
  /** X-coordinate of the focal point. */
318
297
  x?: number;
319
298
  /** Y-coordinate of the focal point. */
320
299
  y?: number;
321
300
  }
322
- export interface UnsharpMasking {
301
+ interface UnsharpMasking {
323
302
  /**
324
303
  * Unsharp masking amount. Controls the sharpening strength. <br />
325
304
  *
@@ -339,38 +318,31 @@ export interface UnsharpMasking {
339
318
  */
340
319
  threshold?: number | null;
341
320
  }
342
- export interface Video {
321
+ interface Video {
343
322
  /** Type of video. */
344
323
  type?: VideoTypeWithLiterals;
345
- /** Information about the video. */
346
- videoInfo?: VideoV2;
324
+ /**
325
+ * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
326
+ *
327
+ * Wix Media: `'wix:video://v1/6e6ea4_461425d7e7db4d5487a28e00c5ba6244/9e6ea4_461425d7e7db4d5487a28e00c5ba6277#posterUri=9e6ea4_461425d7e7db4d5487a28e00c5ba6277f000.jpg&posterWidth=960&posterHeight=540'`
328
+ *
329
+ * Vimeo: `'https://vimeo.com/378840916'`
330
+ *
331
+ * Youtube: `'https://www.youtube.com/results?search_query=uplifting+upbeat+music'`
332
+ */
333
+ videoInfo?: string;
347
334
  /** Manually defined video duration in milliseconds. */
348
335
  durationInMillis?: number | null;
349
336
  }
350
- export declare enum VideoType {
337
+ declare enum VideoType {
351
338
  UNDEFINED = "UNDEFINED",
352
339
  WIX_MEDIA = "WIX_MEDIA",
353
340
  YOUTUBE = "YOUTUBE",
354
341
  VIMEO = "VIMEO"
355
342
  }
356
343
  /** @enumType */
357
- export type VideoTypeWithLiterals = VideoType | 'UNDEFINED' | 'WIX_MEDIA' | 'YOUTUBE' | 'VIMEO';
358
- export interface VideoV2 {
359
- /** WixMedia ID. Required when associating an existing Wix Media video. */
360
- id?: string;
361
- /** Video URL. Required when associating a video from an external source. Supported sources: YouTube, Vimeo. */
362
- url?: string;
363
- /**
364
- * Available resolutions for the video, starting with the optimal resolution.
365
- * @maxSize 100
366
- */
367
- resolutions?: VideoResolution[];
368
- /** Video filename. */
369
- filename?: string | null;
370
- /** Video posters. */
371
- posters?: CommonImage[];
372
- }
373
- export interface VideoResolution {
344
+ type VideoTypeWithLiterals = VideoType | 'UNDEFINED' | 'WIX_MEDIA' | 'YOUTUBE' | 'VIMEO';
345
+ interface VideoResolution {
374
346
  /** *Required.** Video URL. */
375
347
  url?: string;
376
348
  /** *Required.** Video height. */
@@ -384,13 +356,13 @@ export interface VideoResolution {
384
356
  /** Video filename. */
385
357
  filename?: string | null;
386
358
  }
387
- export interface Text {
359
+ interface Text {
388
360
  /** Text in HTML format. */
389
361
  html?: string | null;
390
362
  /**
391
363
  * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.
392
364
  *
393
- * __Note:__ The object structure is customizable. See the [List Gallery Items](https://dev.wix.com/api/rest/site-content/pro-gallery/list-gallery-items) code example for supported values.
365
+ * __Note:__ The object structure is customizable. See the [`listGalleryItems()`](/pro-gallery/list-gallery-items) code example for supported values.
394
366
  */
395
367
  css?: Record<string, any> | null;
396
368
  /** Reserved for internal use. */
@@ -398,359 +370,75 @@ export interface Text {
398
370
  /** Reserved for internal use. */
399
371
  editorFontId?: string | null;
400
372
  }
401
- export interface Tags {
373
+ interface Tags {
402
374
  /** List of tags assigned to the media item. */
403
375
  values?: string[];
404
376
  }
405
- export interface SecondaryMedia extends SecondaryMediaMetadataOneOf {
377
+ interface SecondaryMedia extends SecondaryMediaMetadataOneOf {
406
378
  /** secondary media photo metadata (optional) */
407
379
  image?: Image;
408
380
  /** secondary media text metadata (optional) */
409
381
  text?: Text;
410
382
  }
411
383
  /** @oneof */
412
- export interface SecondaryMediaMetadataOneOf {
384
+ interface SecondaryMediaMetadataOneOf {
413
385
  /** secondary media photo metadata (optional) */
414
386
  image?: Image;
415
387
  /** secondary media text metadata (optional) */
416
388
  text?: Text;
417
389
  }
418
- export interface InvalidateCache extends InvalidateCacheGetByOneOf {
419
- /**
420
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
421
- * @format GUID
422
- */
423
- metaSiteId?: string;
424
- /**
425
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
426
- * @format GUID
427
- */
428
- siteId?: string;
429
- /** Invalidate by App */
430
- app?: App;
431
- /** Invalidate by page id */
432
- page?: Page;
433
- /** Invalidate by URI path */
434
- uri?: URI;
435
- /** Invalidate by file (for media files such as PDFs) */
436
- file?: File;
437
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
438
- customTag?: CustomTag;
439
- /**
440
- * tell us why you're invalidating the cache. You don't need to add your app name
441
- * @maxLength 256
442
- */
443
- reason?: string | null;
444
- /** Is local DS */
445
- localDc?: boolean;
446
- hardPurge?: boolean;
447
- }
448
- /** @oneof */
449
- export interface InvalidateCacheGetByOneOf {
450
- /**
451
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
452
- * @format GUID
453
- */
454
- metaSiteId?: string;
455
- /**
456
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
457
- * @format GUID
458
- */
459
- siteId?: string;
460
- /** Invalidate by App */
461
- app?: App;
462
- /** Invalidate by page id */
463
- page?: Page;
464
- /** Invalidate by URI path */
465
- uri?: URI;
466
- /** Invalidate by file (for media files such as PDFs) */
467
- file?: File;
468
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
469
- customTag?: CustomTag;
470
- }
471
- export interface App {
472
- /**
473
- * The AppDefId
474
- * @minLength 1
475
- */
476
- appDefId?: string;
477
- /**
478
- * The instance Id
479
- * @format GUID
480
- */
481
- instanceId?: string;
482
- }
483
- export interface Page {
484
- /**
485
- * the msid the page is on
486
- * @format GUID
487
- */
488
- metaSiteId?: string;
390
+ interface RestoreAllGalleriesEvent {
489
391
  /**
490
- * Invalidate by Page ID
491
- * @minLength 1
492
- */
493
- pageId?: string;
494
- }
495
- export interface URI {
496
- /**
497
- * the msid the URI is on
498
- * @format GUID
499
- */
500
- metaSiteId?: string;
501
- /**
502
- * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
503
- * @minLength 1
504
- */
505
- uriPath?: string;
506
- }
507
- export interface File {
508
- /**
509
- * the msid the file is related to
510
- * @format GUID
511
- */
512
- metaSiteId?: string;
513
- /**
514
- * Invalidate by filename (for media files such as PDFs)
515
- * @minLength 1
516
- * @maxLength 256
517
- */
518
- fileName?: string;
519
- }
520
- export interface CustomTag {
521
- /**
522
- * the msid the tag is related to
523
- * @format GUID
524
- */
525
- metaSiteId?: string;
526
- /**
527
- * Tag to invalidate by
528
- * @minLength 1
529
- * @maxLength 256
530
- */
531
- tag?: string;
532
- }
533
- export interface GalleryPublished {
534
- /**
535
- * id of the gallery that will be published
536
- * @readonly
537
- * @format GUID
538
- */
539
- galleryId?: string;
540
- isRc?: boolean;
541
- /** @readonly */
542
- newRevision?: Date | null;
543
- /** @readonly */
544
- oldRevision?: Date | null;
545
- }
546
- export interface CleanDeletedGalleriesEvent {
547
- /**
548
- * @readonly
392
+ * instance id of galleries to restore
549
393
  * @format GUID
550
394
  */
551
395
  instanceId?: string;
552
- /**
553
- * @readonly
554
- * @format GUID
555
- */
556
- metaSiteId?: string;
557
- /** @readonly */
558
- htmlSiteRevision?: string;
559
- /** @readonly */
560
- timeSitePublished?: Date | null;
561
396
  }
562
- export interface ProgallerypublisherPublishGalleryRequest {
397
+ interface ListGalleriesItemsRequest {
563
398
  /**
564
- * id of the gallery that will be published
565
- * @format GUID
399
+ * IDs of the media items to retrieve.
400
+ * @minSize 1
401
+ * @maxSize 100
566
402
  */
567
- galleryId?: string;
568
- }
569
- export interface ProgallerypublisherPublishGalleryResponse {
570
- }
571
- export interface GetActiveGalleryRevisionRequest {
572
- /** @format GUID */
573
- galleryId?: string;
574
- }
575
- export interface GetActiveGalleryRevisionResponse {
576
- galleryActiveRevision?: Date | null;
577
- htmlSiteRevision?: string | null;
578
- }
579
- export interface GetGalleryRevisionRequest {
580
- /** @format GUID */
581
- galleryId?: string;
582
- revision?: Date | null;
583
- }
584
- export interface GetGalleryRevisionResponse {
585
- htmlSiteRevision?: string | null;
586
- /** @format GUID */
587
- instanceId?: string | null;
403
+ itemsId?: ItemId[];
588
404
  }
589
- export interface PublishGalleryItemRequest {
405
+ interface ItemId {
590
406
  /**
591
- * id of the gallery that will be published
407
+ * Gallery ID.
592
408
  * @format GUID
593
409
  */
594
410
  galleryId?: string;
595
411
  /**
596
- * id of the item that will be published
412
+ * Item ID.
597
413
  * @format GUID
598
414
  */
599
415
  itemId?: string;
600
416
  }
601
- export interface PublishGalleryItemResponse {
417
+ interface ListGalleriesItemsResponse {
418
+ /** Retrieved media items. */
419
+ itemsInGalleries?: ItemsInGallery[];
602
420
  }
603
- export interface PublishGalleryItemsRequest {
421
+ interface ItemsInGallery {
604
422
  /**
605
- * id of the gallery that will be published
423
+ * Gallery ID.
606
424
  * @format GUID
607
425
  */
608
426
  galleryId?: string;
609
- /**
610
- * ids of the items that will be published
611
- * @format GUID
612
- * @minSize 1
613
- * @maxSize 100
614
- */
615
- itemIds?: string[];
616
- }
617
- export interface PublishGalleryItemsResponse {
618
- }
619
- export interface Empty {
620
- }
621
- export interface HtmlSitePublished {
622
- /**
623
- * Application instance ID
624
- * @maxLength 50
625
- */
626
- appInstanceId?: string;
627
- /**
628
- * Application type
629
- * @maxLength 100
630
- */
631
- appType?: string;
632
- /** Revision */
633
- revision?: string;
634
- /**
635
- * MSID
636
- * @maxLength 100
637
- */
638
- metaSiteId?: string | null;
639
- /**
640
- * optional branch id if publish is done from branch
641
- * @format GUID
642
- */
643
- branchId?: string | null;
644
- /** The site's last transactionId */
645
- lastTransactionId?: string | null;
646
- /** A list of the site's pages */
647
- pages?: EventsPage[];
648
- /** Site's publish date */
649
- publishDate?: string;
650
- }
651
- export interface EventsPage {
652
- /**
653
- * Page's Id
654
- * @maxLength 100
655
- */
656
- id?: string;
427
+ /** Retrieved media items. */
428
+ items?: Item[];
657
429
  }
658
- export interface HtmlSiteRCPublished {
659
- /**
660
- * Application instance ID
661
- * @maxLength 50
662
- */
663
- appInstanceId?: string;
664
- /** Revision */
665
- revision?: string;
430
+ interface TriggerRestoreAllGalleriesAsyncRequest {
666
431
  /**
667
- * Optional branch Id
432
+ * instance id of galleries to restore
668
433
  * @format GUID
669
434
  */
670
- branchId?: string | null;
671
- /** Site's publish date */
672
- publishDate?: string;
673
- /** RC label */
674
- rcLabel?: RCLabelWithLiterals;
675
- }
676
- export declare enum RCLabel {
677
- /** Illegal default value, exception will be thrown if used */
678
- UNKNOWN = "UNKNOWN",
679
- RELEASE_MANAGER = "RELEASE_MANAGER",
680
- BLOCKS = "BLOCKS",
681
- WIX_CLI = "WIX_CLI",
682
- MOBILE_APP_BUILDER = "MOBILE_APP_BUILDER",
683
- SEO = "SEO",
684
- FEEDBACK = "FEEDBACK",
685
- ACCESSIBILITY = "ACCESSIBILITY"
686
- }
687
- /** @enumType */
688
- export type RCLabelWithLiterals = RCLabel | 'UNKNOWN' | 'RELEASE_MANAGER' | 'BLOCKS' | 'WIX_CLI' | 'MOBILE_APP_BUILDER' | 'SEO' | 'FEEDBACK' | 'ACCESSIBILITY';
689
- export interface DomainEvent extends DomainEventBodyOneOf {
690
- createdEvent?: EntityCreatedEvent;
691
- updatedEvent?: EntityUpdatedEvent;
692
- deletedEvent?: EntityDeletedEvent;
693
- actionEvent?: ActionEvent;
694
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
695
- id?: string;
696
- /**
697
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
698
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
699
- */
700
- entityFqdn?: string;
701
- /**
702
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
703
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
704
- */
705
- slug?: string;
706
- /** ID of the entity associated with the event. */
707
- entityId?: string;
708
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
709
- eventTime?: Date | null;
710
- /**
711
- * Whether the event was triggered as a result of a privacy regulation application
712
- * (for example, GDPR).
713
- */
714
- triggeredByAnonymizeRequest?: boolean | null;
715
- /** If present, indicates the action that triggered the event. */
716
- originatedFrom?: string | null;
717
- /**
718
- * 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.
719
- * 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.
720
- */
721
- entityEventSequence?: string | null;
722
- }
723
- /** @oneof */
724
- export interface DomainEventBodyOneOf {
725
- createdEvent?: EntityCreatedEvent;
726
- updatedEvent?: EntityUpdatedEvent;
727
- deletedEvent?: EntityDeletedEvent;
728
- actionEvent?: ActionEvent;
729
- }
730
- export interface EntityCreatedEvent {
731
- entityAsJson?: string;
732
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
733
- restoreInfo?: RestoreInfo;
734
- }
735
- export interface RestoreInfo {
736
- deletedDate?: Date | null;
737
- }
738
- export interface EntityUpdatedEvent {
739
- /**
740
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
741
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
742
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
743
- */
744
- currentEntityAsJson?: string;
435
+ instanceId?: string;
745
436
  }
746
- export interface EntityDeletedEvent {
747
- /** Entity that was deleted. */
748
- deletedEntityAsJson?: string | null;
437
+ interface TriggerRestoreAllGalleriesAsyncResponse {
749
438
  }
750
- export interface ActionEvent {
751
- bodyAsJson?: string;
439
+ interface Empty {
752
440
  }
753
- export interface MessageEnvelope {
441
+ interface MessageEnvelope {
754
442
  /**
755
443
  * App instance ID.
756
444
  * @format GUID
@@ -766,7 +454,7 @@ export interface MessageEnvelope {
766
454
  /** Stringify payload. */
767
455
  data?: string;
768
456
  }
769
- export interface IdentificationData extends IdentificationDataIdOneOf {
457
+ interface IdentificationData extends IdentificationDataIdOneOf {
770
458
  /**
771
459
  * ID of a site visitor that has not logged in to the site.
772
460
  * @format GUID
@@ -791,7 +479,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
791
479
  identityType?: WebhookIdentityTypeWithLiterals;
792
480
  }
793
481
  /** @oneof */
794
- export interface IdentificationDataIdOneOf {
482
+ interface IdentificationDataIdOneOf {
795
483
  /**
796
484
  * ID of a site visitor that has not logged in to the site.
797
485
  * @format GUID
@@ -813,7 +501,7 @@ export interface IdentificationDataIdOneOf {
813
501
  */
814
502
  appId?: string;
815
503
  }
816
- export declare enum WebhookIdentityType {
504
+ declare enum WebhookIdentityType {
817
505
  UNKNOWN = "UNKNOWN",
818
506
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
819
507
  MEMBER = "MEMBER",
@@ -821,100 +509,39 @@ export declare enum WebhookIdentityType {
821
509
  APP = "APP"
822
510
  }
823
511
  /** @enumType */
824
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
825
- export interface RestoreAllGalleriesEvent {
826
- /**
827
- * instance id of galleries to restore
828
- * @format GUID
829
- */
830
- instanceId?: string;
831
- }
832
- export interface ListGalleriesItemsRequest {
833
- /**
834
- * IDs of the media items to retrieve.
835
- * @minSize 1
836
- * @maxSize 100
837
- */
838
- itemsId?: ItemId[];
839
- }
840
- export interface ItemId {
841
- /**
842
- * Gallery ID.
843
- * @format GUID
844
- */
845
- galleryId?: string;
846
- /**
847
- * Item ID.
848
- * @format GUID
849
- */
850
- itemId?: string;
851
- }
852
- export interface ListGalleriesItemsResponse {
853
- /** Retrieved media items. */
854
- itemsInGalleries?: ItemsInGallery[];
855
- }
856
- export interface ItemsInGallery {
857
- /**
858
- * Gallery ID.
859
- * @format GUID
860
- */
861
- galleryId?: string;
862
- /** Retrieved media items. */
863
- items?: Item[];
864
- }
865
- export interface TriggerRestoreAllGalleriesAsyncRequest {
866
- /**
867
- * instance id of galleries to restore
868
- * @format GUID
869
- */
870
- instanceId?: string;
871
- }
872
- export interface TriggerRestoreAllGalleriesAsyncResponse {
873
- }
874
- export interface GalleryItemCreated {
512
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
513
+ interface GalleryItemCreated {
875
514
  /** Created gallery item. */
876
515
  item?: Item;
877
516
  }
878
- export interface GalleryItemUpdated {
517
+ interface GalleryItemUpdated {
879
518
  /** Updated gallery item. */
880
519
  updatedItem?: Item;
881
520
  }
882
- export interface GalleryItemDeleted {
521
+ interface GalleryItemDeleted {
883
522
  /**
884
523
  * ID of the deleted gallery item.
885
524
  * @format GUID
886
525
  */
887
526
  itemId?: string;
888
527
  }
889
- export interface ListGalleriesRequest {
528
+ interface ListGalleriesRequest {
890
529
  /**
891
- * Maximum number of media items to return. <br />
892
- *
893
- * Min: `1` <br />
894
- * Max: `100` <br />
895
- * Default: `10`
530
+ * Number of galleries to list. Defaults to `10`.
896
531
  * @min 1
897
532
  * @max 100
898
533
  */
899
534
  itemLimit?: number | null;
900
- /**
901
- * Number of galleries to skip in the response. <br />
902
- *
903
- * Default: `0`
904
- */
535
+ /** Number of galleries to skip in the returns. Defaults to `0`. */
905
536
  offset?: number | null;
906
537
  /**
907
- * Maximum number of galleries to return. <br />
908
- *
909
- * Min: `1` <br />
910
- * Max: `10` <br />
911
- * Default: `10`
538
+ * Number of galleries to list. Defaults to `10`.
912
539
  * @min 1
913
540
  * @max 10
914
541
  */
915
542
  limit?: number | null;
916
543
  }
917
- export declare enum State {
544
+ declare enum State {
918
545
  /** Undefined state. */
919
546
  UNDEFINED = "UNDEFINED",
920
547
  /** The gallery in the Editor. */
@@ -922,25 +549,19 @@ export declare enum State {
922
549
  /** The gallery in the LiveSite. */
923
550
  PUBLISHED = "PUBLISHED"
924
551
  }
925
- /** @enumType */
926
- export type StateWithLiterals = State | 'UNDEFINED' | 'SAVED' | 'PUBLISHED';
927
- export interface ListGalleriesResponse {
552
+ interface ListGalleriesResponse {
928
553
  /** Total number of galleries in the site. */
929
554
  totalGalleries?: number | null;
930
- /** List of galleries. Sorted by `createdDate`. */
555
+ /** List of galleries. Sorted by `_createdDate`. */
931
556
  galleries?: Gallery[];
932
557
  }
933
- export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
558
+ interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
934
559
  /**
935
560
  * Gallery ID.
936
561
  * @format GUID
937
562
  */
938
563
  galleryId: string;
939
- /**
940
- * Number of media items to skip in the response. <br />
941
- *
942
- * Default: `0`
943
- */
564
+ /** Number of media items to skip in the returns. Defaults to `0`. */
944
565
  itemOffset?: number | null;
945
566
  /**
946
567
  * Maximum number of media items to return. <br />
@@ -954,23 +575,19 @@ export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
954
575
  itemLimit?: number | null;
955
576
  }
956
577
  /** @oneof */
957
- export interface GetGalleryRequestVersionOneOf {
578
+ interface GetGalleryRequestVersionOneOf {
958
579
  }
959
- export interface GetGalleryResponse {
580
+ interface GetGalleryResponse {
960
581
  /** Returned gallery. */
961
582
  gallery?: Gallery;
962
583
  }
963
- export interface ListGalleryItemsRequest {
584
+ interface ListGalleryItemsRequest {
964
585
  /**
965
586
  * Gallery ID.
966
587
  * @format GUID
967
588
  */
968
589
  galleryId: string;
969
- /**
970
- * Number of media items to skip in the response. <br />
971
- *
972
- * Default: `0`
973
- */
590
+ /** Number of media items to skip in the returns. Defaults to `0`. */
974
591
  itemOffset?: number | null;
975
592
  /**
976
593
  * Maximum number of media items to return. <br />
@@ -983,11 +600,11 @@ export interface ListGalleryItemsRequest {
983
600
  */
984
601
  itemLimit?: number | null;
985
602
  }
986
- export interface ListGalleryItemsResponse {
603
+ interface ListGalleryItemsResponse {
987
604
  /** List of media items in the gallery. */
988
605
  items?: Item[];
989
606
  }
990
- export interface GetGalleryItemRequest {
607
+ interface GetGalleryItemRequest {
991
608
  /**
992
609
  * Gallery ID.
993
610
  * @format GUID
@@ -999,11 +616,11 @@ export interface GetGalleryItemRequest {
999
616
  */
1000
617
  itemId: string;
1001
618
  }
1002
- export interface GetGalleryItemResponse {
619
+ interface GetGalleryItemResponse {
1003
620
  /** Returned media item. */
1004
621
  item?: Item;
1005
622
  }
1006
- export interface CreateGalleryRequest {
623
+ interface CreateGalleryRequest {
1007
624
  /** Gallery to create. */
1008
625
  gallery?: Gallery;
1009
626
  /**
@@ -1012,26 +629,26 @@ export interface CreateGalleryRequest {
1012
629
  */
1013
630
  cloneFromGalleryId?: string | null;
1014
631
  }
1015
- export interface CreateGalleryResponse {
632
+ interface CreateGalleryResponse {
1016
633
  /** Created gallery. */
1017
634
  gallery?: Gallery;
1018
635
  }
1019
- export interface UpdateGalleryRequest {
636
+ interface UpdateGalleryRequest {
1020
637
  /** Gallery to update. */
1021
638
  gallery: Gallery;
1022
639
  }
1023
- export interface UpdateGalleryResponse {
640
+ interface UpdateGalleryResponse {
1024
641
  /** Updated gallery. */
1025
642
  gallery?: Gallery;
1026
643
  }
1027
- export interface DeleteGalleryRequest {
644
+ interface DeleteGalleryRequest {
1028
645
  /**
1029
646
  * ID of the gallery to delete.
1030
647
  * @format GUID
1031
648
  */
1032
649
  galleryId: string;
1033
650
  }
1034
- export interface DeleteGalleryResponse {
651
+ interface DeleteGalleryResponse {
1035
652
  /**
1036
653
  * ID of the deleted gallery.
1037
654
  * @readonly
@@ -1039,7 +656,7 @@ export interface DeleteGalleryResponse {
1039
656
  */
1040
657
  galleryId?: string;
1041
658
  }
1042
- export interface DeleteGalleryItemsRequest {
659
+ interface DeleteGalleryItemsRequest {
1043
660
  /**
1044
661
  * Gallery ID.
1045
662
  * @format GUID
@@ -1051,11 +668,11 @@ export interface DeleteGalleryItemsRequest {
1051
668
  */
1052
669
  itemsIds?: string[];
1053
670
  }
1054
- export interface DeleteGalleryItemsResponse {
671
+ interface DeleteGalleryItemsResponse {
1055
672
  /** Gallery that previously included the deleted media item. */
1056
673
  gallery?: Gallery;
1057
674
  }
1058
- export interface BulkDeleteGalleryItemsRequest {
675
+ interface BulkDeleteGalleryItemsRequest {
1059
676
  /**
1060
677
  * Gallery ID.
1061
678
  * @format GUID
@@ -1069,7 +686,7 @@ export interface BulkDeleteGalleryItemsRequest {
1069
686
  */
1070
687
  itemIds: string[];
1071
688
  }
1072
- export interface BulkDeleteGalleryItemsResponse {
689
+ interface BulkDeleteGalleryItemsResponse {
1073
690
  /**
1074
691
  * IDs of the deleted media items.
1075
692
  * @readonly
@@ -1077,7 +694,7 @@ export interface BulkDeleteGalleryItemsResponse {
1077
694
  */
1078
695
  itemIds?: string[];
1079
696
  }
1080
- export interface CreateGalleryItemRequest {
697
+ interface CreateGalleryItemRequest {
1081
698
  /**
1082
699
  * Gallery ID.
1083
700
  * @format GUID
@@ -1086,11 +703,11 @@ export interface CreateGalleryItemRequest {
1086
703
  /** Media item to create. */
1087
704
  item: Item;
1088
705
  }
1089
- export interface CreateGalleryItemResponse {
706
+ interface CreateGalleryItemResponse {
1090
707
  /** Created media item. */
1091
708
  item?: Item;
1092
709
  }
1093
- export interface CreateGalleryItemsRequest {
710
+ interface CreateGalleryItemsRequest {
1094
711
  /**
1095
712
  * Gallery ID.
1096
713
  * @format GUID
@@ -1102,24 +719,24 @@ export interface CreateGalleryItemsRequest {
1102
719
  */
1103
720
  items?: Item[];
1104
721
  }
1105
- export interface CreateGalleryItemsResponse {
722
+ interface CreateGalleryItemsResponse {
1106
723
  /** Created media items. */
1107
724
  items?: Item[];
1108
725
  }
1109
- export interface UpdateGalleryItemRequest {
726
+ interface UpdateGalleryItemRequest {
1110
727
  /**
1111
728
  * Gallery ID.
1112
729
  * @format GUID
1113
730
  */
1114
731
  galleryId: string;
1115
- /** Media item to update. */
732
+ /** The information for the media item being updated. */
1116
733
  item: Item;
1117
734
  }
1118
- export interface UpdateGalleryItemResponse {
735
+ interface UpdateGalleryItemResponse {
1119
736
  /** Updated media item. */
1120
737
  item?: Item;
1121
738
  }
1122
- export interface DeleteGalleryItemRequest {
739
+ interface DeleteGalleryItemRequest {
1123
740
  /**
1124
741
  * Gallery ID.
1125
742
  * @format GUID
@@ -1131,7 +748,7 @@ export interface DeleteGalleryItemRequest {
1131
748
  */
1132
749
  itemId: string;
1133
750
  }
1134
- export interface DeleteGalleryItemResponse {
751
+ interface DeleteGalleryItemResponse {
1135
752
  /**
1136
753
  * ID of the deleted media item.
1137
754
  * @readonly
@@ -1139,18 +756,81 @@ export interface DeleteGalleryItemResponse {
1139
756
  */
1140
757
  itemId?: string;
1141
758
  }
1142
- export interface PublishGalleryRequest {
759
+ interface PublishGalleryRequest {
1143
760
  /**
1144
761
  * ID of the gallery to publish.
1145
762
  * @format GUID
1146
763
  */
1147
764
  galleryId?: string;
1148
765
  }
1149
- export interface PublishGalleryResponse {
766
+ interface PublishGalleryResponse {
1150
767
  /** Published gallery. */
1151
768
  gallery?: Gallery;
1152
769
  }
1153
- export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
770
+ interface DomainEvent extends DomainEventBodyOneOf {
771
+ /** Information about a newly-created gallery. */
772
+ createdEvent?: EntityCreatedEvent;
773
+ updatedEvent?: EntityUpdatedEvent;
774
+ deletedEvent?: EntityDeletedEvent;
775
+ actionEvent?: ActionEvent;
776
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
777
+ _id?: string;
778
+ /**
779
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
780
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
781
+ */
782
+ entityFqdn?: string;
783
+ /**
784
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
785
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
786
+ */
787
+ slug?: string;
788
+ /** ID of the entity associated with the event. */
789
+ entityId?: string;
790
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
791
+ eventTime?: Date | null;
792
+ /**
793
+ * Whether the event was triggered as a result of a privacy regulation application
794
+ * (for example, GDPR).
795
+ */
796
+ triggeredByAnonymizeRequest?: boolean | null;
797
+ /** If present, indicates the action that triggered the event. */
798
+ originatedFrom?: string | null;
799
+ /**
800
+ * 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.
801
+ * 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.
802
+ */
803
+ entityEventSequence?: string | null;
804
+ }
805
+ /** @oneof */
806
+ interface DomainEventBodyOneOf {
807
+ createdEvent?: EntityCreatedEvent;
808
+ updatedEvent?: EntityUpdatedEvent;
809
+ deletedEvent?: EntityDeletedEvent;
810
+ actionEvent?: ActionEvent;
811
+ }
812
+ interface EntityCreatedEvent {
813
+ entity?: string;
814
+ }
815
+ interface RestoreInfo {
816
+ deletedDate?: Date | null;
817
+ }
818
+ interface EntityUpdatedEvent {
819
+ /**
820
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
821
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
822
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
823
+ */
824
+ currentEntity?: string;
825
+ }
826
+ interface EntityDeletedEvent {
827
+ /** Entity that was deleted. */
828
+ deletedEntity?: string | null;
829
+ }
830
+ interface ActionEvent {
831
+ body?: string;
832
+ }
833
+ interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
1154
834
  /** insert/update documents */
1155
835
  update?: DocumentUpdateOperation;
1156
836
  /** delete by document ids */
@@ -1183,7 +863,7 @@ export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf
1183
863
  msId?: string | null;
1184
864
  }
1185
865
  /** @oneof */
1186
- export interface UpdateDocumentsEventOperationOneOf {
866
+ interface UpdateDocumentsEventOperationOneOf {
1187
867
  /** insert/update documents */
1188
868
  update?: DocumentUpdateOperation;
1189
869
  /** delete by document ids */
@@ -1195,11 +875,11 @@ export interface UpdateDocumentsEventOperationOneOf {
1195
875
  /** update only existing documents */
1196
876
  updateExisting?: UpdateExistingOperation;
1197
877
  }
1198
- export interface DocumentUpdateOperation {
878
+ interface DocumentUpdateOperation {
1199
879
  /** documents to index or update */
1200
880
  documents?: IndexDocument[];
1201
881
  }
1202
- export interface IndexDocument {
882
+ interface IndexDocument {
1203
883
  /** data bag with non-searchable fields (url, image) */
1204
884
  payload?: DocumentPayload;
1205
885
  /** what type of users should documents be visible to */
@@ -1213,13 +893,13 @@ export interface IndexDocument {
1213
893
  /** if true the page is a lightbox popup */
1214
894
  isPopup?: boolean | null;
1215
895
  }
1216
- export interface DocumentPayload {
896
+ interface DocumentPayload {
1217
897
  /** url of the page representing the document */
1218
898
  url?: string | null;
1219
899
  /** image which represents the document */
1220
900
  documentImage?: DocumentImage;
1221
901
  }
1222
- export interface DocumentImage {
902
+ interface DocumentImage {
1223
903
  /** the name of the image */
1224
904
  name?: string;
1225
905
  /** the width of the image */
@@ -1227,7 +907,7 @@ export interface DocumentImage {
1227
907
  /** the height of the image */
1228
908
  height?: number;
1229
909
  }
1230
- export declare enum Enum {
910
+ declare enum Enum {
1231
911
  /** Default value. Means that permission not set */
1232
912
  UNKNOWN = "UNKNOWN",
1233
913
  /** Protected exposure. Exposed to members and owners */
@@ -1242,26 +922,26 @@ export declare enum Enum {
1242
922
  GROUP_PROTECTED = "GROUP_PROTECTED"
1243
923
  }
1244
924
  /** @enumType */
1245
- export type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
1246
- export interface DeleteByIdsOperation {
925
+ type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
926
+ interface DeleteByIdsOperation {
1247
927
  /** ids of the documents to delete */
1248
928
  documentIds?: string[];
1249
929
  }
1250
- export interface DeleteByFilterOperation {
930
+ interface DeleteByFilterOperation {
1251
931
  /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1252
932
  filter?: Record<string, any> | null;
1253
933
  }
1254
- export interface UpdateByFilterOperation {
934
+ interface UpdateByFilterOperation {
1255
935
  /** documents matching this filter will be updated */
1256
936
  filter?: Record<string, any> | null;
1257
937
  /** partial document to apply */
1258
938
  document?: IndexDocument;
1259
939
  }
1260
- export interface UpdateExistingOperation {
940
+ interface UpdateExistingOperation {
1261
941
  /** documents to update */
1262
942
  documents?: IndexDocument[];
1263
943
  }
1264
- export interface SearchIndexingNotification {
944
+ interface SearchIndexingNotification {
1265
945
  /** new state of indexing for the site specified in ms_id */
1266
946
  indexState?: SearchIndexingNotificationStateWithLiterals;
1267
947
  /** type of the document the notification is targeted for. Applies to all types if not provided */
@@ -1274,7 +954,7 @@ export interface SearchIndexingNotification {
1274
954
  */
1275
955
  msId?: string | null;
1276
956
  }
1277
- export declare enum SearchIndexingNotificationState {
957
+ declare enum SearchIndexingNotificationState {
1278
958
  /** default state */
1279
959
  Unknown = "Unknown",
1280
960
  /** metasite does not require site search indexing */
@@ -1283,4 +963,246 @@ export declare enum SearchIndexingNotificationState {
1283
963
  On = "On"
1284
964
  }
1285
965
  /** @enumType */
1286
- export type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
966
+ type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
967
+ interface BaseEventMetadata {
968
+ /**
969
+ * App instance ID.
970
+ * @format GUID
971
+ */
972
+ instanceId?: string | null;
973
+ /**
974
+ * Event type.
975
+ * @maxLength 150
976
+ */
977
+ eventType?: string;
978
+ /** The identification type and identity data. */
979
+ identity?: IdentificationData;
980
+ }
981
+ interface EventMetadata extends BaseEventMetadata {
982
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
983
+ _id?: string;
984
+ /**
985
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
986
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
987
+ */
988
+ entityFqdn?: string;
989
+ /**
990
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
991
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
992
+ */
993
+ slug?: string;
994
+ /** ID of the entity associated with the event. */
995
+ entityId?: string;
996
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
997
+ eventTime?: Date | null;
998
+ /**
999
+ * Whether the event was triggered as a result of a privacy regulation application
1000
+ * (for example, GDPR).
1001
+ */
1002
+ triggeredByAnonymizeRequest?: boolean | null;
1003
+ /** If present, indicates the action that triggered the event. */
1004
+ originatedFrom?: string | null;
1005
+ /**
1006
+ * 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.
1007
+ * 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.
1008
+ */
1009
+ entityEventSequence?: string | null;
1010
+ }
1011
+ interface GalleryCreatedEnvelope {
1012
+ entity: Gallery;
1013
+ metadata: EventMetadata;
1014
+ }
1015
+ interface GalleryDeletedEnvelope {
1016
+ metadata: EventMetadata;
1017
+ }
1018
+ interface GalleryItemCreatedEnvelope {
1019
+ data: GalleryItemCreated;
1020
+ metadata: EventMetadata;
1021
+ }
1022
+ interface GalleryItemDeletedEnvelope {
1023
+ data: GalleryItemDeleted;
1024
+ metadata: EventMetadata;
1025
+ }
1026
+ interface GalleryItemUpdatedEnvelope {
1027
+ data: GalleryItemUpdated;
1028
+ metadata: EventMetadata;
1029
+ }
1030
+ interface GalleryUpdatedEnvelope {
1031
+ entity: Gallery;
1032
+ metadata: EventMetadata;
1033
+ }
1034
+ interface ListGalleriesOptions {
1035
+ /**
1036
+ * Number of galleries to list. Defaults to `10`.
1037
+ * @min 1
1038
+ * @max 100
1039
+ */
1040
+ itemLimit?: number | null;
1041
+ /** Number of galleries to skip in the returns. Defaults to `0`. */
1042
+ offset?: number | null;
1043
+ /**
1044
+ * Number of galleries to list. Defaults to `10`.
1045
+ * @min 1
1046
+ * @max 10
1047
+ */
1048
+ limit?: number | null;
1049
+ }
1050
+ interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
1051
+ /** Number of media items to skip in the returns. Defaults to `0`. */
1052
+ itemOffset?: number | null;
1053
+ /**
1054
+ * Maximum number of media items to return. <br />
1055
+ *
1056
+ * Min: `1` <br />
1057
+ * Max: `100` <br />
1058
+ * Default: `50`
1059
+ * @min 1
1060
+ * @max 200
1061
+ */
1062
+ itemLimit?: number | null;
1063
+ }
1064
+ /** @oneof */
1065
+ interface GetGalleryOptionsVersionOneOf {
1066
+ }
1067
+ interface ListGalleryItemsOptions {
1068
+ /** Number of media items to skip in the returns. Defaults to `0`. */
1069
+ itemOffset?: number | null;
1070
+ /**
1071
+ * Maximum number of media items to return. <br />
1072
+ *
1073
+ * Min: `1` <br />
1074
+ * Max: `100` <br />
1075
+ * Default: `50`
1076
+ * @min 1
1077
+ * @max 200
1078
+ */
1079
+ itemLimit?: number | null;
1080
+ }
1081
+ interface GetGalleryItemIdentifiers {
1082
+ /**
1083
+ * Gallery ID.
1084
+ * @format GUID
1085
+ */
1086
+ galleryId: string;
1087
+ /**
1088
+ * Item ID.
1089
+ * @format GUID
1090
+ */
1091
+ itemId: string;
1092
+ }
1093
+ interface CreateGalleryOptions {
1094
+ /** Gallery to create. */
1095
+ gallery?: Gallery;
1096
+ /**
1097
+ * Gallery ID to clone from.
1098
+ * @format GUID
1099
+ */
1100
+ cloneFromGalleryId?: string | null;
1101
+ }
1102
+ interface UpdateGallery {
1103
+ /**
1104
+ * Gallery ID.
1105
+ * @readonly
1106
+ * @format GUID
1107
+ */
1108
+ _id?: string | null;
1109
+ /** Gallery name. */
1110
+ name?: string | null;
1111
+ /**
1112
+ * Total number of items in the gallery.
1113
+ * @readonly
1114
+ */
1115
+ totalItems?: number | null;
1116
+ /** Media items in the gallery. */
1117
+ items?: Item[];
1118
+ /**
1119
+ * Index that determines which position a gallery is displayed on the site. <br />
1120
+ *
1121
+ * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
1122
+ */
1123
+ sortOrder?: number | null;
1124
+ /**
1125
+ * Date and time the gallery was created.
1126
+ * @readonly
1127
+ */
1128
+ _createdDate?: Date | null;
1129
+ }
1130
+ interface DeleteGalleryItemsOptions {
1131
+ /**
1132
+ * ID of the media item to delete.
1133
+ * @format GUID
1134
+ */
1135
+ itemsIds?: string[];
1136
+ }
1137
+ interface UpdateGalleryItemIdentifiers {
1138
+ /**
1139
+ * ID of the gallery containing the item to update.
1140
+ * @format GUID
1141
+ */
1142
+ galleryId: string;
1143
+ /**
1144
+ * ID of the item to update.
1145
+ * @readonly
1146
+ * @format GUID
1147
+ */
1148
+ itemId?: string | null;
1149
+ }
1150
+ interface UpdateGalleryItem {
1151
+ /** Details about the image. */
1152
+ image?: Image;
1153
+ /** Details about the video. */
1154
+ video?: Video;
1155
+ /** Details about the text file. */
1156
+ text?: Text;
1157
+ /**
1158
+ * Item ID.
1159
+ * @readonly
1160
+ * @format GUID
1161
+ */
1162
+ _id?: string | null;
1163
+ /**
1164
+ * Index that determines which position a media item is displayed in the gallery. <br />
1165
+ *
1166
+ * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
1167
+ *
1168
+ * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
1169
+ */
1170
+ sortOrder?: number | null;
1171
+ /** Item title. */
1172
+ title?: string | null;
1173
+ /** Item description. */
1174
+ description?: string | null;
1175
+ /** Link from the item. You can link to Wix sites or external URLs. */
1176
+ link?: Link;
1177
+ /**
1178
+ * Type of item.
1179
+ * @readonly
1180
+ */
1181
+ type?: TypeWithLiterals;
1182
+ /**
1183
+ * Date and time the item was created.
1184
+ * @readonly
1185
+ */
1186
+ _createdDate?: Date | null;
1187
+ /**
1188
+ * Date and time the item was last updated.
1189
+ * @readonly
1190
+ */
1191
+ _updatedDate?: Date | null;
1192
+ /** Item tags. */
1193
+ tags?: Tags;
1194
+ }
1195
+ interface DeleteGalleryItemIdentifiers {
1196
+ /**
1197
+ * Gallery ID.
1198
+ * @format GUID
1199
+ */
1200
+ galleryId: string;
1201
+ /**
1202
+ * ID of the media item to delete.
1203
+ * @format GUID
1204
+ */
1205
+ itemId: string;
1206
+ }
1207
+
1208
+ export { type Tags as $, type AnchorLink as A, type BulkDeleteGalleryItemsResponse as B, type CreateGalleryOptions as C, type DeleteGalleryResponse as D, Enum as E, type DynamicPageLink as F, type GetGalleryOptions as G, type DocumentLink as H, type Item as I, type EmailLink as J, type PhoneLink as K, type ListGalleriesOptions as L, type AddressLink as M, type WhatsAppLink as N, type TpaPageLink as O, type PageLink as P, type Image as Q, type Point as R, State as S, Type as T, type UpdateGallery as U, VideoType as V, WebhookIdentityType as W, type UnsharpMasking as X, type Video as Y, type VideoResolution as Z, type Text as _, type ListGalleriesResponse as a, type SecondaryMedia as a0, type SecondaryMediaMetadataOneOf as a1, type RestoreAllGalleriesEvent as a2, type ListGalleriesItemsRequest as a3, type ItemId as a4, type ListGalleriesItemsResponse as a5, type ItemsInGallery as a6, type TriggerRestoreAllGalleriesAsyncRequest as a7, type TriggerRestoreAllGalleriesAsyncResponse as a8, type Empty as a9, type DeleteGalleryItemRequest as aA, type PublishGalleryRequest as aB, type PublishGalleryResponse as aC, type DomainEvent as aD, type DomainEventBodyOneOf as aE, type EntityCreatedEvent as aF, type RestoreInfo as aG, type EntityUpdatedEvent as aH, type EntityDeletedEvent as aI, type ActionEvent as aJ, type UpdateDocumentsEvent as aK, type UpdateDocumentsEventOperationOneOf as aL, type DocumentUpdateOperation as aM, type IndexDocument as aN, type DocumentPayload as aO, type DocumentImage as aP, type DeleteByIdsOperation as aQ, type DeleteByFilterOperation as aR, type UpdateByFilterOperation as aS, type UpdateExistingOperation as aT, type SearchIndexingNotification as aU, type BaseEventMetadata as aV, type EventMetadata as aW, type GetGalleryOptionsVersionOneOf as aX, type MessageEnvelope as aa, type IdentificationData as ab, type IdentificationDataIdOneOf as ac, type GalleryItemCreated as ad, type GalleryItemUpdated as ae, type GalleryItemDeleted as af, type ListGalleriesRequest as ag, type GetGalleryRequest as ah, type GetGalleryRequestVersionOneOf as ai, type GetGalleryResponse as aj, type ListGalleryItemsRequest as ak, type GetGalleryItemRequest as al, type GetGalleryItemResponse as am, type CreateGalleryRequest as an, type CreateGalleryResponse as ao, type UpdateGalleryRequest as ap, type UpdateGalleryResponse as aq, type DeleteGalleryRequest as ar, type DeleteGalleryItemsRequest as as, type BulkDeleteGalleryItemsRequest as at, type CreateGalleryItemRequest as au, type CreateGalleryItemResponse as av, type CreateGalleryItemsRequest as aw, type CreateGalleryItemsResponse as ax, type UpdateGalleryItemRequest as ay, type UpdateGalleryItemResponse as az, type Gallery as b, type ListGalleryItemsOptions as c, type ListGalleryItemsResponse as d, type GetGalleryItemIdentifiers as e, type DeleteGalleryItemsOptions as f, type DeleteGalleryItemsResponse as g, type UpdateGalleryItemIdentifiers as h, type UpdateGalleryItem as i, type DeleteGalleryItemIdentifiers as j, type DeleteGalleryItemResponse as k, type GalleryCreatedEnvelope as l, type GalleryDeletedEnvelope as m, type GalleryItemCreatedEnvelope as n, type GalleryItemDeletedEnvelope as o, type GalleryItemUpdatedEnvelope as p, type GalleryUpdatedEnvelope as q, LinkType as r, LinkRel as s, ImageType as t, SearchIndexingNotificationState as u, type ItemMetadataOneOf as v, type Link as w, type WixLink as x, type WixLinkLinkOneOf as y, type ExternalLink as z };