@wix/auto_sdk_media-collections_media-collections 1.0.3 → 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/{internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.mts} +280 -388
- package/build/{internal/es/src/collections-v1-collection-media-collections.universal.d.ts → collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +280 -388
- 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/{cjs/src/collections-v1-collection-media-collections.universal.d.ts → internal/collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.mts} +280 -388
- package/build/{es/src/collections-v1-collection-media-collections.universal.d.ts → internal/collections-v1-collection-media-collections.universal-CG3Rf3hZ.d.ts} +280 -388
- 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/{es/src/collections-v1-collection-media-collections.types.d.ts → internal/meta.d.mts} +145 -408
- package/build/internal/{cjs/src/collections-v1-collection-media-collections.types.d.ts → meta.d.ts} +145 -408
- 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/{cjs/src/collections-v1-collection-media-collections.types.d.ts → meta.d.mts} +145 -408
- package/build/{internal/es/src/collections-v1-collection-media-collections.types.d.ts → meta.d.ts} +145 -408
- 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.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.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.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.js +0 -535
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.js.map +0 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
import { ac as GetMediaCollectionRequest$1, ad as GetMediaCollectionResponse$1, ae as ListCollectionsForItemRequest$1, a as ListCollectionsForItemResponse$1, ag as GetCollectionItemRequest$1, c as GetCollectionItemResponse$1, ah as ListMediaCollectionsRequest$1, e as ListMediaCollectionsResponse$1, ak as CreateMediaCollectionRequest$1, f as CreateMediaCollectionResponse$1, am as PartiallyUpdateMediaCollectionRequest$1, an as PartiallyUpdateMediaCollectionResponse$1, aq as DeleteMediaCollectionRequest$1, ar as DeleteMediaCollectionResponse$1, as as ListCollectionMembersRequest$1, i as ListCollectionMembersResponse$1, av as AddItemsRequest$1, aw as AddItemsResponse$1, ax as RemoveItemsRequest$1, ay as RemoveItemsResponse$1, aC as JoinToCollectionRequest$1, aD as JoinToCollectionResponse$1, aG as LeaveCollectionRequest$1, aH as LeaveCollectionResponse$1, aI as ListCollectionItemsRequest$1, j as ListCollectionItemsResponse$1 } from './collections-v1-collection-media-collections.universal-CG3Rf3hZ.mjs';
|
|
2
|
+
|
|
3
|
+
interface MediaCollection {
|
|
2
4
|
/**
|
|
3
5
|
* Collection id
|
|
4
6
|
* @readonly
|
|
@@ -35,11 +37,11 @@ export interface MediaCollection {
|
|
|
35
37
|
*/
|
|
36
38
|
itemsCount?: number;
|
|
37
39
|
/** Privacy settings */
|
|
38
|
-
privacySettings?:
|
|
40
|
+
privacySettings?: PrivacySettingsWithLiterals;
|
|
39
41
|
/** If true, the collection is locked and should not be updated */
|
|
40
42
|
locked?: boolean;
|
|
41
43
|
}
|
|
42
|
-
|
|
44
|
+
interface CollectionMember {
|
|
43
45
|
/**
|
|
44
46
|
* Member id
|
|
45
47
|
* @readonly
|
|
@@ -62,7 +64,7 @@ export interface CollectionMember {
|
|
|
62
64
|
*/
|
|
63
65
|
photoUrl?: string | null;
|
|
64
66
|
}
|
|
65
|
-
|
|
67
|
+
interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
66
68
|
/** Photo metadata */
|
|
67
69
|
photoMetadata?: PhotoMetadata;
|
|
68
70
|
/** Video metadata */
|
|
@@ -88,7 +90,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
88
90
|
/** a link from the item to something else */
|
|
89
91
|
link?: Link;
|
|
90
92
|
/** item type: text, photo or video */
|
|
91
|
-
dataType?:
|
|
93
|
+
dataType?: DataTypeWithLiterals;
|
|
92
94
|
/**
|
|
93
95
|
* When the item was added to the collection
|
|
94
96
|
* @readonly
|
|
@@ -100,7 +102,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
100
102
|
*/
|
|
101
103
|
updatedDate?: Date | null;
|
|
102
104
|
/** The owner of the media */
|
|
103
|
-
mediaOwner?:
|
|
105
|
+
mediaOwner?: MediaOwnerWithLiterals;
|
|
104
106
|
/** Tags for media */
|
|
105
107
|
tags?: string[];
|
|
106
108
|
/** Token for media */
|
|
@@ -109,7 +111,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
109
111
|
galleryId?: string;
|
|
110
112
|
}
|
|
111
113
|
/** @oneof */
|
|
112
|
-
|
|
114
|
+
interface MediaCollectionItemMetadataOneOf {
|
|
113
115
|
/** Photo metadata */
|
|
114
116
|
photoMetadata?: PhotoMetadata;
|
|
115
117
|
/** Video metadata */
|
|
@@ -117,8 +119,8 @@ export interface MediaCollectionItemMetadataOneOf {
|
|
|
117
119
|
/** Text metadata */
|
|
118
120
|
textMetadata?: TextMetadata;
|
|
119
121
|
}
|
|
120
|
-
|
|
121
|
-
type?:
|
|
122
|
+
interface Link {
|
|
123
|
+
type?: TypeWithLiterals;
|
|
122
124
|
/** Link text */
|
|
123
125
|
text?: string | null;
|
|
124
126
|
/** Link url */
|
|
@@ -128,7 +130,7 @@ export interface Link {
|
|
|
128
130
|
/** Data on how to construct the link from wix editor inputs */
|
|
129
131
|
wixLinkData?: WixLink;
|
|
130
132
|
}
|
|
131
|
-
|
|
133
|
+
declare enum Type {
|
|
132
134
|
/** Undefined */
|
|
133
135
|
Undefined = "Undefined",
|
|
134
136
|
/** external link */
|
|
@@ -136,8 +138,10 @@ export declare enum Type {
|
|
|
136
138
|
/** link to wix pages */
|
|
137
139
|
Internal = "Internal"
|
|
138
140
|
}
|
|
141
|
+
/** @enumType */
|
|
142
|
+
type TypeWithLiterals = Type | 'Undefined' | 'External' | 'Internal';
|
|
139
143
|
/** The link object generated by panels in the editor and used by applications in Wix */
|
|
140
|
-
|
|
144
|
+
interface WixLink extends WixLinkLinkOneOf {
|
|
141
145
|
/** External link type */
|
|
142
146
|
external?: ExternalLink;
|
|
143
147
|
/** Page link type */
|
|
@@ -160,7 +164,7 @@ export interface WixLink extends WixLinkLinkOneOf {
|
|
|
160
164
|
tpaPage?: TpaPageLink;
|
|
161
165
|
}
|
|
162
166
|
/** @oneof */
|
|
163
|
-
|
|
167
|
+
interface WixLinkLinkOneOf {
|
|
164
168
|
/** External link type */
|
|
165
169
|
external?: ExternalLink;
|
|
166
170
|
/** Page link type */
|
|
@@ -182,7 +186,7 @@ export interface WixLinkLinkOneOf {
|
|
|
182
186
|
/** TPA link type */
|
|
183
187
|
tpaPage?: TpaPageLink;
|
|
184
188
|
}
|
|
185
|
-
|
|
189
|
+
interface ExternalLink {
|
|
186
190
|
/**
|
|
187
191
|
* The url of the page
|
|
188
192
|
* @format WEB_URL
|
|
@@ -196,7 +200,7 @@ export interface ExternalLink {
|
|
|
196
200
|
* Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
|
|
197
201
|
* Following are the accepted 'rel' types by Wix applications.
|
|
198
202
|
*/
|
|
199
|
-
|
|
203
|
+
declare enum LinkRel {
|
|
200
204
|
/** default (not implemented) */
|
|
201
205
|
unknown_link_rel = "unknown_link_rel",
|
|
202
206
|
/** Indicates that the current document's original author or publisher does not endorse the referenced document. */
|
|
@@ -208,7 +212,9 @@ export declare enum LinkRel {
|
|
|
208
212
|
/** Indicates a link that resulted from advertisements or paid placements. */
|
|
209
213
|
sponsored = "sponsored"
|
|
210
214
|
}
|
|
211
|
-
|
|
215
|
+
/** @enumType */
|
|
216
|
+
type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
|
|
217
|
+
interface PageLink {
|
|
212
218
|
/** The page id we want from the site */
|
|
213
219
|
pageId?: string;
|
|
214
220
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
|
@@ -217,9 +223,9 @@ export interface PageLink {
|
|
|
217
223
|
* rel of link
|
|
218
224
|
* @maxSize 20
|
|
219
225
|
*/
|
|
220
|
-
rel?:
|
|
226
|
+
rel?: LinkRelWithLiterals[];
|
|
221
227
|
}
|
|
222
|
-
|
|
228
|
+
interface AnchorLink {
|
|
223
229
|
/** The name of the anchor */
|
|
224
230
|
anchorName?: string;
|
|
225
231
|
/** The data id (from the JSON page) of the anchor that should be used */
|
|
@@ -230,9 +236,9 @@ export interface AnchorLink {
|
|
|
230
236
|
* rel of link
|
|
231
237
|
* @maxSize 20
|
|
232
238
|
*/
|
|
233
|
-
rel?:
|
|
239
|
+
rel?: LinkRelWithLiterals[];
|
|
234
240
|
}
|
|
235
|
-
|
|
241
|
+
interface DynamicPageLink {
|
|
236
242
|
/** The router that handles this link */
|
|
237
243
|
routerId?: string;
|
|
238
244
|
/** The path data we'd like */
|
|
@@ -243,9 +249,9 @@ export interface DynamicPageLink {
|
|
|
243
249
|
* rel of link
|
|
244
250
|
* @maxSize 20
|
|
245
251
|
*/
|
|
246
|
-
rel?:
|
|
252
|
+
rel?: LinkRelWithLiterals[];
|
|
247
253
|
}
|
|
248
|
-
|
|
254
|
+
interface DocumentLink {
|
|
249
255
|
/** The id of the document */
|
|
250
256
|
docId?: string;
|
|
251
257
|
/** The name of the document for download purposes */
|
|
@@ -253,7 +259,7 @@ export interface DocumentLink {
|
|
|
253
259
|
/** If this document can be indexed by scrapers, default is false */
|
|
254
260
|
indexable?: boolean;
|
|
255
261
|
}
|
|
256
|
-
|
|
262
|
+
interface EmailLink {
|
|
257
263
|
/**
|
|
258
264
|
* The email we will be sending a message to
|
|
259
265
|
* @format EMAIL
|
|
@@ -264,7 +270,7 @@ export interface EmailLink {
|
|
|
264
270
|
/** The body of the email */
|
|
265
271
|
body?: string | null;
|
|
266
272
|
}
|
|
267
|
-
|
|
273
|
+
interface PhoneLink {
|
|
268
274
|
/**
|
|
269
275
|
* The phone number we want to link to
|
|
270
276
|
* @format PHONE
|
|
@@ -272,11 +278,11 @@ export interface PhoneLink {
|
|
|
272
278
|
*/
|
|
273
279
|
phoneNumber?: string;
|
|
274
280
|
}
|
|
275
|
-
|
|
281
|
+
interface AddressLink {
|
|
276
282
|
/** An address that we can link to */
|
|
277
283
|
address?: string;
|
|
278
284
|
}
|
|
279
|
-
|
|
285
|
+
interface WhatsAppLink {
|
|
280
286
|
/**
|
|
281
287
|
* The whatsApp phone number we want to connect with
|
|
282
288
|
* @format PHONE
|
|
@@ -284,7 +290,7 @@ export interface WhatsAppLink {
|
|
|
284
290
|
phoneNumber?: string;
|
|
285
291
|
}
|
|
286
292
|
/** Link to a TPA page */
|
|
287
|
-
|
|
293
|
+
interface TpaPageLink {
|
|
288
294
|
/** Type of item (e.g. 'wix.stores.sub_pages.product') */
|
|
289
295
|
itemTypeIdentifier?: string;
|
|
290
296
|
/** Id of linked item */
|
|
@@ -299,15 +305,17 @@ export interface TpaPageLink {
|
|
|
299
305
|
* rel of link
|
|
300
306
|
* @maxSize 20
|
|
301
307
|
*/
|
|
302
|
-
rel?:
|
|
308
|
+
rel?: LinkRelWithLiterals[];
|
|
303
309
|
}
|
|
304
|
-
|
|
310
|
+
declare enum DataType {
|
|
305
311
|
Undefined = "Undefined",
|
|
306
312
|
Photo = "Photo",
|
|
307
313
|
Video = "Video",
|
|
308
314
|
Text = "Text"
|
|
309
315
|
}
|
|
310
|
-
|
|
316
|
+
/** @enumType */
|
|
317
|
+
type DataTypeWithLiterals = DataType | 'Undefined' | 'Photo' | 'Video' | 'Text';
|
|
318
|
+
interface PhotoMetadata {
|
|
311
319
|
/** Photo width */
|
|
312
320
|
width?: number | null;
|
|
313
321
|
/** Photo height */
|
|
@@ -327,13 +335,13 @@ export interface PhotoMetadata {
|
|
|
327
335
|
/** id in WixMedia */
|
|
328
336
|
mediaId?: string | null;
|
|
329
337
|
}
|
|
330
|
-
|
|
338
|
+
interface Point {
|
|
331
339
|
/** x coordinate */
|
|
332
340
|
x?: number;
|
|
333
341
|
/** y coordinate */
|
|
334
342
|
y?: number;
|
|
335
343
|
}
|
|
336
|
-
|
|
344
|
+
interface UnsharpMasking {
|
|
337
345
|
/**
|
|
338
346
|
* number controls the amount of contrast that is added at the edges.
|
|
339
347
|
* @max 5
|
|
@@ -347,7 +355,7 @@ export interface UnsharpMasking {
|
|
|
347
355
|
*/
|
|
348
356
|
threshold?: number | null;
|
|
349
357
|
}
|
|
350
|
-
|
|
358
|
+
interface VideoMetadata {
|
|
351
359
|
/** Video width */
|
|
352
360
|
width?: number | null;
|
|
353
361
|
/** Video height */
|
|
@@ -355,7 +363,7 @@ export interface VideoMetadata {
|
|
|
355
363
|
/** Video duration in milliseconds */
|
|
356
364
|
duration?: string | null;
|
|
357
365
|
/** Video source */
|
|
358
|
-
source?:
|
|
366
|
+
source?: SourceWithLiterals;
|
|
359
367
|
/** Video posters */
|
|
360
368
|
posters?: Thumbnail[];
|
|
361
369
|
/** Video resolutions */
|
|
@@ -363,7 +371,7 @@ export interface VideoMetadata {
|
|
|
363
371
|
/** External source's representation for this video's id */
|
|
364
372
|
externalId?: string | null;
|
|
365
373
|
}
|
|
366
|
-
|
|
374
|
+
declare enum Source {
|
|
367
375
|
/** Undefined */
|
|
368
376
|
Undefined = "Undefined",
|
|
369
377
|
/** Youtube */
|
|
@@ -373,7 +381,9 @@ export declare enum Source {
|
|
|
373
381
|
/** Custom */
|
|
374
382
|
Custom = "Custom"
|
|
375
383
|
}
|
|
376
|
-
|
|
384
|
+
/** @enumType */
|
|
385
|
+
type SourceWithLiterals = Source | 'Undefined' | 'Youtube' | 'Vimeo' | 'Custom';
|
|
386
|
+
interface Thumbnail {
|
|
377
387
|
/** Thumbnail url */
|
|
378
388
|
url?: string | null;
|
|
379
389
|
/** Thumbnail width */
|
|
@@ -385,7 +395,7 @@ export interface Thumbnail {
|
|
|
385
395
|
/** The focal point of the image */
|
|
386
396
|
focalPoint?: Point;
|
|
387
397
|
}
|
|
388
|
-
|
|
398
|
+
interface Resolution {
|
|
389
399
|
/** eg 720p, 1024p etc */
|
|
390
400
|
videoMode?: string | null;
|
|
391
401
|
/** Video width */
|
|
@@ -395,7 +405,7 @@ export interface Resolution {
|
|
|
395
405
|
/** Map representing the file format (eg mp4) to the url. In case of an external source the format can be youtube, vimeo, etc. */
|
|
396
406
|
urls?: Record<string, string>;
|
|
397
407
|
}
|
|
398
|
-
|
|
408
|
+
interface TextMetadata {
|
|
399
409
|
/** text data */
|
|
400
410
|
html?: string | null;
|
|
401
411
|
/** css style info for container */
|
|
@@ -405,7 +415,7 @@ export interface TextMetadata {
|
|
|
405
415
|
/** the wix editor's font Id used to display the text data */
|
|
406
416
|
editorFontId?: string | null;
|
|
407
417
|
}
|
|
408
|
-
|
|
418
|
+
declare enum MediaOwner {
|
|
409
419
|
/** Undefined */
|
|
410
420
|
Undefined = "Undefined",
|
|
411
421
|
/** Wix */
|
|
@@ -415,7 +425,9 @@ export declare enum MediaOwner {
|
|
|
415
425
|
/** Custom */
|
|
416
426
|
Custom = "Custom"
|
|
417
427
|
}
|
|
418
|
-
|
|
428
|
+
/** @enumType */
|
|
429
|
+
type MediaOwnerWithLiterals = MediaOwner | 'Undefined' | 'Wix' | 'DeviantArt' | 'Custom';
|
|
430
|
+
declare enum PrivacySettings {
|
|
419
431
|
/** Undefined */
|
|
420
432
|
Undefined = "Undefined",
|
|
421
433
|
/** Public */
|
|
@@ -423,282 +435,9 @@ export declare enum PrivacySettings {
|
|
|
423
435
|
/** Secret */
|
|
424
436
|
Secret = "Secret"
|
|
425
437
|
}
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
uniqueServiceIdentifier?: string;
|
|
430
|
-
status?: Status;
|
|
431
|
-
/** @readonly */
|
|
432
|
-
createdDate?: Date | null;
|
|
433
|
-
}
|
|
434
|
-
export declare enum Status {
|
|
435
|
-
UNKNOWN = "UNKNOWN",
|
|
436
|
-
HANDLED = "HANDLED",
|
|
437
|
-
NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
|
|
438
|
-
}
|
|
439
|
-
export interface Empty {
|
|
440
|
-
}
|
|
441
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
442
|
-
createdEvent?: EntityCreatedEvent;
|
|
443
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
444
|
-
deletedEvent?: EntityDeletedEvent;
|
|
445
|
-
actionEvent?: ActionEvent;
|
|
446
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
447
|
-
id?: string;
|
|
448
|
-
/**
|
|
449
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
450
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
451
|
-
*/
|
|
452
|
-
entityFqdn?: string;
|
|
453
|
-
/**
|
|
454
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
455
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
456
|
-
*/
|
|
457
|
-
slug?: string;
|
|
458
|
-
/** ID of the entity associated with the event. */
|
|
459
|
-
entityId?: string;
|
|
460
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
461
|
-
eventTime?: Date | null;
|
|
462
|
-
/**
|
|
463
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
464
|
-
* (for example, GDPR).
|
|
465
|
-
*/
|
|
466
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
467
|
-
/** If present, indicates the action that triggered the event. */
|
|
468
|
-
originatedFrom?: string | null;
|
|
469
|
-
/**
|
|
470
|
-
* 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.
|
|
471
|
-
* 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.
|
|
472
|
-
*/
|
|
473
|
-
entityEventSequence?: string | null;
|
|
474
|
-
}
|
|
475
|
-
/** @oneof */
|
|
476
|
-
export interface DomainEventBodyOneOf {
|
|
477
|
-
createdEvent?: EntityCreatedEvent;
|
|
478
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
479
|
-
deletedEvent?: EntityDeletedEvent;
|
|
480
|
-
actionEvent?: ActionEvent;
|
|
481
|
-
}
|
|
482
|
-
export interface EntityCreatedEvent {
|
|
483
|
-
entityAsJson?: string;
|
|
484
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
485
|
-
restoreInfo?: RestoreInfo;
|
|
486
|
-
}
|
|
487
|
-
export interface RestoreInfo {
|
|
488
|
-
deletedDate?: Date | null;
|
|
489
|
-
}
|
|
490
|
-
export interface EntityUpdatedEvent {
|
|
491
|
-
/**
|
|
492
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
493
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
494
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
495
|
-
*/
|
|
496
|
-
currentEntityAsJson?: string;
|
|
497
|
-
}
|
|
498
|
-
export interface EntityDeletedEvent {
|
|
499
|
-
/** Entity that was deleted. */
|
|
500
|
-
deletedEntityAsJson?: string | null;
|
|
501
|
-
}
|
|
502
|
-
export interface ActionEvent {
|
|
503
|
-
bodyAsJson?: string;
|
|
504
|
-
}
|
|
505
|
-
export interface MessageEnvelope {
|
|
506
|
-
/**
|
|
507
|
-
* App instance ID.
|
|
508
|
-
* @format GUID
|
|
509
|
-
*/
|
|
510
|
-
instanceId?: string | null;
|
|
511
|
-
/**
|
|
512
|
-
* Event type.
|
|
513
|
-
* @maxLength 150
|
|
514
|
-
*/
|
|
515
|
-
eventType?: string;
|
|
516
|
-
/** The identification type and identity data. */
|
|
517
|
-
identity?: IdentificationData;
|
|
518
|
-
/** Stringify payload. */
|
|
519
|
-
data?: string;
|
|
520
|
-
}
|
|
521
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
522
|
-
/**
|
|
523
|
-
* ID of a site visitor that has not logged in to the site.
|
|
524
|
-
* @format GUID
|
|
525
|
-
*/
|
|
526
|
-
anonymousVisitorId?: string;
|
|
527
|
-
/**
|
|
528
|
-
* ID of a site visitor that has logged in to the site.
|
|
529
|
-
* @format GUID
|
|
530
|
-
*/
|
|
531
|
-
memberId?: string;
|
|
532
|
-
/**
|
|
533
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
534
|
-
* @format GUID
|
|
535
|
-
*/
|
|
536
|
-
wixUserId?: string;
|
|
537
|
-
/**
|
|
538
|
-
* ID of an app.
|
|
539
|
-
* @format GUID
|
|
540
|
-
*/
|
|
541
|
-
appId?: string;
|
|
542
|
-
/** @readonly */
|
|
543
|
-
identityType?: WebhookIdentityType;
|
|
544
|
-
}
|
|
545
|
-
/** @oneof */
|
|
546
|
-
export interface IdentificationDataIdOneOf {
|
|
547
|
-
/**
|
|
548
|
-
* ID of a site visitor that has not logged in to the site.
|
|
549
|
-
* @format GUID
|
|
550
|
-
*/
|
|
551
|
-
anonymousVisitorId?: string;
|
|
552
|
-
/**
|
|
553
|
-
* ID of a site visitor that has logged in to the site.
|
|
554
|
-
* @format GUID
|
|
555
|
-
*/
|
|
556
|
-
memberId?: string;
|
|
557
|
-
/**
|
|
558
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
559
|
-
* @format GUID
|
|
560
|
-
*/
|
|
561
|
-
wixUserId?: string;
|
|
562
|
-
/**
|
|
563
|
-
* ID of an app.
|
|
564
|
-
* @format GUID
|
|
565
|
-
*/
|
|
566
|
-
appId?: string;
|
|
567
|
-
}
|
|
568
|
-
export declare enum WebhookIdentityType {
|
|
569
|
-
UNKNOWN = "UNKNOWN",
|
|
570
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
571
|
-
MEMBER = "MEMBER",
|
|
572
|
-
WIX_USER = "WIX_USER",
|
|
573
|
-
APP = "APP"
|
|
574
|
-
}
|
|
575
|
-
export interface CollectionEvent extends CollectionEventEventTypeOneOf {
|
|
576
|
-
/** Collection created */
|
|
577
|
-
collectionCreated?: CollectionCreated;
|
|
578
|
-
/** Items added to collection */
|
|
579
|
-
itemsAddedToCollection?: ItemsAddedToCollection;
|
|
580
|
-
/** Items removed from collection */
|
|
581
|
-
itemsRemovedFromCollection?: ItemsRemovedFromCollection;
|
|
582
|
-
/** Member joined to collection */
|
|
583
|
-
memberJoinedToCollection?: MemberJoinedToCollection;
|
|
584
|
-
/** Member left collection */
|
|
585
|
-
memberLeftCollection?: MemberLeftCollection;
|
|
586
|
-
}
|
|
587
|
-
/** @oneof */
|
|
588
|
-
export interface CollectionEventEventTypeOneOf {
|
|
589
|
-
/** Collection created */
|
|
590
|
-
collectionCreated?: CollectionCreated;
|
|
591
|
-
/** Items added to collection */
|
|
592
|
-
itemsAddedToCollection?: ItemsAddedToCollection;
|
|
593
|
-
/** Items removed from collection */
|
|
594
|
-
itemsRemovedFromCollection?: ItemsRemovedFromCollection;
|
|
595
|
-
/** Member joined to collection */
|
|
596
|
-
memberJoinedToCollection?: MemberJoinedToCollection;
|
|
597
|
-
/** Member left collection */
|
|
598
|
-
memberLeftCollection?: MemberLeftCollection;
|
|
599
|
-
}
|
|
600
|
-
export interface CollectionItemId {
|
|
601
|
-
/**
|
|
602
|
-
* Id of the gallery in ProGallery
|
|
603
|
-
* @format GUID
|
|
604
|
-
*/
|
|
605
|
-
galleryId?: string;
|
|
606
|
-
/**
|
|
607
|
-
* Id of the item in ProGallery
|
|
608
|
-
* @format GUID
|
|
609
|
-
*/
|
|
610
|
-
itemId?: string;
|
|
611
|
-
}
|
|
612
|
-
export interface CollectionCreated {
|
|
613
|
-
/**
|
|
614
|
-
* Collection id
|
|
615
|
-
* @format GUID
|
|
616
|
-
*/
|
|
617
|
-
id?: string;
|
|
618
|
-
/**
|
|
619
|
-
* Collection name
|
|
620
|
-
* @maxLength 100
|
|
621
|
-
*/
|
|
622
|
-
name?: string;
|
|
623
|
-
/**
|
|
624
|
-
* Collection description
|
|
625
|
-
* @maxLength 500
|
|
626
|
-
*/
|
|
627
|
-
description?: string | null;
|
|
628
|
-
/**
|
|
629
|
-
* Id of the member who created the collection
|
|
630
|
-
* @format GUID
|
|
631
|
-
*/
|
|
632
|
-
creatorMemberId?: string;
|
|
633
|
-
/** When the collection was created */
|
|
634
|
-
createdDate?: Date | null;
|
|
635
|
-
/** Privacy settings */
|
|
636
|
-
privacySettings?: PrivacySettings;
|
|
637
|
-
}
|
|
638
|
-
export interface ItemsAddedToCollection {
|
|
639
|
-
/**
|
|
640
|
-
* Id of the collection
|
|
641
|
-
* @format GUID
|
|
642
|
-
*/
|
|
643
|
-
collectionId?: string;
|
|
644
|
-
/**
|
|
645
|
-
* Id of the member who added items
|
|
646
|
-
* @format GUID
|
|
647
|
-
*/
|
|
648
|
-
addedByMember?: string;
|
|
649
|
-
/** Ids of the items that were added */
|
|
650
|
-
collectionItemIds?: CollectionItemId[];
|
|
651
|
-
/** When the items were added */
|
|
652
|
-
addedDate?: Date | null;
|
|
653
|
-
}
|
|
654
|
-
export interface ItemsRemovedFromCollection {
|
|
655
|
-
/**
|
|
656
|
-
* Id of the collection
|
|
657
|
-
* @format GUID
|
|
658
|
-
*/
|
|
659
|
-
collectionId?: string;
|
|
660
|
-
/**
|
|
661
|
-
* Id of the member who removed items
|
|
662
|
-
* @format GUID
|
|
663
|
-
*/
|
|
664
|
-
removedByMember?: string;
|
|
665
|
-
/**
|
|
666
|
-
* Ids of the items that were removed
|
|
667
|
-
* @format GUID
|
|
668
|
-
*/
|
|
669
|
-
itemIds?: string[];
|
|
670
|
-
/** When the items were removed */
|
|
671
|
-
removedDate?: Date | null;
|
|
672
|
-
}
|
|
673
|
-
export interface MemberJoinedToCollection {
|
|
674
|
-
/**
|
|
675
|
-
* Id of the collection
|
|
676
|
-
* @format GUID
|
|
677
|
-
*/
|
|
678
|
-
collectionId?: string;
|
|
679
|
-
/**
|
|
680
|
-
* Id of the member who joined
|
|
681
|
-
* @format GUID
|
|
682
|
-
*/
|
|
683
|
-
memberId?: string;
|
|
684
|
-
/** When the member was joined */
|
|
685
|
-
joinedDate?: Date | null;
|
|
686
|
-
}
|
|
687
|
-
export interface MemberLeftCollection {
|
|
688
|
-
/**
|
|
689
|
-
* Id of the collection
|
|
690
|
-
* @format GUID
|
|
691
|
-
*/
|
|
692
|
-
collectionId?: string;
|
|
693
|
-
/**
|
|
694
|
-
* Id of the member who left
|
|
695
|
-
* @format GUID
|
|
696
|
-
*/
|
|
697
|
-
memberId?: string;
|
|
698
|
-
/** When the member left */
|
|
699
|
-
leftDate?: Date | null;
|
|
700
|
-
}
|
|
701
|
-
export interface GetMediaCollectionRequest {
|
|
438
|
+
/** @enumType */
|
|
439
|
+
type PrivacySettingsWithLiterals = PrivacySettings | 'Undefined' | 'Public' | 'Secret';
|
|
440
|
+
interface GetMediaCollectionRequest {
|
|
702
441
|
/**
|
|
703
442
|
* Collection id
|
|
704
443
|
* @format GUID
|
|
@@ -713,13 +452,13 @@ export interface GetMediaCollectionRequest {
|
|
|
713
452
|
*/
|
|
714
453
|
limit?: number | null;
|
|
715
454
|
}
|
|
716
|
-
|
|
455
|
+
interface GetMediaCollectionResponse {
|
|
717
456
|
/** The collection */
|
|
718
457
|
mediaCollection?: MediaCollection;
|
|
719
458
|
/** The member's status in the collection */
|
|
720
|
-
memberStatus?:
|
|
459
|
+
memberStatus?: MemberStatusWithLiterals;
|
|
721
460
|
}
|
|
722
|
-
|
|
461
|
+
declare enum MemberStatus {
|
|
723
462
|
/** Undefined */
|
|
724
463
|
UNDEFINED = "UNDEFINED",
|
|
725
464
|
/** Not a member */
|
|
@@ -729,7 +468,9 @@ export declare enum MemberStatus {
|
|
|
729
468
|
/** Admin */
|
|
730
469
|
ADMIN = "ADMIN"
|
|
731
470
|
}
|
|
732
|
-
|
|
471
|
+
/** @enumType */
|
|
472
|
+
type MemberStatusWithLiterals = MemberStatus | 'UNDEFINED' | 'NOT_MEMBER' | 'MEMBER' | 'ADMIN';
|
|
473
|
+
interface ListCollectionsForItemRequest {
|
|
733
474
|
/**
|
|
734
475
|
* Gallery id
|
|
735
476
|
* @format GUID
|
|
@@ -741,11 +482,11 @@ export interface ListCollectionsForItemRequest {
|
|
|
741
482
|
*/
|
|
742
483
|
itemId: string;
|
|
743
484
|
}
|
|
744
|
-
|
|
485
|
+
interface ListCollectionsForItemResponse {
|
|
745
486
|
/** The collections that the item belongs to */
|
|
746
487
|
itemInCollections?: ItemInCollection[];
|
|
747
488
|
}
|
|
748
|
-
|
|
489
|
+
interface ItemInCollection {
|
|
749
490
|
/**
|
|
750
491
|
* Collection id
|
|
751
492
|
* @format GUID
|
|
@@ -762,7 +503,7 @@ export interface ItemInCollection {
|
|
|
762
503
|
/** Is the collection locked */
|
|
763
504
|
isLocked?: boolean;
|
|
764
505
|
/** Member's role in the collection */
|
|
765
|
-
role?:
|
|
506
|
+
role?: MemberStatusWithLiterals;
|
|
766
507
|
/** Total count of items in the collection */
|
|
767
508
|
totalItemsCount?: number | null;
|
|
768
509
|
/** The first item in the collection */
|
|
@@ -773,7 +514,7 @@ export interface ItemInCollection {
|
|
|
773
514
|
*/
|
|
774
515
|
creatorNickname?: string | null;
|
|
775
516
|
}
|
|
776
|
-
|
|
517
|
+
interface GetCollectionItemRequest {
|
|
777
518
|
/**
|
|
778
519
|
* Collection id
|
|
779
520
|
* @format GUID
|
|
@@ -785,11 +526,11 @@ export interface GetCollectionItemRequest {
|
|
|
785
526
|
*/
|
|
786
527
|
itemId: string;
|
|
787
528
|
}
|
|
788
|
-
|
|
529
|
+
interface GetCollectionItemResponse {
|
|
789
530
|
/** The item */
|
|
790
531
|
item?: MediaCollectionItem;
|
|
791
532
|
}
|
|
792
|
-
|
|
533
|
+
interface ListMediaCollectionsRequest {
|
|
793
534
|
/**
|
|
794
535
|
* the amount of collections per response, default is 1000
|
|
795
536
|
* @min 1
|
|
@@ -804,10 +545,10 @@ export interface ListMediaCollectionsRequest {
|
|
|
804
545
|
*/
|
|
805
546
|
filterByRoles?: FilterByRoles;
|
|
806
547
|
}
|
|
807
|
-
|
|
808
|
-
roles?:
|
|
548
|
+
interface FilterByRoles {
|
|
549
|
+
roles?: MemberStatusWithLiterals[];
|
|
809
550
|
}
|
|
810
|
-
|
|
551
|
+
interface ListMediaCollectionsResponse {
|
|
811
552
|
/** The collections and the member's role in them */
|
|
812
553
|
collectionsStatus?: CollectionAndStatus[];
|
|
813
554
|
/**
|
|
@@ -816,13 +557,13 @@ export interface ListMediaCollectionsResponse {
|
|
|
816
557
|
*/
|
|
817
558
|
totalCollectionsCount?: number | null;
|
|
818
559
|
}
|
|
819
|
-
|
|
560
|
+
interface CollectionAndStatus {
|
|
820
561
|
/** The Media Collection */
|
|
821
562
|
mediaCollection?: MediaCollection;
|
|
822
563
|
/** The member's status in the collection */
|
|
823
|
-
memberStatus?:
|
|
564
|
+
memberStatus?: MemberStatusWithLiterals;
|
|
824
565
|
}
|
|
825
|
-
|
|
566
|
+
interface CreateMediaCollectionRequest {
|
|
826
567
|
/**
|
|
827
568
|
* Name of the collection
|
|
828
569
|
* @minLength 1
|
|
@@ -835,11 +576,11 @@ export interface CreateMediaCollectionRequest {
|
|
|
835
576
|
*/
|
|
836
577
|
description?: string | null;
|
|
837
578
|
/** Privacy settings of the collection */
|
|
838
|
-
privacySettings?:
|
|
579
|
+
privacySettings?: PrivacySettingsWithLiterals;
|
|
839
580
|
/** Items to add to the collection */
|
|
840
581
|
items?: AddItem[];
|
|
841
582
|
}
|
|
842
|
-
|
|
583
|
+
interface AddItem {
|
|
843
584
|
/**
|
|
844
585
|
* Gallery id
|
|
845
586
|
* @format GUID
|
|
@@ -853,14 +594,14 @@ export interface AddItem {
|
|
|
853
594
|
/** Order index of the item */
|
|
854
595
|
orderIndex?: number | null;
|
|
855
596
|
}
|
|
856
|
-
|
|
597
|
+
interface CreateMediaCollectionResponse {
|
|
857
598
|
/**
|
|
858
599
|
* id of the collection that was created
|
|
859
600
|
* @format GUID
|
|
860
601
|
*/
|
|
861
602
|
mediaCollectionId?: string;
|
|
862
603
|
}
|
|
863
|
-
|
|
604
|
+
interface PartiallyUpdateMediaCollectionRequest {
|
|
864
605
|
/** Collection to update */
|
|
865
606
|
mediaCollection: MediaCollection;
|
|
866
607
|
/**
|
|
@@ -869,29 +610,18 @@ export interface PartiallyUpdateMediaCollectionRequest {
|
|
|
869
610
|
*/
|
|
870
611
|
fieldMask: string[];
|
|
871
612
|
}
|
|
872
|
-
|
|
873
|
-
}
|
|
874
|
-
export interface UpdateCollectionLockRequest {
|
|
875
|
-
/**
|
|
876
|
-
* Collection to lock
|
|
877
|
-
* @format GUID
|
|
878
|
-
*/
|
|
879
|
-
mediaCollectionId?: string;
|
|
880
|
-
/** Lock status */
|
|
881
|
-
locked?: boolean;
|
|
882
|
-
}
|
|
883
|
-
export interface UpdateCollectionLockResponse {
|
|
613
|
+
interface PartiallyUpdateMediaCollectionResponse {
|
|
884
614
|
}
|
|
885
|
-
|
|
615
|
+
interface DeleteMediaCollectionRequest {
|
|
886
616
|
/**
|
|
887
617
|
* the collection to delete
|
|
888
618
|
* @format GUID
|
|
889
619
|
*/
|
|
890
620
|
mediaCollectionId: string;
|
|
891
621
|
}
|
|
892
|
-
|
|
622
|
+
interface DeleteMediaCollectionResponse {
|
|
893
623
|
}
|
|
894
|
-
|
|
624
|
+
interface ListCollectionMembersRequest {
|
|
895
625
|
/**
|
|
896
626
|
* the collection to get its members
|
|
897
627
|
* @format GUID
|
|
@@ -900,21 +630,21 @@ export interface ListCollectionMembersRequest {
|
|
|
900
630
|
/** Filter the members by their role in the collection */
|
|
901
631
|
filterBy?: FilterBy;
|
|
902
632
|
}
|
|
903
|
-
|
|
633
|
+
interface FilterBy {
|
|
904
634
|
/** Member's status in the collection */
|
|
905
|
-
memberStatus?:
|
|
635
|
+
memberStatus?: MemberStatusWithLiterals;
|
|
906
636
|
}
|
|
907
|
-
|
|
637
|
+
interface ListCollectionMembersResponse {
|
|
908
638
|
/** The collection's members and their roles */
|
|
909
639
|
membersRoles?: MemberAndStatus[];
|
|
910
640
|
}
|
|
911
|
-
|
|
641
|
+
interface MemberAndStatus {
|
|
912
642
|
/** The member */
|
|
913
643
|
member?: CollectionMember;
|
|
914
644
|
/** The member's role in the collection */
|
|
915
|
-
memberStatus?:
|
|
645
|
+
memberStatus?: MemberStatusWithLiterals;
|
|
916
646
|
}
|
|
917
|
-
|
|
647
|
+
interface AddItemsRequest {
|
|
918
648
|
/**
|
|
919
649
|
* Collection to add items
|
|
920
650
|
* @format GUID
|
|
@@ -923,9 +653,9 @@ export interface AddItemsRequest {
|
|
|
923
653
|
/** Items to add */
|
|
924
654
|
items?: AddItem[];
|
|
925
655
|
}
|
|
926
|
-
|
|
656
|
+
interface AddItemsResponse {
|
|
927
657
|
}
|
|
928
|
-
|
|
658
|
+
interface RemoveItemsRequest {
|
|
929
659
|
/**
|
|
930
660
|
* Collection to remove items from
|
|
931
661
|
* @format GUID
|
|
@@ -937,71 +667,38 @@ export interface RemoveItemsRequest {
|
|
|
937
667
|
*/
|
|
938
668
|
itemsIds?: string[];
|
|
939
669
|
}
|
|
940
|
-
|
|
670
|
+
interface RemoveItemsResponse {
|
|
941
671
|
}
|
|
942
|
-
|
|
943
|
-
/**
|
|
944
|
-
* Collection to update items
|
|
945
|
-
* @format GUID
|
|
946
|
-
*/
|
|
947
|
-
mediaCollectionId?: string;
|
|
948
|
-
items?: UpdateItem[];
|
|
949
|
-
}
|
|
950
|
-
export interface UpdateItem {
|
|
951
|
-
/**
|
|
952
|
-
* Item to update
|
|
953
|
-
* @format GUID
|
|
954
|
-
*/
|
|
955
|
-
itemId?: string;
|
|
956
|
-
/** New order index of the item */
|
|
957
|
-
orderIndex?: number;
|
|
958
|
-
}
|
|
959
|
-
export interface UpdateItemsResponse {
|
|
960
|
-
}
|
|
961
|
-
export interface JoinToCollectionRequest {
|
|
672
|
+
interface JoinToCollectionRequest {
|
|
962
673
|
/**
|
|
963
674
|
* Collection to join
|
|
964
675
|
* @format GUID
|
|
965
676
|
*/
|
|
966
677
|
mediaCollectionId: string;
|
|
967
678
|
}
|
|
968
|
-
|
|
969
|
-
}
|
|
970
|
-
export interface RemoveMemberFromCollectionRequest {
|
|
971
|
-
/**
|
|
972
|
-
* Collection the member will be removed from being a member
|
|
973
|
-
* @format GUID
|
|
974
|
-
*/
|
|
975
|
-
mediaCollectionId?: string;
|
|
976
|
-
/**
|
|
977
|
-
* Member id to remove from the collection
|
|
978
|
-
* @format GUID
|
|
979
|
-
*/
|
|
980
|
-
memberId?: string;
|
|
981
|
-
}
|
|
982
|
-
export interface RemoveMemberFromCollectionResponse {
|
|
679
|
+
interface JoinToCollectionResponse {
|
|
983
680
|
}
|
|
984
|
-
|
|
681
|
+
interface LeaveCollectionRequest {
|
|
985
682
|
/**
|
|
986
683
|
* Collection the member will be leaving
|
|
987
684
|
* @format GUID
|
|
988
685
|
*/
|
|
989
686
|
mediaCollectionId: string;
|
|
990
687
|
}
|
|
991
|
-
|
|
688
|
+
interface LeaveCollectionResponse {
|
|
992
689
|
}
|
|
993
|
-
|
|
690
|
+
interface ListCollectionItemsRequest {
|
|
994
691
|
/**
|
|
995
692
|
* Collection to get its items
|
|
996
693
|
* @format GUID
|
|
997
694
|
*/
|
|
998
695
|
mediaCollectionId: string;
|
|
999
696
|
}
|
|
1000
|
-
|
|
697
|
+
interface ListCollectionItemsResponse {
|
|
1001
698
|
/** The collection's items */
|
|
1002
699
|
collectionItems?: CollectionItem[];
|
|
1003
700
|
}
|
|
1004
|
-
|
|
701
|
+
interface CollectionItem {
|
|
1005
702
|
/**
|
|
1006
703
|
* Gallery id
|
|
1007
704
|
* @format GUID
|
|
@@ -1017,12 +714,52 @@ export interface CollectionItem {
|
|
|
1017
714
|
/** Date the item was added to the collection */
|
|
1018
715
|
addedDate?: Date | null;
|
|
1019
716
|
}
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
717
|
+
|
|
718
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
719
|
+
getUrl: (context: any) => string;
|
|
720
|
+
httpMethod: K;
|
|
721
|
+
path: string;
|
|
722
|
+
pathParams: M;
|
|
723
|
+
__requestType: T;
|
|
724
|
+
__originalRequestType: S;
|
|
725
|
+
__responseType: Q;
|
|
726
|
+
__originalResponseType: R;
|
|
727
|
+
};
|
|
728
|
+
declare function get(): __PublicMethodMetaInfo<'GET', {
|
|
729
|
+
mediaCollectionId: string;
|
|
730
|
+
}, GetMediaCollectionRequest$1, GetMediaCollectionRequest, GetMediaCollectionResponse$1, GetMediaCollectionResponse>;
|
|
731
|
+
declare function listCollectionsForItem(): __PublicMethodMetaInfo<'GET', {
|
|
732
|
+
itemId: string;
|
|
733
|
+
}, ListCollectionsForItemRequest$1, ListCollectionsForItemRequest, ListCollectionsForItemResponse$1, ListCollectionsForItemResponse>;
|
|
734
|
+
declare function getCollectionItem(): __PublicMethodMetaInfo<'GET', {
|
|
735
|
+
mediaCollectionId: string;
|
|
736
|
+
itemId: string;
|
|
737
|
+
}, GetCollectionItemRequest$1, GetCollectionItemRequest, GetCollectionItemResponse$1, GetCollectionItemResponse>;
|
|
738
|
+
declare function list(): __PublicMethodMetaInfo<'GET', {}, ListMediaCollectionsRequest$1, ListMediaCollectionsRequest, ListMediaCollectionsResponse$1, ListMediaCollectionsResponse>;
|
|
739
|
+
declare function create(): __PublicMethodMetaInfo<'POST', {}, CreateMediaCollectionRequest$1, CreateMediaCollectionRequest, CreateMediaCollectionResponse$1, CreateMediaCollectionResponse>;
|
|
740
|
+
declare function partiallyUpdate(): __PublicMethodMetaInfo<'PUT', {
|
|
741
|
+
mediaCollectionId: string;
|
|
742
|
+
}, PartiallyUpdateMediaCollectionRequest$1, PartiallyUpdateMediaCollectionRequest, PartiallyUpdateMediaCollectionResponse$1, PartiallyUpdateMediaCollectionResponse>;
|
|
743
|
+
declare function _delete(): __PublicMethodMetaInfo<'DELETE', {
|
|
744
|
+
mediaCollectionId: string;
|
|
745
|
+
}, DeleteMediaCollectionRequest$1, DeleteMediaCollectionRequest, DeleteMediaCollectionResponse$1, DeleteMediaCollectionResponse>;
|
|
746
|
+
declare function listCollectionMembers(): __PublicMethodMetaInfo<'GET', {
|
|
747
|
+
mediaCollectionId: string;
|
|
748
|
+
}, ListCollectionMembersRequest$1, ListCollectionMembersRequest, ListCollectionMembersResponse$1, ListCollectionMembersResponse>;
|
|
749
|
+
declare function addItems(): __PublicMethodMetaInfo<'POST', {
|
|
750
|
+
mediaCollectionId: string;
|
|
751
|
+
}, AddItemsRequest$1, AddItemsRequest, AddItemsResponse$1, AddItemsResponse>;
|
|
752
|
+
declare function removeItems(): __PublicMethodMetaInfo<'DELETE', {
|
|
753
|
+
mediaCollectionId: string;
|
|
754
|
+
}, RemoveItemsRequest$1, RemoveItemsRequest, RemoveItemsResponse$1, RemoveItemsResponse>;
|
|
755
|
+
declare function joinToCollection(): __PublicMethodMetaInfo<'POST', {
|
|
756
|
+
mediaCollectionId: string;
|
|
757
|
+
}, JoinToCollectionRequest$1, JoinToCollectionRequest, JoinToCollectionResponse$1, JoinToCollectionResponse>;
|
|
758
|
+
declare function leaveCollection(): __PublicMethodMetaInfo<'DELETE', {
|
|
759
|
+
mediaCollectionId: string;
|
|
760
|
+
}, LeaveCollectionRequest$1, LeaveCollectionRequest, LeaveCollectionResponse$1, LeaveCollectionResponse>;
|
|
761
|
+
declare function listCollectionItems(): __PublicMethodMetaInfo<'GET', {
|
|
762
|
+
mediaCollectionId: string;
|
|
763
|
+
}, ListCollectionItemsRequest$1, ListCollectionItemsRequest, ListCollectionItemsResponse$1, ListCollectionItemsResponse>;
|
|
764
|
+
|
|
765
|
+
export { type __PublicMethodMetaInfo, _delete, addItems, create, get, getCollectionItem, joinToCollection, leaveCollection, list, listCollectionItems, listCollectionMembers, listCollectionsForItem, partiallyUpdate, removeItems };
|