@wix/auto_sdk_pro-gallery_pro-gallery 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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +56 -0
  11. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +69 -0
  12. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -0
  13. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +90 -0
  14. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +821 -0
  15. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -0
  16. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +47 -0
  17. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js +256 -0
  18. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +1 -0
  19. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +167 -0
  20. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js +309 -0
  21. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -0
  22. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +1138 -0
  23. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +102 -0
  24. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -0
  25. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +1606 -0
  26. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +849 -0
  27. package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +56 -0
  39. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +56 -0
  40. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -0
  41. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +90 -0
  42. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +806 -0
  43. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -0
  44. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +47 -0
  45. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js +218 -0
  46. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +1 -0
  47. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +167 -0
  48. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.js +284 -0
  49. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -0
  50. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +1138 -0
  51. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +99 -0
  52. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -0
  53. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +1606 -0
  54. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +811 -0
  55. package/build/es/src/pro-gallery-v2-gallery-pro-gallery.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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +56 -0
  66. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +69 -0
  67. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -0
  68. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +90 -0
  69. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +821 -0
  70. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -0
  71. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +47 -0
  72. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js +256 -0
  73. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +1 -0
  74. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +167 -0
  75. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js +309 -0
  76. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -0
  77. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +1138 -0
  78. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +102 -0
  79. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -0
  80. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +1606 -0
  81. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +849 -0
  82. package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +56 -0
  93. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +56 -0
  94. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -0
  95. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +90 -0
  96. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +806 -0
  97. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -0
  98. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.d.ts +47 -0
  99. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js +218 -0
  100. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.meta.js.map +1 -0
  101. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +167 -0
  102. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.js +284 -0
  103. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -0
  104. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +1138 -0
  105. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +99 -0
  106. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -0
  107. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +1606 -0
  108. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +811 -0
  109. package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1606 @@
1
+ export interface Gallery {
2
+ /**
3
+ * Gallery ID.
4
+ * @readonly
5
+ */
6
+ _id?: string | null;
7
+ /** Gallery name. */
8
+ name?: string | null;
9
+ /**
10
+ * Total number of items in the gallery.
11
+ * @readonly
12
+ */
13
+ totalItems?: number | null;
14
+ /** Media items in the gallery. */
15
+ items?: Item[];
16
+ /**
17
+ * Index that determines which position a gallery is displayed on the site. <br />
18
+ *
19
+ * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
20
+ */
21
+ sortOrder?: number | null;
22
+ /**
23
+ * Date and time the gallery was created.
24
+ * @readonly
25
+ */
26
+ _createdDate?: Date | null;
27
+ }
28
+ export interface Item extends ItemMetadataOneOf {
29
+ /** Details about the image. */
30
+ image?: Image;
31
+ /** Details about the video. */
32
+ video?: Video;
33
+ /** Details about the text file. */
34
+ text?: Text;
35
+ /**
36
+ * Item ID.
37
+ * @readonly
38
+ */
39
+ _id?: string | null;
40
+ /**
41
+ * Index that determines which position a media item is displayed in the gallery. <br />
42
+ *
43
+ * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
44
+ *
45
+ * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
46
+ */
47
+ sortOrder?: number | null;
48
+ /** Item title. */
49
+ title?: string | null;
50
+ /** Item description. */
51
+ description?: string | null;
52
+ /** Link from the item. You can link to Wix sites or external URLs. */
53
+ link?: Link;
54
+ /**
55
+ * Type of item.
56
+ * @readonly
57
+ */
58
+ type?: Type;
59
+ /**
60
+ * Date and time the item was created.
61
+ * @readonly
62
+ */
63
+ _createdDate?: Date | null;
64
+ /**
65
+ * Date and time the item was last updated.
66
+ * @readonly
67
+ */
68
+ _updatedDate?: Date | null;
69
+ /** Item tags. */
70
+ tags?: Tags;
71
+ }
72
+ /** @oneof */
73
+ export interface ItemMetadataOneOf {
74
+ /** Details about the image. */
75
+ image?: Image;
76
+ /** Details about the video. */
77
+ video?: Video;
78
+ /** Details about the text file. */
79
+ text?: Text;
80
+ }
81
+ export interface Link {
82
+ /** Display text of the link. */
83
+ text?: string | null;
84
+ /** Target URL of the link. */
85
+ url?: string | null;
86
+ }
87
+ export declare enum LinkType {
88
+ UNDEFINED = "UNDEFINED",
89
+ /** External link. */
90
+ EXTERNAL = "EXTERNAL",
91
+ /** For internal usage using wixLinkData. */
92
+ INTERNAL = "INTERNAL"
93
+ }
94
+ /** The link object generated by panels in the editor and used by applications in Wix */
95
+ export interface WixLink extends WixLinkLinkOneOf {
96
+ /** External link type */
97
+ external?: ExternalLink;
98
+ /** Page link type */
99
+ page?: PageLink;
100
+ /** Anchor link type */
101
+ anchor?: AnchorLink;
102
+ /** Dynamic page link type */
103
+ dynamicPage?: DynamicPageLink;
104
+ /** Document link type */
105
+ document?: DocumentLink;
106
+ /** Email link type */
107
+ email?: EmailLink;
108
+ /** Phone link type */
109
+ phone?: PhoneLink;
110
+ /** Address link type */
111
+ address?: AddressLink;
112
+ /** WhatsApp link type */
113
+ whatsApp?: WhatsAppLink;
114
+ /** TPA link type */
115
+ tpaPage?: TpaPageLink;
116
+ }
117
+ /** @oneof */
118
+ export interface WixLinkLinkOneOf {
119
+ /** External link type */
120
+ external?: ExternalLink;
121
+ /** Page link type */
122
+ page?: PageLink;
123
+ /** Anchor link type */
124
+ anchor?: AnchorLink;
125
+ /** Dynamic page link type */
126
+ dynamicPage?: DynamicPageLink;
127
+ /** Document link type */
128
+ document?: DocumentLink;
129
+ /** Email link type */
130
+ email?: EmailLink;
131
+ /** Phone link type */
132
+ phone?: PhoneLink;
133
+ /** Address link type */
134
+ address?: AddressLink;
135
+ /** WhatsApp link type */
136
+ whatsApp?: WhatsAppLink;
137
+ /** TPA link type */
138
+ tpaPage?: TpaPageLink;
139
+ }
140
+ export interface ExternalLink {
141
+ /** The url of the page */
142
+ url?: string;
143
+ /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
144
+ target?: string | null;
145
+ }
146
+ /**
147
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
148
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
149
+ * Following are the accepted 'rel' types by Wix applications.
150
+ */
151
+ export declare enum LinkRel {
152
+ /** default (not implemented) */
153
+ unknown_link_rel = "unknown_link_rel",
154
+ /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
155
+ nofollow = "nofollow",
156
+ /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
157
+ noopener = "noopener",
158
+ /** No Referer header will be included. Additionally, has the same effect as noopener. */
159
+ noreferrer = "noreferrer",
160
+ /** Indicates a link that resulted from advertisements or paid placements. */
161
+ sponsored = "sponsored"
162
+ }
163
+ export interface PageLink {
164
+ /** The page id we want from the site */
165
+ pageId?: string;
166
+ /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
167
+ target?: string | null;
168
+ /** rel of link */
169
+ rel?: LinkRel[];
170
+ }
171
+ export interface AnchorLink {
172
+ /** The name of the anchor */
173
+ anchorName?: string;
174
+ /** The data id (from the JSON page) of the anchor that should be used */
175
+ anchorDataId?: string;
176
+ /** The page id we want from the site */
177
+ pageId?: string;
178
+ /** rel of link */
179
+ rel?: LinkRel[];
180
+ }
181
+ export interface DynamicPageLink {
182
+ /** The router that handles this link */
183
+ routerId?: string;
184
+ /** The path data we'd like */
185
+ innerRoute?: string;
186
+ /** The data id (from the JSON page) of the anchor that should be used */
187
+ anchorDataId?: string | null;
188
+ /** rel of link */
189
+ rel?: LinkRel[];
190
+ }
191
+ export interface DocumentLink {
192
+ /** The id of the document */
193
+ docId?: string;
194
+ /** The name of the document for download purposes */
195
+ name?: string | null;
196
+ /** If this document can be indexed by scrapers, default is false */
197
+ indexable?: boolean;
198
+ }
199
+ export interface EmailLink {
200
+ /** The email we will be sending a message to */
201
+ recipient?: string;
202
+ /** The subject of the email */
203
+ subject?: string | null;
204
+ /** The body of the email */
205
+ body?: string | null;
206
+ }
207
+ export interface PhoneLink {
208
+ /** The phone number we want to link to */
209
+ phoneNumber?: string;
210
+ }
211
+ export interface AddressLink {
212
+ /** An address that we can link to */
213
+ address?: string;
214
+ }
215
+ export interface WhatsAppLink {
216
+ /** The whatsApp phone number we want to connect with */
217
+ phoneNumber?: string;
218
+ }
219
+ /** Link to a TPA page */
220
+ export interface TpaPageLink {
221
+ /** Type of item (e.g. 'wix.stores.sub_pages.product') */
222
+ itemTypeIdentifier?: string;
223
+ /** Id of linked item */
224
+ itemId?: string;
225
+ /** Id of linked page */
226
+ pageId?: string;
227
+ /** Id of app being linked to (AppDefId) */
228
+ appDefinitionId?: string;
229
+ /** The relativepath of linked page */
230
+ path?: string;
231
+ /** rel of link */
232
+ rel?: LinkRel[];
233
+ }
234
+ export declare enum Type {
235
+ UNDEFINED = "UNDEFINED",
236
+ IMAGE = "IMAGE",
237
+ VIDEO = "VIDEO",
238
+ TEXT = "TEXT"
239
+ }
240
+ export interface Image {
241
+ /** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
242
+ imageInfo?: string;
243
+ /** Focal point of the image. */
244
+ focalPoint?: Point;
245
+ /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
246
+ exif?: Record<string, any> | null;
247
+ /**
248
+ * Image compression level. <br />
249
+ *
250
+ * Min: `30` <br />
251
+ * Max: `100`
252
+ */
253
+ quality?: number | null;
254
+ /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
255
+ unsharpMasking?: UnsharpMasking;
256
+ }
257
+ export declare enum ImageType {
258
+ UNDEFINED = "UNDEFINED",
259
+ WIX_MEDIA = "WIX_MEDIA",
260
+ EXTERNAL = "EXTERNAL"
261
+ }
262
+ export interface Point {
263
+ /** X-coordinate of the focal point. */
264
+ x?: number;
265
+ /** Y-coordinate of the focal point. */
266
+ y?: number;
267
+ }
268
+ export interface UnsharpMasking {
269
+ /**
270
+ * Unsharp masking amount. Controls the sharpening strength. <br />
271
+ *
272
+ * Min: `0` <br />
273
+ * Max: `5`
274
+ */
275
+ amount?: number | null;
276
+ /** Unsharp masking radius in pixels. Controls the sharpening width. */
277
+ radius?: number | null;
278
+ /**
279
+ * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
280
+ *
281
+ * Min: `0` <br />
282
+ * Max: `1`
283
+ */
284
+ threshold?: number | null;
285
+ }
286
+ export interface Video {
287
+ /** Type of video. */
288
+ type?: VideoType;
289
+ /**
290
+ * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
291
+ *
292
+ * Wix Media: `'wix:video://v1/6e6ea4_461425d7e7db4d5487a28e00c5ba6244/9e6ea4_461425d7e7db4d5487a28e00c5ba6277#posterUri=9e6ea4_461425d7e7db4d5487a28e00c5ba6277f000.jpg&posterWidth=960&posterHeight=540'`
293
+ *
294
+ * Vimeo: `'https://vimeo.com/378840916'`
295
+ *
296
+ * Youtube: `'https://www.youtube.com/results?search_query=uplifting+upbeat+music'`
297
+ */
298
+ videoInfo?: string;
299
+ /** Manually defined video duration in milliseconds. */
300
+ durationInMillis?: number | null;
301
+ }
302
+ export declare enum VideoType {
303
+ UNDEFINED = "UNDEFINED",
304
+ WIX_MEDIA = "WIX_MEDIA",
305
+ YOUTUBE = "YOUTUBE",
306
+ VIMEO = "VIMEO"
307
+ }
308
+ export interface VideoResolution {
309
+ /** *Required.** Video URL. */
310
+ url?: string;
311
+ /** *Required.** Video height. */
312
+ height?: number;
313
+ /** *Required.** Video width. */
314
+ width?: number;
315
+ /** *Required.** Video format. For example, `mp4` or `hls`. */
316
+ format?: string;
317
+ /** Video quality. For example, `480p` or `720p`. */
318
+ quality?: string | null;
319
+ /** Video filename. */
320
+ filename?: string | null;
321
+ }
322
+ export interface Text {
323
+ /** Text in HTML format. */
324
+ html?: string | null;
325
+ /**
326
+ * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.
327
+ *
328
+ * __Note:__ The object structure is customizable. See the [`listGalleryItems()`](/pro-gallery/list-gallery-items) code example for supported values.
329
+ */
330
+ css?: Record<string, any> | null;
331
+ /** Reserved for internal use. */
332
+ editorHtml?: string | null;
333
+ /** Reserved for internal use. */
334
+ editorFontId?: string | null;
335
+ }
336
+ export interface Tags {
337
+ /** List of tags assigned to the media item. */
338
+ values?: string[];
339
+ }
340
+ export interface SecondaryMedia extends SecondaryMediaMetadataOneOf {
341
+ /** secondary media photo metadata (optional) */
342
+ image?: Image;
343
+ /** secondary media text metadata (optional) */
344
+ text?: Text;
345
+ }
346
+ /** @oneof */
347
+ export interface SecondaryMediaMetadataOneOf {
348
+ /** secondary media photo metadata (optional) */
349
+ image?: Image;
350
+ /** secondary media text metadata (optional) */
351
+ text?: Text;
352
+ }
353
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
354
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
355
+ metaSiteId?: string;
356
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
357
+ siteId?: string;
358
+ /** Invalidate by App */
359
+ app?: App;
360
+ /** Invalidate by page id */
361
+ page?: Page;
362
+ /** Invalidate by URI path */
363
+ uri?: URI;
364
+ /** Invalidate by file (for media files such as PDFs) */
365
+ file?: File;
366
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
367
+ reason?: string | null;
368
+ /** Is local DS */
369
+ localDc?: boolean;
370
+ hardPurge?: boolean;
371
+ }
372
+ /** @oneof */
373
+ export interface InvalidateCacheGetByOneOf {
374
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
375
+ metaSiteId?: string;
376
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
377
+ siteId?: string;
378
+ /** Invalidate by App */
379
+ app?: App;
380
+ /** Invalidate by page id */
381
+ page?: Page;
382
+ /** Invalidate by URI path */
383
+ uri?: URI;
384
+ /** Invalidate by file (for media files such as PDFs) */
385
+ file?: File;
386
+ }
387
+ export interface App {
388
+ /** The AppDefId */
389
+ appDefId?: string;
390
+ /** The instance Id */
391
+ instanceId?: string;
392
+ }
393
+ export interface Page {
394
+ /** the msid the page is on */
395
+ metaSiteId?: string;
396
+ /** Invalidate by Page ID */
397
+ pageId?: string;
398
+ }
399
+ export interface URI {
400
+ /** the msid the URI is on */
401
+ metaSiteId?: string;
402
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
403
+ uriPath?: string;
404
+ }
405
+ export interface File {
406
+ /** the msid the file is related to */
407
+ metaSiteId?: string;
408
+ /** Invalidate by filename (for media files such as PDFs) */
409
+ fileName?: string;
410
+ }
411
+ export interface GalleryPublished {
412
+ /**
413
+ * id of the gallery that will be published
414
+ * @readonly
415
+ */
416
+ galleryId?: string;
417
+ isRc?: boolean;
418
+ /** @readonly */
419
+ newRevision?: Date | null;
420
+ /** @readonly */
421
+ oldRevision?: Date | null;
422
+ }
423
+ export interface CleanDeletedGalleriesEvent {
424
+ /** @readonly */
425
+ instanceId?: string;
426
+ /** @readonly */
427
+ metaSiteId?: string;
428
+ /** @readonly */
429
+ htmlSiteRevision?: string;
430
+ /** @readonly */
431
+ timeSitePublished?: Date | null;
432
+ }
433
+ export interface ProgallerypublisherPublishGalleryRequest {
434
+ /** id of the gallery that will be published */
435
+ galleryId?: string;
436
+ }
437
+ export interface ProgallerypublisherPublishGalleryResponse {
438
+ }
439
+ export interface GetActiveGalleryRevisionRequest {
440
+ galleryId?: string;
441
+ }
442
+ export interface GetActiveGalleryRevisionResponse {
443
+ galleryActiveRevision?: Date | null;
444
+ htmlSiteRevision?: string | null;
445
+ }
446
+ export interface GetGalleryRevisionRequest {
447
+ galleryId?: string;
448
+ revision?: Date | null;
449
+ }
450
+ export interface GetGalleryRevisionResponse {
451
+ htmlSiteRevision?: string | null;
452
+ instanceId?: string | null;
453
+ }
454
+ export interface PublishGalleryItemRequest {
455
+ /** id of the gallery that will be published */
456
+ galleryId?: string;
457
+ /** id of the item that will be published */
458
+ itemId?: string;
459
+ }
460
+ export interface PublishGalleryItemResponse {
461
+ }
462
+ export interface PublishGalleryItemsRequest {
463
+ /** id of the gallery that will be published */
464
+ galleryId?: string;
465
+ /** ids of the items that will be published */
466
+ itemIds?: string[];
467
+ }
468
+ export interface PublishGalleryItemsResponse {
469
+ }
470
+ export interface Empty {
471
+ }
472
+ export interface HtmlSitePublished {
473
+ /** Application instance ID */
474
+ appInstanceId?: string;
475
+ /** Application type */
476
+ appType?: string;
477
+ /** Revision */
478
+ revision?: string;
479
+ /** MSID */
480
+ metaSiteId?: string | null;
481
+ /** optional branch id if publish is done from branch */
482
+ branchId?: string | null;
483
+ /** The site's last transactionId */
484
+ lastTransactionId?: string | null;
485
+ /** A list of the site's pages */
486
+ pages?: EventsPage[];
487
+ /** Site's publish date */
488
+ publishDate?: string;
489
+ }
490
+ export interface EventsPage {
491
+ /** Page's Id */
492
+ _id?: string;
493
+ }
494
+ export interface HtmlSiteRCPublished {
495
+ /** Application instance ID */
496
+ appInstanceId?: string;
497
+ /** Revision */
498
+ revision?: string;
499
+ /** Optional branch Id */
500
+ branchId?: string | null;
501
+ /** Site's publish date */
502
+ publishDate?: string;
503
+ /** RC label */
504
+ rcLabel?: RCLabel;
505
+ }
506
+ export declare enum RCLabel {
507
+ /** Illegal default value, exception will be thrown if used */
508
+ UNKNOWN = "UNKNOWN",
509
+ RELEASE_MANAGER = "RELEASE_MANAGER",
510
+ BLOCKS = "BLOCKS",
511
+ WIX_CLI = "WIX_CLI",
512
+ MOBILE_APP_BUILDER = "MOBILE_APP_BUILDER",
513
+ SEO = "SEO",
514
+ FEEDBACK = "FEEDBACK"
515
+ }
516
+ export interface DomainEvent extends DomainEventBodyOneOf {
517
+ /** Information about a newly-created gallery. */
518
+ createdEvent?: EntityCreatedEvent;
519
+ updatedEvent?: EntityUpdatedEvent;
520
+ deletedEvent?: EntityDeletedEvent;
521
+ actionEvent?: ActionEvent;
522
+ /**
523
+ * Unique event ID.
524
+ * Allows clients to ignore duplicate webhooks.
525
+ */
526
+ _id?: string;
527
+ /**
528
+ * Assumes actions are also always typed to an entity_type
529
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
530
+ */
531
+ entityFqdn?: string;
532
+ /**
533
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
534
+ * This is although the created/updated/deleted notion is duplication of the oneof types
535
+ * Example: created/updated/deleted/started/completed/email_opened
536
+ */
537
+ slug?: string;
538
+ /** ID of the entity associated with the event. */
539
+ entityId?: string;
540
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
541
+ eventTime?: Date | null;
542
+ /**
543
+ * Whether the event was triggered as a result of a privacy regulation application
544
+ * (for example, GDPR).
545
+ */
546
+ triggeredByAnonymizeRequest?: boolean | null;
547
+ /** If present, indicates the action that triggered the event. */
548
+ originatedFrom?: string | null;
549
+ /**
550
+ * A sequence number defining the order of updates to the underlying entity.
551
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
552
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
553
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
554
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
555
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
556
+ */
557
+ entityEventSequence?: string | null;
558
+ }
559
+ /** @oneof */
560
+ export interface DomainEventBodyOneOf {
561
+ createdEvent?: EntityCreatedEvent;
562
+ updatedEvent?: EntityUpdatedEvent;
563
+ deletedEvent?: EntityDeletedEvent;
564
+ actionEvent?: ActionEvent;
565
+ }
566
+ export interface EntityCreatedEvent {
567
+ entity?: string;
568
+ }
569
+ export interface RestoreInfo {
570
+ deletedDate?: Date | null;
571
+ }
572
+ export interface EntityUpdatedEvent {
573
+ /**
574
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
575
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
576
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
577
+ */
578
+ currentEntity?: string;
579
+ }
580
+ export interface EntityDeletedEvent {
581
+ /** Entity that was deleted */
582
+ deletedEntity?: string | null;
583
+ }
584
+ export interface ActionEvent {
585
+ body?: string;
586
+ }
587
+ export interface MessageEnvelope {
588
+ /** App instance ID. */
589
+ instanceId?: string | null;
590
+ /** Event type. */
591
+ eventType?: string;
592
+ /** The identification type and identity data. */
593
+ identity?: IdentificationData;
594
+ /** Stringify payload. */
595
+ data?: string;
596
+ }
597
+ export interface IdentificationData extends IdentificationDataIdOneOf {
598
+ /** ID of a site visitor that has not logged in to the site. */
599
+ anonymousVisitorId?: string;
600
+ /** ID of a site visitor that has logged in to the site. */
601
+ memberId?: string;
602
+ /** ID of a Wix user (site owner, contributor, etc.). */
603
+ wixUserId?: string;
604
+ /** ID of an app. */
605
+ appId?: string;
606
+ /** @readonly */
607
+ identityType?: WebhookIdentityType;
608
+ }
609
+ /** @oneof */
610
+ export interface IdentificationDataIdOneOf {
611
+ /** ID of a site visitor that has not logged in to the site. */
612
+ anonymousVisitorId?: string;
613
+ /** ID of a site visitor that has logged in to the site. */
614
+ memberId?: string;
615
+ /** ID of a Wix user (site owner, contributor, etc.). */
616
+ wixUserId?: string;
617
+ /** ID of an app. */
618
+ appId?: string;
619
+ }
620
+ export declare enum WebhookIdentityType {
621
+ UNKNOWN = "UNKNOWN",
622
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
623
+ MEMBER = "MEMBER",
624
+ WIX_USER = "WIX_USER",
625
+ APP = "APP"
626
+ }
627
+ export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
628
+ /** insert/update documents */
629
+ update?: DocumentUpdateOperation;
630
+ /** delete by document ids */
631
+ deleteByIds?: DeleteByIdsOperation;
632
+ /** delete documents matching filter */
633
+ deleteByFilter?: DeleteByFilterOperation;
634
+ /** update documents matching filter */
635
+ updateByFilter?: UpdateByFilterOperation;
636
+ /** update only existing documents */
637
+ updateExisting?: UpdateExistingOperation;
638
+ /** application which owns documents */
639
+ appDefId?: string | null;
640
+ /** type of the documents */
641
+ documentType?: string | null;
642
+ /** language of the documents */
643
+ language?: string | null;
644
+ /** site documents belong to */
645
+ msId?: string | null;
646
+ }
647
+ /** @oneof */
648
+ export interface UpdateDocumentsEventOperationOneOf {
649
+ /** insert/update documents */
650
+ update?: DocumentUpdateOperation;
651
+ /** delete by document ids */
652
+ deleteByIds?: DeleteByIdsOperation;
653
+ /** delete documents matching filter */
654
+ deleteByFilter?: DeleteByFilterOperation;
655
+ /** update documents matching filter */
656
+ updateByFilter?: UpdateByFilterOperation;
657
+ /** update only existing documents */
658
+ updateExisting?: UpdateExistingOperation;
659
+ }
660
+ export interface DocumentUpdateOperation {
661
+ /** documents to index or update */
662
+ documents?: IndexDocument[];
663
+ }
664
+ export interface IndexDocument {
665
+ /** data bag with non-searchable fields (url, image) */
666
+ payload?: DocumentPayload;
667
+ /** what type of users should documents be visible to */
668
+ exposure?: Enum;
669
+ /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
670
+ document?: Record<string, any> | null;
671
+ /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
672
+ permittedMemberGroups?: string[];
673
+ /** if true SEO is disabled for this document */
674
+ seoHidden?: boolean | null;
675
+ /** if true the page is a lightbox popup */
676
+ isPopup?: boolean | null;
677
+ }
678
+ export interface DocumentPayload {
679
+ /** url of the page representing the document */
680
+ url?: string | null;
681
+ /** image which represents the document */
682
+ documentImage?: DocumentImage;
683
+ }
684
+ export interface DocumentImage {
685
+ /** the name of the image */
686
+ name?: string;
687
+ /** the width of the image */
688
+ width?: number;
689
+ /** the height of the image */
690
+ height?: number;
691
+ }
692
+ export declare enum Enum {
693
+ /** Default value. Means that permission not set */
694
+ UNKNOWN = "UNKNOWN",
695
+ /** Protected exposure. Exposed to members and owners */
696
+ PROTECTED = "PROTECTED",
697
+ /** Private exposure. Exposed to owners */
698
+ PRIVATE = "PRIVATE",
699
+ /** Public exposure. Visible to everyone */
700
+ PUBLIC = "PUBLIC",
701
+ /** Used for partial updates, to state that exposure is not changing */
702
+ UNCHANGED = "UNCHANGED",
703
+ /** Protected to members of permitted groups and owners */
704
+ GROUP_PROTECTED = "GROUP_PROTECTED"
705
+ }
706
+ export interface DeleteByIdsOperation {
707
+ /** ids of the documents to delete */
708
+ documentIds?: string[];
709
+ }
710
+ export interface DeleteByFilterOperation {
711
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
712
+ filter?: Record<string, any> | null;
713
+ }
714
+ export interface UpdateByFilterOperation {
715
+ /** documents matching this filter will be updated */
716
+ filter?: Record<string, any> | null;
717
+ /** partial document to apply */
718
+ document?: IndexDocument;
719
+ }
720
+ export interface UpdateExistingOperation {
721
+ /** documents to update */
722
+ documents?: IndexDocument[];
723
+ }
724
+ export interface SearchIndexingNotification {
725
+ /** new state of indexing for the site specified in ms_id */
726
+ indexState?: SearchIndexingNotificationState;
727
+ /** type of the document the notification is targeted for. Applies to all types if not provided */
728
+ documentType?: string | null;
729
+ /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
730
+ language?: string | null;
731
+ /** site for which notification is targeted */
732
+ msId?: string | null;
733
+ }
734
+ export declare enum SearchIndexingNotificationState {
735
+ /** default state */
736
+ Unknown = "Unknown",
737
+ /** metasite does not require site search indexing */
738
+ Off = "Off",
739
+ /** metasite requires site search indexing */
740
+ On = "On"
741
+ }
742
+ export interface ListGalleriesItemsRequest {
743
+ /** IDs of the media items to retrieve. */
744
+ itemsId?: ItemId[];
745
+ }
746
+ export interface ItemId {
747
+ /** Gallery ID. */
748
+ galleryId?: string;
749
+ /** Item ID. */
750
+ itemId?: string;
751
+ }
752
+ export interface ListGalleriesItemsResponse {
753
+ /** Retrieved media items. */
754
+ itemsInGalleries?: ItemsInGallery[];
755
+ }
756
+ export interface ItemsInGallery {
757
+ /** Gallery ID. */
758
+ galleryId?: string;
759
+ /** Retrieved media items. */
760
+ items?: Item[];
761
+ }
762
+ export interface GalleryItemCreated {
763
+ /** Created gallery item. */
764
+ item?: Item;
765
+ }
766
+ export interface GalleryItemUpdated {
767
+ /** Updated gallery item. */
768
+ updatedItem?: Item;
769
+ }
770
+ export interface GalleryItemDeleted {
771
+ /** ID of the deleted gallery item. */
772
+ itemId?: string;
773
+ }
774
+ export interface ListGalleriesRequest {
775
+ /** Number of galleries to list. Defaults to `10`. */
776
+ itemLimit?: number | null;
777
+ /** Number of galleries to skip in the returns. Defaults to `0`. */
778
+ offset?: number | null;
779
+ /** Number of galleries to list. Defaults to `10`. */
780
+ limit?: number | null;
781
+ }
782
+ export declare enum State {
783
+ /** Undefined state. */
784
+ UNDEFINED = "UNDEFINED",
785
+ /** The gallery in the Editor. */
786
+ SAVED = "SAVED",
787
+ /** The gallery in the LiveSite. */
788
+ PUBLISHED = "PUBLISHED"
789
+ }
790
+ export interface ListGalleriesResponse {
791
+ /** Total number of galleries in the site. */
792
+ totalGalleries?: number | null;
793
+ /** List of galleries. Sorted by `_createdDate`. */
794
+ galleries?: Gallery[];
795
+ }
796
+ export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
797
+ /** Gallery ID. */
798
+ galleryId: string;
799
+ /** Number of media items to skip in the returns. Defaults to `0`. */
800
+ itemOffset?: number | null;
801
+ /**
802
+ * Maximum number of media items to return. <br />
803
+ *
804
+ * Min: `1` <br />
805
+ * Max: `100` <br />
806
+ * Default: `50`
807
+ */
808
+ itemLimit?: number | null;
809
+ }
810
+ /** @oneof */
811
+ export interface GetGalleryRequestVersionOneOf {
812
+ }
813
+ export interface GetGalleryResponse {
814
+ /** Returned gallery. */
815
+ gallery?: Gallery;
816
+ }
817
+ export interface ListGalleryItemsRequest {
818
+ /** Gallery ID. */
819
+ galleryId: string;
820
+ /** Number of media items to skip in the returns. Defaults to `0`. */
821
+ itemOffset?: number | null;
822
+ /**
823
+ * Maximum number of media items to return. <br />
824
+ *
825
+ * Min: `1` <br />
826
+ * Max: `100` <br />
827
+ * Default: `50`
828
+ */
829
+ itemLimit?: number | null;
830
+ }
831
+ export interface ListGalleryItemsResponse {
832
+ /** List of media items in the gallery. */
833
+ items?: Item[];
834
+ }
835
+ export interface GetGalleryItemRequest {
836
+ /** Gallery ID. */
837
+ galleryId: string;
838
+ /** Item ID. */
839
+ itemId: string;
840
+ }
841
+ export interface GetGalleryItemResponse {
842
+ /** Returned media item. */
843
+ item?: Item;
844
+ }
845
+ export interface CreateGalleryRequest {
846
+ /** Gallery to create. */
847
+ gallery?: Gallery;
848
+ /** Gallery ID to clone from. */
849
+ cloneFromGalleryId?: string | null;
850
+ }
851
+ export interface CreateGalleryResponse {
852
+ /** Created gallery. */
853
+ gallery?: Gallery;
854
+ }
855
+ export interface UpdateGalleryRequest {
856
+ /** Gallery to update. */
857
+ gallery: Gallery;
858
+ }
859
+ export interface UpdateGalleryResponse {
860
+ /** Updated gallery. */
861
+ gallery?: Gallery;
862
+ }
863
+ export interface DeleteGalleryRequest {
864
+ /** ID of the gallery to delete. */
865
+ galleryId: string;
866
+ }
867
+ export interface DeleteGalleryResponse {
868
+ /**
869
+ * ID of the deleted gallery.
870
+ * @readonly
871
+ */
872
+ galleryId?: string;
873
+ }
874
+ export interface DeleteGalleryItemsRequest {
875
+ /** Gallery ID. */
876
+ galleryId: string;
877
+ /** ID of the media item to delete. */
878
+ itemsIds?: string[];
879
+ }
880
+ export interface DeleteGalleryItemsResponse {
881
+ /** Gallery that previously included the deleted media item. */
882
+ gallery?: Gallery;
883
+ }
884
+ export interface BulkDeleteGalleryItemsRequest {
885
+ /** Gallery ID. */
886
+ galleryId: string;
887
+ /** IDs of the media items to delete. */
888
+ itemIds: string[];
889
+ }
890
+ export interface BulkDeleteGalleryItemsResponse {
891
+ /**
892
+ * IDs of the deleted media items.
893
+ * @readonly
894
+ */
895
+ itemIds?: string[];
896
+ }
897
+ export interface CreateGalleryItemRequest {
898
+ /** Gallery ID. */
899
+ galleryId: string;
900
+ /** Media item to create. */
901
+ item: Item;
902
+ }
903
+ export interface CreateGalleryItemResponse {
904
+ /** Created media item. */
905
+ item?: Item;
906
+ }
907
+ export interface CreateGalleryItemsRequest {
908
+ /** Gallery ID. */
909
+ galleryId?: string;
910
+ /** Media items to create. */
911
+ items?: Item[];
912
+ }
913
+ export interface CreateGalleryItemsResponse {
914
+ /** Created media items. */
915
+ items?: Item[];
916
+ }
917
+ export interface UpdateGalleryItemRequest {
918
+ /** Gallery ID. */
919
+ galleryId: string;
920
+ /** The information for the media item being updated. */
921
+ item: Item;
922
+ }
923
+ export interface UpdateGalleryItemResponse {
924
+ /** Updated media item. */
925
+ item?: Item;
926
+ }
927
+ export interface DeleteGalleryItemRequest {
928
+ /** Gallery ID. */
929
+ galleryId: string;
930
+ /** ID of the media item to delete. */
931
+ itemId: string;
932
+ }
933
+ export interface DeleteGalleryItemResponse {
934
+ /**
935
+ * ID of the deleted media item.
936
+ * @readonly
937
+ */
938
+ itemId?: string;
939
+ }
940
+ export interface PublishGalleryRequest {
941
+ /** ID of the gallery to publish. */
942
+ galleryId?: string;
943
+ }
944
+ export interface PublishGalleryResponse {
945
+ /** Published gallery. */
946
+ gallery?: Gallery;
947
+ }
948
+ interface PointNonNullableFields {
949
+ x: number;
950
+ y: number;
951
+ }
952
+ interface ImageNonNullableFields {
953
+ type: ImageType;
954
+ imageInfo: string;
955
+ focalPoint?: PointNonNullableFields;
956
+ }
957
+ interface VideoNonNullableFields {
958
+ type: VideoType;
959
+ videoInfo: string;
960
+ }
961
+ interface ExternalLinkNonNullableFields {
962
+ url: string;
963
+ rel: LinkRel[];
964
+ }
965
+ interface PageLinkNonNullableFields {
966
+ pageId: string;
967
+ rel: LinkRel[];
968
+ }
969
+ interface AnchorLinkNonNullableFields {
970
+ anchorName: string;
971
+ anchorDataId: string;
972
+ pageId: string;
973
+ rel: LinkRel[];
974
+ }
975
+ interface DynamicPageLinkNonNullableFields {
976
+ routerId: string;
977
+ innerRoute: string;
978
+ rel: LinkRel[];
979
+ }
980
+ interface DocumentLinkNonNullableFields {
981
+ docId: string;
982
+ indexable: boolean;
983
+ }
984
+ interface EmailLinkNonNullableFields {
985
+ recipient: string;
986
+ }
987
+ interface PhoneLinkNonNullableFields {
988
+ phoneNumber: string;
989
+ }
990
+ interface AddressLinkNonNullableFields {
991
+ address: string;
992
+ }
993
+ interface WhatsAppLinkNonNullableFields {
994
+ phoneNumber: string;
995
+ }
996
+ interface TpaPageLinkNonNullableFields {
997
+ itemTypeIdentifier: string;
998
+ itemId: string;
999
+ pageId: string;
1000
+ appDefinitionId: string;
1001
+ path: string;
1002
+ rel: LinkRel[];
1003
+ }
1004
+ interface WixLinkNonNullableFields {
1005
+ external?: ExternalLinkNonNullableFields;
1006
+ page?: PageLinkNonNullableFields;
1007
+ anchor?: AnchorLinkNonNullableFields;
1008
+ dynamicPage?: DynamicPageLinkNonNullableFields;
1009
+ document?: DocumentLinkNonNullableFields;
1010
+ email?: EmailLinkNonNullableFields;
1011
+ phone?: PhoneLinkNonNullableFields;
1012
+ address?: AddressLinkNonNullableFields;
1013
+ whatsApp?: WhatsAppLinkNonNullableFields;
1014
+ tpaPage?: TpaPageLinkNonNullableFields;
1015
+ }
1016
+ interface LinkNonNullableFields {
1017
+ type: LinkType;
1018
+ wixLinkData?: WixLinkNonNullableFields;
1019
+ }
1020
+ interface TagsNonNullableFields {
1021
+ values: string[];
1022
+ }
1023
+ interface SecondaryMediaNonNullableFields {
1024
+ image?: ImageNonNullableFields;
1025
+ }
1026
+ export interface ItemNonNullableFields {
1027
+ image?: ImageNonNullableFields;
1028
+ video?: VideoNonNullableFields;
1029
+ link?: LinkNonNullableFields;
1030
+ type: Type;
1031
+ tags?: TagsNonNullableFields;
1032
+ secondaryMedia?: SecondaryMediaNonNullableFields;
1033
+ }
1034
+ export interface GalleryNonNullableFields {
1035
+ items: ItemNonNullableFields[];
1036
+ }
1037
+ export interface ListGalleriesResponseNonNullableFields {
1038
+ galleries: GalleryNonNullableFields[];
1039
+ }
1040
+ export interface GetGalleryResponseNonNullableFields {
1041
+ gallery?: GalleryNonNullableFields;
1042
+ }
1043
+ export interface ListGalleryItemsResponseNonNullableFields {
1044
+ items: ItemNonNullableFields[];
1045
+ }
1046
+ export interface GetGalleryItemResponseNonNullableFields {
1047
+ item?: ItemNonNullableFields;
1048
+ }
1049
+ export interface CreateGalleryResponseNonNullableFields {
1050
+ gallery?: GalleryNonNullableFields;
1051
+ }
1052
+ export interface UpdateGalleryResponseNonNullableFields {
1053
+ gallery?: GalleryNonNullableFields;
1054
+ }
1055
+ export interface DeleteGalleryResponseNonNullableFields {
1056
+ galleryId: string;
1057
+ }
1058
+ export interface DeleteGalleryItemsResponseNonNullableFields {
1059
+ gallery?: GalleryNonNullableFields;
1060
+ }
1061
+ export interface BulkDeleteGalleryItemsResponseNonNullableFields {
1062
+ itemIds: string[];
1063
+ }
1064
+ export interface CreateGalleryItemResponseNonNullableFields {
1065
+ item?: ItemNonNullableFields;
1066
+ }
1067
+ export interface UpdateGalleryItemResponseNonNullableFields {
1068
+ item?: ItemNonNullableFields;
1069
+ }
1070
+ export interface DeleteGalleryItemResponseNonNullableFields {
1071
+ itemId: string;
1072
+ }
1073
+ export interface BaseEventMetadata {
1074
+ /** App instance ID. */
1075
+ instanceId?: string | null;
1076
+ /** Event type. */
1077
+ eventType?: string;
1078
+ /** The identification type and identity data. */
1079
+ identity?: IdentificationData;
1080
+ }
1081
+ export interface EventMetadata extends BaseEventMetadata {
1082
+ /**
1083
+ * Unique event ID.
1084
+ * Allows clients to ignore duplicate webhooks.
1085
+ */
1086
+ _id?: string;
1087
+ /**
1088
+ * Assumes actions are also always typed to an entity_type
1089
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1090
+ */
1091
+ entityFqdn?: string;
1092
+ /**
1093
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1094
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1095
+ * Example: created/updated/deleted/started/completed/email_opened
1096
+ */
1097
+ slug?: string;
1098
+ /** ID of the entity associated with the event. */
1099
+ entityId?: string;
1100
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1101
+ eventTime?: Date | null;
1102
+ /**
1103
+ * Whether the event was triggered as a result of a privacy regulation application
1104
+ * (for example, GDPR).
1105
+ */
1106
+ triggeredByAnonymizeRequest?: boolean | null;
1107
+ /** If present, indicates the action that triggered the event. */
1108
+ originatedFrom?: string | null;
1109
+ /**
1110
+ * A sequence number defining the order of updates to the underlying entity.
1111
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1112
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1113
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1114
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1115
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1116
+ */
1117
+ entityEventSequence?: string | null;
1118
+ }
1119
+ export interface GalleryCreatedEnvelope {
1120
+ entity: Gallery;
1121
+ metadata: EventMetadata;
1122
+ }
1123
+ /**
1124
+ * Triggered when a gallery is created.
1125
+ *
1126
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1127
+ * > To receive information about the created items you need to listen to the [Gallery Item Created webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-created-webhook).
1128
+ * @permissionScope Manage Galleries
1129
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1130
+ * @permissionScope Read Galleries
1131
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1132
+ * @permissionId PRO_GALLERY.READ
1133
+ * @webhook
1134
+ * @eventType wix.pro_gallery.gallery_v2_created
1135
+ * @documentationMaturity preview
1136
+ */
1137
+ export declare function onGalleryCreated(handler: (event: GalleryCreatedEnvelope) => void | Promise<void>): void;
1138
+ export interface GalleryDeletedEnvelope {
1139
+ metadata: EventMetadata;
1140
+ }
1141
+ /**
1142
+ * Triggered when a gallery is deleted.
1143
+ * @permissionScope Manage Galleries
1144
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1145
+ * @permissionScope Read Galleries
1146
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1147
+ * @permissionId PRO_GALLERY.READ
1148
+ * @webhook
1149
+ * @eventType wix.pro_gallery.gallery_v2_deleted
1150
+ * @documentationMaturity preview
1151
+ */
1152
+ export declare function onGalleryDeleted(handler: (event: GalleryDeletedEnvelope) => void | Promise<void>): void;
1153
+ export interface GalleryItemCreatedEnvelope {
1154
+ data: GalleryItemCreated;
1155
+ metadata: EventMetadata;
1156
+ }
1157
+ /**
1158
+ * Triggered when a media item in a specified gallery is created.
1159
+ * @permissionScope Manage Galleries
1160
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1161
+ * @permissionScope Read Galleries
1162
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1163
+ * @permissionId PRO_GALLERY.READ
1164
+ * @webhook
1165
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_created
1166
+ * @documentationMaturity preview
1167
+ */
1168
+ export declare function onGalleryItemCreated(handler: (event: GalleryItemCreatedEnvelope) => void | Promise<void>): void;
1169
+ export interface GalleryItemDeletedEnvelope {
1170
+ data: GalleryItemDeleted;
1171
+ metadata: EventMetadata;
1172
+ }
1173
+ /**
1174
+ * Triggered when a media item in a specified gallery is deleted.
1175
+ *
1176
+ * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1177
+ * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1178
+ * @permissionScope Manage Galleries
1179
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1180
+ * @permissionScope Read Galleries
1181
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1182
+ * @permissionId PRO_GALLERY.READ
1183
+ * @webhook
1184
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_deleted
1185
+ * @documentationMaturity preview
1186
+ */
1187
+ export declare function onGalleryItemDeleted(handler: (event: GalleryItemDeletedEnvelope) => void | Promise<void>): void;
1188
+ export interface GalleryItemUpdatedEnvelope {
1189
+ data: GalleryItemUpdated;
1190
+ metadata: EventMetadata;
1191
+ }
1192
+ /**
1193
+ * Triggered when a media item in a specified gallery is updated.
1194
+ * @permissionScope Manage Galleries
1195
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1196
+ * @permissionScope Read Galleries
1197
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1198
+ * @permissionId PRO_GALLERY.READ
1199
+ * @webhook
1200
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_updated
1201
+ * @documentationMaturity preview
1202
+ */
1203
+ export declare function onGalleryItemUpdated(handler: (event: GalleryItemUpdatedEnvelope) => void | Promise<void>): void;
1204
+ export interface GalleryUpdatedEnvelope {
1205
+ entity: Gallery;
1206
+ metadata: EventMetadata;
1207
+ }
1208
+ /**
1209
+ * Triggered when a gallery is updated.
1210
+ *
1211
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1212
+ * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1213
+ * @permissionScope Manage Galleries
1214
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1215
+ * @permissionScope Read Galleries
1216
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1217
+ * @permissionId PRO_GALLERY.READ
1218
+ * @webhook
1219
+ * @eventType wix.pro_gallery.gallery_v2_updated
1220
+ * @documentationMaturity preview
1221
+ */
1222
+ export declare function onGalleryUpdated(handler: (event: GalleryUpdatedEnvelope) => void | Promise<void>): void;
1223
+ /**
1224
+ * Retrieves a list of galleries.
1225
+ *
1226
+ * This function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.
1227
+ * @public
1228
+ * @documentationMaturity preview
1229
+ * @param options - Options to use when getting the list of galleries.
1230
+ * @permissionId PRO_GALLERY.READ
1231
+ * @permissionScope Manage Galleries
1232
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1233
+ * @permissionScope Read Galleries
1234
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1235
+ * @applicableIdentity APP
1236
+ * @applicableIdentity VISITOR
1237
+ * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleries
1238
+ */
1239
+ export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
1240
+ export interface ListGalleriesOptions {
1241
+ /** Number of galleries to list. Defaults to `10`. */
1242
+ itemLimit?: number | null;
1243
+ /** Number of galleries to skip in the returns. Defaults to `0`. */
1244
+ offset?: number | null;
1245
+ /** Number of galleries to list. Defaults to `10`. */
1246
+ limit?: number | null;
1247
+ }
1248
+ /**
1249
+ * Retrieves a gallery by ID.
1250
+ * @param galleryId - Gallery ID.
1251
+ * @public
1252
+ * @documentationMaturity preview
1253
+ * @requiredField galleryId
1254
+ * @param options - Options to use when getting the gallery.
1255
+ * @permissionId PRO_GALLERY.READ
1256
+ * @permissionScope Manage Galleries
1257
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1258
+ * @permissionScope Read Galleries
1259
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1260
+ * @applicableIdentity APP
1261
+ * @applicableIdentity VISITOR
1262
+ * @returns Returned gallery.
1263
+ * @fqn com.wixpress.exposure.progallery.ProGallery.GetGallery
1264
+ */
1265
+ export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery & GalleryNonNullableFields>;
1266
+ export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
1267
+ /** Number of media items to skip in the returns. Defaults to `0`. */
1268
+ itemOffset?: number | null;
1269
+ /**
1270
+ * Maximum number of media items to return. <br />
1271
+ *
1272
+ * Min: `1` <br />
1273
+ * Max: `100` <br />
1274
+ * Default: `50`
1275
+ */
1276
+ itemLimit?: number | null;
1277
+ }
1278
+ /**
1279
+ * Retrieves a list of media items in a specified gallery.
1280
+ *
1281
+ * This function retrieves a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order.
1282
+ * @param galleryId - Gallery ID.
1283
+ * @public
1284
+ * @documentationMaturity preview
1285
+ * @requiredField galleryId
1286
+ * @param options - Options to use when getting the list of gallery items.
1287
+ * @permissionId PRO_GALLERY.READ
1288
+ * @permissionScope Manage Galleries
1289
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1290
+ * @permissionScope Read Galleries
1291
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1292
+ * @applicableIdentity APP
1293
+ * @applicableIdentity VISITOR
1294
+ * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleryItems
1295
+ */
1296
+ export declare function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise<ListGalleryItemsResponse & ListGalleryItemsResponseNonNullableFields>;
1297
+ export interface ListGalleryItemsOptions {
1298
+ /** Number of media items to skip in the returns. Defaults to `0`. */
1299
+ itemOffset?: number | null;
1300
+ /**
1301
+ * Maximum number of media items to return. <br />
1302
+ *
1303
+ * Min: `1` <br />
1304
+ * Max: `100` <br />
1305
+ * Default: `50`
1306
+ */
1307
+ itemLimit?: number | null;
1308
+ }
1309
+ /**
1310
+ * Retrieves a gallery item by ID.
1311
+ * @public
1312
+ * @documentationMaturity preview
1313
+ * @requiredField identifiers
1314
+ * @requiredField identifiers.galleryId
1315
+ * @requiredField identifiers.itemId
1316
+ * @param identifiers - Gallery ID and Item ID.
1317
+ * @permissionId PRO_GALLERY.READ
1318
+ * @permissionScope Manage Galleries
1319
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1320
+ * @permissionScope Read Galleries
1321
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1322
+ * @applicableIdentity APP
1323
+ * @applicableIdentity VISITOR
1324
+ * @returns Returned media item.
1325
+ * @fqn com.wixpress.exposure.progallery.ProGallery.GetGalleryItem
1326
+ */
1327
+ export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item & ItemNonNullableFields>;
1328
+ export interface GetGalleryItemIdentifiers {
1329
+ /** Gallery ID. */
1330
+ galleryId: string;
1331
+ /** Item ID. */
1332
+ itemId: string;
1333
+ }
1334
+ /**
1335
+ * Creates a new gallery.
1336
+ *
1337
+ * You can create your own gallery by providing the gallery information, or clone an existing gallery using the ID of that existing gallery. When a gallery is cloned, the newly-created gallery includes the same properties as the existing gallery except for the gallery and item IDs, sort order, and created and updated dates.
1338
+ *
1339
+ * The newly-created gallery is only available on your backend, and doesn't appear on your live site. To display your backend gallery on your live site, you need to connect it to a gallery component on your live site. To do this, import the `createGallery()` function to your page code, and write code to convert the backend gallery object to the frontend gallery component object. Once converted, the newly created backend gallery is visible on your live site. For reference, check out the code example, "Create a gallery and display it on your live site". To learn more, see [Displaying a Pro Gallery on Your Site Using the Pro Gallery Backend API](https://support.wix.com/en/article/velo-tutorial-displaying-a-pro-gallery-on-your-site-using-the-pro-gallery-backend-api).
1340
+ *
1341
+ * <blockquote class="important">
1342
+ *
1343
+ * __Important:__
1344
+ * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1345
+ *
1346
+ * </blockquote>
1347
+ * @public
1348
+ * @documentationMaturity preview
1349
+ * @requiredField options.gallery.items.image.imageInfo
1350
+ * @requiredField options.gallery.items.text.html
1351
+ * @requiredField options.gallery.items.video.videoInfo
1352
+ * @param options - Options to use when creating the gallery.
1353
+ * @permissionId PRO_GALLERY.MANAGE
1354
+ * @permissionScope Manage Galleries
1355
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1356
+ * @applicableIdentity APP
1357
+ * @returns Created gallery.
1358
+ * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGallery
1359
+ */
1360
+ export declare function createGallery(options?: CreateGalleryOptions): Promise<Gallery & GalleryNonNullableFields>;
1361
+ export interface CreateGalleryOptions {
1362
+ /** Gallery to create. */
1363
+ gallery?: Gallery;
1364
+ /** Gallery ID to clone from. */
1365
+ cloneFromGalleryId?: string | null;
1366
+ }
1367
+ /**
1368
+ * Updates a gallery.
1369
+ *
1370
+ * Only the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
1371
+ *
1372
+ * <blockquote class="important">
1373
+ *
1374
+ * __Important:__
1375
+ * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1376
+ *
1377
+ * </blockquote>
1378
+ * @public
1379
+ * @documentationMaturity preview
1380
+ * @requiredField _id
1381
+ * @requiredField gallery
1382
+ * @requiredField gallery.items.image.imageInfo
1383
+ * @requiredField gallery.items.text.html
1384
+ * @requiredField gallery.items.video.videoInfo
1385
+ * @param _id - ID of the gallery to update.
1386
+ * @param gallery - The information for the gallery being updated.
1387
+ * @permissionId PRO_GALLERY.MANAGE
1388
+ * @permissionScope Manage Galleries
1389
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1390
+ * @applicableIdentity APP
1391
+ * @returns Updated gallery.
1392
+ * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGallery
1393
+ */
1394
+ export declare function updateGallery(_id: string | null, gallery: UpdateGallery): Promise<Gallery & GalleryNonNullableFields>;
1395
+ export interface UpdateGallery {
1396
+ /**
1397
+ * Gallery ID.
1398
+ * @readonly
1399
+ */
1400
+ _id?: string | null;
1401
+ /** Gallery name. */
1402
+ name?: string | null;
1403
+ /**
1404
+ * Total number of items in the gallery.
1405
+ * @readonly
1406
+ */
1407
+ totalItems?: number | null;
1408
+ /** Media items in the gallery. */
1409
+ items?: Item[];
1410
+ /**
1411
+ * Index that determines which position a gallery is displayed on the site. <br />
1412
+ *
1413
+ * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
1414
+ */
1415
+ sortOrder?: number | null;
1416
+ /**
1417
+ * Date and time the gallery was created.
1418
+ * @readonly
1419
+ */
1420
+ _createdDate?: Date | null;
1421
+ }
1422
+ /**
1423
+ * Deletes a gallery.
1424
+ *
1425
+ * When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function.
1426
+ * @param galleryId - ID of the gallery to delete.
1427
+ * @public
1428
+ * @documentationMaturity preview
1429
+ * @requiredField galleryId
1430
+ * @permissionId PRO_GALLERY.MANAGE
1431
+ * @permissionScope Manage Galleries
1432
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1433
+ * @applicableIdentity APP
1434
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGallery
1435
+ */
1436
+ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryResponse & DeleteGalleryResponseNonNullableFields>;
1437
+ /**
1438
+ * Deletes multiple media items from a gallery.
1439
+ * @param galleryId - Gallery ID.
1440
+ * @public
1441
+ * @documentationMaturity preview
1442
+ * @requiredField galleryId
1443
+ * @permissionId PRO_GALLERY.MANAGE
1444
+ * @permissionScope Manage Galleries
1445
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1446
+ * @applicableIdentity APP
1447
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItems
1448
+ * @deprecated
1449
+ * @replacedBy com.wixpress.exposure.progallery.BulkDeleteGalleryItems
1450
+ * @targetRemovalDate 2024-08-15
1451
+ */
1452
+ export declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<DeleteGalleryItemsResponse & DeleteGalleryItemsResponseNonNullableFields>;
1453
+ export interface DeleteGalleryItemsOptions {
1454
+ /** ID of the media item to delete. */
1455
+ itemsIds?: string[];
1456
+ }
1457
+ /**
1458
+ * Deletes multiple media items from a gallery.
1459
+ * @param galleryId - Gallery ID.
1460
+ * @param itemIds - IDs of the media items to delete.
1461
+ * @public
1462
+ * @documentationMaturity preview
1463
+ * @requiredField galleryId
1464
+ * @requiredField itemIds
1465
+ * @permissionId PRO_GALLERY.MANAGE
1466
+ * @permissionScope Manage Galleries
1467
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1468
+ * @applicableIdentity APP
1469
+ * @fqn com.wixpress.exposure.progallery.ProGallery.BulkDeleteGalleryItems
1470
+ */
1471
+ export declare function bulkDeleteGalleryItems(galleryId: string, itemIds: string[]): Promise<BulkDeleteGalleryItemsResponse & BulkDeleteGalleryItemsResponseNonNullableFields>;
1472
+ /**
1473
+ * Creates a media item in a specified gallery.
1474
+ *
1475
+ * The `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created.
1476
+ *
1477
+ * <blockquote class="important">
1478
+ *
1479
+ * __Important:__
1480
+ * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1481
+ *
1482
+ * </blockquote>
1483
+ * @param galleryId - Gallery ID.
1484
+ * @param item - Media item to create.
1485
+ * @public
1486
+ * @documentationMaturity preview
1487
+ * @requiredField galleryId
1488
+ * @requiredField item
1489
+ * @requiredField item.image.imageInfo
1490
+ * @requiredField item.text.html
1491
+ * @requiredField item.video.videoInfo
1492
+ * @permissionId PRO_GALLERY.MANAGE
1493
+ * @permissionScope Manage Galleries
1494
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1495
+ * @applicableIdentity APP
1496
+ * @returns Created media item.
1497
+ * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGalleryItem
1498
+ */
1499
+ export declare function createGalleryItem(galleryId: string, item: Item): Promise<Item & ItemNonNullableFields>;
1500
+ /**
1501
+ * Updates a media item in a specified gallery.
1502
+ *
1503
+ * Only the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
1504
+ *
1505
+ * <blockquote class="important">
1506
+ *
1507
+ * __Important:__
1508
+ * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1509
+ *
1510
+ * </blockquote>
1511
+ * @public
1512
+ * @documentationMaturity preview
1513
+ * @requiredField identifiers
1514
+ * @requiredField identifiers.galleryId
1515
+ * @requiredField identifiers.itemId
1516
+ * @requiredField item
1517
+ * @requiredField item.image.imageInfo
1518
+ * @requiredField item.text.html
1519
+ * @requiredField item.video.videoInfo
1520
+ * @param item - The information for the gallery item being updated.
1521
+ * @param identifiers - Gallery ID and Item ID.
1522
+ * @permissionId PRO_GALLERY.MANAGE
1523
+ * @permissionScope Manage Galleries
1524
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1525
+ * @applicableIdentity APP
1526
+ * @returns Updated media item.
1527
+ * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGalleryItem
1528
+ */
1529
+ export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item & ItemNonNullableFields>;
1530
+ export interface UpdateGalleryItemIdentifiers {
1531
+ /** ID of the gallery containing the item to update. */
1532
+ galleryId: string;
1533
+ /**
1534
+ * ID of the item to update.
1535
+ * @readonly
1536
+ */
1537
+ itemId?: string | null;
1538
+ }
1539
+ export interface UpdateGalleryItem {
1540
+ /** Details about the image. */
1541
+ image?: Image;
1542
+ /** Details about the video. */
1543
+ video?: Video;
1544
+ /** Details about the text file. */
1545
+ text?: Text;
1546
+ /**
1547
+ * Item ID.
1548
+ * @readonly
1549
+ */
1550
+ _id?: string | null;
1551
+ /**
1552
+ * Index that determines which position a media item is displayed in the gallery. <br />
1553
+ *
1554
+ * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
1555
+ *
1556
+ * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
1557
+ */
1558
+ sortOrder?: number | null;
1559
+ /** Item title. */
1560
+ title?: string | null;
1561
+ /** Item description. */
1562
+ description?: string | null;
1563
+ /** Link from the item. You can link to Wix sites or external URLs. */
1564
+ link?: Link;
1565
+ /**
1566
+ * Type of item.
1567
+ * @readonly
1568
+ */
1569
+ type?: Type;
1570
+ /**
1571
+ * Date and time the item was created.
1572
+ * @readonly
1573
+ */
1574
+ _createdDate?: Date | null;
1575
+ /**
1576
+ * Date and time the item was last updated.
1577
+ * @readonly
1578
+ */
1579
+ _updatedDate?: Date | null;
1580
+ /** Item tags. */
1581
+ tags?: Tags;
1582
+ }
1583
+ /**
1584
+ * Deletes a media item from a gallery.
1585
+ *
1586
+ * When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function.
1587
+ * @public
1588
+ * @documentationMaturity preview
1589
+ * @requiredField identifiers
1590
+ * @requiredField identifiers.galleryId
1591
+ * @requiredField identifiers.itemId
1592
+ * @param identifiers - Gallery ID and Item ID.
1593
+ * @permissionId PRO_GALLERY.MANAGE
1594
+ * @permissionScope Manage Galleries
1595
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1596
+ * @applicableIdentity APP
1597
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItem
1598
+ */
1599
+ export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
1600
+ export interface DeleteGalleryItemIdentifiers {
1601
+ /** Gallery ID. */
1602
+ galleryId: string;
1603
+ /** ID of the media item to delete. */
1604
+ itemId: string;
1605
+ }
1606
+ export {};