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