@wix/auto_sdk_media-collections_media-collections 1.0.4 → 1.0.6
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/{es/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CUKnIZcW.d.mts} +284 -118
- package/build/{cjs/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CUKnIZcW.d.ts} +284 -118
- package/build/index.d.mts +120 -0
- package/build/index.d.ts +120 -0
- package/build/index.js +1157 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1111 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CUKnIZcW.d.mts} +284 -118
- package/build/internal/{es/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CUKnIZcW.d.ts} +284 -118
- package/build/internal/index.d.mts +120 -0
- package/build/internal/index.d.ts +120 -0
- package/build/internal/index.js +1157 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1111 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +765 -0
- package/build/internal/meta.d.ts +765 -0
- package/build/internal/meta.js +789 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +750 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +765 -0
- package/build/meta.d.ts +765 -0
- package/build/meta.js +789 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +750 -0
- package/build/meta.mjs.map +1 -0
- 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/collections-v1-collection-media-collections.context.d.ts +0 -21
- package/build/cjs/src/collections-v1-collection-media-collections.context.js +0 -33
- package/build/cjs/src/collections-v1-collection-media-collections.context.js.map +0 -1
- package/build/cjs/src/collections-v1-collection-media-collections.http.d.ts +0 -25
- package/build/cjs/src/collections-v1-collection-media-collections.http.js +0 -490
- package/build/cjs/src/collections-v1-collection-media-collections.http.js.map +0 -1
- package/build/cjs/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
- package/build/cjs/src/collections-v1-collection-media-collections.meta.js +0 -278
- package/build/cjs/src/collections-v1-collection-media-collections.meta.js.map +0 -1
- package/build/cjs/src/collections-v1-collection-media-collections.public.d.ts +0 -104
- package/build/cjs/src/collections-v1-collection-media-collections.public.js +0 -123
- package/build/cjs/src/collections-v1-collection-media-collections.public.js.map +0 -1
- package/build/cjs/src/collections-v1-collection-media-collections.types.js +0 -94
- package/build/cjs/src/collections-v1-collection-media-collections.types.js.map +0 -1
- package/build/cjs/src/collections-v1-collection-media-collections.universal.d.ts +0 -1338
- package/build/cjs/src/collections-v1-collection-media-collections.universal.js +0 -574
- package/build/cjs/src/collections-v1-collection-media-collections.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/collections-v1-collection-media-collections.context.d.ts +0 -21
- package/build/es/src/collections-v1-collection-media-collections.context.js +0 -21
- package/build/es/src/collections-v1-collection-media-collections.context.js.map +0 -1
- package/build/es/src/collections-v1-collection-media-collections.http.d.ts +0 -25
- package/build/es/src/collections-v1-collection-media-collections.http.js +0 -474
- package/build/es/src/collections-v1-collection-media-collections.http.js.map +0 -1
- package/build/es/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
- package/build/es/src/collections-v1-collection-media-collections.meta.js +0 -239
- package/build/es/src/collections-v1-collection-media-collections.meta.js.map +0 -1
- package/build/es/src/collections-v1-collection-media-collections.public.d.ts +0 -104
- package/build/es/src/collections-v1-collection-media-collections.public.js +0 -98
- package/build/es/src/collections-v1-collection-media-collections.public.js.map +0 -1
- package/build/es/src/collections-v1-collection-media-collections.types.js +0 -91
- package/build/es/src/collections-v1-collection-media-collections.types.js.map +0 -1
- package/build/es/src/collections-v1-collection-media-collections.universal.d.ts +0 -1338
- package/build/es/src/collections-v1-collection-media-collections.universal.js +0 -535
- package/build/es/src/collections-v1-collection-media-collections.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/collections-v1-collection-media-collections.context.d.ts +0 -21
- package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js +0 -33
- package/build/internal/cjs/src/collections-v1-collection-media-collections.context.js.map +0 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.http.d.ts +0 -25
- package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js +0 -490
- package/build/internal/cjs/src/collections-v1-collection-media-collections.http.js.map +0 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
- package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js +0 -278
- package/build/internal/cjs/src/collections-v1-collection-media-collections.meta.js.map +0 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.public.d.ts +0 -104
- package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js +0 -123
- package/build/internal/cjs/src/collections-v1-collection-media-collections.public.js.map +0 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js +0 -94
- package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js.map +0 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts +0 -1338
- package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js +0 -574
- package/build/internal/cjs/src/collections-v1-collection-media-collections.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/collections-v1-collection-media-collections.context.d.ts +0 -21
- package/build/internal/es/src/collections-v1-collection-media-collections.context.js +0 -21
- package/build/internal/es/src/collections-v1-collection-media-collections.context.js.map +0 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.http.d.ts +0 -25
- package/build/internal/es/src/collections-v1-collection-media-collections.http.js +0 -474
- package/build/internal/es/src/collections-v1-collection-media-collections.http.js.map +0 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.meta.d.ts +0 -48
- package/build/internal/es/src/collections-v1-collection-media-collections.meta.js +0 -239
- package/build/internal/es/src/collections-v1-collection-media-collections.meta.js.map +0 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.public.d.ts +0 -104
- package/build/internal/es/src/collections-v1-collection-media-collections.public.js +0 -98
- package/build/internal/es/src/collections-v1-collection-media-collections.public.js.map +0 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.types.js +0 -91
- package/build/internal/es/src/collections-v1-collection-media-collections.types.js.map +0 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.d.ts +0 -1338
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.js +0 -535
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface MediaCollection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection id
|
|
4
4
|
* @readonly
|
|
5
5
|
* @format GUID
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string;
|
|
8
8
|
/**
|
|
9
9
|
* Collection name
|
|
10
10
|
* @maxLength 100
|
|
@@ -26,7 +26,7 @@ export interface MediaCollection {
|
|
|
26
26
|
* when MediaCollection was created
|
|
27
27
|
* @readonly
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
_createdDate?: Date | null;
|
|
30
30
|
/** Items in the collection */
|
|
31
31
|
items?: MediaCollectionItem[];
|
|
32
32
|
/**
|
|
@@ -39,7 +39,7 @@ export interface MediaCollection {
|
|
|
39
39
|
/** If true, the collection is locked and should not be updated */
|
|
40
40
|
locked?: boolean;
|
|
41
41
|
}
|
|
42
|
-
|
|
42
|
+
interface CollectionMember {
|
|
43
43
|
/**
|
|
44
44
|
* Member id
|
|
45
45
|
* @readonly
|
|
@@ -62,7 +62,7 @@ export interface CollectionMember {
|
|
|
62
62
|
*/
|
|
63
63
|
photoUrl?: string | null;
|
|
64
64
|
}
|
|
65
|
-
|
|
65
|
+
interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
66
66
|
/** Photo metadata */
|
|
67
67
|
photoMetadata?: PhotoMetadata;
|
|
68
68
|
/** Video metadata */
|
|
@@ -74,7 +74,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
74
74
|
* @readonly
|
|
75
75
|
* @format GUID
|
|
76
76
|
*/
|
|
77
|
-
|
|
77
|
+
_id?: string | null;
|
|
78
78
|
/** item url for photos or video */
|
|
79
79
|
mediaUrl?: string | null;
|
|
80
80
|
/** if not present in an update it mean the item will be added as currentTimestamp */
|
|
@@ -98,7 +98,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
98
98
|
* When the item was last updated
|
|
99
99
|
* @readonly
|
|
100
100
|
*/
|
|
101
|
-
|
|
101
|
+
_updatedDate?: Date | null;
|
|
102
102
|
/** The owner of the media */
|
|
103
103
|
mediaOwner?: MediaOwnerWithLiterals;
|
|
104
104
|
/** Tags for media */
|
|
@@ -109,7 +109,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
109
109
|
galleryId?: string;
|
|
110
110
|
}
|
|
111
111
|
/** @oneof */
|
|
112
|
-
|
|
112
|
+
interface MediaCollectionItemMetadataOneOf {
|
|
113
113
|
/** Photo metadata */
|
|
114
114
|
photoMetadata?: PhotoMetadata;
|
|
115
115
|
/** Video metadata */
|
|
@@ -117,7 +117,7 @@ export interface MediaCollectionItemMetadataOneOf {
|
|
|
117
117
|
/** Text metadata */
|
|
118
118
|
textMetadata?: TextMetadata;
|
|
119
119
|
}
|
|
120
|
-
|
|
120
|
+
interface Link {
|
|
121
121
|
type?: TypeWithLiterals;
|
|
122
122
|
/** Link text */
|
|
123
123
|
text?: string | null;
|
|
@@ -128,7 +128,7 @@ export interface Link {
|
|
|
128
128
|
/** Data on how to construct the link from wix editor inputs */
|
|
129
129
|
wixLinkData?: WixLink;
|
|
130
130
|
}
|
|
131
|
-
|
|
131
|
+
declare enum Type {
|
|
132
132
|
/** Undefined */
|
|
133
133
|
Undefined = "Undefined",
|
|
134
134
|
/** external link */
|
|
@@ -137,9 +137,9 @@ export declare enum Type {
|
|
|
137
137
|
Internal = "Internal"
|
|
138
138
|
}
|
|
139
139
|
/** @enumType */
|
|
140
|
-
|
|
140
|
+
type TypeWithLiterals = Type | 'Undefined' | 'External' | 'Internal';
|
|
141
141
|
/** The link object generated by panels in the editor and used by applications in Wix */
|
|
142
|
-
|
|
142
|
+
interface WixLink extends WixLinkLinkOneOf {
|
|
143
143
|
/** External link type */
|
|
144
144
|
external?: ExternalLink;
|
|
145
145
|
/** Page link type */
|
|
@@ -162,7 +162,7 @@ export interface WixLink extends WixLinkLinkOneOf {
|
|
|
162
162
|
tpaPage?: TpaPageLink;
|
|
163
163
|
}
|
|
164
164
|
/** @oneof */
|
|
165
|
-
|
|
165
|
+
interface WixLinkLinkOneOf {
|
|
166
166
|
/** External link type */
|
|
167
167
|
external?: ExternalLink;
|
|
168
168
|
/** Page link type */
|
|
@@ -184,7 +184,7 @@ export interface WixLinkLinkOneOf {
|
|
|
184
184
|
/** TPA link type */
|
|
185
185
|
tpaPage?: TpaPageLink;
|
|
186
186
|
}
|
|
187
|
-
|
|
187
|
+
interface ExternalLink {
|
|
188
188
|
/**
|
|
189
189
|
* The url of the page
|
|
190
190
|
* @format WEB_URL
|
|
@@ -198,7 +198,7 @@ export interface ExternalLink {
|
|
|
198
198
|
* Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
|
|
199
199
|
* Following are the accepted 'rel' types by Wix applications.
|
|
200
200
|
*/
|
|
201
|
-
|
|
201
|
+
declare enum LinkRel {
|
|
202
202
|
/** default (not implemented) */
|
|
203
203
|
unknown_link_rel = "unknown_link_rel",
|
|
204
204
|
/** Indicates that the current document's original author or publisher does not endorse the referenced document. */
|
|
@@ -211,8 +211,8 @@ export declare enum LinkRel {
|
|
|
211
211
|
sponsored = "sponsored"
|
|
212
212
|
}
|
|
213
213
|
/** @enumType */
|
|
214
|
-
|
|
215
|
-
|
|
214
|
+
type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
|
|
215
|
+
interface PageLink {
|
|
216
216
|
/** The page id we want from the site */
|
|
217
217
|
pageId?: string;
|
|
218
218
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
|
@@ -223,7 +223,7 @@ export interface PageLink {
|
|
|
223
223
|
*/
|
|
224
224
|
rel?: LinkRelWithLiterals[];
|
|
225
225
|
}
|
|
226
|
-
|
|
226
|
+
interface AnchorLink {
|
|
227
227
|
/** The name of the anchor */
|
|
228
228
|
anchorName?: string;
|
|
229
229
|
/** The data id (from the JSON page) of the anchor that should be used */
|
|
@@ -236,7 +236,7 @@ export interface AnchorLink {
|
|
|
236
236
|
*/
|
|
237
237
|
rel?: LinkRelWithLiterals[];
|
|
238
238
|
}
|
|
239
|
-
|
|
239
|
+
interface DynamicPageLink {
|
|
240
240
|
/** The router that handles this link */
|
|
241
241
|
routerId?: string;
|
|
242
242
|
/** The path data we'd like */
|
|
@@ -249,7 +249,7 @@ export interface DynamicPageLink {
|
|
|
249
249
|
*/
|
|
250
250
|
rel?: LinkRelWithLiterals[];
|
|
251
251
|
}
|
|
252
|
-
|
|
252
|
+
interface DocumentLink {
|
|
253
253
|
/** The id of the document */
|
|
254
254
|
docId?: string;
|
|
255
255
|
/** The name of the document for download purposes */
|
|
@@ -257,7 +257,7 @@ export interface DocumentLink {
|
|
|
257
257
|
/** If this document can be indexed by scrapers, default is false */
|
|
258
258
|
indexable?: boolean;
|
|
259
259
|
}
|
|
260
|
-
|
|
260
|
+
interface EmailLink {
|
|
261
261
|
/**
|
|
262
262
|
* The email we will be sending a message to
|
|
263
263
|
* @format EMAIL
|
|
@@ -268,7 +268,7 @@ export interface EmailLink {
|
|
|
268
268
|
/** The body of the email */
|
|
269
269
|
body?: string | null;
|
|
270
270
|
}
|
|
271
|
-
|
|
271
|
+
interface PhoneLink {
|
|
272
272
|
/**
|
|
273
273
|
* The phone number we want to link to
|
|
274
274
|
* @format PHONE
|
|
@@ -276,11 +276,11 @@ export interface PhoneLink {
|
|
|
276
276
|
*/
|
|
277
277
|
phoneNumber?: string;
|
|
278
278
|
}
|
|
279
|
-
|
|
279
|
+
interface AddressLink {
|
|
280
280
|
/** An address that we can link to */
|
|
281
281
|
address?: string;
|
|
282
282
|
}
|
|
283
|
-
|
|
283
|
+
interface WhatsAppLink {
|
|
284
284
|
/**
|
|
285
285
|
* The whatsApp phone number we want to connect with
|
|
286
286
|
* @format PHONE
|
|
@@ -288,7 +288,7 @@ export interface WhatsAppLink {
|
|
|
288
288
|
phoneNumber?: string;
|
|
289
289
|
}
|
|
290
290
|
/** Link to a TPA page */
|
|
291
|
-
|
|
291
|
+
interface TpaPageLink {
|
|
292
292
|
/** Type of item (e.g. 'wix.stores.sub_pages.product') */
|
|
293
293
|
itemTypeIdentifier?: string;
|
|
294
294
|
/** Id of linked item */
|
|
@@ -305,15 +305,15 @@ export interface TpaPageLink {
|
|
|
305
305
|
*/
|
|
306
306
|
rel?: LinkRelWithLiterals[];
|
|
307
307
|
}
|
|
308
|
-
|
|
308
|
+
declare enum DataType {
|
|
309
309
|
Undefined = "Undefined",
|
|
310
310
|
Photo = "Photo",
|
|
311
311
|
Video = "Video",
|
|
312
312
|
Text = "Text"
|
|
313
313
|
}
|
|
314
314
|
/** @enumType */
|
|
315
|
-
|
|
316
|
-
|
|
315
|
+
type DataTypeWithLiterals = DataType | 'Undefined' | 'Photo' | 'Video' | 'Text';
|
|
316
|
+
interface PhotoMetadata {
|
|
317
317
|
/** Photo width */
|
|
318
318
|
width?: number | null;
|
|
319
319
|
/** Photo height */
|
|
@@ -333,13 +333,13 @@ export interface PhotoMetadata {
|
|
|
333
333
|
/** id in WixMedia */
|
|
334
334
|
mediaId?: string | null;
|
|
335
335
|
}
|
|
336
|
-
|
|
336
|
+
interface Point {
|
|
337
337
|
/** x coordinate */
|
|
338
338
|
x?: number;
|
|
339
339
|
/** y coordinate */
|
|
340
340
|
y?: number;
|
|
341
341
|
}
|
|
342
|
-
|
|
342
|
+
interface UnsharpMasking {
|
|
343
343
|
/**
|
|
344
344
|
* number controls the amount of contrast that is added at the edges.
|
|
345
345
|
* @max 5
|
|
@@ -353,7 +353,7 @@ export interface UnsharpMasking {
|
|
|
353
353
|
*/
|
|
354
354
|
threshold?: number | null;
|
|
355
355
|
}
|
|
356
|
-
|
|
356
|
+
interface VideoMetadata {
|
|
357
357
|
/** Video width */
|
|
358
358
|
width?: number | null;
|
|
359
359
|
/** Video height */
|
|
@@ -369,7 +369,7 @@ export interface VideoMetadata {
|
|
|
369
369
|
/** External source's representation for this video's id */
|
|
370
370
|
externalId?: string | null;
|
|
371
371
|
}
|
|
372
|
-
|
|
372
|
+
declare enum Source {
|
|
373
373
|
/** Undefined */
|
|
374
374
|
Undefined = "Undefined",
|
|
375
375
|
/** Youtube */
|
|
@@ -380,8 +380,8 @@ export declare enum Source {
|
|
|
380
380
|
Custom = "Custom"
|
|
381
381
|
}
|
|
382
382
|
/** @enumType */
|
|
383
|
-
|
|
384
|
-
|
|
383
|
+
type SourceWithLiterals = Source | 'Undefined' | 'Youtube' | 'Vimeo' | 'Custom';
|
|
384
|
+
interface Thumbnail {
|
|
385
385
|
/** Thumbnail url */
|
|
386
386
|
url?: string | null;
|
|
387
387
|
/** Thumbnail width */
|
|
@@ -393,7 +393,7 @@ export interface Thumbnail {
|
|
|
393
393
|
/** The focal point of the image */
|
|
394
394
|
focalPoint?: Point;
|
|
395
395
|
}
|
|
396
|
-
|
|
396
|
+
interface Resolution {
|
|
397
397
|
/** eg 720p, 1024p etc */
|
|
398
398
|
videoMode?: string | null;
|
|
399
399
|
/** Video width */
|
|
@@ -403,7 +403,7 @@ export interface Resolution {
|
|
|
403
403
|
/** Map representing the file format (eg mp4) to the url. In case of an external source the format can be youtube, vimeo, etc. */
|
|
404
404
|
urls?: Record<string, string>;
|
|
405
405
|
}
|
|
406
|
-
|
|
406
|
+
interface TextMetadata {
|
|
407
407
|
/** text data */
|
|
408
408
|
html?: string | null;
|
|
409
409
|
/** css style info for container */
|
|
@@ -413,7 +413,7 @@ export interface TextMetadata {
|
|
|
413
413
|
/** the wix editor's font Id used to display the text data */
|
|
414
414
|
editorFontId?: string | null;
|
|
415
415
|
}
|
|
416
|
-
|
|
416
|
+
declare enum MediaOwner {
|
|
417
417
|
/** Undefined */
|
|
418
418
|
Undefined = "Undefined",
|
|
419
419
|
/** Wix */
|
|
@@ -424,8 +424,8 @@ export declare enum MediaOwner {
|
|
|
424
424
|
Custom = "Custom"
|
|
425
425
|
}
|
|
426
426
|
/** @enumType */
|
|
427
|
-
|
|
428
|
-
|
|
427
|
+
type MediaOwnerWithLiterals = MediaOwner | 'Undefined' | 'Wix' | 'DeviantArt' | 'Custom';
|
|
428
|
+
declare enum PrivacySettings {
|
|
429
429
|
/** Undefined */
|
|
430
430
|
Undefined = "Undefined",
|
|
431
431
|
/** Public */
|
|
@@ -434,31 +434,31 @@ export declare enum PrivacySettings {
|
|
|
434
434
|
Secret = "Secret"
|
|
435
435
|
}
|
|
436
436
|
/** @enumType */
|
|
437
|
-
|
|
438
|
-
|
|
437
|
+
type PrivacySettingsWithLiterals = PrivacySettings | 'Undefined' | 'Public' | 'Secret';
|
|
438
|
+
interface PermanentSiteDeletedResponse {
|
|
439
439
|
/** @format GUID */
|
|
440
440
|
requestId?: string;
|
|
441
441
|
uniqueServiceIdentifier?: string;
|
|
442
442
|
status?: StatusWithLiterals;
|
|
443
443
|
/** @readonly */
|
|
444
|
-
|
|
444
|
+
_createdDate?: Date | null;
|
|
445
445
|
}
|
|
446
|
-
|
|
446
|
+
declare enum Status {
|
|
447
447
|
UNKNOWN = "UNKNOWN",
|
|
448
448
|
HANDLED = "HANDLED",
|
|
449
449
|
NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
|
|
450
450
|
}
|
|
451
451
|
/** @enumType */
|
|
452
|
-
|
|
453
|
-
|
|
452
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'HANDLED' | 'NOTHING_TO_HANDLE';
|
|
453
|
+
interface Empty {
|
|
454
454
|
}
|
|
455
|
-
|
|
455
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
456
456
|
createdEvent?: EntityCreatedEvent;
|
|
457
457
|
updatedEvent?: EntityUpdatedEvent;
|
|
458
458
|
deletedEvent?: EntityDeletedEvent;
|
|
459
459
|
actionEvent?: ActionEvent;
|
|
460
460
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
461
|
-
|
|
461
|
+
_id?: string;
|
|
462
462
|
/**
|
|
463
463
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
464
464
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -487,36 +487,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
487
487
|
entityEventSequence?: string | null;
|
|
488
488
|
}
|
|
489
489
|
/** @oneof */
|
|
490
|
-
|
|
490
|
+
interface DomainEventBodyOneOf {
|
|
491
491
|
createdEvent?: EntityCreatedEvent;
|
|
492
492
|
updatedEvent?: EntityUpdatedEvent;
|
|
493
493
|
deletedEvent?: EntityDeletedEvent;
|
|
494
494
|
actionEvent?: ActionEvent;
|
|
495
495
|
}
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
499
|
-
restoreInfo?: RestoreInfo;
|
|
496
|
+
interface EntityCreatedEvent {
|
|
497
|
+
entity?: string;
|
|
500
498
|
}
|
|
501
|
-
|
|
499
|
+
interface RestoreInfo {
|
|
502
500
|
deletedDate?: Date | null;
|
|
503
501
|
}
|
|
504
|
-
|
|
502
|
+
interface EntityUpdatedEvent {
|
|
505
503
|
/**
|
|
506
504
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
507
505
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
508
506
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
509
507
|
*/
|
|
510
|
-
|
|
508
|
+
currentEntity?: string;
|
|
511
509
|
}
|
|
512
|
-
|
|
510
|
+
interface EntityDeletedEvent {
|
|
513
511
|
/** Entity that was deleted. */
|
|
514
|
-
|
|
512
|
+
deletedEntity?: string | null;
|
|
515
513
|
}
|
|
516
|
-
|
|
517
|
-
|
|
514
|
+
interface ActionEvent {
|
|
515
|
+
body?: string;
|
|
518
516
|
}
|
|
519
|
-
|
|
517
|
+
interface MessageEnvelope {
|
|
520
518
|
/**
|
|
521
519
|
* App instance ID.
|
|
522
520
|
* @format GUID
|
|
@@ -532,7 +530,7 @@ export interface MessageEnvelope {
|
|
|
532
530
|
/** Stringify payload. */
|
|
533
531
|
data?: string;
|
|
534
532
|
}
|
|
535
|
-
|
|
533
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
536
534
|
/**
|
|
537
535
|
* ID of a site visitor that has not logged in to the site.
|
|
538
536
|
* @format GUID
|
|
@@ -557,7 +555,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
557
555
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
558
556
|
}
|
|
559
557
|
/** @oneof */
|
|
560
|
-
|
|
558
|
+
interface IdentificationDataIdOneOf {
|
|
561
559
|
/**
|
|
562
560
|
* ID of a site visitor that has not logged in to the site.
|
|
563
561
|
* @format GUID
|
|
@@ -579,7 +577,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
579
577
|
*/
|
|
580
578
|
appId?: string;
|
|
581
579
|
}
|
|
582
|
-
|
|
580
|
+
declare enum WebhookIdentityType {
|
|
583
581
|
UNKNOWN = "UNKNOWN",
|
|
584
582
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
585
583
|
MEMBER = "MEMBER",
|
|
@@ -587,8 +585,8 @@ export declare enum WebhookIdentityType {
|
|
|
587
585
|
APP = "APP"
|
|
588
586
|
}
|
|
589
587
|
/** @enumType */
|
|
590
|
-
|
|
591
|
-
|
|
588
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
589
|
+
interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
592
590
|
/** Collection created */
|
|
593
591
|
collectionCreated?: CollectionCreated;
|
|
594
592
|
/** Items added to collection */
|
|
@@ -601,7 +599,7 @@ export interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
|
601
599
|
memberLeftCollection?: MemberLeftCollection;
|
|
602
600
|
}
|
|
603
601
|
/** @oneof */
|
|
604
|
-
|
|
602
|
+
interface CollectionEventEventTypeOneOf {
|
|
605
603
|
/** Collection created */
|
|
606
604
|
collectionCreated?: CollectionCreated;
|
|
607
605
|
/** Items added to collection */
|
|
@@ -613,7 +611,7 @@ export interface CollectionEventEventTypeOneOf {
|
|
|
613
611
|
/** Member left collection */
|
|
614
612
|
memberLeftCollection?: MemberLeftCollection;
|
|
615
613
|
}
|
|
616
|
-
|
|
614
|
+
interface CollectionItemId {
|
|
617
615
|
/**
|
|
618
616
|
* Id of the gallery in ProGallery
|
|
619
617
|
* @format GUID
|
|
@@ -625,12 +623,12 @@ export interface CollectionItemId {
|
|
|
625
623
|
*/
|
|
626
624
|
itemId?: string;
|
|
627
625
|
}
|
|
628
|
-
|
|
626
|
+
interface CollectionCreated {
|
|
629
627
|
/**
|
|
630
628
|
* Collection id
|
|
631
629
|
* @format GUID
|
|
632
630
|
*/
|
|
633
|
-
|
|
631
|
+
_id?: string;
|
|
634
632
|
/**
|
|
635
633
|
* Collection name
|
|
636
634
|
* @maxLength 100
|
|
@@ -647,11 +645,11 @@ export interface CollectionCreated {
|
|
|
647
645
|
*/
|
|
648
646
|
creatorMemberId?: string;
|
|
649
647
|
/** When the collection was created */
|
|
650
|
-
|
|
648
|
+
_createdDate?: Date | null;
|
|
651
649
|
/** Privacy settings */
|
|
652
650
|
privacySettings?: PrivacySettingsWithLiterals;
|
|
653
651
|
}
|
|
654
|
-
|
|
652
|
+
interface ItemsAddedToCollection {
|
|
655
653
|
/**
|
|
656
654
|
* Id of the collection
|
|
657
655
|
* @format GUID
|
|
@@ -667,7 +665,7 @@ export interface ItemsAddedToCollection {
|
|
|
667
665
|
/** When the items were added */
|
|
668
666
|
addedDate?: Date | null;
|
|
669
667
|
}
|
|
670
|
-
|
|
668
|
+
interface ItemsRemovedFromCollection {
|
|
671
669
|
/**
|
|
672
670
|
* Id of the collection
|
|
673
671
|
* @format GUID
|
|
@@ -686,7 +684,7 @@ export interface ItemsRemovedFromCollection {
|
|
|
686
684
|
/** When the items were removed */
|
|
687
685
|
removedDate?: Date | null;
|
|
688
686
|
}
|
|
689
|
-
|
|
687
|
+
interface MemberJoinedToCollection {
|
|
690
688
|
/**
|
|
691
689
|
* Id of the collection
|
|
692
690
|
* @format GUID
|
|
@@ -700,7 +698,7 @@ export interface MemberJoinedToCollection {
|
|
|
700
698
|
/** When the member was joined */
|
|
701
699
|
joinedDate?: Date | null;
|
|
702
700
|
}
|
|
703
|
-
|
|
701
|
+
interface MemberLeftCollection {
|
|
704
702
|
/**
|
|
705
703
|
* Id of the collection
|
|
706
704
|
* @format GUID
|
|
@@ -714,7 +712,7 @@ export interface MemberLeftCollection {
|
|
|
714
712
|
/** When the member left */
|
|
715
713
|
leftDate?: Date | null;
|
|
716
714
|
}
|
|
717
|
-
|
|
715
|
+
interface GetMediaCollectionRequest {
|
|
718
716
|
/**
|
|
719
717
|
* Collection id
|
|
720
718
|
* @format GUID
|
|
@@ -729,13 +727,13 @@ export interface GetMediaCollectionRequest {
|
|
|
729
727
|
*/
|
|
730
728
|
limit?: number | null;
|
|
731
729
|
}
|
|
732
|
-
|
|
730
|
+
interface GetMediaCollectionResponse {
|
|
733
731
|
/** The collection */
|
|
734
732
|
mediaCollection?: MediaCollection;
|
|
735
733
|
/** The member's status in the collection */
|
|
736
734
|
memberStatus?: MemberStatusWithLiterals;
|
|
737
735
|
}
|
|
738
|
-
|
|
736
|
+
declare enum MemberStatus {
|
|
739
737
|
/** Undefined */
|
|
740
738
|
UNDEFINED = "UNDEFINED",
|
|
741
739
|
/** Not a member */
|
|
@@ -746,8 +744,8 @@ export declare enum MemberStatus {
|
|
|
746
744
|
ADMIN = "ADMIN"
|
|
747
745
|
}
|
|
748
746
|
/** @enumType */
|
|
749
|
-
|
|
750
|
-
|
|
747
|
+
type MemberStatusWithLiterals = MemberStatus | 'UNDEFINED' | 'NOT_MEMBER' | 'MEMBER' | 'ADMIN';
|
|
748
|
+
interface ListCollectionsForItemRequest {
|
|
751
749
|
/**
|
|
752
750
|
* Gallery id
|
|
753
751
|
* @format GUID
|
|
@@ -759,11 +757,11 @@ export interface ListCollectionsForItemRequest {
|
|
|
759
757
|
*/
|
|
760
758
|
itemId: string;
|
|
761
759
|
}
|
|
762
|
-
|
|
760
|
+
interface ListCollectionsForItemResponse {
|
|
763
761
|
/** The collections that the item belongs to */
|
|
764
762
|
itemInCollections?: ItemInCollection[];
|
|
765
763
|
}
|
|
766
|
-
|
|
764
|
+
interface ItemInCollection {
|
|
767
765
|
/**
|
|
768
766
|
* Collection id
|
|
769
767
|
* @format GUID
|
|
@@ -791,7 +789,7 @@ export interface ItemInCollection {
|
|
|
791
789
|
*/
|
|
792
790
|
creatorNickname?: string | null;
|
|
793
791
|
}
|
|
794
|
-
|
|
792
|
+
interface GetCollectionItemRequest {
|
|
795
793
|
/**
|
|
796
794
|
* Collection id
|
|
797
795
|
* @format GUID
|
|
@@ -803,11 +801,11 @@ export interface GetCollectionItemRequest {
|
|
|
803
801
|
*/
|
|
804
802
|
itemId: string;
|
|
805
803
|
}
|
|
806
|
-
|
|
804
|
+
interface GetCollectionItemResponse {
|
|
807
805
|
/** The item */
|
|
808
806
|
item?: MediaCollectionItem;
|
|
809
807
|
}
|
|
810
|
-
|
|
808
|
+
interface ListMediaCollectionsRequest {
|
|
811
809
|
/**
|
|
812
810
|
* the amount of collections per response, default is 1000
|
|
813
811
|
* @min 1
|
|
@@ -822,10 +820,10 @@ export interface ListMediaCollectionsRequest {
|
|
|
822
820
|
*/
|
|
823
821
|
filterByRoles?: FilterByRoles;
|
|
824
822
|
}
|
|
825
|
-
|
|
823
|
+
interface FilterByRoles {
|
|
826
824
|
roles?: MemberStatusWithLiterals[];
|
|
827
825
|
}
|
|
828
|
-
|
|
826
|
+
interface ListMediaCollectionsResponse {
|
|
829
827
|
/** The collections and the member's role in them */
|
|
830
828
|
collectionsStatus?: CollectionAndStatus[];
|
|
831
829
|
/**
|
|
@@ -834,13 +832,13 @@ export interface ListMediaCollectionsResponse {
|
|
|
834
832
|
*/
|
|
835
833
|
totalCollectionsCount?: number | null;
|
|
836
834
|
}
|
|
837
|
-
|
|
835
|
+
interface CollectionAndStatus {
|
|
838
836
|
/** The Media Collection */
|
|
839
837
|
mediaCollection?: MediaCollection;
|
|
840
838
|
/** The member's status in the collection */
|
|
841
839
|
memberStatus?: MemberStatusWithLiterals;
|
|
842
840
|
}
|
|
843
|
-
|
|
841
|
+
interface CreateMediaCollectionRequest {
|
|
844
842
|
/**
|
|
845
843
|
* Name of the collection
|
|
846
844
|
* @minLength 1
|
|
@@ -857,7 +855,7 @@ export interface CreateMediaCollectionRequest {
|
|
|
857
855
|
/** Items to add to the collection */
|
|
858
856
|
items?: AddItem[];
|
|
859
857
|
}
|
|
860
|
-
|
|
858
|
+
interface AddItem {
|
|
861
859
|
/**
|
|
862
860
|
* Gallery id
|
|
863
861
|
* @format GUID
|
|
@@ -871,14 +869,14 @@ export interface AddItem {
|
|
|
871
869
|
/** Order index of the item */
|
|
872
870
|
orderIndex?: number | null;
|
|
873
871
|
}
|
|
874
|
-
|
|
872
|
+
interface CreateMediaCollectionResponse {
|
|
875
873
|
/**
|
|
876
874
|
* id of the collection that was created
|
|
877
875
|
* @format GUID
|
|
878
876
|
*/
|
|
879
877
|
mediaCollectionId?: string;
|
|
880
878
|
}
|
|
881
|
-
|
|
879
|
+
interface PartiallyUpdateMediaCollectionRequest {
|
|
882
880
|
/** Collection to update */
|
|
883
881
|
mediaCollection: MediaCollection;
|
|
884
882
|
/**
|
|
@@ -887,9 +885,9 @@ export interface PartiallyUpdateMediaCollectionRequest {
|
|
|
887
885
|
*/
|
|
888
886
|
fieldMask: string[];
|
|
889
887
|
}
|
|
890
|
-
|
|
888
|
+
interface PartiallyUpdateMediaCollectionResponse {
|
|
891
889
|
}
|
|
892
|
-
|
|
890
|
+
interface UpdateCollectionLockRequest {
|
|
893
891
|
/**
|
|
894
892
|
* Collection to lock
|
|
895
893
|
* @format GUID
|
|
@@ -898,18 +896,18 @@ export interface UpdateCollectionLockRequest {
|
|
|
898
896
|
/** Lock status */
|
|
899
897
|
locked?: boolean;
|
|
900
898
|
}
|
|
901
|
-
|
|
899
|
+
interface UpdateCollectionLockResponse {
|
|
902
900
|
}
|
|
903
|
-
|
|
901
|
+
interface DeleteMediaCollectionRequest {
|
|
904
902
|
/**
|
|
905
903
|
* the collection to delete
|
|
906
904
|
* @format GUID
|
|
907
905
|
*/
|
|
908
906
|
mediaCollectionId: string;
|
|
909
907
|
}
|
|
910
|
-
|
|
908
|
+
interface DeleteMediaCollectionResponse {
|
|
911
909
|
}
|
|
912
|
-
|
|
910
|
+
interface ListCollectionMembersRequest {
|
|
913
911
|
/**
|
|
914
912
|
* the collection to get its members
|
|
915
913
|
* @format GUID
|
|
@@ -918,21 +916,21 @@ export interface ListCollectionMembersRequest {
|
|
|
918
916
|
/** Filter the members by their role in the collection */
|
|
919
917
|
filterBy?: FilterBy;
|
|
920
918
|
}
|
|
921
|
-
|
|
919
|
+
interface FilterBy {
|
|
922
920
|
/** Member's status in the collection */
|
|
923
921
|
memberStatus?: MemberStatusWithLiterals;
|
|
924
922
|
}
|
|
925
|
-
|
|
923
|
+
interface ListCollectionMembersResponse {
|
|
926
924
|
/** The collection's members and their roles */
|
|
927
925
|
membersRoles?: MemberAndStatus[];
|
|
928
926
|
}
|
|
929
|
-
|
|
927
|
+
interface MemberAndStatus {
|
|
930
928
|
/** The member */
|
|
931
929
|
member?: CollectionMember;
|
|
932
930
|
/** The member's role in the collection */
|
|
933
931
|
memberStatus?: MemberStatusWithLiterals;
|
|
934
932
|
}
|
|
935
|
-
|
|
933
|
+
interface AddItemsRequest {
|
|
936
934
|
/**
|
|
937
935
|
* Collection to add items
|
|
938
936
|
* @format GUID
|
|
@@ -941,9 +939,9 @@ export interface AddItemsRequest {
|
|
|
941
939
|
/** Items to add */
|
|
942
940
|
items?: AddItem[];
|
|
943
941
|
}
|
|
944
|
-
|
|
942
|
+
interface AddItemsResponse {
|
|
945
943
|
}
|
|
946
|
-
|
|
944
|
+
interface RemoveItemsRequest {
|
|
947
945
|
/**
|
|
948
946
|
* Collection to remove items from
|
|
949
947
|
* @format GUID
|
|
@@ -955,9 +953,9 @@ export interface RemoveItemsRequest {
|
|
|
955
953
|
*/
|
|
956
954
|
itemsIds?: string[];
|
|
957
955
|
}
|
|
958
|
-
|
|
956
|
+
interface RemoveItemsResponse {
|
|
959
957
|
}
|
|
960
|
-
|
|
958
|
+
interface UpdateItemsRequest {
|
|
961
959
|
/**
|
|
962
960
|
* Collection to update items
|
|
963
961
|
* @format GUID
|
|
@@ -965,7 +963,7 @@ export interface UpdateItemsRequest {
|
|
|
965
963
|
mediaCollectionId?: string;
|
|
966
964
|
items?: UpdateItem[];
|
|
967
965
|
}
|
|
968
|
-
|
|
966
|
+
interface UpdateItem {
|
|
969
967
|
/**
|
|
970
968
|
* Item to update
|
|
971
969
|
* @format GUID
|
|
@@ -974,18 +972,18 @@ export interface UpdateItem {
|
|
|
974
972
|
/** New order index of the item */
|
|
975
973
|
orderIndex?: number;
|
|
976
974
|
}
|
|
977
|
-
|
|
975
|
+
interface UpdateItemsResponse {
|
|
978
976
|
}
|
|
979
|
-
|
|
977
|
+
interface JoinToCollectionRequest {
|
|
980
978
|
/**
|
|
981
979
|
* Collection to join
|
|
982
980
|
* @format GUID
|
|
983
981
|
*/
|
|
984
982
|
mediaCollectionId: string;
|
|
985
983
|
}
|
|
986
|
-
|
|
984
|
+
interface JoinToCollectionResponse {
|
|
987
985
|
}
|
|
988
|
-
|
|
986
|
+
interface RemoveMemberFromCollectionRequest {
|
|
989
987
|
/**
|
|
990
988
|
* Collection the member will be removed from being a member
|
|
991
989
|
* @format GUID
|
|
@@ -997,29 +995,29 @@ export interface RemoveMemberFromCollectionRequest {
|
|
|
997
995
|
*/
|
|
998
996
|
memberId?: string;
|
|
999
997
|
}
|
|
1000
|
-
|
|
998
|
+
interface RemoveMemberFromCollectionResponse {
|
|
1001
999
|
}
|
|
1002
|
-
|
|
1000
|
+
interface LeaveCollectionRequest {
|
|
1003
1001
|
/**
|
|
1004
1002
|
* Collection the member will be leaving
|
|
1005
1003
|
* @format GUID
|
|
1006
1004
|
*/
|
|
1007
1005
|
mediaCollectionId: string;
|
|
1008
1006
|
}
|
|
1009
|
-
|
|
1007
|
+
interface LeaveCollectionResponse {
|
|
1010
1008
|
}
|
|
1011
|
-
|
|
1009
|
+
interface ListCollectionItemsRequest {
|
|
1012
1010
|
/**
|
|
1013
1011
|
* Collection to get its items
|
|
1014
1012
|
* @format GUID
|
|
1015
1013
|
*/
|
|
1016
1014
|
mediaCollectionId: string;
|
|
1017
1015
|
}
|
|
1018
|
-
|
|
1016
|
+
interface ListCollectionItemsResponse {
|
|
1019
1017
|
/** The collection's items */
|
|
1020
1018
|
collectionItems?: CollectionItem[];
|
|
1021
1019
|
}
|
|
1022
|
-
|
|
1020
|
+
interface CollectionItem {
|
|
1023
1021
|
/**
|
|
1024
1022
|
* Gallery id
|
|
1025
1023
|
* @format GUID
|
|
@@ -1035,12 +1033,180 @@ export interface CollectionItem {
|
|
|
1035
1033
|
/** Date the item was added to the collection */
|
|
1036
1034
|
addedDate?: Date | null;
|
|
1037
1035
|
}
|
|
1038
|
-
|
|
1036
|
+
interface ListAllItemsBelongToCollectionRequest {
|
|
1039
1037
|
}
|
|
1040
|
-
|
|
1038
|
+
interface ListAllItemsBelongToCollectionResponse {
|
|
1041
1039
|
/**
|
|
1042
1040
|
* List of the item ids that belong to one or more collection
|
|
1043
1041
|
* @format GUID
|
|
1044
1042
|
*/
|
|
1045
1043
|
itemIds?: string[];
|
|
1046
1044
|
}
|
|
1045
|
+
interface BaseEventMetadata {
|
|
1046
|
+
/**
|
|
1047
|
+
* App instance ID.
|
|
1048
|
+
* @format GUID
|
|
1049
|
+
*/
|
|
1050
|
+
instanceId?: string | null;
|
|
1051
|
+
/**
|
|
1052
|
+
* Event type.
|
|
1053
|
+
* @maxLength 150
|
|
1054
|
+
*/
|
|
1055
|
+
eventType?: string;
|
|
1056
|
+
/** The identification type and identity data. */
|
|
1057
|
+
identity?: IdentificationData;
|
|
1058
|
+
}
|
|
1059
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1060
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1061
|
+
_id?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1064
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1065
|
+
*/
|
|
1066
|
+
entityFqdn?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1069
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1070
|
+
*/
|
|
1071
|
+
slug?: string;
|
|
1072
|
+
/** ID of the entity associated with the event. */
|
|
1073
|
+
entityId?: string;
|
|
1074
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1075
|
+
eventTime?: Date | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1078
|
+
* (for example, GDPR).
|
|
1079
|
+
*/
|
|
1080
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1081
|
+
/** If present, indicates the action that triggered the event. */
|
|
1082
|
+
originatedFrom?: string | null;
|
|
1083
|
+
/**
|
|
1084
|
+
* 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.
|
|
1085
|
+
* 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.
|
|
1086
|
+
*/
|
|
1087
|
+
entityEventSequence?: string | null;
|
|
1088
|
+
}
|
|
1089
|
+
interface CollectionCreatedEnvelope {
|
|
1090
|
+
entity: MediaCollection;
|
|
1091
|
+
metadata: EventMetadata;
|
|
1092
|
+
}
|
|
1093
|
+
interface GetOptions {
|
|
1094
|
+
/** number of items to skip in the current sort order, default is 0 */
|
|
1095
|
+
offset?: number | null;
|
|
1096
|
+
/**
|
|
1097
|
+
* The amount of items per response, default is 50
|
|
1098
|
+
* @min 1
|
|
1099
|
+
* @max 200
|
|
1100
|
+
*/
|
|
1101
|
+
limit?: number | null;
|
|
1102
|
+
}
|
|
1103
|
+
interface ListCollectionsForItemOptions {
|
|
1104
|
+
/**
|
|
1105
|
+
* Gallery id
|
|
1106
|
+
* @format GUID
|
|
1107
|
+
*/
|
|
1108
|
+
galleryId?: string;
|
|
1109
|
+
}
|
|
1110
|
+
interface GetCollectionItemIdentifiers {
|
|
1111
|
+
/**
|
|
1112
|
+
* Collection id
|
|
1113
|
+
* @format GUID
|
|
1114
|
+
*/
|
|
1115
|
+
mediaCollectionId: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* Item id
|
|
1118
|
+
* @format GUID
|
|
1119
|
+
*/
|
|
1120
|
+
itemId: string;
|
|
1121
|
+
}
|
|
1122
|
+
interface ListOptions {
|
|
1123
|
+
/**
|
|
1124
|
+
* the amount of collections per response, default is 1000
|
|
1125
|
+
* @min 1
|
|
1126
|
+
* @max 2000
|
|
1127
|
+
*/
|
|
1128
|
+
limit?: number | null;
|
|
1129
|
+
/** number of collections to skip in the current sort order, default is 0 */
|
|
1130
|
+
offset?: number | null;
|
|
1131
|
+
/**
|
|
1132
|
+
* If empty, no filter will be applied
|
|
1133
|
+
* Else, will return only collections that the member has those roles on them. Currently supporting: MEMBER, ADMIN.
|
|
1134
|
+
*/
|
|
1135
|
+
filterByRoles?: FilterByRoles;
|
|
1136
|
+
}
|
|
1137
|
+
interface CreateOptions {
|
|
1138
|
+
/**
|
|
1139
|
+
* Description of the collection
|
|
1140
|
+
* @maxLength 500
|
|
1141
|
+
*/
|
|
1142
|
+
description?: string | null;
|
|
1143
|
+
/** Privacy settings of the collection */
|
|
1144
|
+
privacySettings?: PrivacySettingsWithLiterals;
|
|
1145
|
+
/** Items to add to the collection */
|
|
1146
|
+
items?: AddItem[];
|
|
1147
|
+
}
|
|
1148
|
+
interface PartiallyUpdateMediaCollection {
|
|
1149
|
+
/**
|
|
1150
|
+
* Collection id
|
|
1151
|
+
* @readonly
|
|
1152
|
+
* @format GUID
|
|
1153
|
+
*/
|
|
1154
|
+
_id?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* Collection name
|
|
1157
|
+
* @maxLength 100
|
|
1158
|
+
*/
|
|
1159
|
+
name?: string;
|
|
1160
|
+
/** @maxLength 500 */
|
|
1161
|
+
description?: string | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* total count of MediaCollection members
|
|
1164
|
+
* @readonly
|
|
1165
|
+
*/
|
|
1166
|
+
membersCount?: number;
|
|
1167
|
+
/**
|
|
1168
|
+
* the member who created the MediaCollection
|
|
1169
|
+
* @readonly
|
|
1170
|
+
*/
|
|
1171
|
+
creator?: CollectionMember;
|
|
1172
|
+
/**
|
|
1173
|
+
* when MediaCollection was created
|
|
1174
|
+
* @readonly
|
|
1175
|
+
*/
|
|
1176
|
+
_createdDate?: Date | null;
|
|
1177
|
+
/** Items in the collection */
|
|
1178
|
+
items?: MediaCollectionItem[];
|
|
1179
|
+
/**
|
|
1180
|
+
* total count of items
|
|
1181
|
+
* @readonly
|
|
1182
|
+
*/
|
|
1183
|
+
itemsCount?: number;
|
|
1184
|
+
/** Privacy settings */
|
|
1185
|
+
privacySettings?: PrivacySettingsWithLiterals;
|
|
1186
|
+
/** If true, the collection is locked and should not be updated */
|
|
1187
|
+
locked?: boolean;
|
|
1188
|
+
}
|
|
1189
|
+
interface PartiallyUpdateOptions {
|
|
1190
|
+
/**
|
|
1191
|
+
* fields to update
|
|
1192
|
+
* supported fields: name, description, privacy_settings
|
|
1193
|
+
*/
|
|
1194
|
+
fieldMask: string[];
|
|
1195
|
+
}
|
|
1196
|
+
interface ListCollectionMembersOptions {
|
|
1197
|
+
/** Filter the members by their role in the collection */
|
|
1198
|
+
filterBy?: FilterBy;
|
|
1199
|
+
}
|
|
1200
|
+
interface AddItemsOptions {
|
|
1201
|
+
/** Items to add */
|
|
1202
|
+
items?: AddItem[];
|
|
1203
|
+
}
|
|
1204
|
+
interface RemoveItemsOptions {
|
|
1205
|
+
/**
|
|
1206
|
+
* Items to remove
|
|
1207
|
+
* @format GUID
|
|
1208
|
+
*/
|
|
1209
|
+
itemsIds?: string[];
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
export { type DomainEventBodyOneOf as $, type AddItemsOptions as A, type EmailLink as B, type CreateOptions as C, DataType as D, type ExternalLink as E, type PhoneLink as F, type GetOptions as G, type AddressLink as H, type WhatsAppLink as I, type TpaPageLink as J, type PhotoMetadata as K, type ListCollectionsForItemOptions as L, type MediaCollection as M, type Point as N, type Thumbnail as O, type PartiallyUpdateMediaCollection as P, type Resolution as Q, type RemoveItemsOptions as R, Source as S, Type as T, type UnsharpMasking as U, type VideoMetadata as V, WebhookIdentityType as W, type TextMetadata as X, type PermanentSiteDeletedResponse as Y, type Empty as Z, type DomainEvent as _, type ListCollectionsForItemResponse as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type CollectionEvent as a8, type CollectionEventEventTypeOneOf as a9, type AddItemsResponse as aA, type RemoveItemsRequest as aB, type RemoveItemsResponse as aC, type UpdateItemsRequest as aD, type UpdateItem as aE, type UpdateItemsResponse as aF, type JoinToCollectionRequest as aG, type JoinToCollectionResponse as aH, type RemoveMemberFromCollectionRequest as aI, type RemoveMemberFromCollectionResponse as aJ, type LeaveCollectionRequest as aK, type LeaveCollectionResponse as aL, type ListCollectionItemsRequest as aM, type CollectionItem as aN, type ListAllItemsBelongToCollectionRequest as aO, type ListAllItemsBelongToCollectionResponse as aP, type BaseEventMetadata as aQ, type EventMetadata as aR, type CollectionItemId as aa, type CollectionCreated as ab, type ItemsAddedToCollection as ac, type ItemsRemovedFromCollection as ad, type MemberJoinedToCollection as ae, type MemberLeftCollection as af, type GetMediaCollectionRequest as ag, type GetMediaCollectionResponse as ah, type ListCollectionsForItemRequest as ai, type ItemInCollection as aj, type GetCollectionItemRequest as ak, type ListMediaCollectionsRequest as al, type FilterByRoles as am, type CollectionAndStatus as an, type CreateMediaCollectionRequest as ao, type AddItem as ap, type PartiallyUpdateMediaCollectionRequest as aq, type PartiallyUpdateMediaCollectionResponse as ar, type UpdateCollectionLockRequest as as, type UpdateCollectionLockResponse as at, type DeleteMediaCollectionRequest as au, type DeleteMediaCollectionResponse as av, type ListCollectionMembersRequest as aw, type FilterBy as ax, type MemberAndStatus as ay, type AddItemsRequest as az, type GetCollectionItemIdentifiers as b, type GetCollectionItemResponse as c, type ListOptions as d, type ListMediaCollectionsResponse as e, type CreateMediaCollectionResponse as f, type PartiallyUpdateOptions as g, type ListCollectionMembersOptions as h, type ListCollectionMembersResponse as i, type ListCollectionItemsResponse as j, type CollectionCreatedEnvelope as k, LinkRel as l, MediaOwner as m, PrivacySettings as n, Status as o, MemberStatus as p, type CollectionMember as q, type MediaCollectionItem as r, type MediaCollectionItemMetadataOneOf as s, type Link as t, type WixLink as u, type WixLinkLinkOneOf as v, type PageLink as w, type AnchorLink as x, type DynamicPageLink as y, type DocumentLink as z };
|