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