@wix/auto_sdk_media-collections_media-collections 1.0.4 → 1.0.5
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-CG3Rf3hZ.d.mts} +413 -247
- package/build/{cjs/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +413 -247
- package/build/index.d.mts +120 -0
- package/build/index.d.ts +120 -0
- package/build/index.js +1151 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1105 -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-CG3Rf3hZ.d.mts} +413 -247
- package/build/internal/{es/src/collections-v1-collection-media-collections.types.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +413 -247
- package/build/internal/index.d.mts +120 -0
- package/build/internal/index.d.ts +120 -0
- package/build/internal/index.js +1151 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1105 -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 +783 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +744 -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 +783 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +744 -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,161 +434,8 @@ export declare enum PrivacySettings {
|
|
|
434
434
|
Secret = "Secret"
|
|
435
435
|
}
|
|
436
436
|
/** @enumType */
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
/** @format GUID */
|
|
440
|
-
requestId?: string;
|
|
441
|
-
uniqueServiceIdentifier?: string;
|
|
442
|
-
status?: StatusWithLiterals;
|
|
443
|
-
/** @readonly */
|
|
444
|
-
createdDate?: Date | null;
|
|
445
|
-
}
|
|
446
|
-
export declare enum Status {
|
|
447
|
-
UNKNOWN = "UNKNOWN",
|
|
448
|
-
HANDLED = "HANDLED",
|
|
449
|
-
NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
|
|
450
|
-
}
|
|
451
|
-
/** @enumType */
|
|
452
|
-
export type StatusWithLiterals = Status | 'UNKNOWN' | 'HANDLED' | 'NOTHING_TO_HANDLE';
|
|
453
|
-
export interface Empty {
|
|
454
|
-
}
|
|
455
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
456
|
-
createdEvent?: EntityCreatedEvent;
|
|
457
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
458
|
-
deletedEvent?: EntityDeletedEvent;
|
|
459
|
-
actionEvent?: ActionEvent;
|
|
460
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
461
|
-
id?: string;
|
|
462
|
-
/**
|
|
463
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
464
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
465
|
-
*/
|
|
466
|
-
entityFqdn?: string;
|
|
467
|
-
/**
|
|
468
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
469
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
470
|
-
*/
|
|
471
|
-
slug?: string;
|
|
472
|
-
/** ID of the entity associated with the event. */
|
|
473
|
-
entityId?: string;
|
|
474
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
475
|
-
eventTime?: Date | null;
|
|
476
|
-
/**
|
|
477
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
478
|
-
* (for example, GDPR).
|
|
479
|
-
*/
|
|
480
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
481
|
-
/** If present, indicates the action that triggered the event. */
|
|
482
|
-
originatedFrom?: string | null;
|
|
483
|
-
/**
|
|
484
|
-
* 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.
|
|
485
|
-
* 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.
|
|
486
|
-
*/
|
|
487
|
-
entityEventSequence?: string | null;
|
|
488
|
-
}
|
|
489
|
-
/** @oneof */
|
|
490
|
-
export interface DomainEventBodyOneOf {
|
|
491
|
-
createdEvent?: EntityCreatedEvent;
|
|
492
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
493
|
-
deletedEvent?: EntityDeletedEvent;
|
|
494
|
-
actionEvent?: ActionEvent;
|
|
495
|
-
}
|
|
496
|
-
export interface EntityCreatedEvent {
|
|
497
|
-
entityAsJson?: string;
|
|
498
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
499
|
-
restoreInfo?: RestoreInfo;
|
|
500
|
-
}
|
|
501
|
-
export interface RestoreInfo {
|
|
502
|
-
deletedDate?: Date | null;
|
|
503
|
-
}
|
|
504
|
-
export interface EntityUpdatedEvent {
|
|
505
|
-
/**
|
|
506
|
-
* 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
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
508
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
509
|
-
*/
|
|
510
|
-
currentEntityAsJson?: string;
|
|
511
|
-
}
|
|
512
|
-
export interface EntityDeletedEvent {
|
|
513
|
-
/** Entity that was deleted. */
|
|
514
|
-
deletedEntityAsJson?: string | null;
|
|
515
|
-
}
|
|
516
|
-
export interface ActionEvent {
|
|
517
|
-
bodyAsJson?: string;
|
|
518
|
-
}
|
|
519
|
-
export interface MessageEnvelope {
|
|
520
|
-
/**
|
|
521
|
-
* App instance ID.
|
|
522
|
-
* @format GUID
|
|
523
|
-
*/
|
|
524
|
-
instanceId?: string | null;
|
|
525
|
-
/**
|
|
526
|
-
* Event type.
|
|
527
|
-
* @maxLength 150
|
|
528
|
-
*/
|
|
529
|
-
eventType?: string;
|
|
530
|
-
/** The identification type and identity data. */
|
|
531
|
-
identity?: IdentificationData;
|
|
532
|
-
/** Stringify payload. */
|
|
533
|
-
data?: string;
|
|
534
|
-
}
|
|
535
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
536
|
-
/**
|
|
537
|
-
* ID of a site visitor that has not logged in to the site.
|
|
538
|
-
* @format GUID
|
|
539
|
-
*/
|
|
540
|
-
anonymousVisitorId?: string;
|
|
541
|
-
/**
|
|
542
|
-
* ID of a site visitor that has logged in to the site.
|
|
543
|
-
* @format GUID
|
|
544
|
-
*/
|
|
545
|
-
memberId?: string;
|
|
546
|
-
/**
|
|
547
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
548
|
-
* @format GUID
|
|
549
|
-
*/
|
|
550
|
-
wixUserId?: string;
|
|
551
|
-
/**
|
|
552
|
-
* ID of an app.
|
|
553
|
-
* @format GUID
|
|
554
|
-
*/
|
|
555
|
-
appId?: string;
|
|
556
|
-
/** @readonly */
|
|
557
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
558
|
-
}
|
|
559
|
-
/** @oneof */
|
|
560
|
-
export interface IdentificationDataIdOneOf {
|
|
561
|
-
/**
|
|
562
|
-
* ID of a site visitor that has not logged in to the site.
|
|
563
|
-
* @format GUID
|
|
564
|
-
*/
|
|
565
|
-
anonymousVisitorId?: string;
|
|
566
|
-
/**
|
|
567
|
-
* ID of a site visitor that has logged in to the site.
|
|
568
|
-
* @format GUID
|
|
569
|
-
*/
|
|
570
|
-
memberId?: string;
|
|
571
|
-
/**
|
|
572
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
573
|
-
* @format GUID
|
|
574
|
-
*/
|
|
575
|
-
wixUserId?: string;
|
|
576
|
-
/**
|
|
577
|
-
* ID of an app.
|
|
578
|
-
* @format GUID
|
|
579
|
-
*/
|
|
580
|
-
appId?: string;
|
|
581
|
-
}
|
|
582
|
-
export declare enum WebhookIdentityType {
|
|
583
|
-
UNKNOWN = "UNKNOWN",
|
|
584
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
585
|
-
MEMBER = "MEMBER",
|
|
586
|
-
WIX_USER = "WIX_USER",
|
|
587
|
-
APP = "APP"
|
|
588
|
-
}
|
|
589
|
-
/** @enumType */
|
|
590
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
591
|
-
export interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
437
|
+
type PrivacySettingsWithLiterals = PrivacySettings | 'Undefined' | 'Public' | 'Secret';
|
|
438
|
+
interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
592
439
|
/** Collection created */
|
|
593
440
|
collectionCreated?: CollectionCreated;
|
|
594
441
|
/** Items added to collection */
|
|
@@ -601,7 +448,7 @@ export interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
|
601
448
|
memberLeftCollection?: MemberLeftCollection;
|
|
602
449
|
}
|
|
603
450
|
/** @oneof */
|
|
604
|
-
|
|
451
|
+
interface CollectionEventEventTypeOneOf {
|
|
605
452
|
/** Collection created */
|
|
606
453
|
collectionCreated?: CollectionCreated;
|
|
607
454
|
/** Items added to collection */
|
|
@@ -613,7 +460,7 @@ export interface CollectionEventEventTypeOneOf {
|
|
|
613
460
|
/** Member left collection */
|
|
614
461
|
memberLeftCollection?: MemberLeftCollection;
|
|
615
462
|
}
|
|
616
|
-
|
|
463
|
+
interface CollectionItemId {
|
|
617
464
|
/**
|
|
618
465
|
* Id of the gallery in ProGallery
|
|
619
466
|
* @format GUID
|
|
@@ -625,12 +472,12 @@ export interface CollectionItemId {
|
|
|
625
472
|
*/
|
|
626
473
|
itemId?: string;
|
|
627
474
|
}
|
|
628
|
-
|
|
475
|
+
interface CollectionCreated {
|
|
629
476
|
/**
|
|
630
477
|
* Collection id
|
|
631
478
|
* @format GUID
|
|
632
479
|
*/
|
|
633
|
-
|
|
480
|
+
_id?: string;
|
|
634
481
|
/**
|
|
635
482
|
* Collection name
|
|
636
483
|
* @maxLength 100
|
|
@@ -647,11 +494,11 @@ export interface CollectionCreated {
|
|
|
647
494
|
*/
|
|
648
495
|
creatorMemberId?: string;
|
|
649
496
|
/** When the collection was created */
|
|
650
|
-
|
|
497
|
+
_createdDate?: Date | null;
|
|
651
498
|
/** Privacy settings */
|
|
652
499
|
privacySettings?: PrivacySettingsWithLiterals;
|
|
653
500
|
}
|
|
654
|
-
|
|
501
|
+
interface ItemsAddedToCollection {
|
|
655
502
|
/**
|
|
656
503
|
* Id of the collection
|
|
657
504
|
* @format GUID
|
|
@@ -667,7 +514,7 @@ export interface ItemsAddedToCollection {
|
|
|
667
514
|
/** When the items were added */
|
|
668
515
|
addedDate?: Date | null;
|
|
669
516
|
}
|
|
670
|
-
|
|
517
|
+
interface ItemsRemovedFromCollection {
|
|
671
518
|
/**
|
|
672
519
|
* Id of the collection
|
|
673
520
|
* @format GUID
|
|
@@ -686,7 +533,7 @@ export interface ItemsRemovedFromCollection {
|
|
|
686
533
|
/** When the items were removed */
|
|
687
534
|
removedDate?: Date | null;
|
|
688
535
|
}
|
|
689
|
-
|
|
536
|
+
interface MemberJoinedToCollection {
|
|
690
537
|
/**
|
|
691
538
|
* Id of the collection
|
|
692
539
|
* @format GUID
|
|
@@ -700,7 +547,7 @@ export interface MemberJoinedToCollection {
|
|
|
700
547
|
/** When the member was joined */
|
|
701
548
|
joinedDate?: Date | null;
|
|
702
549
|
}
|
|
703
|
-
|
|
550
|
+
interface MemberLeftCollection {
|
|
704
551
|
/**
|
|
705
552
|
* Id of the collection
|
|
706
553
|
* @format GUID
|
|
@@ -714,7 +561,71 @@ export interface MemberLeftCollection {
|
|
|
714
561
|
/** When the member left */
|
|
715
562
|
leftDate?: Date | null;
|
|
716
563
|
}
|
|
717
|
-
|
|
564
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
565
|
+
createdEvent?: EntityCreatedEvent;
|
|
566
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
567
|
+
deletedEvent?: EntityDeletedEvent;
|
|
568
|
+
actionEvent?: ActionEvent;
|
|
569
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
570
|
+
_id?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
573
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
574
|
+
*/
|
|
575
|
+
entityFqdn?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
578
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
579
|
+
*/
|
|
580
|
+
slug?: string;
|
|
581
|
+
/** ID of the entity associated with the event. */
|
|
582
|
+
entityId?: string;
|
|
583
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
584
|
+
eventTime?: Date | null;
|
|
585
|
+
/**
|
|
586
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
587
|
+
* (for example, GDPR).
|
|
588
|
+
*/
|
|
589
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
590
|
+
/** If present, indicates the action that triggered the event. */
|
|
591
|
+
originatedFrom?: string | null;
|
|
592
|
+
/**
|
|
593
|
+
* 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.
|
|
594
|
+
* 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.
|
|
595
|
+
*/
|
|
596
|
+
entityEventSequence?: string | null;
|
|
597
|
+
}
|
|
598
|
+
/** @oneof */
|
|
599
|
+
interface DomainEventBodyOneOf {
|
|
600
|
+
createdEvent?: EntityCreatedEvent;
|
|
601
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
602
|
+
deletedEvent?: EntityDeletedEvent;
|
|
603
|
+
actionEvent?: ActionEvent;
|
|
604
|
+
}
|
|
605
|
+
interface EntityCreatedEvent {
|
|
606
|
+
entity?: string;
|
|
607
|
+
}
|
|
608
|
+
interface RestoreInfo {
|
|
609
|
+
deletedDate?: Date | null;
|
|
610
|
+
}
|
|
611
|
+
interface EntityUpdatedEvent {
|
|
612
|
+
/**
|
|
613
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
614
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
615
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
616
|
+
*/
|
|
617
|
+
currentEntity?: string;
|
|
618
|
+
}
|
|
619
|
+
interface EntityDeletedEvent {
|
|
620
|
+
/** Entity that was deleted. */
|
|
621
|
+
deletedEntity?: string | null;
|
|
622
|
+
}
|
|
623
|
+
interface ActionEvent {
|
|
624
|
+
body?: string;
|
|
625
|
+
}
|
|
626
|
+
interface Empty {
|
|
627
|
+
}
|
|
628
|
+
interface GetMediaCollectionRequest {
|
|
718
629
|
/**
|
|
719
630
|
* Collection id
|
|
720
631
|
* @format GUID
|
|
@@ -729,13 +640,13 @@ export interface GetMediaCollectionRequest {
|
|
|
729
640
|
*/
|
|
730
641
|
limit?: number | null;
|
|
731
642
|
}
|
|
732
|
-
|
|
643
|
+
interface GetMediaCollectionResponse {
|
|
733
644
|
/** The collection */
|
|
734
645
|
mediaCollection?: MediaCollection;
|
|
735
646
|
/** The member's status in the collection */
|
|
736
647
|
memberStatus?: MemberStatusWithLiterals;
|
|
737
648
|
}
|
|
738
|
-
|
|
649
|
+
declare enum MemberStatus {
|
|
739
650
|
/** Undefined */
|
|
740
651
|
UNDEFINED = "UNDEFINED",
|
|
741
652
|
/** Not a member */
|
|
@@ -746,8 +657,8 @@ export declare enum MemberStatus {
|
|
|
746
657
|
ADMIN = "ADMIN"
|
|
747
658
|
}
|
|
748
659
|
/** @enumType */
|
|
749
|
-
|
|
750
|
-
|
|
660
|
+
type MemberStatusWithLiterals = MemberStatus | 'UNDEFINED' | 'NOT_MEMBER' | 'MEMBER' | 'ADMIN';
|
|
661
|
+
interface ListCollectionsForItemRequest {
|
|
751
662
|
/**
|
|
752
663
|
* Gallery id
|
|
753
664
|
* @format GUID
|
|
@@ -759,11 +670,11 @@ export interface ListCollectionsForItemRequest {
|
|
|
759
670
|
*/
|
|
760
671
|
itemId: string;
|
|
761
672
|
}
|
|
762
|
-
|
|
673
|
+
interface ListCollectionsForItemResponse {
|
|
763
674
|
/** The collections that the item belongs to */
|
|
764
675
|
itemInCollections?: ItemInCollection[];
|
|
765
676
|
}
|
|
766
|
-
|
|
677
|
+
interface ItemInCollection {
|
|
767
678
|
/**
|
|
768
679
|
* Collection id
|
|
769
680
|
* @format GUID
|
|
@@ -791,7 +702,7 @@ export interface ItemInCollection {
|
|
|
791
702
|
*/
|
|
792
703
|
creatorNickname?: string | null;
|
|
793
704
|
}
|
|
794
|
-
|
|
705
|
+
interface GetCollectionItemRequest {
|
|
795
706
|
/**
|
|
796
707
|
* Collection id
|
|
797
708
|
* @format GUID
|
|
@@ -803,11 +714,11 @@ export interface GetCollectionItemRequest {
|
|
|
803
714
|
*/
|
|
804
715
|
itemId: string;
|
|
805
716
|
}
|
|
806
|
-
|
|
717
|
+
interface GetCollectionItemResponse {
|
|
807
718
|
/** The item */
|
|
808
719
|
item?: MediaCollectionItem;
|
|
809
720
|
}
|
|
810
|
-
|
|
721
|
+
interface ListMediaCollectionsRequest {
|
|
811
722
|
/**
|
|
812
723
|
* the amount of collections per response, default is 1000
|
|
813
724
|
* @min 1
|
|
@@ -822,10 +733,10 @@ export interface ListMediaCollectionsRequest {
|
|
|
822
733
|
*/
|
|
823
734
|
filterByRoles?: FilterByRoles;
|
|
824
735
|
}
|
|
825
|
-
|
|
736
|
+
interface FilterByRoles {
|
|
826
737
|
roles?: MemberStatusWithLiterals[];
|
|
827
738
|
}
|
|
828
|
-
|
|
739
|
+
interface ListMediaCollectionsResponse {
|
|
829
740
|
/** The collections and the member's role in them */
|
|
830
741
|
collectionsStatus?: CollectionAndStatus[];
|
|
831
742
|
/**
|
|
@@ -834,13 +745,13 @@ export interface ListMediaCollectionsResponse {
|
|
|
834
745
|
*/
|
|
835
746
|
totalCollectionsCount?: number | null;
|
|
836
747
|
}
|
|
837
|
-
|
|
748
|
+
interface CollectionAndStatus {
|
|
838
749
|
/** The Media Collection */
|
|
839
750
|
mediaCollection?: MediaCollection;
|
|
840
751
|
/** The member's status in the collection */
|
|
841
752
|
memberStatus?: MemberStatusWithLiterals;
|
|
842
753
|
}
|
|
843
|
-
|
|
754
|
+
interface CreateMediaCollectionRequest {
|
|
844
755
|
/**
|
|
845
756
|
* Name of the collection
|
|
846
757
|
* @minLength 1
|
|
@@ -857,7 +768,7 @@ export interface CreateMediaCollectionRequest {
|
|
|
857
768
|
/** Items to add to the collection */
|
|
858
769
|
items?: AddItem[];
|
|
859
770
|
}
|
|
860
|
-
|
|
771
|
+
interface AddItem {
|
|
861
772
|
/**
|
|
862
773
|
* Gallery id
|
|
863
774
|
* @format GUID
|
|
@@ -871,14 +782,14 @@ export interface AddItem {
|
|
|
871
782
|
/** Order index of the item */
|
|
872
783
|
orderIndex?: number | null;
|
|
873
784
|
}
|
|
874
|
-
|
|
785
|
+
interface CreateMediaCollectionResponse {
|
|
875
786
|
/**
|
|
876
787
|
* id of the collection that was created
|
|
877
788
|
* @format GUID
|
|
878
789
|
*/
|
|
879
790
|
mediaCollectionId?: string;
|
|
880
791
|
}
|
|
881
|
-
|
|
792
|
+
interface PartiallyUpdateMediaCollectionRequest {
|
|
882
793
|
/** Collection to update */
|
|
883
794
|
mediaCollection: MediaCollection;
|
|
884
795
|
/**
|
|
@@ -887,9 +798,9 @@ export interface PartiallyUpdateMediaCollectionRequest {
|
|
|
887
798
|
*/
|
|
888
799
|
fieldMask: string[];
|
|
889
800
|
}
|
|
890
|
-
|
|
801
|
+
interface PartiallyUpdateMediaCollectionResponse {
|
|
891
802
|
}
|
|
892
|
-
|
|
803
|
+
interface UpdateCollectionLockRequest {
|
|
893
804
|
/**
|
|
894
805
|
* Collection to lock
|
|
895
806
|
* @format GUID
|
|
@@ -898,18 +809,18 @@ export interface UpdateCollectionLockRequest {
|
|
|
898
809
|
/** Lock status */
|
|
899
810
|
locked?: boolean;
|
|
900
811
|
}
|
|
901
|
-
|
|
812
|
+
interface UpdateCollectionLockResponse {
|
|
902
813
|
}
|
|
903
|
-
|
|
814
|
+
interface DeleteMediaCollectionRequest {
|
|
904
815
|
/**
|
|
905
816
|
* the collection to delete
|
|
906
817
|
* @format GUID
|
|
907
818
|
*/
|
|
908
819
|
mediaCollectionId: string;
|
|
909
820
|
}
|
|
910
|
-
|
|
821
|
+
interface DeleteMediaCollectionResponse {
|
|
911
822
|
}
|
|
912
|
-
|
|
823
|
+
interface ListCollectionMembersRequest {
|
|
913
824
|
/**
|
|
914
825
|
* the collection to get its members
|
|
915
826
|
* @format GUID
|
|
@@ -918,21 +829,21 @@ export interface ListCollectionMembersRequest {
|
|
|
918
829
|
/** Filter the members by their role in the collection */
|
|
919
830
|
filterBy?: FilterBy;
|
|
920
831
|
}
|
|
921
|
-
|
|
832
|
+
interface FilterBy {
|
|
922
833
|
/** Member's status in the collection */
|
|
923
834
|
memberStatus?: MemberStatusWithLiterals;
|
|
924
835
|
}
|
|
925
|
-
|
|
836
|
+
interface ListCollectionMembersResponse {
|
|
926
837
|
/** The collection's members and their roles */
|
|
927
838
|
membersRoles?: MemberAndStatus[];
|
|
928
839
|
}
|
|
929
|
-
|
|
840
|
+
interface MemberAndStatus {
|
|
930
841
|
/** The member */
|
|
931
842
|
member?: CollectionMember;
|
|
932
843
|
/** The member's role in the collection */
|
|
933
844
|
memberStatus?: MemberStatusWithLiterals;
|
|
934
845
|
}
|
|
935
|
-
|
|
846
|
+
interface AddItemsRequest {
|
|
936
847
|
/**
|
|
937
848
|
* Collection to add items
|
|
938
849
|
* @format GUID
|
|
@@ -941,9 +852,9 @@ export interface AddItemsRequest {
|
|
|
941
852
|
/** Items to add */
|
|
942
853
|
items?: AddItem[];
|
|
943
854
|
}
|
|
944
|
-
|
|
855
|
+
interface AddItemsResponse {
|
|
945
856
|
}
|
|
946
|
-
|
|
857
|
+
interface RemoveItemsRequest {
|
|
947
858
|
/**
|
|
948
859
|
* Collection to remove items from
|
|
949
860
|
* @format GUID
|
|
@@ -955,9 +866,9 @@ export interface RemoveItemsRequest {
|
|
|
955
866
|
*/
|
|
956
867
|
itemsIds?: string[];
|
|
957
868
|
}
|
|
958
|
-
|
|
869
|
+
interface RemoveItemsResponse {
|
|
959
870
|
}
|
|
960
|
-
|
|
871
|
+
interface UpdateItemsRequest {
|
|
961
872
|
/**
|
|
962
873
|
* Collection to update items
|
|
963
874
|
* @format GUID
|
|
@@ -965,7 +876,7 @@ export interface UpdateItemsRequest {
|
|
|
965
876
|
mediaCollectionId?: string;
|
|
966
877
|
items?: UpdateItem[];
|
|
967
878
|
}
|
|
968
|
-
|
|
879
|
+
interface UpdateItem {
|
|
969
880
|
/**
|
|
970
881
|
* Item to update
|
|
971
882
|
* @format GUID
|
|
@@ -974,18 +885,18 @@ export interface UpdateItem {
|
|
|
974
885
|
/** New order index of the item */
|
|
975
886
|
orderIndex?: number;
|
|
976
887
|
}
|
|
977
|
-
|
|
888
|
+
interface UpdateItemsResponse {
|
|
978
889
|
}
|
|
979
|
-
|
|
890
|
+
interface JoinToCollectionRequest {
|
|
980
891
|
/**
|
|
981
892
|
* Collection to join
|
|
982
893
|
* @format GUID
|
|
983
894
|
*/
|
|
984
895
|
mediaCollectionId: string;
|
|
985
896
|
}
|
|
986
|
-
|
|
897
|
+
interface JoinToCollectionResponse {
|
|
987
898
|
}
|
|
988
|
-
|
|
899
|
+
interface RemoveMemberFromCollectionRequest {
|
|
989
900
|
/**
|
|
990
901
|
* Collection the member will be removed from being a member
|
|
991
902
|
* @format GUID
|
|
@@ -997,29 +908,29 @@ export interface RemoveMemberFromCollectionRequest {
|
|
|
997
908
|
*/
|
|
998
909
|
memberId?: string;
|
|
999
910
|
}
|
|
1000
|
-
|
|
911
|
+
interface RemoveMemberFromCollectionResponse {
|
|
1001
912
|
}
|
|
1002
|
-
|
|
913
|
+
interface LeaveCollectionRequest {
|
|
1003
914
|
/**
|
|
1004
915
|
* Collection the member will be leaving
|
|
1005
916
|
* @format GUID
|
|
1006
917
|
*/
|
|
1007
918
|
mediaCollectionId: string;
|
|
1008
919
|
}
|
|
1009
|
-
|
|
920
|
+
interface LeaveCollectionResponse {
|
|
1010
921
|
}
|
|
1011
|
-
|
|
922
|
+
interface ListCollectionItemsRequest {
|
|
1012
923
|
/**
|
|
1013
924
|
* Collection to get its items
|
|
1014
925
|
* @format GUID
|
|
1015
926
|
*/
|
|
1016
927
|
mediaCollectionId: string;
|
|
1017
928
|
}
|
|
1018
|
-
|
|
929
|
+
interface ListCollectionItemsResponse {
|
|
1019
930
|
/** The collection's items */
|
|
1020
931
|
collectionItems?: CollectionItem[];
|
|
1021
932
|
}
|
|
1022
|
-
|
|
933
|
+
interface CollectionItem {
|
|
1023
934
|
/**
|
|
1024
935
|
* Gallery id
|
|
1025
936
|
* @format GUID
|
|
@@ -1035,12 +946,267 @@ export interface CollectionItem {
|
|
|
1035
946
|
/** Date the item was added to the collection */
|
|
1036
947
|
addedDate?: Date | null;
|
|
1037
948
|
}
|
|
1038
|
-
|
|
949
|
+
interface ListAllItemsBelongToCollectionRequest {
|
|
1039
950
|
}
|
|
1040
|
-
|
|
951
|
+
interface ListAllItemsBelongToCollectionResponse {
|
|
1041
952
|
/**
|
|
1042
953
|
* List of the item ids that belong to one or more collection
|
|
1043
954
|
* @format GUID
|
|
1044
955
|
*/
|
|
1045
956
|
itemIds?: string[];
|
|
1046
957
|
}
|
|
958
|
+
interface MessageEnvelope {
|
|
959
|
+
/**
|
|
960
|
+
* App instance ID.
|
|
961
|
+
* @format GUID
|
|
962
|
+
*/
|
|
963
|
+
instanceId?: string | null;
|
|
964
|
+
/**
|
|
965
|
+
* Event type.
|
|
966
|
+
* @maxLength 150
|
|
967
|
+
*/
|
|
968
|
+
eventType?: string;
|
|
969
|
+
/** The identification type and identity data. */
|
|
970
|
+
identity?: IdentificationData;
|
|
971
|
+
/** Stringify payload. */
|
|
972
|
+
data?: string;
|
|
973
|
+
}
|
|
974
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
975
|
+
/**
|
|
976
|
+
* ID of a site visitor that has not logged in to the site.
|
|
977
|
+
* @format GUID
|
|
978
|
+
*/
|
|
979
|
+
anonymousVisitorId?: string;
|
|
980
|
+
/**
|
|
981
|
+
* ID of a site visitor that has logged in to the site.
|
|
982
|
+
* @format GUID
|
|
983
|
+
*/
|
|
984
|
+
memberId?: string;
|
|
985
|
+
/**
|
|
986
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
987
|
+
* @format GUID
|
|
988
|
+
*/
|
|
989
|
+
wixUserId?: string;
|
|
990
|
+
/**
|
|
991
|
+
* ID of an app.
|
|
992
|
+
* @format GUID
|
|
993
|
+
*/
|
|
994
|
+
appId?: string;
|
|
995
|
+
/** @readonly */
|
|
996
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
997
|
+
}
|
|
998
|
+
/** @oneof */
|
|
999
|
+
interface IdentificationDataIdOneOf {
|
|
1000
|
+
/**
|
|
1001
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1002
|
+
* @format GUID
|
|
1003
|
+
*/
|
|
1004
|
+
anonymousVisitorId?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* ID of a site visitor that has logged in to the site.
|
|
1007
|
+
* @format GUID
|
|
1008
|
+
*/
|
|
1009
|
+
memberId?: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1012
|
+
* @format GUID
|
|
1013
|
+
*/
|
|
1014
|
+
wixUserId?: string;
|
|
1015
|
+
/**
|
|
1016
|
+
* ID of an app.
|
|
1017
|
+
* @format GUID
|
|
1018
|
+
*/
|
|
1019
|
+
appId?: string;
|
|
1020
|
+
}
|
|
1021
|
+
declare enum WebhookIdentityType {
|
|
1022
|
+
UNKNOWN = "UNKNOWN",
|
|
1023
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1024
|
+
MEMBER = "MEMBER",
|
|
1025
|
+
WIX_USER = "WIX_USER",
|
|
1026
|
+
APP = "APP"
|
|
1027
|
+
}
|
|
1028
|
+
/** @enumType */
|
|
1029
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1030
|
+
interface PermanentSiteDeletedResponse {
|
|
1031
|
+
/** @format GUID */
|
|
1032
|
+
requestId?: string;
|
|
1033
|
+
uniqueServiceIdentifier?: string;
|
|
1034
|
+
status?: StatusWithLiterals;
|
|
1035
|
+
/** @readonly */
|
|
1036
|
+
_createdDate?: Date | null;
|
|
1037
|
+
}
|
|
1038
|
+
declare enum Status {
|
|
1039
|
+
UNKNOWN = "UNKNOWN",
|
|
1040
|
+
HANDLED = "HANDLED",
|
|
1041
|
+
NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
|
|
1042
|
+
}
|
|
1043
|
+
/** @enumType */
|
|
1044
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'HANDLED' | 'NOTHING_TO_HANDLE';
|
|
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 CollectionCreated 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 CollectionEvent as Y, type CollectionEventEventTypeOneOf as Z, type CollectionItemId as _, type ListCollectionsForItemResponse as a, type ItemsAddedToCollection as a0, type ItemsRemovedFromCollection as a1, type MemberJoinedToCollection as a2, type MemberLeftCollection as a3, type DomainEvent as a4, type DomainEventBodyOneOf as a5, type EntityCreatedEvent as a6, type RestoreInfo as a7, type EntityUpdatedEvent as a8, type EntityDeletedEvent as a9, type UpdateItem as aA, type UpdateItemsResponse as aB, type JoinToCollectionRequest as aC, type JoinToCollectionResponse as aD, type RemoveMemberFromCollectionRequest as aE, type RemoveMemberFromCollectionResponse as aF, type LeaveCollectionRequest as aG, type LeaveCollectionResponse as aH, type ListCollectionItemsRequest as aI, type CollectionItem as aJ, type ListAllItemsBelongToCollectionRequest as aK, type ListAllItemsBelongToCollectionResponse as aL, type MessageEnvelope as aM, type IdentificationData as aN, type IdentificationDataIdOneOf as aO, type PermanentSiteDeletedResponse as aP, type BaseEventMetadata as aQ, type EventMetadata as aR, type ActionEvent as aa, type Empty as ab, type GetMediaCollectionRequest as ac, type GetMediaCollectionResponse as ad, type ListCollectionsForItemRequest as ae, type ItemInCollection as af, type GetCollectionItemRequest as ag, type ListMediaCollectionsRequest as ah, type FilterByRoles as ai, type CollectionAndStatus as aj, type CreateMediaCollectionRequest as ak, type AddItem as al, type PartiallyUpdateMediaCollectionRequest as am, type PartiallyUpdateMediaCollectionResponse as an, type UpdateCollectionLockRequest as ao, type UpdateCollectionLockResponse as ap, type DeleteMediaCollectionRequest as aq, type DeleteMediaCollectionResponse as ar, type ListCollectionMembersRequest as as, type FilterBy as at, type MemberAndStatus as au, type AddItemsRequest as av, type AddItemsResponse as aw, type RemoveItemsRequest as ax, type RemoveItemsResponse as ay, type UpdateItemsRequest 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, MemberStatus as o, Status 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 };
|