@wix/auto_sdk_pro-gallery_pro-gallery 1.0.8 → 1.0.9

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