@wix/media 1.0.140 → 1.0.141
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/context.js.map +1 -0
- package/context.ts +4 -0
- package/index.js.map +1 -0
- package/index.ts +6 -0
- package/meta.js.map +1 -0
- package/meta.ts +4 -0
- package/package.json +26 -21
- package/build/cjs/context.js.map +0 -1
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/meta.js.map +0 -1
- package/context/package.json +0 -7
- package/meta/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -4734
- package/type-bundles/index.bundle.d.ts +0 -4734
- package/type-bundles/meta.bundle.d.ts +0 -3864
- /package/{build/cjs/context.d.ts → context.d.ts} +0 -0
- /package/{build/cjs/context.js → context.js} +0 -0
- /package/{build/cjs/index.d.ts → index.d.ts} +0 -0
- /package/{build/cjs/index.js → index.js} +0 -0
- /package/{build/cjs/meta.d.ts → meta.d.ts} +0 -0
- /package/{build/cjs/meta.js → meta.js} +0 -0
|
@@ -1,3864 +0,0 @@
|
|
|
1
|
-
interface EnterpriseCategory$1 {
|
|
2
|
-
/**
|
|
3
|
-
* Id of the category
|
|
4
|
-
* @readonly
|
|
5
|
-
*/
|
|
6
|
-
id?: string;
|
|
7
|
-
/** The display name that will be shown for the item */
|
|
8
|
-
displayName?: string | null;
|
|
9
|
-
/** Id of the parent category, will default to the account master category */
|
|
10
|
-
parentCategoryId?: string | null;
|
|
11
|
-
/** Sort order number of the category, will determine the order of the category with other categories under the same parent category */
|
|
12
|
-
sortOrder?: number | null;
|
|
13
|
-
/** Publish status of the category */
|
|
14
|
-
publishStatus?: PublishStatus$3;
|
|
15
|
-
/**
|
|
16
|
-
* Date and time the category was created.
|
|
17
|
-
* @readonly
|
|
18
|
-
*/
|
|
19
|
-
createdDate?: Date | null;
|
|
20
|
-
/**
|
|
21
|
-
* Date and time the category was updated.
|
|
22
|
-
* @readonly
|
|
23
|
-
*/
|
|
24
|
-
updatedDate?: Date | null;
|
|
25
|
-
}
|
|
26
|
-
declare enum PublishStatus$3 {
|
|
27
|
-
UNDEFINED = "UNDEFINED",
|
|
28
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
29
|
-
PUBLISHED = "PUBLISHED",
|
|
30
|
-
WIX_ONLY = "WIX_ONLY"
|
|
31
|
-
}
|
|
32
|
-
declare enum MediaType$5 {
|
|
33
|
-
MIXED = "MIXED",
|
|
34
|
-
IMAGE = "IMAGE",
|
|
35
|
-
VIDEO = "VIDEO",
|
|
36
|
-
AUDIO = "AUDIO",
|
|
37
|
-
DOCUMENT = "DOCUMENT",
|
|
38
|
-
VECTOR = "VECTOR",
|
|
39
|
-
ARCHIVE = "ARCHIVE",
|
|
40
|
-
MODEL3D = "MODEL3D"
|
|
41
|
-
}
|
|
42
|
-
interface CreateCategoryRequest$1 {
|
|
43
|
-
/** The category object that will be created */
|
|
44
|
-
category: EnterpriseCategory$1;
|
|
45
|
-
}
|
|
46
|
-
interface CreateCategoryResponse$1 {
|
|
47
|
-
/** A list of items matching the request */
|
|
48
|
-
category?: EnterpriseCategory$1;
|
|
49
|
-
}
|
|
50
|
-
interface DeleteCategoryRequest$1 {
|
|
51
|
-
/** Category id */
|
|
52
|
-
categoryId: string;
|
|
53
|
-
}
|
|
54
|
-
interface DeleteCategoryResponse$1 {
|
|
55
|
-
}
|
|
56
|
-
interface UpdateCategoryRequest$1 {
|
|
57
|
-
/** The category object that will be created */
|
|
58
|
-
category: EnterpriseCategory$1;
|
|
59
|
-
}
|
|
60
|
-
interface UpdateCategoryResponse$1 {
|
|
61
|
-
/** The updated category */
|
|
62
|
-
category?: EnterpriseCategory$1;
|
|
63
|
-
}
|
|
64
|
-
interface GetCategoryRequest$1 {
|
|
65
|
-
/** Category id */
|
|
66
|
-
categoryId: string;
|
|
67
|
-
/** number of sub category levels */
|
|
68
|
-
levels?: number | null;
|
|
69
|
-
/** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */
|
|
70
|
-
publishStatus?: PublishStatus$3;
|
|
71
|
-
}
|
|
72
|
-
interface GetCategoryResponse$1 {
|
|
73
|
-
/** The category details */
|
|
74
|
-
category?: EnterpriseCategoryTree$1;
|
|
75
|
-
}
|
|
76
|
-
interface EnterpriseCategoryTree$1 {
|
|
77
|
-
/** Category information */
|
|
78
|
-
category?: EnterpriseCategory$1;
|
|
79
|
-
/** Information about the sub categories */
|
|
80
|
-
subCategories?: EnterpriseCategoryTree$1[];
|
|
81
|
-
}
|
|
82
|
-
interface EnterpriseOnboardingRequest$1 {
|
|
83
|
-
/** The account id of the organization - will be used as the organization category id */
|
|
84
|
-
accountId: string;
|
|
85
|
-
/** The account name of the organization - will be used as the organization category name */
|
|
86
|
-
accountName?: string;
|
|
87
|
-
}
|
|
88
|
-
interface EnterpriseOnboardingResponse$1 {
|
|
89
|
-
/** The enterprise category */
|
|
90
|
-
category?: EnterpriseCategory$1;
|
|
91
|
-
}
|
|
92
|
-
interface GetMediaManagerCategoriesRequest$1 {
|
|
93
|
-
}
|
|
94
|
-
interface GetMediaManagerCategoriesResponse$1 {
|
|
95
|
-
/** The category details */
|
|
96
|
-
category?: EnterpriseCategoryTree$1;
|
|
97
|
-
}
|
|
98
|
-
interface EnterpriseCategoryNonNullableFields$1 {
|
|
99
|
-
id: string;
|
|
100
|
-
publishStatus: PublishStatus$3;
|
|
101
|
-
mediaType: MediaType$5;
|
|
102
|
-
}
|
|
103
|
-
interface CreateCategoryResponseNonNullableFields$1 {
|
|
104
|
-
category?: EnterpriseCategoryNonNullableFields$1;
|
|
105
|
-
}
|
|
106
|
-
interface UpdateCategoryResponseNonNullableFields$1 {
|
|
107
|
-
category?: EnterpriseCategoryNonNullableFields$1;
|
|
108
|
-
}
|
|
109
|
-
interface EnterpriseCategoryTreeNonNullableFields$1 {
|
|
110
|
-
category?: EnterpriseCategoryNonNullableFields$1;
|
|
111
|
-
subCategories: EnterpriseCategoryTreeNonNullableFields$1[];
|
|
112
|
-
}
|
|
113
|
-
interface GetCategoryResponseNonNullableFields$1 {
|
|
114
|
-
category?: EnterpriseCategoryTreeNonNullableFields$1;
|
|
115
|
-
}
|
|
116
|
-
interface EnterpriseOnboardingResponseNonNullableFields$1 {
|
|
117
|
-
category?: EnterpriseCategoryNonNullableFields$1;
|
|
118
|
-
}
|
|
119
|
-
interface GetMediaManagerCategoriesResponseNonNullableFields$1 {
|
|
120
|
-
category?: EnterpriseCategoryTreeNonNullableFields$1;
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
interface EnterpriseCategory {
|
|
124
|
-
/**
|
|
125
|
-
* Id of the category
|
|
126
|
-
* @readonly
|
|
127
|
-
*/
|
|
128
|
-
_id?: string;
|
|
129
|
-
/** The display name that will be shown for the item */
|
|
130
|
-
displayName?: string | null;
|
|
131
|
-
/** Id of the parent category, will default to the account master category */
|
|
132
|
-
parentCategoryId?: string | null;
|
|
133
|
-
/** Sort order number of the category, will determine the order of the category with other categories under the same parent category */
|
|
134
|
-
sortOrder?: number | null;
|
|
135
|
-
/** Publish status of the category */
|
|
136
|
-
publishStatus?: PublishStatus$2;
|
|
137
|
-
/**
|
|
138
|
-
* Date and time the category was created.
|
|
139
|
-
* @readonly
|
|
140
|
-
*/
|
|
141
|
-
_createdDate?: Date | null;
|
|
142
|
-
/**
|
|
143
|
-
* Date and time the category was updated.
|
|
144
|
-
* @readonly
|
|
145
|
-
*/
|
|
146
|
-
_updatedDate?: Date | null;
|
|
147
|
-
}
|
|
148
|
-
declare enum PublishStatus$2 {
|
|
149
|
-
UNDEFINED = "UNDEFINED",
|
|
150
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
151
|
-
PUBLISHED = "PUBLISHED",
|
|
152
|
-
WIX_ONLY = "WIX_ONLY"
|
|
153
|
-
}
|
|
154
|
-
declare enum MediaType$4 {
|
|
155
|
-
MIXED = "MIXED",
|
|
156
|
-
IMAGE = "IMAGE",
|
|
157
|
-
VIDEO = "VIDEO",
|
|
158
|
-
AUDIO = "AUDIO",
|
|
159
|
-
DOCUMENT = "DOCUMENT",
|
|
160
|
-
VECTOR = "VECTOR",
|
|
161
|
-
ARCHIVE = "ARCHIVE",
|
|
162
|
-
MODEL3D = "MODEL3D"
|
|
163
|
-
}
|
|
164
|
-
interface CreateCategoryRequest {
|
|
165
|
-
/** The category object that will be created */
|
|
166
|
-
category: EnterpriseCategory;
|
|
167
|
-
}
|
|
168
|
-
interface CreateCategoryResponse {
|
|
169
|
-
/** A list of items matching the request */
|
|
170
|
-
category?: EnterpriseCategory;
|
|
171
|
-
}
|
|
172
|
-
interface DeleteCategoryRequest {
|
|
173
|
-
/** Category id */
|
|
174
|
-
categoryId: string;
|
|
175
|
-
}
|
|
176
|
-
interface DeleteCategoryResponse {
|
|
177
|
-
}
|
|
178
|
-
interface UpdateCategoryRequest {
|
|
179
|
-
/** The category object that will be created */
|
|
180
|
-
category: EnterpriseCategory;
|
|
181
|
-
}
|
|
182
|
-
interface UpdateCategoryResponse {
|
|
183
|
-
/** The updated category */
|
|
184
|
-
category?: EnterpriseCategory;
|
|
185
|
-
}
|
|
186
|
-
interface GetCategoryRequest {
|
|
187
|
-
/** Category id */
|
|
188
|
-
categoryId: string;
|
|
189
|
-
/** number of sub category levels */
|
|
190
|
-
levels?: number | null;
|
|
191
|
-
/** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */
|
|
192
|
-
publishStatus?: PublishStatus$2;
|
|
193
|
-
}
|
|
194
|
-
interface GetCategoryResponse {
|
|
195
|
-
/** The category details */
|
|
196
|
-
category?: EnterpriseCategoryTree;
|
|
197
|
-
}
|
|
198
|
-
interface EnterpriseCategoryTree {
|
|
199
|
-
/** Category information */
|
|
200
|
-
category?: EnterpriseCategory;
|
|
201
|
-
/** Information about the sub categories */
|
|
202
|
-
subCategories?: EnterpriseCategoryTree[];
|
|
203
|
-
}
|
|
204
|
-
interface EnterpriseOnboardingRequest {
|
|
205
|
-
/** The account id of the organization - will be used as the organization category id */
|
|
206
|
-
accountId: string;
|
|
207
|
-
/** The account name of the organization - will be used as the organization category name */
|
|
208
|
-
accountName?: string;
|
|
209
|
-
}
|
|
210
|
-
interface EnterpriseOnboardingResponse {
|
|
211
|
-
/** The enterprise category */
|
|
212
|
-
category?: EnterpriseCategory;
|
|
213
|
-
}
|
|
214
|
-
interface GetMediaManagerCategoriesRequest {
|
|
215
|
-
}
|
|
216
|
-
interface GetMediaManagerCategoriesResponse {
|
|
217
|
-
/** The category details */
|
|
218
|
-
category?: EnterpriseCategoryTree;
|
|
219
|
-
}
|
|
220
|
-
interface EnterpriseCategoryNonNullableFields {
|
|
221
|
-
_id: string;
|
|
222
|
-
publishStatus: PublishStatus$2;
|
|
223
|
-
mediaType: MediaType$4;
|
|
224
|
-
}
|
|
225
|
-
interface CreateCategoryResponseNonNullableFields {
|
|
226
|
-
category?: EnterpriseCategoryNonNullableFields;
|
|
227
|
-
}
|
|
228
|
-
interface UpdateCategoryResponseNonNullableFields {
|
|
229
|
-
category?: EnterpriseCategoryNonNullableFields;
|
|
230
|
-
}
|
|
231
|
-
interface EnterpriseCategoryTreeNonNullableFields {
|
|
232
|
-
category?: EnterpriseCategoryNonNullableFields;
|
|
233
|
-
subCategories: EnterpriseCategoryTreeNonNullableFields[];
|
|
234
|
-
}
|
|
235
|
-
interface GetCategoryResponseNonNullableFields {
|
|
236
|
-
category?: EnterpriseCategoryTreeNonNullableFields;
|
|
237
|
-
}
|
|
238
|
-
interface EnterpriseOnboardingResponseNonNullableFields {
|
|
239
|
-
category?: EnterpriseCategoryNonNullableFields;
|
|
240
|
-
}
|
|
241
|
-
interface GetMediaManagerCategoriesResponseNonNullableFields {
|
|
242
|
-
category?: EnterpriseCategoryTreeNonNullableFields;
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
246
|
-
getUrl: (context: any) => string;
|
|
247
|
-
httpMethod: K;
|
|
248
|
-
path: string;
|
|
249
|
-
pathParams: M;
|
|
250
|
-
__requestType: T;
|
|
251
|
-
__originalRequestType: S;
|
|
252
|
-
__responseType: Q;
|
|
253
|
-
__originalResponseType: R;
|
|
254
|
-
};
|
|
255
|
-
declare function createCategory(): __PublicMethodMetaInfo$3<'POST', {}, CreateCategoryRequest, CreateCategoryRequest$1, CreateCategoryResponse & CreateCategoryResponseNonNullableFields, CreateCategoryResponse$1 & CreateCategoryResponseNonNullableFields$1>;
|
|
256
|
-
declare function deleteCategory(): __PublicMethodMetaInfo$3<'DELETE', {
|
|
257
|
-
categoryId: string;
|
|
258
|
-
}, DeleteCategoryRequest, DeleteCategoryRequest$1, DeleteCategoryResponse, DeleteCategoryResponse$1>;
|
|
259
|
-
declare function updateCategory(): __PublicMethodMetaInfo$3<'PATCH', {
|
|
260
|
-
categoryId: string;
|
|
261
|
-
}, UpdateCategoryRequest, UpdateCategoryRequest$1, UpdateCategoryResponse & UpdateCategoryResponseNonNullableFields, UpdateCategoryResponse$1 & UpdateCategoryResponseNonNullableFields$1>;
|
|
262
|
-
declare function getCategory(): __PublicMethodMetaInfo$3<'GET', {
|
|
263
|
-
categoryId: string;
|
|
264
|
-
}, GetCategoryRequest, GetCategoryRequest$1, GetCategoryResponse & GetCategoryResponseNonNullableFields, GetCategoryResponse$1 & GetCategoryResponseNonNullableFields$1>;
|
|
265
|
-
declare function enterpriseOnboarding(): __PublicMethodMetaInfo$3<'POST', {}, EnterpriseOnboardingRequest, EnterpriseOnboardingRequest$1, EnterpriseOnboardingResponse & EnterpriseOnboardingResponseNonNullableFields, EnterpriseOnboardingResponse$1 & EnterpriseOnboardingResponseNonNullableFields$1>;
|
|
266
|
-
declare function getMediaManagerCategories(): __PublicMethodMetaInfo$3<'GET', {}, GetMediaManagerCategoriesRequest, GetMediaManagerCategoriesRequest$1, GetMediaManagerCategoriesResponse & GetMediaManagerCategoriesResponseNonNullableFields, GetMediaManagerCategoriesResponse$1 & GetMediaManagerCategoriesResponseNonNullableFields$1>;
|
|
267
|
-
|
|
268
|
-
declare const meta$3_createCategory: typeof createCategory;
|
|
269
|
-
declare const meta$3_deleteCategory: typeof deleteCategory;
|
|
270
|
-
declare const meta$3_enterpriseOnboarding: typeof enterpriseOnboarding;
|
|
271
|
-
declare const meta$3_getCategory: typeof getCategory;
|
|
272
|
-
declare const meta$3_getMediaManagerCategories: typeof getMediaManagerCategories;
|
|
273
|
-
declare const meta$3_updateCategory: typeof updateCategory;
|
|
274
|
-
declare namespace meta$3 {
|
|
275
|
-
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_createCategory as createCategory, meta$3_deleteCategory as deleteCategory, meta$3_enterpriseOnboarding as enterpriseOnboarding, meta$3_getCategory as getCategory, meta$3_getMediaManagerCategories as getMediaManagerCategories, meta$3_updateCategory as updateCategory };
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* Duration for video fits better if there will be type specific media item.. however, is it ok to implement
|
|
280
|
-
* an additional one of field called details?
|
|
281
|
-
*/
|
|
282
|
-
interface EnterpriseMediaItem$1 {
|
|
283
|
-
/**
|
|
284
|
-
* Id of the item in public media
|
|
285
|
-
* @readonly
|
|
286
|
-
*/
|
|
287
|
-
id?: string;
|
|
288
|
-
/**
|
|
289
|
-
* Media type of the item
|
|
290
|
-
* @readonly
|
|
291
|
-
*/
|
|
292
|
-
mediaType?: MediaType$3;
|
|
293
|
-
/**
|
|
294
|
-
* Size of the uploaded file in bytes.
|
|
295
|
-
* @readonly
|
|
296
|
-
*/
|
|
297
|
-
sizeInBytes?: string | null;
|
|
298
|
-
/** The item title, part of searchable fields */
|
|
299
|
-
title?: string | null;
|
|
300
|
-
/**
|
|
301
|
-
* The aspect ratio of the item
|
|
302
|
-
* An object containing urls for different views of the item
|
|
303
|
-
* @readonly
|
|
304
|
-
*/
|
|
305
|
-
assets?: ItemAssets$1;
|
|
306
|
-
/** Tags describing the image, part of searchable fields */
|
|
307
|
-
displayTags?: string[] | null;
|
|
308
|
-
/** Tags for internal client use, part of searchable fields */
|
|
309
|
-
internalTags?: string[] | null;
|
|
310
|
-
/**
|
|
311
|
-
* Tags for filtering items in the search
|
|
312
|
-
* @readonly
|
|
313
|
-
*/
|
|
314
|
-
systemTags?: string[] | null;
|
|
315
|
-
/**
|
|
316
|
-
* Category ids this item belongs to
|
|
317
|
-
* @readonly
|
|
318
|
-
*/
|
|
319
|
-
parentCategoryIds?: string[] | null;
|
|
320
|
-
/** Status of the item */
|
|
321
|
-
publishStatus?: PublishStatus$1;
|
|
322
|
-
/**
|
|
323
|
-
* Date and time the item was created.
|
|
324
|
-
* @readonly
|
|
325
|
-
*/
|
|
326
|
-
createdDate?: Date | null;
|
|
327
|
-
/**
|
|
328
|
-
* Date and time the item was updated.
|
|
329
|
-
* @readonly
|
|
330
|
-
*/
|
|
331
|
-
updatedDate?: Date | null;
|
|
332
|
-
/**
|
|
333
|
-
* An internal id used with different wix media systems
|
|
334
|
-
* @readonly
|
|
335
|
-
*/
|
|
336
|
-
internalId?: string | null;
|
|
337
|
-
}
|
|
338
|
-
declare enum MediaType$3 {
|
|
339
|
-
MIXED = "MIXED",
|
|
340
|
-
IMAGE = "IMAGE",
|
|
341
|
-
VIDEO = "VIDEO",
|
|
342
|
-
AUDIO = "AUDIO",
|
|
343
|
-
DOCUMENT = "DOCUMENT",
|
|
344
|
-
VECTOR = "VECTOR",
|
|
345
|
-
ARCHIVE = "ARCHIVE",
|
|
346
|
-
MODEL3D = "MODEL3D"
|
|
347
|
-
}
|
|
348
|
-
interface ItemAssets$1 extends ItemAssetsAssetsOneOf$1 {
|
|
349
|
-
/** Assets for image media type */
|
|
350
|
-
image?: Image$1;
|
|
351
|
-
/** Assets for video media type */
|
|
352
|
-
video?: VideoV2$1;
|
|
353
|
-
/** Assets for vector media type */
|
|
354
|
-
vector?: Image$1;
|
|
355
|
-
/** Assets for audio media type */
|
|
356
|
-
audio?: Audio$1;
|
|
357
|
-
/** Assets for document media type */
|
|
358
|
-
document?: Document$1;
|
|
359
|
-
/** Information about the archive. */
|
|
360
|
-
archive?: Archive$3;
|
|
361
|
-
/** Information about the 3D Model. */
|
|
362
|
-
model3d?: Model3D$3;
|
|
363
|
-
}
|
|
364
|
-
/** @oneof */
|
|
365
|
-
interface ItemAssetsAssetsOneOf$1 {
|
|
366
|
-
/** Assets for image media type */
|
|
367
|
-
image?: Image$1;
|
|
368
|
-
/** Assets for video media type */
|
|
369
|
-
video?: VideoV2$1;
|
|
370
|
-
/** Assets for vector media type */
|
|
371
|
-
vector?: Image$1;
|
|
372
|
-
/** Assets for audio media type */
|
|
373
|
-
audio?: Audio$1;
|
|
374
|
-
/** Assets for document media type */
|
|
375
|
-
document?: Document$1;
|
|
376
|
-
/** Information about the archive. */
|
|
377
|
-
archive?: Archive$3;
|
|
378
|
-
/** Information about the 3D Model. */
|
|
379
|
-
model3d?: Model3D$3;
|
|
380
|
-
}
|
|
381
|
-
interface Image$1 {
|
|
382
|
-
/** WixMedia image ID. */
|
|
383
|
-
id?: string;
|
|
384
|
-
/** Image URL. */
|
|
385
|
-
url?: string;
|
|
386
|
-
/**
|
|
387
|
-
* Original image height.
|
|
388
|
-
* @readonly
|
|
389
|
-
*/
|
|
390
|
-
height?: number;
|
|
391
|
-
/**
|
|
392
|
-
* Original image width.
|
|
393
|
-
* @readonly
|
|
394
|
-
*/
|
|
395
|
-
width?: number;
|
|
396
|
-
/** Image alt text. */
|
|
397
|
-
altText?: string | null;
|
|
398
|
-
/**
|
|
399
|
-
* Image filename.
|
|
400
|
-
* @readonly
|
|
401
|
-
*/
|
|
402
|
-
filename?: string | null;
|
|
403
|
-
}
|
|
404
|
-
interface VideoV2$1 {
|
|
405
|
-
/** WixMedia ID. */
|
|
406
|
-
id?: string;
|
|
407
|
-
/**
|
|
408
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
409
|
-
* @readonly
|
|
410
|
-
*/
|
|
411
|
-
resolutions?: VideoResolution$1[];
|
|
412
|
-
/**
|
|
413
|
-
* Video filename.
|
|
414
|
-
* @readonly
|
|
415
|
-
*/
|
|
416
|
-
filename?: string | null;
|
|
417
|
-
}
|
|
418
|
-
interface VideoResolution$1 {
|
|
419
|
-
/** Video URL. */
|
|
420
|
-
url?: string;
|
|
421
|
-
/** Video height. */
|
|
422
|
-
height?: number;
|
|
423
|
-
/** Video width. */
|
|
424
|
-
width?: number;
|
|
425
|
-
/**
|
|
426
|
-
* Video format
|
|
427
|
-
* Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'
|
|
428
|
-
* '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm' ]
|
|
429
|
-
*/
|
|
430
|
-
format?: string;
|
|
431
|
-
}
|
|
432
|
-
interface Audio$1 {
|
|
433
|
-
/** WixMedia ID. */
|
|
434
|
-
id?: string;
|
|
435
|
-
/** Audio URL. */
|
|
436
|
-
url?: string;
|
|
437
|
-
/**
|
|
438
|
-
* Audio filename.
|
|
439
|
-
* @readonly
|
|
440
|
-
*/
|
|
441
|
-
filename?: string | null;
|
|
442
|
-
}
|
|
443
|
-
interface Document$1 {
|
|
444
|
-
/** WixMedia ID. */
|
|
445
|
-
id?: string;
|
|
446
|
-
/** Document URL. */
|
|
447
|
-
url?: string;
|
|
448
|
-
/** Document filename. */
|
|
449
|
-
filename?: string | null;
|
|
450
|
-
}
|
|
451
|
-
interface Archive$3 {
|
|
452
|
-
/** WixMedia ID. */
|
|
453
|
-
id?: string;
|
|
454
|
-
/** Archive URL. */
|
|
455
|
-
url?: string;
|
|
456
|
-
/**
|
|
457
|
-
* Archive URL expiration date (when relevant).
|
|
458
|
-
* @readonly
|
|
459
|
-
*/
|
|
460
|
-
urlExpirationDate?: Date | null;
|
|
461
|
-
/** Archive size in bytes. */
|
|
462
|
-
sizeInBytes?: string | null;
|
|
463
|
-
/** Archive filename. */
|
|
464
|
-
filename?: string | null;
|
|
465
|
-
}
|
|
466
|
-
interface Model3D$3 {
|
|
467
|
-
/** WixMedia 3D ID. */
|
|
468
|
-
id?: string;
|
|
469
|
-
/** 3D URL. */
|
|
470
|
-
url?: string;
|
|
471
|
-
/** 3D thumbnail Image */
|
|
472
|
-
thumbnail?: Image$1;
|
|
473
|
-
/** 3D alt text. */
|
|
474
|
-
altText?: string | null;
|
|
475
|
-
/**
|
|
476
|
-
* 3D URL expiration date (when relevant).
|
|
477
|
-
* @readonly
|
|
478
|
-
*/
|
|
479
|
-
urlExpirationDate?: Date | null;
|
|
480
|
-
/**
|
|
481
|
-
* 3D filename.
|
|
482
|
-
* @readonly
|
|
483
|
-
*/
|
|
484
|
-
filename?: string | null;
|
|
485
|
-
/**
|
|
486
|
-
* 3D size in bytes.
|
|
487
|
-
* @readonly
|
|
488
|
-
*/
|
|
489
|
-
sizeInBytes?: string | null;
|
|
490
|
-
}
|
|
491
|
-
declare enum PublishStatus$1 {
|
|
492
|
-
UNDEFINED = "UNDEFINED",
|
|
493
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
494
|
-
PUBLISHED = "PUBLISHED",
|
|
495
|
-
WIX_ONLY = "WIX_ONLY"
|
|
496
|
-
}
|
|
497
|
-
interface ItemUploadCallbackRequest$1 {
|
|
498
|
-
/** The item id of the created item */
|
|
499
|
-
itemId?: string;
|
|
500
|
-
/** The callback passed to the upload endpoint */
|
|
501
|
-
callbackToken?: string;
|
|
502
|
-
}
|
|
503
|
-
interface ItemUploadCallbackResponse$1 {
|
|
504
|
-
/** A message describing what happened on the endpoint */
|
|
505
|
-
message?: string | null;
|
|
506
|
-
}
|
|
507
|
-
interface GenerateFileUploadUrlRequest$3 {
|
|
508
|
-
/** The uploaded original file name including the extension */
|
|
509
|
-
fileName?: string;
|
|
510
|
-
/** The file mime-type - will be used to identify the type of media */
|
|
511
|
-
contentType?: string;
|
|
512
|
-
/** The file size in bytes */
|
|
513
|
-
sizeInBytes?: number;
|
|
514
|
-
/**
|
|
515
|
-
* An optional list of categories to link the created item to
|
|
516
|
-
* The item will be linked to the account category automatically
|
|
517
|
-
*/
|
|
518
|
-
categoryIds?: string[] | null;
|
|
519
|
-
}
|
|
520
|
-
interface GenerateFileUploadUrlResponse$3 {
|
|
521
|
-
/** The upload url to upload the file to */
|
|
522
|
-
uploadUrl?: string;
|
|
523
|
-
}
|
|
524
|
-
interface ImportFileRequest$3 {
|
|
525
|
-
/** The url to the file to be imported */
|
|
526
|
-
url: string;
|
|
527
|
-
/** The uploaded original file name including the extension - will be used as the initial display name */
|
|
528
|
-
fileName?: string | null;
|
|
529
|
-
/** The file mime-type - will be used to identify the type of media */
|
|
530
|
-
contentType?: string | null;
|
|
531
|
-
/** The file size in bytes */
|
|
532
|
-
sizeInBytes?: number | null;
|
|
533
|
-
/**
|
|
534
|
-
* An optional list of categories to link the created item to
|
|
535
|
-
* The item will be linked to the account category automatically
|
|
536
|
-
*/
|
|
537
|
-
categoryIds?: string[] | null;
|
|
538
|
-
/** The media type of the uploaded file */
|
|
539
|
-
mediaType?: MediaType$3;
|
|
540
|
-
/**
|
|
541
|
-
* A unique identifier of the client that imported the file
|
|
542
|
-
* This information will exist in the system_tags field prefixed by '_external_uploader:{uploader_system_tag}'
|
|
543
|
-
*/
|
|
544
|
-
uploaderSystemTag?: string | null;
|
|
545
|
-
/**
|
|
546
|
-
* An additional container for external information
|
|
547
|
-
* mostly used to pass identifying information of related entities in external services
|
|
548
|
-
* This information will exist in the system_tags field prefixed by '_external_uploader_info:{uploader_info_system_tag}'
|
|
549
|
-
*/
|
|
550
|
-
uploaderInfoSystemTag?: string | null;
|
|
551
|
-
}
|
|
552
|
-
interface ImportFileResponse$3 {
|
|
553
|
-
/**
|
|
554
|
-
* Partial item - without the assets
|
|
555
|
-
* At this stage of implementation only the 'internal_id' will be filled
|
|
556
|
-
* all other required values will be fake values
|
|
557
|
-
*/
|
|
558
|
-
item?: EnterpriseMediaItem$1;
|
|
559
|
-
}
|
|
560
|
-
interface BulkImportFilesRequest$3 {
|
|
561
|
-
/** Information about the files to import. */
|
|
562
|
-
importFileRequests: ImportFileRequest$3[];
|
|
563
|
-
/**
|
|
564
|
-
* Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
|
|
565
|
-
* Default: `true`
|
|
566
|
-
*/
|
|
567
|
-
returnEntity?: boolean | null;
|
|
568
|
-
/**
|
|
569
|
-
* An optional list of categories to link all the items to
|
|
570
|
-
* The item will be linked to the account category automatically
|
|
571
|
-
*/
|
|
572
|
-
categoryIds?: string[] | null;
|
|
573
|
-
}
|
|
574
|
-
interface BulkImportFilesResponse$3 {
|
|
575
|
-
/** Items created by bulk action. */
|
|
576
|
-
results?: BulkImportFilesResult$1[];
|
|
577
|
-
/** Bulk action metadata. */
|
|
578
|
-
bulkActionMetadata?: BulkActionMetadata$3;
|
|
579
|
-
}
|
|
580
|
-
interface BulkImportFilesResult$1 {
|
|
581
|
-
/** Item metadata. */
|
|
582
|
-
itemMetadata?: ItemMetadata$3;
|
|
583
|
-
/** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
|
|
584
|
-
item?: EnterpriseMediaItem$1;
|
|
585
|
-
}
|
|
586
|
-
interface ItemMetadata$3 {
|
|
587
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
588
|
-
id?: string | null;
|
|
589
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
590
|
-
originalIndex?: number;
|
|
591
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
592
|
-
success?: boolean;
|
|
593
|
-
/** Details about the error in case of failure. */
|
|
594
|
-
error?: ApplicationError$3;
|
|
595
|
-
}
|
|
596
|
-
interface ApplicationError$3 {
|
|
597
|
-
/** Error code. */
|
|
598
|
-
code?: string;
|
|
599
|
-
/** Description of the error. */
|
|
600
|
-
description?: string;
|
|
601
|
-
/** Data related to the error. */
|
|
602
|
-
data?: Record<string, any> | null;
|
|
603
|
-
}
|
|
604
|
-
interface BulkActionMetadata$3 {
|
|
605
|
-
/** Number of items that were successfully processed. */
|
|
606
|
-
totalSuccesses?: number;
|
|
607
|
-
/** Number of items that couldn't be processed. */
|
|
608
|
-
totalFailures?: number;
|
|
609
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
610
|
-
undetailedFailures?: number;
|
|
611
|
-
}
|
|
612
|
-
interface SearchItemsRequest$1 {
|
|
613
|
-
/** Items search query */
|
|
614
|
-
query?: Search$1;
|
|
615
|
-
}
|
|
616
|
-
interface Search$1 extends SearchPagingMethodOneOf$1 {
|
|
617
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
618
|
-
paging?: Paging$1;
|
|
619
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
620
|
-
filter?: Record<string, any> | null;
|
|
621
|
-
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
|
622
|
-
sort?: Sorting$5[];
|
|
623
|
-
/** free text to match in searchable fields */
|
|
624
|
-
search?: SearchDetails$1;
|
|
625
|
-
}
|
|
626
|
-
/** @oneof */
|
|
627
|
-
interface SearchPagingMethodOneOf$1 {
|
|
628
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
629
|
-
paging?: Paging$1;
|
|
630
|
-
}
|
|
631
|
-
interface Sorting$5 {
|
|
632
|
-
/** Name of the field to sort by. */
|
|
633
|
-
fieldName?: string;
|
|
634
|
-
/** Sort order. */
|
|
635
|
-
order?: SortOrder$5;
|
|
636
|
-
}
|
|
637
|
-
declare enum SortOrder$5 {
|
|
638
|
-
ASC = "ASC",
|
|
639
|
-
DESC = "DESC"
|
|
640
|
-
}
|
|
641
|
-
interface SearchDetails$1 {
|
|
642
|
-
/** search term or expression */
|
|
643
|
-
expression?: string | null;
|
|
644
|
-
}
|
|
645
|
-
interface Paging$1 {
|
|
646
|
-
/** Number of items to load. */
|
|
647
|
-
limit?: number | null;
|
|
648
|
-
/** Number of items to skip in the current sort order. */
|
|
649
|
-
offset?: number | null;
|
|
650
|
-
}
|
|
651
|
-
interface SearchItemsResponse$1 {
|
|
652
|
-
/** A list of items matching the request */
|
|
653
|
-
items?: EnterpriseMediaItem$1[];
|
|
654
|
-
/** Information about the search results. */
|
|
655
|
-
pagingMetadata?: PagingMetadataV2$5;
|
|
656
|
-
}
|
|
657
|
-
interface PagingMetadataV2$5 {
|
|
658
|
-
/** Number of items returned in the response. */
|
|
659
|
-
count?: number | null;
|
|
660
|
-
/** Offset that was requested. */
|
|
661
|
-
offset?: number | null;
|
|
662
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
663
|
-
total?: number | null;
|
|
664
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
665
|
-
cursors?: Cursors$5;
|
|
666
|
-
}
|
|
667
|
-
interface Cursors$5 {
|
|
668
|
-
/** Cursor pointing to next page in the list of results. */
|
|
669
|
-
next?: string | null;
|
|
670
|
-
}
|
|
671
|
-
interface QueryItemsRequest$1 {
|
|
672
|
-
/** Items query */
|
|
673
|
-
query?: QueryV2$1;
|
|
674
|
-
}
|
|
675
|
-
interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
|
|
676
|
-
/** Paging options to limit and skip the number of items. */
|
|
677
|
-
paging?: Paging$1;
|
|
678
|
-
/**
|
|
679
|
-
* Filter object in the following format:
|
|
680
|
-
* `"filter" : {
|
|
681
|
-
* "fieldName1": "value1",
|
|
682
|
-
* "fieldName2":{"$operator":"value2"}
|
|
683
|
-
* }`
|
|
684
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
685
|
-
*/
|
|
686
|
-
filter?: Record<string, any> | null;
|
|
687
|
-
/**
|
|
688
|
-
* Sort object in the following format:
|
|
689
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
690
|
-
*/
|
|
691
|
-
sort?: Sorting$5[];
|
|
692
|
-
}
|
|
693
|
-
/** @oneof */
|
|
694
|
-
interface QueryV2PagingMethodOneOf$1 {
|
|
695
|
-
/** Paging options to limit and skip the number of items. */
|
|
696
|
-
paging?: Paging$1;
|
|
697
|
-
}
|
|
698
|
-
interface QueryItemsResponse$1 {
|
|
699
|
-
/** A list of items matching the request */
|
|
700
|
-
items?: EnterpriseMediaItem$1[];
|
|
701
|
-
/** Information for the next request. */
|
|
702
|
-
pagingMetadata?: PagingMetadataV2$5;
|
|
703
|
-
}
|
|
704
|
-
interface UpdateItemRequest$1 {
|
|
705
|
-
/** The category object that will be created */
|
|
706
|
-
item: EnterpriseMediaItem$1;
|
|
707
|
-
}
|
|
708
|
-
interface UpdateItemResponse$1 {
|
|
709
|
-
/** Updated item info */
|
|
710
|
-
item?: EnterpriseMediaItem$1;
|
|
711
|
-
}
|
|
712
|
-
interface BulkUpdateItemRequest$1 {
|
|
713
|
-
/** Requests to update individual item */
|
|
714
|
-
updateItemRequests: UpdateItemRequest$1[];
|
|
715
|
-
/** Should the response return the updated item */
|
|
716
|
-
returnEntity?: boolean;
|
|
717
|
-
}
|
|
718
|
-
interface BulkUpdateItemResponse$1 {
|
|
719
|
-
/** Requests to update individual item */
|
|
720
|
-
results?: BulkItemUpdateResult$1[];
|
|
721
|
-
/** Metadata of the operation */
|
|
722
|
-
bulkActionMetadata?: BulkActionMetadata$3;
|
|
723
|
-
}
|
|
724
|
-
interface BulkItemUpdateResult$1 {
|
|
725
|
-
/** updated item metadata */
|
|
726
|
-
itemMetadata?: ItemMetadata$3;
|
|
727
|
-
/** only returned if operation was successful and if returnEntity flag was on */
|
|
728
|
-
item?: EnterpriseMediaItem$1;
|
|
729
|
-
}
|
|
730
|
-
interface GetItemRequest$1 {
|
|
731
|
-
/** Item id */
|
|
732
|
-
itemId: string;
|
|
733
|
-
}
|
|
734
|
-
interface GetItemResponse$1 {
|
|
735
|
-
/** item info */
|
|
736
|
-
item?: EnterpriseMediaItem$1;
|
|
737
|
-
}
|
|
738
|
-
interface LinkItemToCategoriesRequest$1 {
|
|
739
|
-
/** The item id */
|
|
740
|
-
itemId: string;
|
|
741
|
-
/** The category ids that the item will be linked to */
|
|
742
|
-
categoryIds?: string[];
|
|
743
|
-
}
|
|
744
|
-
interface LinkItemToCategoriesResponse$1 {
|
|
745
|
-
/** The linked category ids */
|
|
746
|
-
linkedCategoryIds?: string[] | null;
|
|
747
|
-
}
|
|
748
|
-
interface UnlinkItemFromCategoriesRequest$1 {
|
|
749
|
-
/** The item id */
|
|
750
|
-
itemId: string;
|
|
751
|
-
/** The category ids that the item will be unlinked from */
|
|
752
|
-
categoryIds?: string[];
|
|
753
|
-
}
|
|
754
|
-
interface UnlinkItemFromCategoriesResponse$1 {
|
|
755
|
-
/** The unlinked category ids */
|
|
756
|
-
unlinkedCategoryIds?: string[] | null;
|
|
757
|
-
}
|
|
758
|
-
interface OverwriteItemCategoriesRequest$1 {
|
|
759
|
-
/** The item id */
|
|
760
|
-
itemId: string;
|
|
761
|
-
/** The category ids the item will be linked to after this operation */
|
|
762
|
-
categoryIds?: string[];
|
|
763
|
-
}
|
|
764
|
-
interface OverwriteItemCategoriesResponse$1 {
|
|
765
|
-
/** The linked category ids */
|
|
766
|
-
linkedCategoryIds?: string[] | null;
|
|
767
|
-
/** The unlinked category ids */
|
|
768
|
-
unlinkedCategoryIds?: string[] | null;
|
|
769
|
-
}
|
|
770
|
-
interface GenerateFileUploadUrlResponseNonNullableFields$3 {
|
|
771
|
-
uploadUrl: string;
|
|
772
|
-
}
|
|
773
|
-
interface ImageNonNullableFields$1 {
|
|
774
|
-
id: string;
|
|
775
|
-
url: string;
|
|
776
|
-
height: number;
|
|
777
|
-
width: number;
|
|
778
|
-
}
|
|
779
|
-
interface VideoResolutionNonNullableFields$1 {
|
|
780
|
-
url: string;
|
|
781
|
-
height: number;
|
|
782
|
-
width: number;
|
|
783
|
-
poster?: ImageNonNullableFields$1;
|
|
784
|
-
format: string;
|
|
785
|
-
}
|
|
786
|
-
interface VideoV2NonNullableFields$1 {
|
|
787
|
-
id: string;
|
|
788
|
-
url: string;
|
|
789
|
-
resolutions: VideoResolutionNonNullableFields$1[];
|
|
790
|
-
posters: ImageNonNullableFields$1[];
|
|
791
|
-
}
|
|
792
|
-
interface AudioNonNullableFields$1 {
|
|
793
|
-
id: string;
|
|
794
|
-
url: string;
|
|
795
|
-
}
|
|
796
|
-
interface DocumentNonNullableFields$1 {
|
|
797
|
-
id: string;
|
|
798
|
-
url: string;
|
|
799
|
-
}
|
|
800
|
-
interface ArchiveNonNullableFields$3 {
|
|
801
|
-
id: string;
|
|
802
|
-
url: string;
|
|
803
|
-
}
|
|
804
|
-
interface Model3DNonNullableFields$3 {
|
|
805
|
-
id: string;
|
|
806
|
-
url: string;
|
|
807
|
-
thumbnail?: ImageNonNullableFields$1;
|
|
808
|
-
}
|
|
809
|
-
interface ItemAssetsNonNullableFields$1 {
|
|
810
|
-
image?: ImageNonNullableFields$1;
|
|
811
|
-
video?: VideoV2NonNullableFields$1;
|
|
812
|
-
vector?: ImageNonNullableFields$1;
|
|
813
|
-
audio?: AudioNonNullableFields$1;
|
|
814
|
-
document?: DocumentNonNullableFields$1;
|
|
815
|
-
archive?: ArchiveNonNullableFields$3;
|
|
816
|
-
model3d?: Model3DNonNullableFields$3;
|
|
817
|
-
}
|
|
818
|
-
interface EnterpriseMediaItemNonNullableFields$1 {
|
|
819
|
-
id: string;
|
|
820
|
-
mediaType: MediaType$3;
|
|
821
|
-
assets?: ItemAssetsNonNullableFields$1;
|
|
822
|
-
publishStatus: PublishStatus$1;
|
|
823
|
-
}
|
|
824
|
-
interface ImportFileResponseNonNullableFields$3 {
|
|
825
|
-
item?: EnterpriseMediaItemNonNullableFields$1;
|
|
826
|
-
}
|
|
827
|
-
interface ApplicationErrorNonNullableFields$3 {
|
|
828
|
-
code: string;
|
|
829
|
-
description: string;
|
|
830
|
-
}
|
|
831
|
-
interface ItemMetadataNonNullableFields$3 {
|
|
832
|
-
originalIndex: number;
|
|
833
|
-
success: boolean;
|
|
834
|
-
error?: ApplicationErrorNonNullableFields$3;
|
|
835
|
-
}
|
|
836
|
-
interface BulkImportFilesResultNonNullableFields$1 {
|
|
837
|
-
itemMetadata?: ItemMetadataNonNullableFields$3;
|
|
838
|
-
item?: EnterpriseMediaItemNonNullableFields$1;
|
|
839
|
-
}
|
|
840
|
-
interface BulkActionMetadataNonNullableFields$3 {
|
|
841
|
-
totalSuccesses: number;
|
|
842
|
-
totalFailures: number;
|
|
843
|
-
undetailedFailures: number;
|
|
844
|
-
}
|
|
845
|
-
interface BulkImportFilesResponseNonNullableFields$3 {
|
|
846
|
-
results: BulkImportFilesResultNonNullableFields$1[];
|
|
847
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields$3;
|
|
848
|
-
}
|
|
849
|
-
interface SearchItemsResponseNonNullableFields$1 {
|
|
850
|
-
items: EnterpriseMediaItemNonNullableFields$1[];
|
|
851
|
-
}
|
|
852
|
-
interface QueryItemsResponseNonNullableFields$1 {
|
|
853
|
-
items: EnterpriseMediaItemNonNullableFields$1[];
|
|
854
|
-
}
|
|
855
|
-
interface UpdateItemResponseNonNullableFields$1 {
|
|
856
|
-
item?: EnterpriseMediaItemNonNullableFields$1;
|
|
857
|
-
}
|
|
858
|
-
interface BulkItemUpdateResultNonNullableFields$1 {
|
|
859
|
-
itemMetadata?: ItemMetadataNonNullableFields$3;
|
|
860
|
-
item?: EnterpriseMediaItemNonNullableFields$1;
|
|
861
|
-
}
|
|
862
|
-
interface BulkUpdateItemResponseNonNullableFields$1 {
|
|
863
|
-
results: BulkItemUpdateResultNonNullableFields$1[];
|
|
864
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields$3;
|
|
865
|
-
}
|
|
866
|
-
interface GetItemResponseNonNullableFields$1 {
|
|
867
|
-
item?: EnterpriseMediaItemNonNullableFields$1;
|
|
868
|
-
}
|
|
869
|
-
|
|
870
|
-
/**
|
|
871
|
-
* Duration for video fits better if there will be type specific media item.. however, is it ok to implement
|
|
872
|
-
* an additional one of field called details?
|
|
873
|
-
*/
|
|
874
|
-
interface EnterpriseMediaItem {
|
|
875
|
-
/**
|
|
876
|
-
* Id of the item in public media
|
|
877
|
-
* @readonly
|
|
878
|
-
*/
|
|
879
|
-
_id?: string;
|
|
880
|
-
/**
|
|
881
|
-
* Media type of the item
|
|
882
|
-
* @readonly
|
|
883
|
-
*/
|
|
884
|
-
mediaType?: MediaType$2;
|
|
885
|
-
/**
|
|
886
|
-
* Size of the uploaded file in bytes.
|
|
887
|
-
* @readonly
|
|
888
|
-
*/
|
|
889
|
-
sizeInBytes?: string | null;
|
|
890
|
-
/** The item title, part of searchable fields */
|
|
891
|
-
title?: string | null;
|
|
892
|
-
/**
|
|
893
|
-
* The aspect ratio of the item
|
|
894
|
-
* An object containing urls for different views of the item
|
|
895
|
-
* @readonly
|
|
896
|
-
*/
|
|
897
|
-
assets?: ItemAssets;
|
|
898
|
-
/** Tags describing the image, part of searchable fields */
|
|
899
|
-
displayTags?: string[] | null;
|
|
900
|
-
/** Tags for internal client use, part of searchable fields */
|
|
901
|
-
internalTags?: string[] | null;
|
|
902
|
-
/**
|
|
903
|
-
* Tags for filtering items in the search
|
|
904
|
-
* @readonly
|
|
905
|
-
*/
|
|
906
|
-
systemTags?: string[] | null;
|
|
907
|
-
/**
|
|
908
|
-
* Category ids this item belongs to
|
|
909
|
-
* @readonly
|
|
910
|
-
*/
|
|
911
|
-
parentCategoryIds?: string[] | null;
|
|
912
|
-
/** Status of the item */
|
|
913
|
-
publishStatus?: PublishStatus;
|
|
914
|
-
/**
|
|
915
|
-
* Date and time the item was created.
|
|
916
|
-
* @readonly
|
|
917
|
-
*/
|
|
918
|
-
_createdDate?: Date | null;
|
|
919
|
-
/**
|
|
920
|
-
* Date and time the item was updated.
|
|
921
|
-
* @readonly
|
|
922
|
-
*/
|
|
923
|
-
_updatedDate?: Date | null;
|
|
924
|
-
/**
|
|
925
|
-
* An internal id used with different wix media systems
|
|
926
|
-
* @readonly
|
|
927
|
-
*/
|
|
928
|
-
internalId?: string | null;
|
|
929
|
-
}
|
|
930
|
-
declare enum MediaType$2 {
|
|
931
|
-
MIXED = "MIXED",
|
|
932
|
-
IMAGE = "IMAGE",
|
|
933
|
-
VIDEO = "VIDEO",
|
|
934
|
-
AUDIO = "AUDIO",
|
|
935
|
-
DOCUMENT = "DOCUMENT",
|
|
936
|
-
VECTOR = "VECTOR",
|
|
937
|
-
ARCHIVE = "ARCHIVE",
|
|
938
|
-
MODEL3D = "MODEL3D"
|
|
939
|
-
}
|
|
940
|
-
interface ItemAssets extends ItemAssetsAssetsOneOf {
|
|
941
|
-
/** Assets for image media type */
|
|
942
|
-
image?: string;
|
|
943
|
-
/** Assets for video media type */
|
|
944
|
-
video?: string;
|
|
945
|
-
/** Assets for vector media type */
|
|
946
|
-
vector?: string;
|
|
947
|
-
/** Assets for audio media type */
|
|
948
|
-
audio?: string;
|
|
949
|
-
/** Assets for document media type */
|
|
950
|
-
document?: string;
|
|
951
|
-
/** Information about the archive. */
|
|
952
|
-
archive?: Archive$2;
|
|
953
|
-
/** Information about the 3D Model. */
|
|
954
|
-
model3d?: Model3D$2;
|
|
955
|
-
}
|
|
956
|
-
/** @oneof */
|
|
957
|
-
interface ItemAssetsAssetsOneOf {
|
|
958
|
-
/** Assets for image media type */
|
|
959
|
-
image?: string;
|
|
960
|
-
/** Assets for video media type */
|
|
961
|
-
video?: string;
|
|
962
|
-
/** Assets for vector media type */
|
|
963
|
-
vector?: string;
|
|
964
|
-
/** Assets for audio media type */
|
|
965
|
-
audio?: string;
|
|
966
|
-
/** Assets for document media type */
|
|
967
|
-
document?: string;
|
|
968
|
-
/** Information about the archive. */
|
|
969
|
-
archive?: Archive$2;
|
|
970
|
-
/** Information about the 3D Model. */
|
|
971
|
-
model3d?: Model3D$2;
|
|
972
|
-
}
|
|
973
|
-
interface Archive$2 {
|
|
974
|
-
/** WixMedia ID. */
|
|
975
|
-
_id?: string;
|
|
976
|
-
/** Archive URL. */
|
|
977
|
-
url?: string;
|
|
978
|
-
/**
|
|
979
|
-
* Archive URL expiration date (when relevant).
|
|
980
|
-
* @readonly
|
|
981
|
-
*/
|
|
982
|
-
urlExpirationDate?: Date | null;
|
|
983
|
-
/** Archive size in bytes. */
|
|
984
|
-
sizeInBytes?: string | null;
|
|
985
|
-
/** Archive filename. */
|
|
986
|
-
filename?: string | null;
|
|
987
|
-
}
|
|
988
|
-
interface Model3D$2 {
|
|
989
|
-
/** WixMedia 3D ID. */
|
|
990
|
-
_id?: string;
|
|
991
|
-
/** 3D URL. */
|
|
992
|
-
url?: string;
|
|
993
|
-
/** 3D thumbnail Image */
|
|
994
|
-
thumbnail?: string;
|
|
995
|
-
/** 3D alt text. */
|
|
996
|
-
altText?: string | null;
|
|
997
|
-
/**
|
|
998
|
-
* 3D URL expiration date (when relevant).
|
|
999
|
-
* @readonly
|
|
1000
|
-
*/
|
|
1001
|
-
urlExpirationDate?: Date | null;
|
|
1002
|
-
/**
|
|
1003
|
-
* 3D filename.
|
|
1004
|
-
* @readonly
|
|
1005
|
-
*/
|
|
1006
|
-
filename?: string | null;
|
|
1007
|
-
/**
|
|
1008
|
-
* 3D size in bytes.
|
|
1009
|
-
* @readonly
|
|
1010
|
-
*/
|
|
1011
|
-
sizeInBytes?: string | null;
|
|
1012
|
-
}
|
|
1013
|
-
declare enum PublishStatus {
|
|
1014
|
-
UNDEFINED = "UNDEFINED",
|
|
1015
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
1016
|
-
PUBLISHED = "PUBLISHED",
|
|
1017
|
-
WIX_ONLY = "WIX_ONLY"
|
|
1018
|
-
}
|
|
1019
|
-
interface ItemUploadCallbackRequest {
|
|
1020
|
-
/** The item id of the created item */
|
|
1021
|
-
itemId?: string;
|
|
1022
|
-
/** The callback passed to the upload endpoint */
|
|
1023
|
-
callbackToken?: string;
|
|
1024
|
-
}
|
|
1025
|
-
interface ItemUploadCallbackResponse {
|
|
1026
|
-
/** A message describing what happened on the endpoint */
|
|
1027
|
-
message?: string | null;
|
|
1028
|
-
}
|
|
1029
|
-
interface GenerateFileUploadUrlRequest$2 {
|
|
1030
|
-
/** The uploaded original file name including the extension */
|
|
1031
|
-
fileName?: string;
|
|
1032
|
-
/** The file mime-type - will be used to identify the type of media */
|
|
1033
|
-
contentType?: string;
|
|
1034
|
-
/** The file size in bytes */
|
|
1035
|
-
sizeInBytes?: number;
|
|
1036
|
-
/**
|
|
1037
|
-
* An optional list of categories to link the created item to
|
|
1038
|
-
* The item will be linked to the account category automatically
|
|
1039
|
-
*/
|
|
1040
|
-
categoryIds?: string[] | null;
|
|
1041
|
-
}
|
|
1042
|
-
interface GenerateFileUploadUrlResponse$2 {
|
|
1043
|
-
/** The upload url to upload the file to */
|
|
1044
|
-
uploadUrl?: string;
|
|
1045
|
-
}
|
|
1046
|
-
interface ImportFileRequest$2 {
|
|
1047
|
-
/** The url to the file to be imported */
|
|
1048
|
-
url: string;
|
|
1049
|
-
/** The uploaded original file name including the extension - will be used as the initial display name */
|
|
1050
|
-
fileName?: string | null;
|
|
1051
|
-
/** The file mime-type - will be used to identify the type of media */
|
|
1052
|
-
contentType?: string | null;
|
|
1053
|
-
/** The file size in bytes */
|
|
1054
|
-
sizeInBytes?: number | null;
|
|
1055
|
-
/**
|
|
1056
|
-
* An optional list of categories to link the created item to
|
|
1057
|
-
* The item will be linked to the account category automatically
|
|
1058
|
-
*/
|
|
1059
|
-
categoryIds?: string[] | null;
|
|
1060
|
-
/** The media type of the uploaded file */
|
|
1061
|
-
mediaType?: MediaType$2;
|
|
1062
|
-
/**
|
|
1063
|
-
* A unique identifier of the client that imported the file
|
|
1064
|
-
* This information will exist in the system_tags field prefixed by '_external_uploader:{uploader_system_tag}'
|
|
1065
|
-
*/
|
|
1066
|
-
uploaderSystemTag?: string | null;
|
|
1067
|
-
/**
|
|
1068
|
-
* An additional container for external information
|
|
1069
|
-
* mostly used to pass identifying information of related entities in external services
|
|
1070
|
-
* This information will exist in the system_tags field prefixed by '_external_uploader_info:{uploader_info_system_tag}'
|
|
1071
|
-
*/
|
|
1072
|
-
uploaderInfoSystemTag?: string | null;
|
|
1073
|
-
}
|
|
1074
|
-
interface ImportFileResponse$2 {
|
|
1075
|
-
/**
|
|
1076
|
-
* Partial item - without the assets
|
|
1077
|
-
* At this stage of implementation only the 'internal_id' will be filled
|
|
1078
|
-
* all other required values will be fake values
|
|
1079
|
-
*/
|
|
1080
|
-
item?: EnterpriseMediaItem;
|
|
1081
|
-
}
|
|
1082
|
-
interface BulkImportFilesRequest$2 {
|
|
1083
|
-
/** Information about the files to import. */
|
|
1084
|
-
importFileRequests: ImportFileRequest$2[];
|
|
1085
|
-
/**
|
|
1086
|
-
* Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
|
|
1087
|
-
* Default: `true`
|
|
1088
|
-
*/
|
|
1089
|
-
returnEntity?: boolean | null;
|
|
1090
|
-
/**
|
|
1091
|
-
* An optional list of categories to link all the items to
|
|
1092
|
-
* The item will be linked to the account category automatically
|
|
1093
|
-
*/
|
|
1094
|
-
categoryIds?: string[] | null;
|
|
1095
|
-
}
|
|
1096
|
-
interface BulkImportFilesResponse$2 {
|
|
1097
|
-
/** Items created by bulk action. */
|
|
1098
|
-
results?: BulkImportFilesResult[];
|
|
1099
|
-
/** Bulk action metadata. */
|
|
1100
|
-
bulkActionMetadata?: BulkActionMetadata$2;
|
|
1101
|
-
}
|
|
1102
|
-
interface BulkImportFilesResult {
|
|
1103
|
-
/** Item metadata. */
|
|
1104
|
-
itemMetadata?: ItemMetadata$2;
|
|
1105
|
-
/** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
|
|
1106
|
-
item?: EnterpriseMediaItem;
|
|
1107
|
-
}
|
|
1108
|
-
interface ItemMetadata$2 {
|
|
1109
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1110
|
-
_id?: string | null;
|
|
1111
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1112
|
-
originalIndex?: number;
|
|
1113
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1114
|
-
success?: boolean;
|
|
1115
|
-
/** Details about the error in case of failure. */
|
|
1116
|
-
error?: ApplicationError$2;
|
|
1117
|
-
}
|
|
1118
|
-
interface ApplicationError$2 {
|
|
1119
|
-
/** Error code. */
|
|
1120
|
-
code?: string;
|
|
1121
|
-
/** Description of the error. */
|
|
1122
|
-
description?: string;
|
|
1123
|
-
/** Data related to the error. */
|
|
1124
|
-
data?: Record<string, any> | null;
|
|
1125
|
-
}
|
|
1126
|
-
interface BulkActionMetadata$2 {
|
|
1127
|
-
/** Number of items that were successfully processed. */
|
|
1128
|
-
totalSuccesses?: number;
|
|
1129
|
-
/** Number of items that couldn't be processed. */
|
|
1130
|
-
totalFailures?: number;
|
|
1131
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1132
|
-
undetailedFailures?: number;
|
|
1133
|
-
}
|
|
1134
|
-
interface SearchItemsRequest {
|
|
1135
|
-
/** Items search query */
|
|
1136
|
-
query?: Search;
|
|
1137
|
-
}
|
|
1138
|
-
interface Search extends SearchPagingMethodOneOf {
|
|
1139
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
1140
|
-
paging?: Paging;
|
|
1141
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
1142
|
-
filter?: Record<string, any> | null;
|
|
1143
|
-
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
|
1144
|
-
sort?: Sorting$4[];
|
|
1145
|
-
/** free text to match in searchable fields */
|
|
1146
|
-
search?: SearchDetails;
|
|
1147
|
-
}
|
|
1148
|
-
/** @oneof */
|
|
1149
|
-
interface SearchPagingMethodOneOf {
|
|
1150
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
1151
|
-
paging?: Paging;
|
|
1152
|
-
}
|
|
1153
|
-
interface Sorting$4 {
|
|
1154
|
-
/** Name of the field to sort by. */
|
|
1155
|
-
fieldName?: string;
|
|
1156
|
-
/** Sort order. */
|
|
1157
|
-
order?: SortOrder$4;
|
|
1158
|
-
}
|
|
1159
|
-
declare enum SortOrder$4 {
|
|
1160
|
-
ASC = "ASC",
|
|
1161
|
-
DESC = "DESC"
|
|
1162
|
-
}
|
|
1163
|
-
interface SearchDetails {
|
|
1164
|
-
/** search term or expression */
|
|
1165
|
-
expression?: string | null;
|
|
1166
|
-
}
|
|
1167
|
-
interface Paging {
|
|
1168
|
-
/** Number of items to load. */
|
|
1169
|
-
limit?: number | null;
|
|
1170
|
-
/** Number of items to skip in the current sort order. */
|
|
1171
|
-
offset?: number | null;
|
|
1172
|
-
}
|
|
1173
|
-
interface SearchItemsResponse {
|
|
1174
|
-
/** A list of items matching the request */
|
|
1175
|
-
items?: EnterpriseMediaItem[];
|
|
1176
|
-
/** Information about the search results. */
|
|
1177
|
-
pagingMetadata?: PagingMetadataV2$4;
|
|
1178
|
-
}
|
|
1179
|
-
interface PagingMetadataV2$4 {
|
|
1180
|
-
/** Number of items returned in the response. */
|
|
1181
|
-
count?: number | null;
|
|
1182
|
-
/** Offset that was requested. */
|
|
1183
|
-
offset?: number | null;
|
|
1184
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1185
|
-
total?: number | null;
|
|
1186
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1187
|
-
cursors?: Cursors$4;
|
|
1188
|
-
}
|
|
1189
|
-
interface Cursors$4 {
|
|
1190
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1191
|
-
next?: string | null;
|
|
1192
|
-
}
|
|
1193
|
-
interface QueryItemsRequest {
|
|
1194
|
-
/** Items query */
|
|
1195
|
-
query?: QueryV2;
|
|
1196
|
-
}
|
|
1197
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1198
|
-
/** Paging options to limit and skip the number of items. */
|
|
1199
|
-
paging?: Paging;
|
|
1200
|
-
/**
|
|
1201
|
-
* Filter object in the following format:
|
|
1202
|
-
* `"filter" : {
|
|
1203
|
-
* "fieldName1": "value1",
|
|
1204
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1205
|
-
* }`
|
|
1206
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1207
|
-
*/
|
|
1208
|
-
filter?: Record<string, any> | null;
|
|
1209
|
-
/**
|
|
1210
|
-
* Sort object in the following format:
|
|
1211
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1212
|
-
*/
|
|
1213
|
-
sort?: Sorting$4[];
|
|
1214
|
-
}
|
|
1215
|
-
/** @oneof */
|
|
1216
|
-
interface QueryV2PagingMethodOneOf {
|
|
1217
|
-
/** Paging options to limit and skip the number of items. */
|
|
1218
|
-
paging?: Paging;
|
|
1219
|
-
}
|
|
1220
|
-
interface QueryItemsResponse {
|
|
1221
|
-
/** A list of items matching the request */
|
|
1222
|
-
items?: EnterpriseMediaItem[];
|
|
1223
|
-
/** Information for the next request. */
|
|
1224
|
-
pagingMetadata?: PagingMetadataV2$4;
|
|
1225
|
-
}
|
|
1226
|
-
interface UpdateItemRequest {
|
|
1227
|
-
/** The category object that will be created */
|
|
1228
|
-
item: EnterpriseMediaItem;
|
|
1229
|
-
}
|
|
1230
|
-
interface UpdateItemResponse {
|
|
1231
|
-
/** Updated item info */
|
|
1232
|
-
item?: EnterpriseMediaItem;
|
|
1233
|
-
}
|
|
1234
|
-
interface BulkUpdateItemRequest {
|
|
1235
|
-
/** Requests to update individual item */
|
|
1236
|
-
updateItemRequests: UpdateItemRequest[];
|
|
1237
|
-
/** Should the response return the updated item */
|
|
1238
|
-
returnEntity?: boolean;
|
|
1239
|
-
}
|
|
1240
|
-
interface BulkUpdateItemResponse {
|
|
1241
|
-
/** Requests to update individual item */
|
|
1242
|
-
results?: BulkItemUpdateResult[];
|
|
1243
|
-
/** Metadata of the operation */
|
|
1244
|
-
bulkActionMetadata?: BulkActionMetadata$2;
|
|
1245
|
-
}
|
|
1246
|
-
interface BulkItemUpdateResult {
|
|
1247
|
-
/** updated item metadata */
|
|
1248
|
-
itemMetadata?: ItemMetadata$2;
|
|
1249
|
-
/** only returned if operation was successful and if returnEntity flag was on */
|
|
1250
|
-
item?: EnterpriseMediaItem;
|
|
1251
|
-
}
|
|
1252
|
-
interface GetItemRequest {
|
|
1253
|
-
/** Item id */
|
|
1254
|
-
itemId: string;
|
|
1255
|
-
}
|
|
1256
|
-
interface GetItemResponse {
|
|
1257
|
-
/** item info */
|
|
1258
|
-
item?: EnterpriseMediaItem;
|
|
1259
|
-
}
|
|
1260
|
-
interface LinkItemToCategoriesRequest {
|
|
1261
|
-
/** The item id */
|
|
1262
|
-
itemId: string;
|
|
1263
|
-
/** The category ids that the item will be linked to */
|
|
1264
|
-
categoryIds?: string[];
|
|
1265
|
-
}
|
|
1266
|
-
interface LinkItemToCategoriesResponse {
|
|
1267
|
-
/** The linked category ids */
|
|
1268
|
-
linkedCategoryIds?: string[] | null;
|
|
1269
|
-
}
|
|
1270
|
-
interface UnlinkItemFromCategoriesRequest {
|
|
1271
|
-
/** The item id */
|
|
1272
|
-
itemId: string;
|
|
1273
|
-
/** The category ids that the item will be unlinked from */
|
|
1274
|
-
categoryIds?: string[];
|
|
1275
|
-
}
|
|
1276
|
-
interface UnlinkItemFromCategoriesResponse {
|
|
1277
|
-
/** The unlinked category ids */
|
|
1278
|
-
unlinkedCategoryIds?: string[] | null;
|
|
1279
|
-
}
|
|
1280
|
-
interface OverwriteItemCategoriesRequest {
|
|
1281
|
-
/** The item id */
|
|
1282
|
-
itemId: string;
|
|
1283
|
-
/** The category ids the item will be linked to after this operation */
|
|
1284
|
-
categoryIds?: string[];
|
|
1285
|
-
}
|
|
1286
|
-
interface OverwriteItemCategoriesResponse {
|
|
1287
|
-
/** The linked category ids */
|
|
1288
|
-
linkedCategoryIds?: string[] | null;
|
|
1289
|
-
/** The unlinked category ids */
|
|
1290
|
-
unlinkedCategoryIds?: string[] | null;
|
|
1291
|
-
}
|
|
1292
|
-
interface GenerateFileUploadUrlResponseNonNullableFields$2 {
|
|
1293
|
-
uploadUrl: string;
|
|
1294
|
-
}
|
|
1295
|
-
interface ArchiveNonNullableFields$2 {
|
|
1296
|
-
_id: string;
|
|
1297
|
-
url: string;
|
|
1298
|
-
}
|
|
1299
|
-
interface Model3DNonNullableFields$2 {
|
|
1300
|
-
_id: string;
|
|
1301
|
-
url: string;
|
|
1302
|
-
thumbnail: string;
|
|
1303
|
-
}
|
|
1304
|
-
interface ItemAssetsNonNullableFields {
|
|
1305
|
-
image: string;
|
|
1306
|
-
video: string;
|
|
1307
|
-
vector: string;
|
|
1308
|
-
audio: string;
|
|
1309
|
-
document: string;
|
|
1310
|
-
archive?: ArchiveNonNullableFields$2;
|
|
1311
|
-
model3d?: Model3DNonNullableFields$2;
|
|
1312
|
-
}
|
|
1313
|
-
interface EnterpriseMediaItemNonNullableFields {
|
|
1314
|
-
_id: string;
|
|
1315
|
-
mediaType: MediaType$2;
|
|
1316
|
-
assets?: ItemAssetsNonNullableFields;
|
|
1317
|
-
publishStatus: PublishStatus;
|
|
1318
|
-
}
|
|
1319
|
-
interface ImportFileResponseNonNullableFields$2 {
|
|
1320
|
-
item?: EnterpriseMediaItemNonNullableFields;
|
|
1321
|
-
}
|
|
1322
|
-
interface ApplicationErrorNonNullableFields$2 {
|
|
1323
|
-
code: string;
|
|
1324
|
-
description: string;
|
|
1325
|
-
}
|
|
1326
|
-
interface ItemMetadataNonNullableFields$2 {
|
|
1327
|
-
originalIndex: number;
|
|
1328
|
-
success: boolean;
|
|
1329
|
-
error?: ApplicationErrorNonNullableFields$2;
|
|
1330
|
-
}
|
|
1331
|
-
interface BulkImportFilesResultNonNullableFields {
|
|
1332
|
-
itemMetadata?: ItemMetadataNonNullableFields$2;
|
|
1333
|
-
item?: EnterpriseMediaItemNonNullableFields;
|
|
1334
|
-
}
|
|
1335
|
-
interface BulkActionMetadataNonNullableFields$2 {
|
|
1336
|
-
totalSuccesses: number;
|
|
1337
|
-
totalFailures: number;
|
|
1338
|
-
undetailedFailures: number;
|
|
1339
|
-
}
|
|
1340
|
-
interface BulkImportFilesResponseNonNullableFields$2 {
|
|
1341
|
-
results: BulkImportFilesResultNonNullableFields[];
|
|
1342
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields$2;
|
|
1343
|
-
}
|
|
1344
|
-
interface SearchItemsResponseNonNullableFields {
|
|
1345
|
-
items: EnterpriseMediaItemNonNullableFields[];
|
|
1346
|
-
}
|
|
1347
|
-
interface QueryItemsResponseNonNullableFields {
|
|
1348
|
-
items: EnterpriseMediaItemNonNullableFields[];
|
|
1349
|
-
}
|
|
1350
|
-
interface UpdateItemResponseNonNullableFields {
|
|
1351
|
-
item?: EnterpriseMediaItemNonNullableFields;
|
|
1352
|
-
}
|
|
1353
|
-
interface BulkItemUpdateResultNonNullableFields {
|
|
1354
|
-
itemMetadata?: ItemMetadataNonNullableFields$2;
|
|
1355
|
-
item?: EnterpriseMediaItemNonNullableFields;
|
|
1356
|
-
}
|
|
1357
|
-
interface BulkUpdateItemResponseNonNullableFields {
|
|
1358
|
-
results: BulkItemUpdateResultNonNullableFields[];
|
|
1359
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields$2;
|
|
1360
|
-
}
|
|
1361
|
-
interface GetItemResponseNonNullableFields {
|
|
1362
|
-
item?: EnterpriseMediaItemNonNullableFields;
|
|
1363
|
-
}
|
|
1364
|
-
|
|
1365
|
-
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1366
|
-
getUrl: (context: any) => string;
|
|
1367
|
-
httpMethod: K;
|
|
1368
|
-
path: string;
|
|
1369
|
-
pathParams: M;
|
|
1370
|
-
__requestType: T;
|
|
1371
|
-
__originalRequestType: S;
|
|
1372
|
-
__responseType: Q;
|
|
1373
|
-
__originalResponseType: R;
|
|
1374
|
-
};
|
|
1375
|
-
declare function itemUploadCallback(): __PublicMethodMetaInfo$2<'POST', {}, ItemUploadCallbackRequest, ItemUploadCallbackRequest$1, ItemUploadCallbackResponse, ItemUploadCallbackResponse$1>;
|
|
1376
|
-
declare function generateFileUploadUrl$1(): __PublicMethodMetaInfo$2<'POST', {}, GenerateFileUploadUrlRequest$2, GenerateFileUploadUrlRequest$3, GenerateFileUploadUrlResponse$2 & GenerateFileUploadUrlResponseNonNullableFields$2, GenerateFileUploadUrlResponse$3 & GenerateFileUploadUrlResponseNonNullableFields$3>;
|
|
1377
|
-
declare function importFile$1(): __PublicMethodMetaInfo$2<'POST', {}, ImportFileRequest$2, ImportFileRequest$3, ImportFileResponse$2 & ImportFileResponseNonNullableFields$2, ImportFileResponse$3 & ImportFileResponseNonNullableFields$3>;
|
|
1378
|
-
declare function bulkImportFiles$1(): __PublicMethodMetaInfo$2<'POST', {}, BulkImportFilesRequest$2, BulkImportFilesRequest$3, BulkImportFilesResponse$2 & BulkImportFilesResponseNonNullableFields$2, BulkImportFilesResponse$3 & BulkImportFilesResponseNonNullableFields$3>;
|
|
1379
|
-
declare function searchItems(): __PublicMethodMetaInfo$2<'POST', {}, SearchItemsRequest, SearchItemsRequest$1, SearchItemsResponse & SearchItemsResponseNonNullableFields, SearchItemsResponse$1 & SearchItemsResponseNonNullableFields$1>;
|
|
1380
|
-
declare function queryItems(): __PublicMethodMetaInfo$2<'POST', {}, QueryItemsRequest, QueryItemsRequest$1, QueryItemsResponse & QueryItemsResponseNonNullableFields, QueryItemsResponse$1 & QueryItemsResponseNonNullableFields$1>;
|
|
1381
|
-
declare function updateItem(): __PublicMethodMetaInfo$2<'PATCH', {
|
|
1382
|
-
itemId: string;
|
|
1383
|
-
}, UpdateItemRequest, UpdateItemRequest$1, UpdateItemResponse & UpdateItemResponseNonNullableFields, UpdateItemResponse$1 & UpdateItemResponseNonNullableFields$1>;
|
|
1384
|
-
declare function bulkUpdateItem(): __PublicMethodMetaInfo$2<'PATCH', {}, BulkUpdateItemRequest, BulkUpdateItemRequest$1, BulkUpdateItemResponse & BulkUpdateItemResponseNonNullableFields, BulkUpdateItemResponse$1 & BulkUpdateItemResponseNonNullableFields$1>;
|
|
1385
|
-
declare function getItem(): __PublicMethodMetaInfo$2<'GET', {
|
|
1386
|
-
itemId: string;
|
|
1387
|
-
}, GetItemRequest, GetItemRequest$1, GetItemResponse & GetItemResponseNonNullableFields, GetItemResponse$1 & GetItemResponseNonNullableFields$1>;
|
|
1388
|
-
declare function linkItemToCategories(): __PublicMethodMetaInfo$2<'POST', {
|
|
1389
|
-
itemId: string;
|
|
1390
|
-
}, LinkItemToCategoriesRequest, LinkItemToCategoriesRequest$1, LinkItemToCategoriesResponse, LinkItemToCategoriesResponse$1>;
|
|
1391
|
-
declare function unlinkItemFromCategories(): __PublicMethodMetaInfo$2<'POST', {
|
|
1392
|
-
itemId: string;
|
|
1393
|
-
}, UnlinkItemFromCategoriesRequest, UnlinkItemFromCategoriesRequest$1, UnlinkItemFromCategoriesResponse, UnlinkItemFromCategoriesResponse$1>;
|
|
1394
|
-
declare function overwriteItemCategories(): __PublicMethodMetaInfo$2<'POST', {
|
|
1395
|
-
itemId: string;
|
|
1396
|
-
}, OverwriteItemCategoriesRequest, OverwriteItemCategoriesRequest$1, OverwriteItemCategoriesResponse, OverwriteItemCategoriesResponse$1>;
|
|
1397
|
-
|
|
1398
|
-
declare const meta$2_bulkUpdateItem: typeof bulkUpdateItem;
|
|
1399
|
-
declare const meta$2_getItem: typeof getItem;
|
|
1400
|
-
declare const meta$2_itemUploadCallback: typeof itemUploadCallback;
|
|
1401
|
-
declare const meta$2_linkItemToCategories: typeof linkItemToCategories;
|
|
1402
|
-
declare const meta$2_overwriteItemCategories: typeof overwriteItemCategories;
|
|
1403
|
-
declare const meta$2_queryItems: typeof queryItems;
|
|
1404
|
-
declare const meta$2_searchItems: typeof searchItems;
|
|
1405
|
-
declare const meta$2_unlinkItemFromCategories: typeof unlinkItemFromCategories;
|
|
1406
|
-
declare const meta$2_updateItem: typeof updateItem;
|
|
1407
|
-
declare namespace meta$2 {
|
|
1408
|
-
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, bulkImportFiles$1 as bulkImportFiles, meta$2_bulkUpdateItem as bulkUpdateItem, generateFileUploadUrl$1 as generateFileUploadUrl, meta$2_getItem as getItem, importFile$1 as importFile, meta$2_itemUploadCallback as itemUploadCallback, meta$2_linkItemToCategories as linkItemToCategories, meta$2_overwriteItemCategories as overwriteItemCategories, meta$2_queryItems as queryItems, meta$2_searchItems as searchItems, meta$2_unlinkItemFromCategories as unlinkItemFromCategories, meta$2_updateItem as updateItem };
|
|
1409
|
-
}
|
|
1410
|
-
|
|
1411
|
-
interface FileDescriptor$1 {
|
|
1412
|
-
/**
|
|
1413
|
-
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
1414
|
-
* @readonly
|
|
1415
|
-
*/
|
|
1416
|
-
id?: string;
|
|
1417
|
-
/** File name as it appears in the Media Manager. */
|
|
1418
|
-
displayName?: string;
|
|
1419
|
-
/**
|
|
1420
|
-
* Static URL of the file.
|
|
1421
|
-
* @readonly
|
|
1422
|
-
*/
|
|
1423
|
-
url?: string;
|
|
1424
|
-
/** ID of the file's parent folder. */
|
|
1425
|
-
parentFolderId?: string | null;
|
|
1426
|
-
/**
|
|
1427
|
-
* File hash.
|
|
1428
|
-
* @readonly
|
|
1429
|
-
*/
|
|
1430
|
-
hash?: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Size of the uploaded file in bytes.
|
|
1433
|
-
* @readonly
|
|
1434
|
-
*/
|
|
1435
|
-
sizeInBytes?: string | null;
|
|
1436
|
-
/**
|
|
1437
|
-
* Whether the file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).
|
|
1438
|
-
* @readonly
|
|
1439
|
-
*/
|
|
1440
|
-
private?: boolean;
|
|
1441
|
-
/**
|
|
1442
|
-
* Media file type.
|
|
1443
|
-
* @readonly
|
|
1444
|
-
*/
|
|
1445
|
-
mediaType?: MediaType$1;
|
|
1446
|
-
/**
|
|
1447
|
-
* Media file content.
|
|
1448
|
-
* @readonly
|
|
1449
|
-
*/
|
|
1450
|
-
media?: FileMedia$1;
|
|
1451
|
-
/**
|
|
1452
|
-
* Status of the file that was uploaded.
|
|
1453
|
-
* * `FAILED`: The file failed to upload, for example, during media post processing.
|
|
1454
|
-
* * `READY`: The file uploaded, finished all processing, and is ready for use.
|
|
1455
|
-
* * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
|
|
1456
|
-
* @readonly
|
|
1457
|
-
*/
|
|
1458
|
-
operationStatus?: OperationStatus$1;
|
|
1459
|
-
/**
|
|
1460
|
-
* URL where the file was uploaded from.
|
|
1461
|
-
* @readonly
|
|
1462
|
-
*/
|
|
1463
|
-
sourceUrl?: string | null;
|
|
1464
|
-
/**
|
|
1465
|
-
* URL of the file's thumbnail.
|
|
1466
|
-
* @readonly
|
|
1467
|
-
*/
|
|
1468
|
-
thumbnailUrl?: string | null;
|
|
1469
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
1470
|
-
labels?: string[];
|
|
1471
|
-
/**
|
|
1472
|
-
* Date and time the file was created.
|
|
1473
|
-
* @readonly
|
|
1474
|
-
*/
|
|
1475
|
-
createdDate?: Date | null;
|
|
1476
|
-
/**
|
|
1477
|
-
* Date and time the file was updated.
|
|
1478
|
-
* @readonly
|
|
1479
|
-
*/
|
|
1480
|
-
updatedDate?: Date | null;
|
|
1481
|
-
/**
|
|
1482
|
-
* The Wix site ID where the media file is stored.
|
|
1483
|
-
* @readonly
|
|
1484
|
-
*/
|
|
1485
|
-
siteId?: string;
|
|
1486
|
-
/**
|
|
1487
|
-
* State of the file.
|
|
1488
|
-
* @readonly
|
|
1489
|
-
*/
|
|
1490
|
-
state?: State$3;
|
|
1491
|
-
}
|
|
1492
|
-
declare enum MediaType$1 {
|
|
1493
|
-
UNKNOWN = "UNKNOWN",
|
|
1494
|
-
IMAGE = "IMAGE",
|
|
1495
|
-
VIDEO = "VIDEO",
|
|
1496
|
-
AUDIO = "AUDIO",
|
|
1497
|
-
DOCUMENT = "DOCUMENT",
|
|
1498
|
-
VECTOR = "VECTOR",
|
|
1499
|
-
ARCHIVE = "ARCHIVE",
|
|
1500
|
-
MODEL3D = "MODEL3D",
|
|
1501
|
-
OTHER = "OTHER"
|
|
1502
|
-
}
|
|
1503
|
-
interface FileMedia$1 extends FileMediaMediaOneOf$1 {
|
|
1504
|
-
/** Information about the image. */
|
|
1505
|
-
image?: ImageMedia$1;
|
|
1506
|
-
/** Information about the video. */
|
|
1507
|
-
video?: VideoV2;
|
|
1508
|
-
/** Information about the audio. */
|
|
1509
|
-
audio?: AudioV2$1;
|
|
1510
|
-
/** Information about the document. */
|
|
1511
|
-
document?: Document;
|
|
1512
|
-
/** Information about the vector. */
|
|
1513
|
-
vector?: ImageMedia$1;
|
|
1514
|
-
/** Information about the archive. */
|
|
1515
|
-
archive?: Archive$1;
|
|
1516
|
-
/** Information about the 3D Model. */
|
|
1517
|
-
model3d?: Model3D$1;
|
|
1518
|
-
}
|
|
1519
|
-
/** @oneof */
|
|
1520
|
-
interface FileMediaMediaOneOf$1 {
|
|
1521
|
-
/** Information about the image. */
|
|
1522
|
-
image?: ImageMedia$1;
|
|
1523
|
-
/** Information about the video. */
|
|
1524
|
-
video?: VideoV2;
|
|
1525
|
-
/** Information about the audio. */
|
|
1526
|
-
audio?: AudioV2$1;
|
|
1527
|
-
/** Information about the document. */
|
|
1528
|
-
document?: Document;
|
|
1529
|
-
/** Information about the vector. */
|
|
1530
|
-
vector?: ImageMedia$1;
|
|
1531
|
-
/** Information about the archive. */
|
|
1532
|
-
archive?: Archive$1;
|
|
1533
|
-
/** Information about the 3D Model. */
|
|
1534
|
-
model3d?: Model3D$1;
|
|
1535
|
-
}
|
|
1536
|
-
interface ImageMedia$1 {
|
|
1537
|
-
/** Image data. */
|
|
1538
|
-
image?: Image;
|
|
1539
|
-
/** Image colors. */
|
|
1540
|
-
colors?: Colors$1;
|
|
1541
|
-
/** Information about faces in the image. Use to crop images without cutting out faces. */
|
|
1542
|
-
faces?: FaceRecognition$1[];
|
|
1543
|
-
/**
|
|
1544
|
-
* Information about the image preview.
|
|
1545
|
-
* You can use this to display a preview for private images.
|
|
1546
|
-
*/
|
|
1547
|
-
previewImage?: Image;
|
|
1548
|
-
/**
|
|
1549
|
-
* Optional, An AI generated description of the image
|
|
1550
|
-
* @readonly
|
|
1551
|
-
*/
|
|
1552
|
-
caption?: string | null;
|
|
1553
|
-
}
|
|
1554
|
-
interface Image {
|
|
1555
|
-
/** WixMedia image ID. */
|
|
1556
|
-
id?: string;
|
|
1557
|
-
/** Image URL. */
|
|
1558
|
-
url?: string;
|
|
1559
|
-
/**
|
|
1560
|
-
* Original image height.
|
|
1561
|
-
* @readonly
|
|
1562
|
-
*/
|
|
1563
|
-
height?: number;
|
|
1564
|
-
/**
|
|
1565
|
-
* Original image width.
|
|
1566
|
-
* @readonly
|
|
1567
|
-
*/
|
|
1568
|
-
width?: number;
|
|
1569
|
-
/** Image alt text. */
|
|
1570
|
-
altText?: string | null;
|
|
1571
|
-
/**
|
|
1572
|
-
* Image filename.
|
|
1573
|
-
* @readonly
|
|
1574
|
-
*/
|
|
1575
|
-
filename?: string | null;
|
|
1576
|
-
}
|
|
1577
|
-
interface Colors$1 {
|
|
1578
|
-
/** Main color of the image. */
|
|
1579
|
-
prominent?: Color$1;
|
|
1580
|
-
/** Color palette of the image. */
|
|
1581
|
-
palette?: Color$1[];
|
|
1582
|
-
}
|
|
1583
|
-
interface Color$1 {
|
|
1584
|
-
/** HEX color. */
|
|
1585
|
-
hex?: string | null;
|
|
1586
|
-
/** RGB color. */
|
|
1587
|
-
rgb?: ColorRGB$1;
|
|
1588
|
-
}
|
|
1589
|
-
interface ColorRGB$1 {
|
|
1590
|
-
/** Red channel. */
|
|
1591
|
-
r?: number | null;
|
|
1592
|
-
/** Green channel. */
|
|
1593
|
-
g?: number | null;
|
|
1594
|
-
/** Blue channel. */
|
|
1595
|
-
b?: number | null;
|
|
1596
|
-
}
|
|
1597
|
-
/**
|
|
1598
|
-
* Using this object you can crop images while centering on faces
|
|
1599
|
-
* ------------------------
|
|
1600
|
-
* | |
|
|
1601
|
-
* | x,y |
|
|
1602
|
-
* | *-------- |
|
|
1603
|
-
* | | . . | |
|
|
1604
|
-
* | | | | height |
|
|
1605
|
-
* | | \ / | |
|
|
1606
|
-
* | | | |
|
|
1607
|
-
* | --------- |
|
|
1608
|
-
* | width |
|
|
1609
|
-
* | |
|
|
1610
|
-
* |______________________|
|
|
1611
|
-
*/
|
|
1612
|
-
interface FaceRecognition$1 {
|
|
1613
|
-
/** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
|
|
1614
|
-
confidence?: number;
|
|
1615
|
-
/** Top left x pixel coordinate of the face. */
|
|
1616
|
-
x?: number;
|
|
1617
|
-
/** Top left y pixel coordinate of the face. */
|
|
1618
|
-
y?: number;
|
|
1619
|
-
/** Face pixel height. */
|
|
1620
|
-
height?: number;
|
|
1621
|
-
/** Face pixel width. */
|
|
1622
|
-
width?: number;
|
|
1623
|
-
}
|
|
1624
|
-
interface VideoV2 {
|
|
1625
|
-
/** WixMedia ID. */
|
|
1626
|
-
id?: string;
|
|
1627
|
-
/**
|
|
1628
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
1629
|
-
* @readonly
|
|
1630
|
-
*/
|
|
1631
|
-
resolutions?: VideoResolution[];
|
|
1632
|
-
/**
|
|
1633
|
-
* Video filename.
|
|
1634
|
-
* @readonly
|
|
1635
|
-
*/
|
|
1636
|
-
filename?: string | null;
|
|
1637
|
-
}
|
|
1638
|
-
interface VideoResolution {
|
|
1639
|
-
/** Video URL. */
|
|
1640
|
-
url?: string;
|
|
1641
|
-
/** Video height. */
|
|
1642
|
-
height?: number;
|
|
1643
|
-
/** Video width. */
|
|
1644
|
-
width?: number;
|
|
1645
|
-
/**
|
|
1646
|
-
* Video format
|
|
1647
|
-
* Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'
|
|
1648
|
-
* '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm', 'hls' ]
|
|
1649
|
-
*/
|
|
1650
|
-
format?: string;
|
|
1651
|
-
}
|
|
1652
|
-
interface AudioV2$1 {
|
|
1653
|
-
/** WixMedia ID. */
|
|
1654
|
-
id?: string;
|
|
1655
|
-
/** Audio formats available for this file. */
|
|
1656
|
-
assets?: Audio[];
|
|
1657
|
-
/**
|
|
1658
|
-
* Audio bitrate.
|
|
1659
|
-
* @readonly
|
|
1660
|
-
*/
|
|
1661
|
-
bitrate?: number | null;
|
|
1662
|
-
/**
|
|
1663
|
-
* Audio format.
|
|
1664
|
-
* @readonly
|
|
1665
|
-
*/
|
|
1666
|
-
format?: string | null;
|
|
1667
|
-
/**
|
|
1668
|
-
* Audio duration in seconds.
|
|
1669
|
-
* @readonly
|
|
1670
|
-
*/
|
|
1671
|
-
duration?: number | null;
|
|
1672
|
-
/**
|
|
1673
|
-
* Audio size in bytes.
|
|
1674
|
-
* @readonly
|
|
1675
|
-
*/
|
|
1676
|
-
sizeInBytes?: string | null;
|
|
1677
|
-
}
|
|
1678
|
-
interface Audio {
|
|
1679
|
-
/** WixMedia ID. */
|
|
1680
|
-
id?: string;
|
|
1681
|
-
/** Audio URL. */
|
|
1682
|
-
url?: string;
|
|
1683
|
-
/**
|
|
1684
|
-
* Audio filename.
|
|
1685
|
-
* @readonly
|
|
1686
|
-
*/
|
|
1687
|
-
filename?: string | null;
|
|
1688
|
-
}
|
|
1689
|
-
interface Document {
|
|
1690
|
-
/** WixMedia ID. */
|
|
1691
|
-
id?: string;
|
|
1692
|
-
/** Document URL. */
|
|
1693
|
-
url?: string;
|
|
1694
|
-
/** Document filename. */
|
|
1695
|
-
filename?: string | null;
|
|
1696
|
-
}
|
|
1697
|
-
interface Archive$1 {
|
|
1698
|
-
/** WixMedia ID. */
|
|
1699
|
-
id?: string;
|
|
1700
|
-
/** Archive URL. */
|
|
1701
|
-
url?: string;
|
|
1702
|
-
/**
|
|
1703
|
-
* Archive URL expiration date (when relevant).
|
|
1704
|
-
* @readonly
|
|
1705
|
-
*/
|
|
1706
|
-
urlExpirationDate?: Date | null;
|
|
1707
|
-
/** Archive size in bytes. */
|
|
1708
|
-
sizeInBytes?: string | null;
|
|
1709
|
-
/** Archive filename. */
|
|
1710
|
-
filename?: string | null;
|
|
1711
|
-
}
|
|
1712
|
-
interface Model3D$1 {
|
|
1713
|
-
/** WixMedia 3D ID. */
|
|
1714
|
-
id?: string;
|
|
1715
|
-
/** 3D URL. */
|
|
1716
|
-
url?: string;
|
|
1717
|
-
/** 3D thumbnail Image */
|
|
1718
|
-
thumbnail?: Image;
|
|
1719
|
-
/** 3D alt text. */
|
|
1720
|
-
altText?: string | null;
|
|
1721
|
-
/**
|
|
1722
|
-
* 3D URL expiration date (when relevant).
|
|
1723
|
-
* @readonly
|
|
1724
|
-
*/
|
|
1725
|
-
urlExpirationDate?: Date | null;
|
|
1726
|
-
/**
|
|
1727
|
-
* 3D filename.
|
|
1728
|
-
* @readonly
|
|
1729
|
-
*/
|
|
1730
|
-
filename?: string | null;
|
|
1731
|
-
/**
|
|
1732
|
-
* 3D size in bytes.
|
|
1733
|
-
* @readonly
|
|
1734
|
-
*/
|
|
1735
|
-
sizeInBytes?: string | null;
|
|
1736
|
-
}
|
|
1737
|
-
declare enum OperationStatus$1 {
|
|
1738
|
-
/** File upload or processing failed */
|
|
1739
|
-
FAILED = "FAILED",
|
|
1740
|
-
/** File is ready for consumption */
|
|
1741
|
-
READY = "READY",
|
|
1742
|
-
/** File is waiting for processing or currently being processed */
|
|
1743
|
-
PENDING = "PENDING"
|
|
1744
|
-
}
|
|
1745
|
-
declare enum State$3 {
|
|
1746
|
-
/** File is ready for consumption */
|
|
1747
|
-
OK = "OK",
|
|
1748
|
-
/** Deleted file */
|
|
1749
|
-
DELETED = "DELETED"
|
|
1750
|
-
}
|
|
1751
|
-
declare enum Namespace$3 {
|
|
1752
|
-
NO_NAMESPACE = "NO_NAMESPACE",
|
|
1753
|
-
OTHERS = "OTHERS",
|
|
1754
|
-
/** ANY = 2; */
|
|
1755
|
-
WIX_VIDEO = "WIX_VIDEO",
|
|
1756
|
-
/** _nsWixMusic */
|
|
1757
|
-
WIX_MUSIC = "WIX_MUSIC",
|
|
1758
|
-
/** _nsArtStore */
|
|
1759
|
-
ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
|
|
1760
|
-
/** _nsDigitalProduct */
|
|
1761
|
-
WIX_ECOM = "WIX_ECOM",
|
|
1762
|
-
/** _nsPhotoShareApp */
|
|
1763
|
-
PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
|
|
1764
|
-
/** _nsSharingApp, */
|
|
1765
|
-
SHARING_APP = "SHARING_APP",
|
|
1766
|
-
/** engage */
|
|
1767
|
-
CHAT = "CHAT",
|
|
1768
|
-
/** logobuilder */
|
|
1769
|
-
LOGO_BUILDER = "LOGO_BUILDER",
|
|
1770
|
-
/** WixExposure */
|
|
1771
|
-
ALBUMS_OLD = "ALBUMS_OLD",
|
|
1772
|
-
/** chat-mobile-uploads */
|
|
1773
|
-
CHAT_MOBILE = "CHAT_MOBILE",
|
|
1774
|
-
/** _nsWixForms */
|
|
1775
|
-
WIX_FORMS = "WIX_FORMS"
|
|
1776
|
-
}
|
|
1777
|
-
declare enum IdentityType$1 {
|
|
1778
|
-
UNKNOWN = "UNKNOWN",
|
|
1779
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1780
|
-
MEMBER = "MEMBER",
|
|
1781
|
-
WIX_USER = "WIX_USER",
|
|
1782
|
-
APP = "APP"
|
|
1783
|
-
}
|
|
1784
|
-
interface ExternalInfo$1 {
|
|
1785
|
-
/** External information to specify in the File Ready or File Failed events. */
|
|
1786
|
-
origin?: string;
|
|
1787
|
-
/** External IDs to specify in the File Ready or File Failed events. */
|
|
1788
|
-
externalIds?: string[];
|
|
1789
|
-
}
|
|
1790
|
-
interface ApplicationError$1 {
|
|
1791
|
-
/** Error code. */
|
|
1792
|
-
code?: string;
|
|
1793
|
-
/** Description of the error. */
|
|
1794
|
-
description?: string;
|
|
1795
|
-
/** Data related to the error. */
|
|
1796
|
-
data?: Record<string, any> | null;
|
|
1797
|
-
}
|
|
1798
|
-
interface ItemMetadata$1 {
|
|
1799
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1800
|
-
id?: string | null;
|
|
1801
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1802
|
-
originalIndex?: number;
|
|
1803
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1804
|
-
success?: boolean;
|
|
1805
|
-
/** Details about the error in case of failure. */
|
|
1806
|
-
error?: ApplicationError$1;
|
|
1807
|
-
}
|
|
1808
|
-
interface BulkActionMetadata$1 {
|
|
1809
|
-
/** Number of items that were successfully processed. */
|
|
1810
|
-
totalSuccesses?: number;
|
|
1811
|
-
/** Number of items that couldn't be processed. */
|
|
1812
|
-
totalFailures?: number;
|
|
1813
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1814
|
-
undetailedFailures?: number;
|
|
1815
|
-
}
|
|
1816
|
-
interface GenerateFilesDownloadUrlRequest$1 {
|
|
1817
|
-
/**
|
|
1818
|
-
* IDs of the files to download.
|
|
1819
|
-
*
|
|
1820
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1821
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
1822
|
-
*/
|
|
1823
|
-
fileIds: string[];
|
|
1824
|
-
}
|
|
1825
|
-
interface GenerateFilesDownloadUrlResponse$1 {
|
|
1826
|
-
/** URL for downloading the compressed file containing the specified files in the Media Manager. */
|
|
1827
|
-
downloadUrl?: string;
|
|
1828
|
-
}
|
|
1829
|
-
interface GenerateFileDownloadUrlRequest$1 {
|
|
1830
|
-
/**
|
|
1831
|
-
* File ID.
|
|
1832
|
-
*
|
|
1833
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
1834
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
1835
|
-
*/
|
|
1836
|
-
fileId: string;
|
|
1837
|
-
/**
|
|
1838
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
1839
|
-
*
|
|
1840
|
-
* **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1841
|
-
*/
|
|
1842
|
-
downloadFileName?: string | null;
|
|
1843
|
-
/**
|
|
1844
|
-
* The time that it takes in minutes for the download URL to expire. <br />
|
|
1845
|
-
* Default: `600`. <br />
|
|
1846
|
-
* Limit: `525600` (1 year).
|
|
1847
|
-
*/
|
|
1848
|
-
expirationInMinutes?: number | null;
|
|
1849
|
-
/**
|
|
1850
|
-
* The redirect URL for when the temporary download URL with a token expires. <br />
|
|
1851
|
-
* Default: A 403 Forbidden response page.
|
|
1852
|
-
*/
|
|
1853
|
-
expirationRedirectUrl?: string | null;
|
|
1854
|
-
/**
|
|
1855
|
-
* Keys for downloading different assets (format and quality) of a file.
|
|
1856
|
-
* Default: `src`, key representing the original file's format and quality.
|
|
1857
|
-
*/
|
|
1858
|
-
assetKeys?: string[] | null;
|
|
1859
|
-
/**
|
|
1860
|
-
* Whether the link downloads the file or opens the file in the browser.
|
|
1861
|
-
*
|
|
1862
|
-
* - `ATTACHMENT`: The link downloads the file.
|
|
1863
|
-
* - `INLINE`: The link opens the file in the browser.
|
|
1864
|
-
*
|
|
1865
|
-
* Default: `ATTACHMENT`
|
|
1866
|
-
*/
|
|
1867
|
-
contentDisposition?: ContentDisposition$1;
|
|
1868
|
-
}
|
|
1869
|
-
declare enum ContentDisposition$1 {
|
|
1870
|
-
/** Using the link in the browser will download the file */
|
|
1871
|
-
ATTACHMENT = "ATTACHMENT",
|
|
1872
|
-
/** Using the link in the browser will open the file in the browser */
|
|
1873
|
-
INLINE = "INLINE"
|
|
1874
|
-
}
|
|
1875
|
-
interface GenerateFileDownloadUrlResponse$1 {
|
|
1876
|
-
/** URL for downloading a specific file in the Media Manager. */
|
|
1877
|
-
downloadUrls?: DownloadUrl$1[];
|
|
1878
|
-
}
|
|
1879
|
-
interface DownloadUrl$1 {
|
|
1880
|
-
/** The file download URL. */
|
|
1881
|
-
url?: string;
|
|
1882
|
-
/**
|
|
1883
|
-
* Key for downloading a different asset (format and quality) of a file.
|
|
1884
|
-
* Default: `src`, key representing the original file's format and quality.
|
|
1885
|
-
*/
|
|
1886
|
-
assetKey?: string;
|
|
1887
|
-
}
|
|
1888
|
-
interface GetFileDescriptorRequest$1 {
|
|
1889
|
-
/**
|
|
1890
|
-
* File ID.
|
|
1891
|
-
*
|
|
1892
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
1893
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
1894
|
-
*
|
|
1895
|
-
* If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
|
|
1896
|
-
*/
|
|
1897
|
-
fileId: string;
|
|
1898
|
-
}
|
|
1899
|
-
interface GetFileDescriptorResponse$1 {
|
|
1900
|
-
/** Information about the file. */
|
|
1901
|
-
file?: FileDescriptor$1;
|
|
1902
|
-
}
|
|
1903
|
-
interface GetFileDescriptorsRequest$1 {
|
|
1904
|
-
/**
|
|
1905
|
-
* File IDs.
|
|
1906
|
-
*
|
|
1907
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1908
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
1909
|
-
*/
|
|
1910
|
-
fileIds: string[];
|
|
1911
|
-
}
|
|
1912
|
-
interface GetFileDescriptorsResponse$1 {
|
|
1913
|
-
/** Information about the requested files. */
|
|
1914
|
-
files?: FileDescriptor$1[];
|
|
1915
|
-
}
|
|
1916
|
-
interface UpdateFileDescriptorRequest$1 {
|
|
1917
|
-
/** The file to update. */
|
|
1918
|
-
file: FileDescriptor$1;
|
|
1919
|
-
}
|
|
1920
|
-
interface UpdateFileDescriptorResponse$1 {
|
|
1921
|
-
/** Information about the updated file. */
|
|
1922
|
-
file?: FileDescriptor$1;
|
|
1923
|
-
}
|
|
1924
|
-
interface GenerateFileUploadUrlRequest$1 {
|
|
1925
|
-
/** File mime type. */
|
|
1926
|
-
mimeType: string | null;
|
|
1927
|
-
/**
|
|
1928
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1929
|
-
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1930
|
-
*/
|
|
1931
|
-
fileName?: string | null;
|
|
1932
|
-
/**
|
|
1933
|
-
* File size in bytes.
|
|
1934
|
-
* @readonly
|
|
1935
|
-
*/
|
|
1936
|
-
sizeInBytes?: string | null;
|
|
1937
|
-
/**
|
|
1938
|
-
* ID of the file's parent folder. <br />
|
|
1939
|
-
* This folder is the path root for the `filePath`.<br />
|
|
1940
|
-
* Default: `media-root`.
|
|
1941
|
-
*/
|
|
1942
|
-
parentFolderId?: string | null;
|
|
1943
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1944
|
-
private?: boolean | null;
|
|
1945
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
1946
|
-
labels?: string[] | null;
|
|
1947
|
-
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
1948
|
-
externalInfo?: ExternalInfo$1;
|
|
1949
|
-
/**
|
|
1950
|
-
* Path to the folder where the file will be stored.
|
|
1951
|
-
* For example, `/videos/2024/december`. <br/>
|
|
1952
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1953
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
1954
|
-
*/
|
|
1955
|
-
filePath?: string | null;
|
|
1956
|
-
}
|
|
1957
|
-
interface GenerateFileUploadUrlResponse$1 {
|
|
1958
|
-
/** The URL for uploading a file to the Media Manager. */
|
|
1959
|
-
uploadUrl?: string;
|
|
1960
|
-
}
|
|
1961
|
-
interface GenerateFileResumableUploadUrlRequest$1 {
|
|
1962
|
-
/** File mime type. */
|
|
1963
|
-
mimeType: string | null;
|
|
1964
|
-
/**
|
|
1965
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1966
|
-
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1967
|
-
*/
|
|
1968
|
-
fileName?: string | null;
|
|
1969
|
-
/**
|
|
1970
|
-
* File size in bytes.
|
|
1971
|
-
* @readonly
|
|
1972
|
-
*/
|
|
1973
|
-
sizeInBytes?: string | null;
|
|
1974
|
-
/**
|
|
1975
|
-
* ID of the file's parent folder. <br />
|
|
1976
|
-
* This folder is the path root for the `filePath`.<br />
|
|
1977
|
-
* Default: `media-root`.
|
|
1978
|
-
*/
|
|
1979
|
-
parentFolderId?: string | null;
|
|
1980
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1981
|
-
private?: boolean | null;
|
|
1982
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
1983
|
-
labels?: string[] | null;
|
|
1984
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
1985
|
-
uploadProtocol?: UploadProtocol$1;
|
|
1986
|
-
/**
|
|
1987
|
-
* Path to the folder where the file will be stored.
|
|
1988
|
-
* For example, `/videos/2024/december`. <br/>
|
|
1989
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1990
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
1991
|
-
*/
|
|
1992
|
-
filePath?: string | null;
|
|
1993
|
-
}
|
|
1994
|
-
declare enum UploadProtocol$1 {
|
|
1995
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
1996
|
-
TUS = "TUS"
|
|
1997
|
-
}
|
|
1998
|
-
interface GenerateFileResumableUploadUrlResponse$1 {
|
|
1999
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
2000
|
-
uploadProtocol?: UploadProtocol$1;
|
|
2001
|
-
/** The URL for uploading a file to the Media Manager. */
|
|
2002
|
-
uploadUrl?: string;
|
|
2003
|
-
/** Single-use upload token. */
|
|
2004
|
-
uploadToken?: string;
|
|
2005
|
-
}
|
|
2006
|
-
interface ImportFileRequest$1 {
|
|
2007
|
-
/** Publicly accessible external file URL. */
|
|
2008
|
-
url: string;
|
|
2009
|
-
/**
|
|
2010
|
-
* Media type of the file to import.
|
|
2011
|
-
* excluding: OTHER media type
|
|
2012
|
-
*/
|
|
2013
|
-
mediaType?: MediaType$1;
|
|
2014
|
-
/** File name that appears in the Media Manager. */
|
|
2015
|
-
displayName?: string | null;
|
|
2016
|
-
/**
|
|
2017
|
-
* ID of the file's parent folder. <br />
|
|
2018
|
-
* This folder is the path root for the `filePath`. <br />
|
|
2019
|
-
* Default: `media-root`.
|
|
2020
|
-
*/
|
|
2021
|
-
parentFolderId?: string | null;
|
|
2022
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2023
|
-
private?: boolean | null;
|
|
2024
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2025
|
-
labels?: string[] | null;
|
|
2026
|
-
/** File mime type. */
|
|
2027
|
-
mimeType?: string;
|
|
2028
|
-
/** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
|
|
2029
|
-
externalInfo?: ExternalInfo$1;
|
|
2030
|
-
/** Optional parameters that should be sent with the external URL. */
|
|
2031
|
-
urlParams?: Record<string, any> | null;
|
|
2032
|
-
/** Optional headers that should be sent with the external URL. */
|
|
2033
|
-
urlHeaders?: Record<string, any> | null;
|
|
2034
|
-
/**
|
|
2035
|
-
* Path to the folder where the file will be stored.
|
|
2036
|
-
* For example, `/videos/2024/december`. <br/>
|
|
2037
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
2038
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
2039
|
-
*/
|
|
2040
|
-
filePath?: string | null;
|
|
2041
|
-
}
|
|
2042
|
-
interface ImportFileResponse$1 {
|
|
2043
|
-
/** Information about the imported file. */
|
|
2044
|
-
file?: FileDescriptor$1;
|
|
2045
|
-
}
|
|
2046
|
-
interface BulkImportFilesRequest$1 {
|
|
2047
|
-
/** Information about the files to import. */
|
|
2048
|
-
importFileRequests: ImportFileRequest$1[];
|
|
2049
|
-
}
|
|
2050
|
-
interface BulkImportFilesResponse$1 {
|
|
2051
|
-
/** Information about the imported files. */
|
|
2052
|
-
files?: FileDescriptor$1[];
|
|
2053
|
-
}
|
|
2054
|
-
interface BulkImportFileRequest$1 {
|
|
2055
|
-
/** Information about the files to import. */
|
|
2056
|
-
importFileRequests: ImportFileRequest$1[];
|
|
2057
|
-
/** Default: `true` */
|
|
2058
|
-
returnEntity?: boolean | null;
|
|
2059
|
-
}
|
|
2060
|
-
interface BulkImportFileResponse$1 {
|
|
2061
|
-
/** Items created by bulk action. */
|
|
2062
|
-
results?: BulkImportFileResult$1[];
|
|
2063
|
-
/** Bulk action metadata. */
|
|
2064
|
-
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2065
|
-
}
|
|
2066
|
-
interface BulkImportFileResult$1 {
|
|
2067
|
-
/** Item metadata. */
|
|
2068
|
-
itemMetadata?: ItemMetadata$1;
|
|
2069
|
-
/** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
|
|
2070
|
-
item?: FileDescriptor$1;
|
|
2071
|
-
}
|
|
2072
|
-
interface ListFilesRequest$1 {
|
|
2073
|
-
/**
|
|
2074
|
-
* ID of the file's parent folder. <br />
|
|
2075
|
-
* Default:`media-root`.
|
|
2076
|
-
*/
|
|
2077
|
-
parentFolderId?: string | null;
|
|
2078
|
-
/** File media type. */
|
|
2079
|
-
mediaTypes?: MediaType$1[];
|
|
2080
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2081
|
-
private?: boolean | null;
|
|
2082
|
-
/**
|
|
2083
|
-
* Field name and order to sort by. One of: <br />
|
|
2084
|
-
* * `displayName`
|
|
2085
|
-
* * `updatedDate`
|
|
2086
|
-
* * `sizeInBytes`
|
|
2087
|
-
* Default: `updatedDate` in `desc` order.
|
|
2088
|
-
*/
|
|
2089
|
-
sort?: Sorting$3;
|
|
2090
|
-
/** Cursor and paging information. */
|
|
2091
|
-
paging?: CursorPaging$3;
|
|
2092
|
-
}
|
|
2093
|
-
interface Sorting$3 {
|
|
2094
|
-
/** Name of the field to sort by. */
|
|
2095
|
-
fieldName?: string;
|
|
2096
|
-
/** Sort order. */
|
|
2097
|
-
order?: SortOrder$3;
|
|
2098
|
-
}
|
|
2099
|
-
declare enum SortOrder$3 {
|
|
2100
|
-
ASC = "ASC",
|
|
2101
|
-
DESC = "DESC"
|
|
2102
|
-
}
|
|
2103
|
-
interface CursorPaging$3 {
|
|
2104
|
-
/** Maximum number of items to return in the results. */
|
|
2105
|
-
limit?: number | null;
|
|
2106
|
-
/**
|
|
2107
|
-
* Pointer to the next or previous page in the list of results.
|
|
2108
|
-
*
|
|
2109
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2110
|
-
* Not relevant for the first request.
|
|
2111
|
-
*/
|
|
2112
|
-
cursor?: string | null;
|
|
2113
|
-
}
|
|
2114
|
-
interface ListFilesResponse$1 {
|
|
2115
|
-
/** List of files in the Media Manager. */
|
|
2116
|
-
files?: FileDescriptor$1[];
|
|
2117
|
-
/** The next cursor if it exists. */
|
|
2118
|
-
nextCursor?: PagingMetadataV2$3;
|
|
2119
|
-
}
|
|
2120
|
-
interface PagingMetadataV2$3 {
|
|
2121
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
2122
|
-
total?: number | null;
|
|
2123
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2124
|
-
cursors?: Cursors$3;
|
|
2125
|
-
}
|
|
2126
|
-
interface Cursors$3 {
|
|
2127
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
2128
|
-
next?: string | null;
|
|
2129
|
-
}
|
|
2130
|
-
interface SearchFilesRequest$1 {
|
|
2131
|
-
/**
|
|
2132
|
-
* Term to search for. Possible terms include the value of a file's
|
|
2133
|
-
* `displayName`, `mimeType`, and `label`. <br />
|
|
2134
|
-
* For example, if a file's label is cat, the search term is 'cat'.
|
|
2135
|
-
*/
|
|
2136
|
-
search?: string | null;
|
|
2137
|
-
/**
|
|
2138
|
-
* A root folder in the media manager to search in. <br />
|
|
2139
|
-
* Default: `MEDIA_ROOT`.
|
|
2140
|
-
*/
|
|
2141
|
-
rootFolder?: RootFolder$3;
|
|
2142
|
-
/** File media type. */
|
|
2143
|
-
mediaTypes?: MediaType$1[];
|
|
2144
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2145
|
-
private?: boolean | null;
|
|
2146
|
-
/**
|
|
2147
|
-
* Field name and order to sort by. One of: <br />
|
|
2148
|
-
* * `displayName`
|
|
2149
|
-
* * `updatedDate`
|
|
2150
|
-
* * `sizeInBytes`
|
|
2151
|
-
* Default: `updatedDate` in `desc` order.
|
|
2152
|
-
*/
|
|
2153
|
-
sort?: Sorting$3;
|
|
2154
|
-
/** Cursor and paging information. */
|
|
2155
|
-
paging?: CursorPaging$3;
|
|
2156
|
-
}
|
|
2157
|
-
declare enum RootFolder$3 {
|
|
2158
|
-
/** Root of all site media */
|
|
2159
|
-
MEDIA_ROOT = "MEDIA_ROOT",
|
|
2160
|
-
/** Root of the trash system folder */
|
|
2161
|
-
TRASH_ROOT = "TRASH_ROOT",
|
|
2162
|
-
/** Root of all visitor uploads */
|
|
2163
|
-
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
2164
|
-
}
|
|
2165
|
-
interface SearchFilesResponse$1 {
|
|
2166
|
-
/** Files matching the query. */
|
|
2167
|
-
files?: FileDescriptor$1[];
|
|
2168
|
-
/** The next cursor if it exists. */
|
|
2169
|
-
nextCursor?: PagingMetadataV2$3;
|
|
2170
|
-
}
|
|
2171
|
-
interface GenerateVideoStreamingUrlRequest$1 {
|
|
2172
|
-
/**
|
|
2173
|
-
* File ID.
|
|
2174
|
-
*
|
|
2175
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2176
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2177
|
-
*/
|
|
2178
|
-
fileId: string;
|
|
2179
|
-
/** Video stream format. */
|
|
2180
|
-
format?: StreamFormat$1;
|
|
2181
|
-
}
|
|
2182
|
-
declare enum StreamFormat$1 {
|
|
2183
|
-
UNKNOWN = "UNKNOWN",
|
|
2184
|
-
HLS = "HLS",
|
|
2185
|
-
DASH = "DASH"
|
|
2186
|
-
}
|
|
2187
|
-
interface GenerateVideoStreamingUrlResponse$1 {
|
|
2188
|
-
/** URL for streaming a specific file in the Media Manager. */
|
|
2189
|
-
downloadUrl?: DownloadUrl$1;
|
|
2190
|
-
}
|
|
2191
|
-
interface BulkDeleteFilesRequest$1 {
|
|
2192
|
-
/**
|
|
2193
|
-
* IDs of the files to move to the Media Manager's trash bin.
|
|
2194
|
-
*
|
|
2195
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2196
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2197
|
-
*/
|
|
2198
|
-
fileIds: string[];
|
|
2199
|
-
/**
|
|
2200
|
-
* Whether the specified files are permanently deleted. <br />
|
|
2201
|
-
* Default: `false`
|
|
2202
|
-
*/
|
|
2203
|
-
permanent?: boolean;
|
|
2204
|
-
}
|
|
2205
|
-
interface BulkDeleteFilesResponse$1 {
|
|
2206
|
-
}
|
|
2207
|
-
interface BulkRestoreFilesFromTrashBinRequest$1 {
|
|
2208
|
-
/**
|
|
2209
|
-
* IDs of the files to restore from the Media Manager's trash bin.
|
|
2210
|
-
*
|
|
2211
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2212
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2213
|
-
*/
|
|
2214
|
-
fileIds: string[];
|
|
2215
|
-
}
|
|
2216
|
-
interface BulkRestoreFilesFromTrashBinResponse$1 {
|
|
2217
|
-
}
|
|
2218
|
-
interface ListDeletedFilesRequest$1 {
|
|
2219
|
-
/**
|
|
2220
|
-
* ID of the file's parent folder. <br />
|
|
2221
|
-
* Default: `media-root`.
|
|
2222
|
-
*/
|
|
2223
|
-
parentFolderId?: string | null;
|
|
2224
|
-
/** File media type. */
|
|
2225
|
-
mediaTypes?: MediaType$1[];
|
|
2226
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2227
|
-
private?: boolean | null;
|
|
2228
|
-
/**
|
|
2229
|
-
* Field name and order to sort by. One of: <br />
|
|
2230
|
-
* * `displayName`
|
|
2231
|
-
* * `updatedDate`
|
|
2232
|
-
* * `sizeInBytes`
|
|
2233
|
-
* Default: `updatedDate` in `desc` order.
|
|
2234
|
-
*/
|
|
2235
|
-
sort?: Sorting$3;
|
|
2236
|
-
/** Cursor and paging information. */
|
|
2237
|
-
paging?: CursorPaging$3;
|
|
2238
|
-
}
|
|
2239
|
-
interface ListDeletedFilesResponse$1 {
|
|
2240
|
-
/** List of files in the Media Manager's trash bin. */
|
|
2241
|
-
files?: FileDescriptor$1[];
|
|
2242
|
-
/** The next cursor if it exists. */
|
|
2243
|
-
nextCursor?: PagingMetadataV2$3;
|
|
2244
|
-
}
|
|
2245
|
-
interface GenerateFilesDownloadUrlResponseNonNullableFields$1 {
|
|
2246
|
-
downloadUrl: string;
|
|
2247
|
-
}
|
|
2248
|
-
interface DownloadUrlNonNullableFields$1 {
|
|
2249
|
-
url: string;
|
|
2250
|
-
assetKey: string;
|
|
2251
|
-
}
|
|
2252
|
-
interface GenerateFileDownloadUrlResponseNonNullableFields$1 {
|
|
2253
|
-
downloadUrls: DownloadUrlNonNullableFields$1[];
|
|
2254
|
-
}
|
|
2255
|
-
interface FocalPointNonNullableFields {
|
|
2256
|
-
x: number;
|
|
2257
|
-
y: number;
|
|
2258
|
-
}
|
|
2259
|
-
interface ImageNonNullableFields {
|
|
2260
|
-
id: string;
|
|
2261
|
-
url: string;
|
|
2262
|
-
height: number;
|
|
2263
|
-
width: number;
|
|
2264
|
-
focalPoint?: FocalPointNonNullableFields;
|
|
2265
|
-
}
|
|
2266
|
-
interface FaceRecognitionNonNullableFields$1 {
|
|
2267
|
-
confidence: number;
|
|
2268
|
-
x: number;
|
|
2269
|
-
y: number;
|
|
2270
|
-
height: number;
|
|
2271
|
-
width: number;
|
|
2272
|
-
}
|
|
2273
|
-
interface ImageMediaNonNullableFields$1 {
|
|
2274
|
-
image?: ImageNonNullableFields;
|
|
2275
|
-
faces: FaceRecognitionNonNullableFields$1[];
|
|
2276
|
-
previewImage?: ImageNonNullableFields;
|
|
2277
|
-
}
|
|
2278
|
-
interface VideoResolutionNonNullableFields {
|
|
2279
|
-
url: string;
|
|
2280
|
-
height: number;
|
|
2281
|
-
width: number;
|
|
2282
|
-
poster?: ImageNonNullableFields;
|
|
2283
|
-
format: string;
|
|
2284
|
-
}
|
|
2285
|
-
interface VideoV2NonNullableFields {
|
|
2286
|
-
id: string;
|
|
2287
|
-
url: string;
|
|
2288
|
-
resolutions: VideoResolutionNonNullableFields[];
|
|
2289
|
-
posters: ImageNonNullableFields[];
|
|
2290
|
-
}
|
|
2291
|
-
interface AudioNonNullableFields {
|
|
2292
|
-
id: string;
|
|
2293
|
-
url: string;
|
|
2294
|
-
}
|
|
2295
|
-
interface AudioV2NonNullableFields$1 {
|
|
2296
|
-
id: string;
|
|
2297
|
-
assets: AudioNonNullableFields[];
|
|
2298
|
-
}
|
|
2299
|
-
interface DocumentNonNullableFields {
|
|
2300
|
-
id: string;
|
|
2301
|
-
url: string;
|
|
2302
|
-
}
|
|
2303
|
-
interface ArchiveNonNullableFields$1 {
|
|
2304
|
-
id: string;
|
|
2305
|
-
url: string;
|
|
2306
|
-
}
|
|
2307
|
-
interface Model3DNonNullableFields$1 {
|
|
2308
|
-
id: string;
|
|
2309
|
-
url: string;
|
|
2310
|
-
thumbnail?: ImageNonNullableFields;
|
|
2311
|
-
}
|
|
2312
|
-
interface OtherMediaNonNullableFields$1 {
|
|
2313
|
-
id: string;
|
|
2314
|
-
url: string;
|
|
2315
|
-
}
|
|
2316
|
-
interface FileMediaNonNullableFields$1 {
|
|
2317
|
-
image?: ImageMediaNonNullableFields$1;
|
|
2318
|
-
video?: VideoV2NonNullableFields;
|
|
2319
|
-
audio?: AudioV2NonNullableFields$1;
|
|
2320
|
-
document?: DocumentNonNullableFields;
|
|
2321
|
-
vector?: ImageMediaNonNullableFields$1;
|
|
2322
|
-
archive?: ArchiveNonNullableFields$1;
|
|
2323
|
-
model3d?: Model3DNonNullableFields$1;
|
|
2324
|
-
other?: OtherMediaNonNullableFields$1;
|
|
2325
|
-
icon?: ImageMediaNonNullableFields$1;
|
|
2326
|
-
flash?: OtherMediaNonNullableFields$1;
|
|
2327
|
-
}
|
|
2328
|
-
interface IdentityInfoNonNullableFields$1 {
|
|
2329
|
-
identityType: IdentityType$1;
|
|
2330
|
-
}
|
|
2331
|
-
interface FileDescriptorNonNullableFields$1 {
|
|
2332
|
-
id: string;
|
|
2333
|
-
displayName: string;
|
|
2334
|
-
url: string;
|
|
2335
|
-
hash: string;
|
|
2336
|
-
private: boolean;
|
|
2337
|
-
mediaType: MediaType$1;
|
|
2338
|
-
media?: FileMediaNonNullableFields$1;
|
|
2339
|
-
operationStatus: OperationStatus$1;
|
|
2340
|
-
labels: string[];
|
|
2341
|
-
siteId: string;
|
|
2342
|
-
state: State$3;
|
|
2343
|
-
internalTags: string[];
|
|
2344
|
-
namespace: Namespace$3;
|
|
2345
|
-
addedBy?: IdentityInfoNonNullableFields$1;
|
|
2346
|
-
}
|
|
2347
|
-
interface GetFileDescriptorResponseNonNullableFields$1 {
|
|
2348
|
-
file?: FileDescriptorNonNullableFields$1;
|
|
2349
|
-
}
|
|
2350
|
-
interface GetFileDescriptorsResponseNonNullableFields$1 {
|
|
2351
|
-
files: FileDescriptorNonNullableFields$1[];
|
|
2352
|
-
}
|
|
2353
|
-
interface UpdateFileDescriptorResponseNonNullableFields$1 {
|
|
2354
|
-
file?: FileDescriptorNonNullableFields$1;
|
|
2355
|
-
}
|
|
2356
|
-
interface GenerateFileUploadUrlResponseNonNullableFields$1 {
|
|
2357
|
-
uploadUrl: string;
|
|
2358
|
-
}
|
|
2359
|
-
interface GenerateFileResumableUploadUrlResponseNonNullableFields$1 {
|
|
2360
|
-
uploadProtocol: UploadProtocol$1;
|
|
2361
|
-
uploadUrl: string;
|
|
2362
|
-
uploadToken: string;
|
|
2363
|
-
}
|
|
2364
|
-
interface ImportFileResponseNonNullableFields$1 {
|
|
2365
|
-
file?: FileDescriptorNonNullableFields$1;
|
|
2366
|
-
}
|
|
2367
|
-
interface BulkImportFilesResponseNonNullableFields$1 {
|
|
2368
|
-
files: FileDescriptorNonNullableFields$1[];
|
|
2369
|
-
}
|
|
2370
|
-
interface ApplicationErrorNonNullableFields$1 {
|
|
2371
|
-
code: string;
|
|
2372
|
-
description: string;
|
|
2373
|
-
}
|
|
2374
|
-
interface ItemMetadataNonNullableFields$1 {
|
|
2375
|
-
originalIndex: number;
|
|
2376
|
-
success: boolean;
|
|
2377
|
-
error?: ApplicationErrorNonNullableFields$1;
|
|
2378
|
-
}
|
|
2379
|
-
interface BulkImportFileResultNonNullableFields$1 {
|
|
2380
|
-
itemMetadata?: ItemMetadataNonNullableFields$1;
|
|
2381
|
-
item?: FileDescriptorNonNullableFields$1;
|
|
2382
|
-
}
|
|
2383
|
-
interface BulkActionMetadataNonNullableFields$1 {
|
|
2384
|
-
totalSuccesses: number;
|
|
2385
|
-
totalFailures: number;
|
|
2386
|
-
undetailedFailures: number;
|
|
2387
|
-
}
|
|
2388
|
-
interface BulkImportFileResponseNonNullableFields$1 {
|
|
2389
|
-
results: BulkImportFileResultNonNullableFields$1[];
|
|
2390
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
|
|
2391
|
-
}
|
|
2392
|
-
interface ListFilesResponseNonNullableFields$1 {
|
|
2393
|
-
files: FileDescriptorNonNullableFields$1[];
|
|
2394
|
-
}
|
|
2395
|
-
interface SearchFilesResponseNonNullableFields$1 {
|
|
2396
|
-
files: FileDescriptorNonNullableFields$1[];
|
|
2397
|
-
}
|
|
2398
|
-
interface GenerateVideoStreamingUrlResponseNonNullableFields$1 {
|
|
2399
|
-
downloadUrl?: DownloadUrlNonNullableFields$1;
|
|
2400
|
-
}
|
|
2401
|
-
interface ListDeletedFilesResponseNonNullableFields$1 {
|
|
2402
|
-
files: FileDescriptorNonNullableFields$1[];
|
|
2403
|
-
}
|
|
2404
|
-
|
|
2405
|
-
interface FileDescriptor {
|
|
2406
|
-
/**
|
|
2407
|
-
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
2408
|
-
* @readonly
|
|
2409
|
-
*/
|
|
2410
|
-
_id?: string;
|
|
2411
|
-
/** File name as it appears in the Media Manager. */
|
|
2412
|
-
displayName?: string;
|
|
2413
|
-
/**
|
|
2414
|
-
* Static URL of the file.
|
|
2415
|
-
* @readonly
|
|
2416
|
-
*/
|
|
2417
|
-
url?: string;
|
|
2418
|
-
/** ID of the file's parent folder. */
|
|
2419
|
-
parentFolderId?: string | null;
|
|
2420
|
-
/**
|
|
2421
|
-
* File hash.
|
|
2422
|
-
* @readonly
|
|
2423
|
-
*/
|
|
2424
|
-
hash?: string;
|
|
2425
|
-
/**
|
|
2426
|
-
* Size of the uploaded file in bytes.
|
|
2427
|
-
* @readonly
|
|
2428
|
-
*/
|
|
2429
|
-
sizeInBytes?: string | null;
|
|
2430
|
-
/**
|
|
2431
|
-
* Whether the file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).
|
|
2432
|
-
* @readonly
|
|
2433
|
-
*/
|
|
2434
|
-
private?: boolean;
|
|
2435
|
-
/**
|
|
2436
|
-
* Media file type.
|
|
2437
|
-
* @readonly
|
|
2438
|
-
*/
|
|
2439
|
-
mediaType?: MediaType;
|
|
2440
|
-
/**
|
|
2441
|
-
* Media file content.
|
|
2442
|
-
* @readonly
|
|
2443
|
-
*/
|
|
2444
|
-
media?: FileMedia;
|
|
2445
|
-
/**
|
|
2446
|
-
* Status of the file that was uploaded.
|
|
2447
|
-
* * `FAILED`: The file failed to upload, for example, during media post processing.
|
|
2448
|
-
* * `READY`: The file uploaded, finished all processing, and is ready for use.
|
|
2449
|
-
* * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
|
|
2450
|
-
* @readonly
|
|
2451
|
-
*/
|
|
2452
|
-
operationStatus?: OperationStatus;
|
|
2453
|
-
/**
|
|
2454
|
-
* URL where the file was uploaded from.
|
|
2455
|
-
* @readonly
|
|
2456
|
-
*/
|
|
2457
|
-
sourceUrl?: string | null;
|
|
2458
|
-
/**
|
|
2459
|
-
* URL of the file's thumbnail.
|
|
2460
|
-
* @readonly
|
|
2461
|
-
*/
|
|
2462
|
-
thumbnailUrl?: string | null;
|
|
2463
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2464
|
-
labels?: string[];
|
|
2465
|
-
/**
|
|
2466
|
-
* Date and time the file was created.
|
|
2467
|
-
* @readonly
|
|
2468
|
-
*/
|
|
2469
|
-
_createdDate?: Date | null;
|
|
2470
|
-
/**
|
|
2471
|
-
* Date and time the file was updated.
|
|
2472
|
-
* @readonly
|
|
2473
|
-
*/
|
|
2474
|
-
_updatedDate?: Date | null;
|
|
2475
|
-
/**
|
|
2476
|
-
* The Wix site ID where the media file is stored.
|
|
2477
|
-
* @readonly
|
|
2478
|
-
*/
|
|
2479
|
-
siteId?: string;
|
|
2480
|
-
/**
|
|
2481
|
-
* State of the file.
|
|
2482
|
-
* @readonly
|
|
2483
|
-
*/
|
|
2484
|
-
state?: State$2;
|
|
2485
|
-
}
|
|
2486
|
-
declare enum MediaType {
|
|
2487
|
-
UNKNOWN = "UNKNOWN",
|
|
2488
|
-
IMAGE = "IMAGE",
|
|
2489
|
-
VIDEO = "VIDEO",
|
|
2490
|
-
AUDIO = "AUDIO",
|
|
2491
|
-
DOCUMENT = "DOCUMENT",
|
|
2492
|
-
VECTOR = "VECTOR",
|
|
2493
|
-
ARCHIVE = "ARCHIVE",
|
|
2494
|
-
MODEL3D = "MODEL3D",
|
|
2495
|
-
OTHER = "OTHER"
|
|
2496
|
-
}
|
|
2497
|
-
interface FileMedia extends FileMediaMediaOneOf {
|
|
2498
|
-
/** Information about the image. */
|
|
2499
|
-
image?: ImageMedia;
|
|
2500
|
-
/** Information about the video. */
|
|
2501
|
-
video?: string;
|
|
2502
|
-
/** Information about the audio. */
|
|
2503
|
-
audio?: AudioV2;
|
|
2504
|
-
/** Information about the document. */
|
|
2505
|
-
document?: string;
|
|
2506
|
-
/** Information about the vector. */
|
|
2507
|
-
vector?: ImageMedia;
|
|
2508
|
-
/** Information about the archive. */
|
|
2509
|
-
archive?: Archive;
|
|
2510
|
-
/** Information about the 3D Model. */
|
|
2511
|
-
model3d?: Model3D;
|
|
2512
|
-
}
|
|
2513
|
-
/** @oneof */
|
|
2514
|
-
interface FileMediaMediaOneOf {
|
|
2515
|
-
/** Information about the image. */
|
|
2516
|
-
image?: ImageMedia;
|
|
2517
|
-
/** Information about the video. */
|
|
2518
|
-
video?: string;
|
|
2519
|
-
/** Information about the audio. */
|
|
2520
|
-
audio?: AudioV2;
|
|
2521
|
-
/** Information about the document. */
|
|
2522
|
-
document?: string;
|
|
2523
|
-
/** Information about the vector. */
|
|
2524
|
-
vector?: ImageMedia;
|
|
2525
|
-
/** Information about the archive. */
|
|
2526
|
-
archive?: Archive;
|
|
2527
|
-
/** Information about the 3D Model. */
|
|
2528
|
-
model3d?: Model3D;
|
|
2529
|
-
}
|
|
2530
|
-
interface ImageMedia {
|
|
2531
|
-
/** Image data. */
|
|
2532
|
-
image?: string;
|
|
2533
|
-
/** Image colors. */
|
|
2534
|
-
colors?: Colors;
|
|
2535
|
-
/** Information about faces in the image. Use to crop images without cutting out faces. */
|
|
2536
|
-
faces?: FaceRecognition[];
|
|
2537
|
-
/**
|
|
2538
|
-
* Information about the image preview.
|
|
2539
|
-
* You can use this to display a preview for private images.
|
|
2540
|
-
*/
|
|
2541
|
-
previewImage?: string;
|
|
2542
|
-
/**
|
|
2543
|
-
* Optional, An AI generated description of the image
|
|
2544
|
-
* @readonly
|
|
2545
|
-
*/
|
|
2546
|
-
caption?: string | null;
|
|
2547
|
-
}
|
|
2548
|
-
interface Colors {
|
|
2549
|
-
/** Main color of the image. */
|
|
2550
|
-
prominent?: Color;
|
|
2551
|
-
/** Color palette of the image. */
|
|
2552
|
-
palette?: Color[];
|
|
2553
|
-
}
|
|
2554
|
-
interface Color {
|
|
2555
|
-
/** HEX color. */
|
|
2556
|
-
hex?: string | null;
|
|
2557
|
-
/** RGB color. */
|
|
2558
|
-
rgb?: ColorRGB;
|
|
2559
|
-
}
|
|
2560
|
-
interface ColorRGB {
|
|
2561
|
-
/** Red channel. */
|
|
2562
|
-
r?: number | null;
|
|
2563
|
-
/** Green channel. */
|
|
2564
|
-
g?: number | null;
|
|
2565
|
-
/** Blue channel. */
|
|
2566
|
-
b?: number | null;
|
|
2567
|
-
}
|
|
2568
|
-
/**
|
|
2569
|
-
* Using this object you can crop images while centering on faces
|
|
2570
|
-
* ------------------------
|
|
2571
|
-
* | |
|
|
2572
|
-
* | x,y |
|
|
2573
|
-
* | *-------- |
|
|
2574
|
-
* | | . . | |
|
|
2575
|
-
* | | | | height |
|
|
2576
|
-
* | | \ / | |
|
|
2577
|
-
* | | | |
|
|
2578
|
-
* | --------- |
|
|
2579
|
-
* | width |
|
|
2580
|
-
* | |
|
|
2581
|
-
* |______________________|
|
|
2582
|
-
*/
|
|
2583
|
-
interface FaceRecognition {
|
|
2584
|
-
/** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
|
|
2585
|
-
confidence?: number;
|
|
2586
|
-
/** Top left x pixel coordinate of the face. */
|
|
2587
|
-
x?: number;
|
|
2588
|
-
/** Top left y pixel coordinate of the face. */
|
|
2589
|
-
y?: number;
|
|
2590
|
-
/** Face pixel height. */
|
|
2591
|
-
height?: number;
|
|
2592
|
-
/** Face pixel width. */
|
|
2593
|
-
width?: number;
|
|
2594
|
-
}
|
|
2595
|
-
interface AudioV2 {
|
|
2596
|
-
/** WixMedia ID. */
|
|
2597
|
-
_id?: string;
|
|
2598
|
-
/** Audio formats available for this file. */
|
|
2599
|
-
assets?: string[];
|
|
2600
|
-
/**
|
|
2601
|
-
* Audio bitrate.
|
|
2602
|
-
* @readonly
|
|
2603
|
-
*/
|
|
2604
|
-
bitrate?: number | null;
|
|
2605
|
-
/**
|
|
2606
|
-
* Audio format.
|
|
2607
|
-
* @readonly
|
|
2608
|
-
*/
|
|
2609
|
-
format?: string | null;
|
|
2610
|
-
/**
|
|
2611
|
-
* Audio duration in seconds.
|
|
2612
|
-
* @readonly
|
|
2613
|
-
*/
|
|
2614
|
-
duration?: number | null;
|
|
2615
|
-
/**
|
|
2616
|
-
* Audio size in bytes.
|
|
2617
|
-
* @readonly
|
|
2618
|
-
*/
|
|
2619
|
-
sizeInBytes?: string | null;
|
|
2620
|
-
}
|
|
2621
|
-
interface Archive {
|
|
2622
|
-
/** WixMedia ID. */
|
|
2623
|
-
_id?: string;
|
|
2624
|
-
/** Archive URL. */
|
|
2625
|
-
url?: string;
|
|
2626
|
-
/**
|
|
2627
|
-
* Archive URL expiration date (when relevant).
|
|
2628
|
-
* @readonly
|
|
2629
|
-
*/
|
|
2630
|
-
urlExpirationDate?: Date | null;
|
|
2631
|
-
/** Archive size in bytes. */
|
|
2632
|
-
sizeInBytes?: string | null;
|
|
2633
|
-
/** Archive filename. */
|
|
2634
|
-
filename?: string | null;
|
|
2635
|
-
}
|
|
2636
|
-
interface Model3D {
|
|
2637
|
-
/** WixMedia 3D ID. */
|
|
2638
|
-
_id?: string;
|
|
2639
|
-
/** 3D URL. */
|
|
2640
|
-
url?: string;
|
|
2641
|
-
/** 3D thumbnail Image */
|
|
2642
|
-
thumbnail?: string;
|
|
2643
|
-
/** 3D alt text. */
|
|
2644
|
-
altText?: string | null;
|
|
2645
|
-
/**
|
|
2646
|
-
* 3D URL expiration date (when relevant).
|
|
2647
|
-
* @readonly
|
|
2648
|
-
*/
|
|
2649
|
-
urlExpirationDate?: Date | null;
|
|
2650
|
-
/**
|
|
2651
|
-
* 3D filename.
|
|
2652
|
-
* @readonly
|
|
2653
|
-
*/
|
|
2654
|
-
filename?: string | null;
|
|
2655
|
-
/**
|
|
2656
|
-
* 3D size in bytes.
|
|
2657
|
-
* @readonly
|
|
2658
|
-
*/
|
|
2659
|
-
sizeInBytes?: string | null;
|
|
2660
|
-
}
|
|
2661
|
-
declare enum OperationStatus {
|
|
2662
|
-
/** File upload or processing failed */
|
|
2663
|
-
FAILED = "FAILED",
|
|
2664
|
-
/** File is ready for consumption */
|
|
2665
|
-
READY = "READY",
|
|
2666
|
-
/** File is waiting for processing or currently being processed */
|
|
2667
|
-
PENDING = "PENDING"
|
|
2668
|
-
}
|
|
2669
|
-
declare enum State$2 {
|
|
2670
|
-
/** File is ready for consumption */
|
|
2671
|
-
OK = "OK",
|
|
2672
|
-
/** Deleted file */
|
|
2673
|
-
DELETED = "DELETED"
|
|
2674
|
-
}
|
|
2675
|
-
declare enum Namespace$2 {
|
|
2676
|
-
NO_NAMESPACE = "NO_NAMESPACE",
|
|
2677
|
-
OTHERS = "OTHERS",
|
|
2678
|
-
/** ANY = 2; */
|
|
2679
|
-
WIX_VIDEO = "WIX_VIDEO",
|
|
2680
|
-
/** _nsWixMusic */
|
|
2681
|
-
WIX_MUSIC = "WIX_MUSIC",
|
|
2682
|
-
/** _nsArtStore */
|
|
2683
|
-
ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
|
|
2684
|
-
/** _nsDigitalProduct */
|
|
2685
|
-
WIX_ECOM = "WIX_ECOM",
|
|
2686
|
-
/** _nsPhotoShareApp */
|
|
2687
|
-
PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
|
|
2688
|
-
/** _nsSharingApp, */
|
|
2689
|
-
SHARING_APP = "SHARING_APP",
|
|
2690
|
-
/** engage */
|
|
2691
|
-
CHAT = "CHAT",
|
|
2692
|
-
/** logobuilder */
|
|
2693
|
-
LOGO_BUILDER = "LOGO_BUILDER",
|
|
2694
|
-
/** WixExposure */
|
|
2695
|
-
ALBUMS_OLD = "ALBUMS_OLD",
|
|
2696
|
-
/** chat-mobile-uploads */
|
|
2697
|
-
CHAT_MOBILE = "CHAT_MOBILE",
|
|
2698
|
-
/** _nsWixForms */
|
|
2699
|
-
WIX_FORMS = "WIX_FORMS"
|
|
2700
|
-
}
|
|
2701
|
-
declare enum IdentityType {
|
|
2702
|
-
UNKNOWN = "UNKNOWN",
|
|
2703
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2704
|
-
MEMBER = "MEMBER",
|
|
2705
|
-
WIX_USER = "WIX_USER",
|
|
2706
|
-
APP = "APP"
|
|
2707
|
-
}
|
|
2708
|
-
interface ExternalInfo {
|
|
2709
|
-
/** External information to specify in the File Ready or File Failed events. */
|
|
2710
|
-
origin?: string;
|
|
2711
|
-
/** External IDs to specify in the File Ready or File Failed events. */
|
|
2712
|
-
externalIds?: string[];
|
|
2713
|
-
}
|
|
2714
|
-
interface ApplicationError {
|
|
2715
|
-
/** Error code. */
|
|
2716
|
-
code?: string;
|
|
2717
|
-
/** Description of the error. */
|
|
2718
|
-
description?: string;
|
|
2719
|
-
/** Data related to the error. */
|
|
2720
|
-
data?: Record<string, any> | null;
|
|
2721
|
-
}
|
|
2722
|
-
interface ItemMetadata {
|
|
2723
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2724
|
-
_id?: string | null;
|
|
2725
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2726
|
-
originalIndex?: number;
|
|
2727
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2728
|
-
success?: boolean;
|
|
2729
|
-
/** Details about the error in case of failure. */
|
|
2730
|
-
error?: ApplicationError;
|
|
2731
|
-
}
|
|
2732
|
-
interface BulkActionMetadata {
|
|
2733
|
-
/** Number of items that were successfully processed. */
|
|
2734
|
-
totalSuccesses?: number;
|
|
2735
|
-
/** Number of items that couldn't be processed. */
|
|
2736
|
-
totalFailures?: number;
|
|
2737
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2738
|
-
undetailedFailures?: number;
|
|
2739
|
-
}
|
|
2740
|
-
interface GenerateFilesDownloadUrlRequest {
|
|
2741
|
-
/**
|
|
2742
|
-
* IDs of the files to download.
|
|
2743
|
-
*
|
|
2744
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2745
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2746
|
-
*/
|
|
2747
|
-
fileIds: string[];
|
|
2748
|
-
}
|
|
2749
|
-
interface GenerateFilesDownloadUrlResponse {
|
|
2750
|
-
/** URL for downloading the compressed file containing the specified files in the Media Manager. */
|
|
2751
|
-
downloadUrl?: string;
|
|
2752
|
-
}
|
|
2753
|
-
interface GenerateFileDownloadUrlRequest {
|
|
2754
|
-
/**
|
|
2755
|
-
* File ID.
|
|
2756
|
-
*
|
|
2757
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2758
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2759
|
-
*/
|
|
2760
|
-
fileId: string;
|
|
2761
|
-
/**
|
|
2762
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
2763
|
-
*
|
|
2764
|
-
* **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
2765
|
-
*/
|
|
2766
|
-
downloadFileName?: string | null;
|
|
2767
|
-
/**
|
|
2768
|
-
* The time that it takes in minutes for the download URL to expire. <br />
|
|
2769
|
-
* Default: `600`. <br />
|
|
2770
|
-
* Limit: `525600` (1 year).
|
|
2771
|
-
*/
|
|
2772
|
-
expirationInMinutes?: number | null;
|
|
2773
|
-
/**
|
|
2774
|
-
* The redirect URL for when the temporary download URL with a token expires. <br />
|
|
2775
|
-
* Default: A 403 Forbidden response page.
|
|
2776
|
-
*/
|
|
2777
|
-
expirationRedirectUrl?: string | null;
|
|
2778
|
-
/**
|
|
2779
|
-
* Keys for downloading different assets (format and quality) of a file.
|
|
2780
|
-
* Default: `src`, key representing the original file's format and quality.
|
|
2781
|
-
*/
|
|
2782
|
-
assetKeys?: string[] | null;
|
|
2783
|
-
/**
|
|
2784
|
-
* Whether the link downloads the file or opens the file in the browser.
|
|
2785
|
-
*
|
|
2786
|
-
* - `ATTACHMENT`: The link downloads the file.
|
|
2787
|
-
* - `INLINE`: The link opens the file in the browser.
|
|
2788
|
-
*
|
|
2789
|
-
* Default: `ATTACHMENT`
|
|
2790
|
-
*/
|
|
2791
|
-
contentDisposition?: ContentDisposition;
|
|
2792
|
-
}
|
|
2793
|
-
declare enum ContentDisposition {
|
|
2794
|
-
/** Using the link in the browser will download the file */
|
|
2795
|
-
ATTACHMENT = "ATTACHMENT",
|
|
2796
|
-
/** Using the link in the browser will open the file in the browser */
|
|
2797
|
-
INLINE = "INLINE"
|
|
2798
|
-
}
|
|
2799
|
-
interface GenerateFileDownloadUrlResponse {
|
|
2800
|
-
/** URL for downloading a specific file in the Media Manager. */
|
|
2801
|
-
downloadUrls?: DownloadUrl[];
|
|
2802
|
-
}
|
|
2803
|
-
interface DownloadUrl {
|
|
2804
|
-
/** The file download URL. */
|
|
2805
|
-
url?: string;
|
|
2806
|
-
/**
|
|
2807
|
-
* Key for downloading a different asset (format and quality) of a file.
|
|
2808
|
-
* Default: `src`, key representing the original file's format and quality.
|
|
2809
|
-
*/
|
|
2810
|
-
assetKey?: string;
|
|
2811
|
-
}
|
|
2812
|
-
interface GetFileDescriptorRequest {
|
|
2813
|
-
/**
|
|
2814
|
-
* File ID.
|
|
2815
|
-
*
|
|
2816
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2817
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2818
|
-
*
|
|
2819
|
-
* If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
|
|
2820
|
-
*/
|
|
2821
|
-
fileId: string;
|
|
2822
|
-
}
|
|
2823
|
-
interface GetFileDescriptorResponse {
|
|
2824
|
-
/** Information about the file. */
|
|
2825
|
-
file?: FileDescriptor;
|
|
2826
|
-
}
|
|
2827
|
-
interface GetFileDescriptorsRequest {
|
|
2828
|
-
/**
|
|
2829
|
-
* File IDs.
|
|
2830
|
-
*
|
|
2831
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2832
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
2833
|
-
*/
|
|
2834
|
-
fileIds: string[];
|
|
2835
|
-
}
|
|
2836
|
-
interface GetFileDescriptorsResponse {
|
|
2837
|
-
/** Information about the requested files. */
|
|
2838
|
-
files?: FileDescriptor[];
|
|
2839
|
-
}
|
|
2840
|
-
interface UpdateFileDescriptorRequest {
|
|
2841
|
-
/** The file to update. */
|
|
2842
|
-
file: FileDescriptor;
|
|
2843
|
-
}
|
|
2844
|
-
interface UpdateFileDescriptorResponse {
|
|
2845
|
-
/** Information about the updated file. */
|
|
2846
|
-
file?: FileDescriptor;
|
|
2847
|
-
}
|
|
2848
|
-
interface GenerateFileUploadUrlRequest {
|
|
2849
|
-
/** File mime type. */
|
|
2850
|
-
mimeType: string | null;
|
|
2851
|
-
/**
|
|
2852
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
2853
|
-
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
2854
|
-
*/
|
|
2855
|
-
fileName?: string | null;
|
|
2856
|
-
/**
|
|
2857
|
-
* File size in bytes.
|
|
2858
|
-
* @readonly
|
|
2859
|
-
*/
|
|
2860
|
-
sizeInBytes?: string | null;
|
|
2861
|
-
/**
|
|
2862
|
-
* ID of the file's parent folder. <br />
|
|
2863
|
-
* This folder is the path root for the `filePath`.<br />
|
|
2864
|
-
* Default: `media-root`.
|
|
2865
|
-
*/
|
|
2866
|
-
parentFolderId?: string | null;
|
|
2867
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2868
|
-
private?: boolean | null;
|
|
2869
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2870
|
-
labels?: string[] | null;
|
|
2871
|
-
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
2872
|
-
externalInfo?: ExternalInfo;
|
|
2873
|
-
/**
|
|
2874
|
-
* Path to the folder where the file will be stored.
|
|
2875
|
-
* For example, `/videos/2024/december`. <br/>
|
|
2876
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
2877
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
2878
|
-
*/
|
|
2879
|
-
filePath?: string | null;
|
|
2880
|
-
}
|
|
2881
|
-
interface GenerateFileUploadUrlResponse {
|
|
2882
|
-
/** The URL for uploading a file to the Media Manager. */
|
|
2883
|
-
uploadUrl?: string;
|
|
2884
|
-
}
|
|
2885
|
-
interface GenerateFileResumableUploadUrlRequest {
|
|
2886
|
-
/** File mime type. */
|
|
2887
|
-
mimeType: string | null;
|
|
2888
|
-
/**
|
|
2889
|
-
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
2890
|
-
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
2891
|
-
*/
|
|
2892
|
-
fileName?: string | null;
|
|
2893
|
-
/**
|
|
2894
|
-
* File size in bytes.
|
|
2895
|
-
* @readonly
|
|
2896
|
-
*/
|
|
2897
|
-
sizeInBytes?: string | null;
|
|
2898
|
-
/**
|
|
2899
|
-
* ID of the file's parent folder. <br />
|
|
2900
|
-
* This folder is the path root for the `filePath`.<br />
|
|
2901
|
-
* Default: `media-root`.
|
|
2902
|
-
*/
|
|
2903
|
-
parentFolderId?: string | null;
|
|
2904
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2905
|
-
private?: boolean | null;
|
|
2906
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2907
|
-
labels?: string[] | null;
|
|
2908
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
2909
|
-
uploadProtocol?: UploadProtocol;
|
|
2910
|
-
/**
|
|
2911
|
-
* Path to the folder where the file will be stored.
|
|
2912
|
-
* For example, `/videos/2024/december`. <br/>
|
|
2913
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
2914
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
2915
|
-
*/
|
|
2916
|
-
filePath?: string | null;
|
|
2917
|
-
}
|
|
2918
|
-
declare enum UploadProtocol {
|
|
2919
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
2920
|
-
TUS = "TUS"
|
|
2921
|
-
}
|
|
2922
|
-
interface GenerateFileResumableUploadUrlResponse {
|
|
2923
|
-
/** The upload protocol to use for implementing the resumable upload. */
|
|
2924
|
-
uploadProtocol?: UploadProtocol;
|
|
2925
|
-
/** The URL for uploading a file to the Media Manager. */
|
|
2926
|
-
uploadUrl?: string;
|
|
2927
|
-
/** Single-use upload token. */
|
|
2928
|
-
uploadToken?: string;
|
|
2929
|
-
}
|
|
2930
|
-
interface ImportFileRequest {
|
|
2931
|
-
/** Publicly accessible external file URL. */
|
|
2932
|
-
url: string;
|
|
2933
|
-
/**
|
|
2934
|
-
* Media type of the file to import.
|
|
2935
|
-
* excluding: OTHER media type
|
|
2936
|
-
*/
|
|
2937
|
-
mediaType?: MediaType;
|
|
2938
|
-
/** File name that appears in the Media Manager. */
|
|
2939
|
-
displayName?: string | null;
|
|
2940
|
-
/**
|
|
2941
|
-
* ID of the file's parent folder. <br />
|
|
2942
|
-
* This folder is the path root for the `filePath`. <br />
|
|
2943
|
-
* Default: `media-root`.
|
|
2944
|
-
*/
|
|
2945
|
-
parentFolderId?: string | null;
|
|
2946
|
-
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2947
|
-
private?: boolean | null;
|
|
2948
|
-
/** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2949
|
-
labels?: string[] | null;
|
|
2950
|
-
/** File mime type. */
|
|
2951
|
-
mimeType?: string;
|
|
2952
|
-
/** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
|
|
2953
|
-
externalInfo?: ExternalInfo;
|
|
2954
|
-
/** Optional parameters that should be sent with the external URL. */
|
|
2955
|
-
urlParams?: Record<string, any> | null;
|
|
2956
|
-
/** Optional headers that should be sent with the external URL. */
|
|
2957
|
-
urlHeaders?: Record<string, any> | null;
|
|
2958
|
-
/**
|
|
2959
|
-
* Path to the folder where the file will be stored.
|
|
2960
|
-
* For example, `/videos/2024/december`. <br/>
|
|
2961
|
-
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
2962
|
-
* The folders in the path will be created if they don't already exist. <br />
|
|
2963
|
-
*/
|
|
2964
|
-
filePath?: string | null;
|
|
2965
|
-
}
|
|
2966
|
-
interface ImportFileResponse {
|
|
2967
|
-
/** Information about the imported file. */
|
|
2968
|
-
file?: FileDescriptor;
|
|
2969
|
-
}
|
|
2970
|
-
interface BulkImportFilesRequest {
|
|
2971
|
-
/** Information about the files to import. */
|
|
2972
|
-
importFileRequests: ImportFileRequest[];
|
|
2973
|
-
}
|
|
2974
|
-
interface BulkImportFilesResponse {
|
|
2975
|
-
/** Information about the imported files. */
|
|
2976
|
-
files?: FileDescriptor[];
|
|
2977
|
-
}
|
|
2978
|
-
interface BulkImportFileRequest {
|
|
2979
|
-
/** Information about the files to import. */
|
|
2980
|
-
importFileRequests: ImportFileRequest[];
|
|
2981
|
-
/** Default: `true` */
|
|
2982
|
-
returnEntity?: boolean | null;
|
|
2983
|
-
}
|
|
2984
|
-
interface BulkImportFileResponse {
|
|
2985
|
-
/** Items created by bulk action. */
|
|
2986
|
-
results?: BulkImportFileResult[];
|
|
2987
|
-
/** Bulk action metadata. */
|
|
2988
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2989
|
-
}
|
|
2990
|
-
interface BulkImportFileResult {
|
|
2991
|
-
/** Item metadata. */
|
|
2992
|
-
itemMetadata?: ItemMetadata;
|
|
2993
|
-
/** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
|
|
2994
|
-
item?: FileDescriptor;
|
|
2995
|
-
}
|
|
2996
|
-
interface ListFilesRequest {
|
|
2997
|
-
/**
|
|
2998
|
-
* ID of the file's parent folder. <br />
|
|
2999
|
-
* Default:`media-root`.
|
|
3000
|
-
*/
|
|
3001
|
-
parentFolderId?: string | null;
|
|
3002
|
-
/** File media type. */
|
|
3003
|
-
mediaTypes?: MediaType[];
|
|
3004
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
3005
|
-
private?: boolean | null;
|
|
3006
|
-
/**
|
|
3007
|
-
* Field name and order to sort by. One of: <br />
|
|
3008
|
-
* * `displayName`
|
|
3009
|
-
* * `updatedDate`
|
|
3010
|
-
* * `sizeInBytes`
|
|
3011
|
-
* Default: `updatedDate` in `desc` order.
|
|
3012
|
-
*/
|
|
3013
|
-
sort?: Sorting$2;
|
|
3014
|
-
/** Cursor and paging information. */
|
|
3015
|
-
paging?: CursorPaging$2;
|
|
3016
|
-
}
|
|
3017
|
-
interface Sorting$2 {
|
|
3018
|
-
/** Name of the field to sort by. */
|
|
3019
|
-
fieldName?: string;
|
|
3020
|
-
/** Sort order. */
|
|
3021
|
-
order?: SortOrder$2;
|
|
3022
|
-
}
|
|
3023
|
-
declare enum SortOrder$2 {
|
|
3024
|
-
ASC = "ASC",
|
|
3025
|
-
DESC = "DESC"
|
|
3026
|
-
}
|
|
3027
|
-
interface CursorPaging$2 {
|
|
3028
|
-
/** Maximum number of items to return in the results. */
|
|
3029
|
-
limit?: number | null;
|
|
3030
|
-
/**
|
|
3031
|
-
* Pointer to the next or previous page in the list of results.
|
|
3032
|
-
*
|
|
3033
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
3034
|
-
* Not relevant for the first request.
|
|
3035
|
-
*/
|
|
3036
|
-
cursor?: string | null;
|
|
3037
|
-
}
|
|
3038
|
-
interface ListFilesResponse {
|
|
3039
|
-
/** List of files in the Media Manager. */
|
|
3040
|
-
files?: FileDescriptor[];
|
|
3041
|
-
/** The next cursor if it exists. */
|
|
3042
|
-
nextCursor?: PagingMetadataV2$2;
|
|
3043
|
-
}
|
|
3044
|
-
interface PagingMetadataV2$2 {
|
|
3045
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
3046
|
-
total?: number | null;
|
|
3047
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3048
|
-
cursors?: Cursors$2;
|
|
3049
|
-
}
|
|
3050
|
-
interface Cursors$2 {
|
|
3051
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
3052
|
-
next?: string | null;
|
|
3053
|
-
}
|
|
3054
|
-
interface SearchFilesRequest {
|
|
3055
|
-
/**
|
|
3056
|
-
* Term to search for. Possible terms include the value of a file's
|
|
3057
|
-
* `displayName`, `mimeType`, and `label`. <br />
|
|
3058
|
-
* For example, if a file's label is cat, the search term is 'cat'.
|
|
3059
|
-
*/
|
|
3060
|
-
search?: string | null;
|
|
3061
|
-
/**
|
|
3062
|
-
* A root folder in the media manager to search in. <br />
|
|
3063
|
-
* Default: `MEDIA_ROOT`.
|
|
3064
|
-
*/
|
|
3065
|
-
rootFolder?: RootFolder$2;
|
|
3066
|
-
/** File media type. */
|
|
3067
|
-
mediaTypes?: MediaType[];
|
|
3068
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
3069
|
-
private?: boolean | null;
|
|
3070
|
-
/**
|
|
3071
|
-
* Field name and order to sort by. One of: <br />
|
|
3072
|
-
* * `displayName`
|
|
3073
|
-
* * `updatedDate`
|
|
3074
|
-
* * `sizeInBytes`
|
|
3075
|
-
* Default: `updatedDate` in `desc` order.
|
|
3076
|
-
*/
|
|
3077
|
-
sort?: Sorting$2;
|
|
3078
|
-
/** Cursor and paging information. */
|
|
3079
|
-
paging?: CursorPaging$2;
|
|
3080
|
-
}
|
|
3081
|
-
declare enum RootFolder$2 {
|
|
3082
|
-
/** Root of all site media */
|
|
3083
|
-
MEDIA_ROOT = "MEDIA_ROOT",
|
|
3084
|
-
/** Root of the trash system folder */
|
|
3085
|
-
TRASH_ROOT = "TRASH_ROOT",
|
|
3086
|
-
/** Root of all visitor uploads */
|
|
3087
|
-
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
3088
|
-
}
|
|
3089
|
-
interface SearchFilesResponse {
|
|
3090
|
-
/** Files matching the query. */
|
|
3091
|
-
files?: FileDescriptor[];
|
|
3092
|
-
/** The next cursor if it exists. */
|
|
3093
|
-
nextCursor?: PagingMetadataV2$2;
|
|
3094
|
-
}
|
|
3095
|
-
interface GenerateVideoStreamingUrlRequest {
|
|
3096
|
-
/**
|
|
3097
|
-
* File ID.
|
|
3098
|
-
*
|
|
3099
|
-
* You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
3100
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
3101
|
-
*/
|
|
3102
|
-
fileId: string;
|
|
3103
|
-
/** Video stream format. */
|
|
3104
|
-
format?: StreamFormat;
|
|
3105
|
-
}
|
|
3106
|
-
declare enum StreamFormat {
|
|
3107
|
-
UNKNOWN = "UNKNOWN",
|
|
3108
|
-
HLS = "HLS",
|
|
3109
|
-
DASH = "DASH"
|
|
3110
|
-
}
|
|
3111
|
-
interface GenerateVideoStreamingUrlResponse {
|
|
3112
|
-
/** URL for streaming a specific file in the Media Manager. */
|
|
3113
|
-
downloadUrl?: DownloadUrl;
|
|
3114
|
-
}
|
|
3115
|
-
interface BulkDeleteFilesRequest {
|
|
3116
|
-
/**
|
|
3117
|
-
* IDs of the files to move to the Media Manager's trash bin.
|
|
3118
|
-
*
|
|
3119
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
3120
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
3121
|
-
*/
|
|
3122
|
-
fileIds: string[];
|
|
3123
|
-
/**
|
|
3124
|
-
* Whether the specified files are permanently deleted. <br />
|
|
3125
|
-
* Default: `false`
|
|
3126
|
-
*/
|
|
3127
|
-
permanent?: boolean;
|
|
3128
|
-
}
|
|
3129
|
-
interface BulkDeleteFilesResponse {
|
|
3130
|
-
}
|
|
3131
|
-
interface BulkRestoreFilesFromTrashBinRequest {
|
|
3132
|
-
/**
|
|
3133
|
-
* IDs of the files to restore from the Media Manager's trash bin.
|
|
3134
|
-
*
|
|
3135
|
-
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
3136
|
-
* Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
|
|
3137
|
-
*/
|
|
3138
|
-
fileIds: string[];
|
|
3139
|
-
}
|
|
3140
|
-
interface BulkRestoreFilesFromTrashBinResponse {
|
|
3141
|
-
}
|
|
3142
|
-
interface ListDeletedFilesRequest {
|
|
3143
|
-
/**
|
|
3144
|
-
* ID of the file's parent folder. <br />
|
|
3145
|
-
* Default: `media-root`.
|
|
3146
|
-
*/
|
|
3147
|
-
parentFolderId?: string | null;
|
|
3148
|
-
/** File media type. */
|
|
3149
|
-
mediaTypes?: MediaType[];
|
|
3150
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
3151
|
-
private?: boolean | null;
|
|
3152
|
-
/**
|
|
3153
|
-
* Field name and order to sort by. One of: <br />
|
|
3154
|
-
* * `displayName`
|
|
3155
|
-
* * `updatedDate`
|
|
3156
|
-
* * `sizeInBytes`
|
|
3157
|
-
* Default: `updatedDate` in `desc` order.
|
|
3158
|
-
*/
|
|
3159
|
-
sort?: Sorting$2;
|
|
3160
|
-
/** Cursor and paging information. */
|
|
3161
|
-
paging?: CursorPaging$2;
|
|
3162
|
-
}
|
|
3163
|
-
interface ListDeletedFilesResponse {
|
|
3164
|
-
/** List of files in the Media Manager's trash bin. */
|
|
3165
|
-
files?: FileDescriptor[];
|
|
3166
|
-
/** The next cursor if it exists. */
|
|
3167
|
-
nextCursor?: PagingMetadataV2$2;
|
|
3168
|
-
}
|
|
3169
|
-
interface GenerateFilesDownloadUrlResponseNonNullableFields {
|
|
3170
|
-
downloadUrl: string;
|
|
3171
|
-
}
|
|
3172
|
-
interface DownloadUrlNonNullableFields {
|
|
3173
|
-
url: string;
|
|
3174
|
-
assetKey: string;
|
|
3175
|
-
}
|
|
3176
|
-
interface GenerateFileDownloadUrlResponseNonNullableFields {
|
|
3177
|
-
downloadUrls: DownloadUrlNonNullableFields[];
|
|
3178
|
-
}
|
|
3179
|
-
interface FaceRecognitionNonNullableFields {
|
|
3180
|
-
confidence: number;
|
|
3181
|
-
x: number;
|
|
3182
|
-
y: number;
|
|
3183
|
-
height: number;
|
|
3184
|
-
width: number;
|
|
3185
|
-
}
|
|
3186
|
-
interface ImageMediaNonNullableFields {
|
|
3187
|
-
image: string;
|
|
3188
|
-
faces: FaceRecognitionNonNullableFields[];
|
|
3189
|
-
previewImage: string;
|
|
3190
|
-
}
|
|
3191
|
-
interface AudioV2NonNullableFields {
|
|
3192
|
-
_id: string;
|
|
3193
|
-
assets: string[];
|
|
3194
|
-
}
|
|
3195
|
-
interface ArchiveNonNullableFields {
|
|
3196
|
-
_id: string;
|
|
3197
|
-
url: string;
|
|
3198
|
-
}
|
|
3199
|
-
interface Model3DNonNullableFields {
|
|
3200
|
-
_id: string;
|
|
3201
|
-
url: string;
|
|
3202
|
-
thumbnail: string;
|
|
3203
|
-
}
|
|
3204
|
-
interface OtherMediaNonNullableFields {
|
|
3205
|
-
_id: string;
|
|
3206
|
-
url: string;
|
|
3207
|
-
}
|
|
3208
|
-
interface FileMediaNonNullableFields {
|
|
3209
|
-
image?: ImageMediaNonNullableFields;
|
|
3210
|
-
video: string;
|
|
3211
|
-
audio?: AudioV2NonNullableFields;
|
|
3212
|
-
document: string;
|
|
3213
|
-
vector?: ImageMediaNonNullableFields;
|
|
3214
|
-
archive?: ArchiveNonNullableFields;
|
|
3215
|
-
model3d?: Model3DNonNullableFields;
|
|
3216
|
-
other?: OtherMediaNonNullableFields;
|
|
3217
|
-
icon?: ImageMediaNonNullableFields;
|
|
3218
|
-
flash?: OtherMediaNonNullableFields;
|
|
3219
|
-
}
|
|
3220
|
-
interface IdentityInfoNonNullableFields {
|
|
3221
|
-
identityType: IdentityType;
|
|
3222
|
-
}
|
|
3223
|
-
interface FileDescriptorNonNullableFields {
|
|
3224
|
-
_id: string;
|
|
3225
|
-
displayName: string;
|
|
3226
|
-
url: string;
|
|
3227
|
-
hash: string;
|
|
3228
|
-
private: boolean;
|
|
3229
|
-
mediaType: MediaType;
|
|
3230
|
-
media?: FileMediaNonNullableFields;
|
|
3231
|
-
operationStatus: OperationStatus;
|
|
3232
|
-
labels: string[];
|
|
3233
|
-
siteId: string;
|
|
3234
|
-
state: State$2;
|
|
3235
|
-
internalTags: string[];
|
|
3236
|
-
namespace: Namespace$2;
|
|
3237
|
-
addedBy?: IdentityInfoNonNullableFields;
|
|
3238
|
-
}
|
|
3239
|
-
interface GetFileDescriptorResponseNonNullableFields {
|
|
3240
|
-
file?: FileDescriptorNonNullableFields;
|
|
3241
|
-
}
|
|
3242
|
-
interface GetFileDescriptorsResponseNonNullableFields {
|
|
3243
|
-
files: FileDescriptorNonNullableFields[];
|
|
3244
|
-
}
|
|
3245
|
-
interface UpdateFileDescriptorResponseNonNullableFields {
|
|
3246
|
-
file?: FileDescriptorNonNullableFields;
|
|
3247
|
-
}
|
|
3248
|
-
interface GenerateFileUploadUrlResponseNonNullableFields {
|
|
3249
|
-
uploadUrl: string;
|
|
3250
|
-
}
|
|
3251
|
-
interface GenerateFileResumableUploadUrlResponseNonNullableFields {
|
|
3252
|
-
uploadProtocol: UploadProtocol;
|
|
3253
|
-
uploadUrl: string;
|
|
3254
|
-
uploadToken: string;
|
|
3255
|
-
}
|
|
3256
|
-
interface ImportFileResponseNonNullableFields {
|
|
3257
|
-
file?: FileDescriptorNonNullableFields;
|
|
3258
|
-
}
|
|
3259
|
-
interface BulkImportFilesResponseNonNullableFields {
|
|
3260
|
-
files: FileDescriptorNonNullableFields[];
|
|
3261
|
-
}
|
|
3262
|
-
interface ApplicationErrorNonNullableFields {
|
|
3263
|
-
code: string;
|
|
3264
|
-
description: string;
|
|
3265
|
-
}
|
|
3266
|
-
interface ItemMetadataNonNullableFields {
|
|
3267
|
-
originalIndex: number;
|
|
3268
|
-
success: boolean;
|
|
3269
|
-
error?: ApplicationErrorNonNullableFields;
|
|
3270
|
-
}
|
|
3271
|
-
interface BulkImportFileResultNonNullableFields {
|
|
3272
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
3273
|
-
item?: FileDescriptorNonNullableFields;
|
|
3274
|
-
}
|
|
3275
|
-
interface BulkActionMetadataNonNullableFields {
|
|
3276
|
-
totalSuccesses: number;
|
|
3277
|
-
totalFailures: number;
|
|
3278
|
-
undetailedFailures: number;
|
|
3279
|
-
}
|
|
3280
|
-
interface BulkImportFileResponseNonNullableFields {
|
|
3281
|
-
results: BulkImportFileResultNonNullableFields[];
|
|
3282
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3283
|
-
}
|
|
3284
|
-
interface ListFilesResponseNonNullableFields {
|
|
3285
|
-
files: FileDescriptorNonNullableFields[];
|
|
3286
|
-
}
|
|
3287
|
-
interface SearchFilesResponseNonNullableFields {
|
|
3288
|
-
files: FileDescriptorNonNullableFields[];
|
|
3289
|
-
}
|
|
3290
|
-
interface GenerateVideoStreamingUrlResponseNonNullableFields {
|
|
3291
|
-
downloadUrl?: DownloadUrlNonNullableFields;
|
|
3292
|
-
}
|
|
3293
|
-
interface ListDeletedFilesResponseNonNullableFields {
|
|
3294
|
-
files: FileDescriptorNonNullableFields[];
|
|
3295
|
-
}
|
|
3296
|
-
|
|
3297
|
-
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3298
|
-
getUrl: (context: any) => string;
|
|
3299
|
-
httpMethod: K;
|
|
3300
|
-
path: string;
|
|
3301
|
-
pathParams: M;
|
|
3302
|
-
__requestType: T;
|
|
3303
|
-
__originalRequestType: S;
|
|
3304
|
-
__responseType: Q;
|
|
3305
|
-
__originalResponseType: R;
|
|
3306
|
-
};
|
|
3307
|
-
declare function generateFilesDownloadUrl(): __PublicMethodMetaInfo$1<'POST', {}, GenerateFilesDownloadUrlRequest, GenerateFilesDownloadUrlRequest$1, GenerateFilesDownloadUrlResponse & GenerateFilesDownloadUrlResponseNonNullableFields, GenerateFilesDownloadUrlResponse$1 & GenerateFilesDownloadUrlResponseNonNullableFields$1>;
|
|
3308
|
-
declare function generateFileDownloadUrl(): __PublicMethodMetaInfo$1<'POST', {}, GenerateFileDownloadUrlRequest, GenerateFileDownloadUrlRequest$1, GenerateFileDownloadUrlResponse & GenerateFileDownloadUrlResponseNonNullableFields, GenerateFileDownloadUrlResponse$1 & GenerateFileDownloadUrlResponseNonNullableFields$1>;
|
|
3309
|
-
declare function getFileDescriptor(): __PublicMethodMetaInfo$1<'GET', {}, GetFileDescriptorRequest, GetFileDescriptorRequest$1, GetFileDescriptorResponse & GetFileDescriptorResponseNonNullableFields, GetFileDescriptorResponse$1 & GetFileDescriptorResponseNonNullableFields$1>;
|
|
3310
|
-
declare function getFileDescriptors(): __PublicMethodMetaInfo$1<'POST', {}, GetFileDescriptorsRequest, GetFileDescriptorsRequest$1, GetFileDescriptorsResponse & GetFileDescriptorsResponseNonNullableFields, GetFileDescriptorsResponse$1 & GetFileDescriptorsResponseNonNullableFields$1>;
|
|
3311
|
-
declare function updateFileDescriptor(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateFileDescriptorRequest, UpdateFileDescriptorRequest$1, UpdateFileDescriptorResponse & UpdateFileDescriptorResponseNonNullableFields, UpdateFileDescriptorResponse$1 & UpdateFileDescriptorResponseNonNullableFields$1>;
|
|
3312
|
-
declare function generateFileUploadUrl(): __PublicMethodMetaInfo$1<'POST', {}, GenerateFileUploadUrlRequest, GenerateFileUploadUrlRequest$1, GenerateFileUploadUrlResponse & GenerateFileUploadUrlResponseNonNullableFields, GenerateFileUploadUrlResponse$1 & GenerateFileUploadUrlResponseNonNullableFields$1>;
|
|
3313
|
-
declare function generateFileResumableUploadUrl(): __PublicMethodMetaInfo$1<'POST', {}, GenerateFileResumableUploadUrlRequest, GenerateFileResumableUploadUrlRequest$1, GenerateFileResumableUploadUrlResponse & GenerateFileResumableUploadUrlResponseNonNullableFields, GenerateFileResumableUploadUrlResponse$1 & GenerateFileResumableUploadUrlResponseNonNullableFields$1>;
|
|
3314
|
-
declare function importFile(): __PublicMethodMetaInfo$1<'POST', {}, ImportFileRequest, ImportFileRequest$1, ImportFileResponse & ImportFileResponseNonNullableFields, ImportFileResponse$1 & ImportFileResponseNonNullableFields$1>;
|
|
3315
|
-
declare function bulkImportFiles(): __PublicMethodMetaInfo$1<'POST', {}, BulkImportFilesRequest, BulkImportFilesRequest$1, BulkImportFilesResponse & BulkImportFilesResponseNonNullableFields, BulkImportFilesResponse$1 & BulkImportFilesResponseNonNullableFields$1>;
|
|
3316
|
-
declare function bulkImportFile(): __PublicMethodMetaInfo$1<'POST', {}, BulkImportFileRequest, BulkImportFileRequest$1, BulkImportFileResponse & BulkImportFileResponseNonNullableFields, BulkImportFileResponse$1 & BulkImportFileResponseNonNullableFields$1>;
|
|
3317
|
-
declare function listFiles(): __PublicMethodMetaInfo$1<'GET', {}, ListFilesRequest, ListFilesRequest$1, ListFilesResponse & ListFilesResponseNonNullableFields, ListFilesResponse$1 & ListFilesResponseNonNullableFields$1>;
|
|
3318
|
-
declare function searchFiles(): __PublicMethodMetaInfo$1<'POST', {}, SearchFilesRequest, SearchFilesRequest$1, SearchFilesResponse & SearchFilesResponseNonNullableFields, SearchFilesResponse$1 & SearchFilesResponseNonNullableFields$1>;
|
|
3319
|
-
declare function generateVideoStreamingUrl(): __PublicMethodMetaInfo$1<'POST', {}, GenerateVideoStreamingUrlRequest, GenerateVideoStreamingUrlRequest$1, GenerateVideoStreamingUrlResponse & GenerateVideoStreamingUrlResponseNonNullableFields, GenerateVideoStreamingUrlResponse$1 & GenerateVideoStreamingUrlResponseNonNullableFields$1>;
|
|
3320
|
-
declare function bulkDeleteFiles(): __PublicMethodMetaInfo$1<'POST', {}, BulkDeleteFilesRequest, BulkDeleteFilesRequest$1, BulkDeleteFilesResponse, BulkDeleteFilesResponse$1>;
|
|
3321
|
-
declare function bulkRestoreFilesFromTrashBin(): __PublicMethodMetaInfo$1<'POST', {}, BulkRestoreFilesFromTrashBinRequest, BulkRestoreFilesFromTrashBinRequest$1, BulkRestoreFilesFromTrashBinResponse, BulkRestoreFilesFromTrashBinResponse$1>;
|
|
3322
|
-
declare function listDeletedFiles(): __PublicMethodMetaInfo$1<'GET', {}, ListDeletedFilesRequest, ListDeletedFilesRequest$1, ListDeletedFilesResponse & ListDeletedFilesResponseNonNullableFields, ListDeletedFilesResponse$1 & ListDeletedFilesResponseNonNullableFields$1>;
|
|
3323
|
-
|
|
3324
|
-
declare const meta$1_bulkDeleteFiles: typeof bulkDeleteFiles;
|
|
3325
|
-
declare const meta$1_bulkImportFile: typeof bulkImportFile;
|
|
3326
|
-
declare const meta$1_bulkImportFiles: typeof bulkImportFiles;
|
|
3327
|
-
declare const meta$1_bulkRestoreFilesFromTrashBin: typeof bulkRestoreFilesFromTrashBin;
|
|
3328
|
-
declare const meta$1_generateFileDownloadUrl: typeof generateFileDownloadUrl;
|
|
3329
|
-
declare const meta$1_generateFileResumableUploadUrl: typeof generateFileResumableUploadUrl;
|
|
3330
|
-
declare const meta$1_generateFileUploadUrl: typeof generateFileUploadUrl;
|
|
3331
|
-
declare const meta$1_generateFilesDownloadUrl: typeof generateFilesDownloadUrl;
|
|
3332
|
-
declare const meta$1_generateVideoStreamingUrl: typeof generateVideoStreamingUrl;
|
|
3333
|
-
declare const meta$1_getFileDescriptor: typeof getFileDescriptor;
|
|
3334
|
-
declare const meta$1_getFileDescriptors: typeof getFileDescriptors;
|
|
3335
|
-
declare const meta$1_importFile: typeof importFile;
|
|
3336
|
-
declare const meta$1_listDeletedFiles: typeof listDeletedFiles;
|
|
3337
|
-
declare const meta$1_listFiles: typeof listFiles;
|
|
3338
|
-
declare const meta$1_searchFiles: typeof searchFiles;
|
|
3339
|
-
declare const meta$1_updateFileDescriptor: typeof updateFileDescriptor;
|
|
3340
|
-
declare namespace meta$1 {
|
|
3341
|
-
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkDeleteFiles as bulkDeleteFiles, meta$1_bulkImportFile as bulkImportFile, meta$1_bulkImportFiles as bulkImportFiles, meta$1_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin, meta$1_generateFileDownloadUrl as generateFileDownloadUrl, meta$1_generateFileResumableUploadUrl as generateFileResumableUploadUrl, meta$1_generateFileUploadUrl as generateFileUploadUrl, meta$1_generateFilesDownloadUrl as generateFilesDownloadUrl, meta$1_generateVideoStreamingUrl as generateVideoStreamingUrl, meta$1_getFileDescriptor as getFileDescriptor, meta$1_getFileDescriptors as getFileDescriptors, meta$1_importFile as importFile, meta$1_listDeletedFiles as listDeletedFiles, meta$1_listFiles as listFiles, meta$1_searchFiles as searchFiles, meta$1_updateFileDescriptor as updateFileDescriptor };
|
|
3342
|
-
}
|
|
3343
|
-
|
|
3344
|
-
interface Folder$1 {
|
|
3345
|
-
/** Folder ID. Generated when a folder is created in the Media Manager. */
|
|
3346
|
-
id?: string;
|
|
3347
|
-
/** Folder name as it appears in the Media Manager. */
|
|
3348
|
-
displayName?: string;
|
|
3349
|
-
/** ID of the folder's parent folder. <br /> Default: `media-root` folder. */
|
|
3350
|
-
parentFolderId?: string;
|
|
3351
|
-
/**
|
|
3352
|
-
* Date the folder was created.
|
|
3353
|
-
* @readonly
|
|
3354
|
-
*/
|
|
3355
|
-
createdDate?: Date | null;
|
|
3356
|
-
/**
|
|
3357
|
-
* Date the folder was updated.
|
|
3358
|
-
* @readonly
|
|
3359
|
-
*/
|
|
3360
|
-
updatedDate?: Date | null;
|
|
3361
|
-
/**
|
|
3362
|
-
* State of the folder.
|
|
3363
|
-
* @readonly
|
|
3364
|
-
*/
|
|
3365
|
-
state?: State$1;
|
|
3366
|
-
}
|
|
3367
|
-
declare enum State$1 {
|
|
3368
|
-
OK = "OK",
|
|
3369
|
-
DELETED = "DELETED"
|
|
3370
|
-
}
|
|
3371
|
-
declare enum Namespace$1 {
|
|
3372
|
-
NO_NAMESPACE = "NO_NAMESPACE",
|
|
3373
|
-
OTHERS = "OTHERS",
|
|
3374
|
-
/** ANY = 2; */
|
|
3375
|
-
WIX_VIDEO = "WIX_VIDEO",
|
|
3376
|
-
/** _nsWixMusic */
|
|
3377
|
-
WIX_MUSIC = "WIX_MUSIC",
|
|
3378
|
-
/** _nsArtStore */
|
|
3379
|
-
ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
|
|
3380
|
-
/** _nsDigitalProduct */
|
|
3381
|
-
WIX_ECOM = "WIX_ECOM",
|
|
3382
|
-
/** _nsPhotoShareApp */
|
|
3383
|
-
PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
|
|
3384
|
-
/** _nsSharingApp, */
|
|
3385
|
-
SHARING_APP = "SHARING_APP",
|
|
3386
|
-
/** engage */
|
|
3387
|
-
CHAT = "CHAT",
|
|
3388
|
-
/** logobuilder */
|
|
3389
|
-
LOGO_BUILDER = "LOGO_BUILDER",
|
|
3390
|
-
/** WixExposure */
|
|
3391
|
-
ALBUMS_OLD = "ALBUMS_OLD",
|
|
3392
|
-
/** chat-mobile-uploads */
|
|
3393
|
-
CHAT_MOBILE = "CHAT_MOBILE",
|
|
3394
|
-
/** _nsWixForms */
|
|
3395
|
-
WIX_FORMS = "WIX_FORMS"
|
|
3396
|
-
}
|
|
3397
|
-
interface CreateFolderRequest$1 {
|
|
3398
|
-
/** Folder name that appears in the Media Manager. */
|
|
3399
|
-
displayName: string;
|
|
3400
|
-
/** ID of the folder's parent folder. */
|
|
3401
|
-
parentFolderId?: string | null;
|
|
3402
|
-
}
|
|
3403
|
-
interface CreateFolderResponse$1 {
|
|
3404
|
-
/** Information about the newly created folder. */
|
|
3405
|
-
folder?: Folder$1;
|
|
3406
|
-
}
|
|
3407
|
-
interface GetFolderRequest$1 {
|
|
3408
|
-
/** Folder ID. */
|
|
3409
|
-
folderId: string;
|
|
3410
|
-
}
|
|
3411
|
-
interface GetFolderResponse$1 {
|
|
3412
|
-
/** Information about the folder. */
|
|
3413
|
-
folder?: Folder$1;
|
|
3414
|
-
}
|
|
3415
|
-
interface ListFoldersRequest$1 {
|
|
3416
|
-
/**
|
|
3417
|
-
* ID of the folder's parent folder.
|
|
3418
|
-
* <br /> Default: `media-root` folder.
|
|
3419
|
-
*/
|
|
3420
|
-
parentFolderId?: string | null;
|
|
3421
|
-
/**
|
|
3422
|
-
* Field name and order to sort by. One of: <br />
|
|
3423
|
-
* * `displayName`
|
|
3424
|
-
* * `updatedDate`
|
|
3425
|
-
* Default: `updatedDate` in `desc` order.
|
|
3426
|
-
*/
|
|
3427
|
-
sort?: Sorting$1;
|
|
3428
|
-
/** Cursor and paging information. */
|
|
3429
|
-
paging?: CursorPaging$1;
|
|
3430
|
-
}
|
|
3431
|
-
interface Sorting$1 {
|
|
3432
|
-
/** Name of the field to sort by. */
|
|
3433
|
-
fieldName?: string;
|
|
3434
|
-
/** Sort order. */
|
|
3435
|
-
order?: SortOrder$1;
|
|
3436
|
-
}
|
|
3437
|
-
declare enum SortOrder$1 {
|
|
3438
|
-
ASC = "ASC",
|
|
3439
|
-
DESC = "DESC"
|
|
3440
|
-
}
|
|
3441
|
-
interface CursorPaging$1 {
|
|
3442
|
-
/** Maximum number of items to return in the results. */
|
|
3443
|
-
limit?: number | null;
|
|
3444
|
-
/**
|
|
3445
|
-
* Pointer to the next or previous page in the list of results.
|
|
3446
|
-
*
|
|
3447
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
3448
|
-
* Not relevant for the first request.
|
|
3449
|
-
*/
|
|
3450
|
-
cursor?: string | null;
|
|
3451
|
-
}
|
|
3452
|
-
interface ListFoldersResponse$1 {
|
|
3453
|
-
/** Information about the folders in the requested folder. */
|
|
3454
|
-
folders?: Folder$1[];
|
|
3455
|
-
/** The next cursor if it exists. */
|
|
3456
|
-
nextCursor?: PagingMetadataV2$1;
|
|
3457
|
-
}
|
|
3458
|
-
interface PagingMetadataV2$1 {
|
|
3459
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
3460
|
-
total?: number | null;
|
|
3461
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3462
|
-
cursors?: Cursors$1;
|
|
3463
|
-
}
|
|
3464
|
-
interface Cursors$1 {
|
|
3465
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
3466
|
-
next?: string | null;
|
|
3467
|
-
}
|
|
3468
|
-
interface SearchFoldersRequest$1 {
|
|
3469
|
-
/**
|
|
3470
|
-
* A root folder in the Media Manager to search in. <br />
|
|
3471
|
-
* Default: `MEDIA_ROOT`.
|
|
3472
|
-
*/
|
|
3473
|
-
rootFolder?: RootFolder$1;
|
|
3474
|
-
/**
|
|
3475
|
-
* Field name and order to sort by. One of:
|
|
3476
|
-
* * `displayName`
|
|
3477
|
-
* * `updatedDate`
|
|
3478
|
-
* Default: `updatedDate` in `desc` order.
|
|
3479
|
-
*/
|
|
3480
|
-
sort?: Sorting$1;
|
|
3481
|
-
/** Cursor and paging information. */
|
|
3482
|
-
paging?: CursorPaging$1;
|
|
3483
|
-
/**
|
|
3484
|
-
* Term to search for, such as the value of a folder's `displayName`. <br />
|
|
3485
|
-
* For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
|
|
3486
|
-
*/
|
|
3487
|
-
search?: string | null;
|
|
3488
|
-
}
|
|
3489
|
-
declare enum RootFolder$1 {
|
|
3490
|
-
/** Root of all site media */
|
|
3491
|
-
MEDIA_ROOT = "MEDIA_ROOT",
|
|
3492
|
-
/** Root of the trash system folder */
|
|
3493
|
-
TRASH_ROOT = "TRASH_ROOT",
|
|
3494
|
-
/** Root of all visitor uploads */
|
|
3495
|
-
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
3496
|
-
}
|
|
3497
|
-
interface SearchFoldersResponse$1 {
|
|
3498
|
-
/** Information about the folders in the requested folder. */
|
|
3499
|
-
folders?: Folder$1[];
|
|
3500
|
-
/** The next cursor if it exists. */
|
|
3501
|
-
nextCursor?: PagingMetadataV2$1;
|
|
3502
|
-
}
|
|
3503
|
-
interface UpdateFolderRequest$1 {
|
|
3504
|
-
/** Folder to update. */
|
|
3505
|
-
folder: Folder$1;
|
|
3506
|
-
}
|
|
3507
|
-
interface UpdateFolderResponse$1 {
|
|
3508
|
-
/** Information about the updated folder. */
|
|
3509
|
-
folder?: Folder$1;
|
|
3510
|
-
}
|
|
3511
|
-
interface GenerateFolderDownloadUrlRequest$1 {
|
|
3512
|
-
/** Folder ID. */
|
|
3513
|
-
folderId: string;
|
|
3514
|
-
}
|
|
3515
|
-
interface GenerateFolderDownloadUrlResponse$1 {
|
|
3516
|
-
/** URL for downloading a specific folder in the Media Manager. */
|
|
3517
|
-
downloadUrl?: string;
|
|
3518
|
-
}
|
|
3519
|
-
interface BulkDeleteFoldersRequest$1 {
|
|
3520
|
-
/** IDs of the folders to move to the Media Manager's trash bin. */
|
|
3521
|
-
folderIds: string[];
|
|
3522
|
-
/**
|
|
3523
|
-
* Whether the specified folders are permanently deleted. <br />
|
|
3524
|
-
* Default: `false`
|
|
3525
|
-
*/
|
|
3526
|
-
permanent?: boolean;
|
|
3527
|
-
}
|
|
3528
|
-
interface BulkDeleteFoldersResponse$1 {
|
|
3529
|
-
}
|
|
3530
|
-
interface BulkRestoreFoldersFromTrashBinRequest$1 {
|
|
3531
|
-
/** IDs of the folders to restore from the Media Manager's trash bin. */
|
|
3532
|
-
folderIds: string[];
|
|
3533
|
-
}
|
|
3534
|
-
interface BulkRestoreFoldersFromTrashBinResponse$1 {
|
|
3535
|
-
}
|
|
3536
|
-
interface ListDeletedFoldersRequest$1 {
|
|
3537
|
-
/** ID of the folder's parent folder. */
|
|
3538
|
-
parentFolderId?: string | null;
|
|
3539
|
-
/**
|
|
3540
|
-
* Field name and order to sort by. One of:
|
|
3541
|
-
* * `displayName`
|
|
3542
|
-
* * `updatedDate`
|
|
3543
|
-
* Default: `updatedDate` in `desc` order.
|
|
3544
|
-
*/
|
|
3545
|
-
sort?: Sorting$1;
|
|
3546
|
-
/** Cursor and paging information. */
|
|
3547
|
-
paging?: CursorPaging$1;
|
|
3548
|
-
}
|
|
3549
|
-
interface ListDeletedFoldersResponse$1 {
|
|
3550
|
-
/** List of folders in the Media Manager's trash bin. */
|
|
3551
|
-
folders?: Folder$1[];
|
|
3552
|
-
/** The next cursor if it exists. */
|
|
3553
|
-
nextCursor?: PagingMetadataV2$1;
|
|
3554
|
-
}
|
|
3555
|
-
interface FolderNonNullableFields$1 {
|
|
3556
|
-
id: string;
|
|
3557
|
-
displayName: string;
|
|
3558
|
-
parentFolderId: string;
|
|
3559
|
-
state: State$1;
|
|
3560
|
-
namespace: Namespace$1;
|
|
3561
|
-
}
|
|
3562
|
-
interface CreateFolderResponseNonNullableFields$1 {
|
|
3563
|
-
folder?: FolderNonNullableFields$1;
|
|
3564
|
-
}
|
|
3565
|
-
interface GetFolderResponseNonNullableFields$1 {
|
|
3566
|
-
folder?: FolderNonNullableFields$1;
|
|
3567
|
-
}
|
|
3568
|
-
interface ListFoldersResponseNonNullableFields$1 {
|
|
3569
|
-
folders: FolderNonNullableFields$1[];
|
|
3570
|
-
}
|
|
3571
|
-
interface SearchFoldersResponseNonNullableFields$1 {
|
|
3572
|
-
folders: FolderNonNullableFields$1[];
|
|
3573
|
-
}
|
|
3574
|
-
interface UpdateFolderResponseNonNullableFields$1 {
|
|
3575
|
-
folder?: FolderNonNullableFields$1;
|
|
3576
|
-
}
|
|
3577
|
-
interface GenerateFolderDownloadUrlResponseNonNullableFields$1 {
|
|
3578
|
-
downloadUrl: string;
|
|
3579
|
-
}
|
|
3580
|
-
interface ListDeletedFoldersResponseNonNullableFields$1 {
|
|
3581
|
-
folders: FolderNonNullableFields$1[];
|
|
3582
|
-
}
|
|
3583
|
-
|
|
3584
|
-
interface Folder {
|
|
3585
|
-
/** Folder ID. Generated when a folder is created in the Media Manager. */
|
|
3586
|
-
_id?: string;
|
|
3587
|
-
/** Folder name as it appears in the Media Manager. */
|
|
3588
|
-
displayName?: string;
|
|
3589
|
-
/** ID of the folder's parent folder. <br /> Default: `media-root` folder. */
|
|
3590
|
-
parentFolderId?: string;
|
|
3591
|
-
/**
|
|
3592
|
-
* Date the folder was created.
|
|
3593
|
-
* @readonly
|
|
3594
|
-
*/
|
|
3595
|
-
_createdDate?: Date | null;
|
|
3596
|
-
/**
|
|
3597
|
-
* Date the folder was updated.
|
|
3598
|
-
* @readonly
|
|
3599
|
-
*/
|
|
3600
|
-
_updatedDate?: Date | null;
|
|
3601
|
-
/**
|
|
3602
|
-
* State of the folder.
|
|
3603
|
-
* @readonly
|
|
3604
|
-
*/
|
|
3605
|
-
state?: State;
|
|
3606
|
-
}
|
|
3607
|
-
declare enum State {
|
|
3608
|
-
OK = "OK",
|
|
3609
|
-
DELETED = "DELETED"
|
|
3610
|
-
}
|
|
3611
|
-
declare enum Namespace {
|
|
3612
|
-
NO_NAMESPACE = "NO_NAMESPACE",
|
|
3613
|
-
OTHERS = "OTHERS",
|
|
3614
|
-
/** ANY = 2; */
|
|
3615
|
-
WIX_VIDEO = "WIX_VIDEO",
|
|
3616
|
-
/** _nsWixMusic */
|
|
3617
|
-
WIX_MUSIC = "WIX_MUSIC",
|
|
3618
|
-
/** _nsArtStore */
|
|
3619
|
-
ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
|
|
3620
|
-
/** _nsDigitalProduct */
|
|
3621
|
-
WIX_ECOM = "WIX_ECOM",
|
|
3622
|
-
/** _nsPhotoShareApp */
|
|
3623
|
-
PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
|
|
3624
|
-
/** _nsSharingApp, */
|
|
3625
|
-
SHARING_APP = "SHARING_APP",
|
|
3626
|
-
/** engage */
|
|
3627
|
-
CHAT = "CHAT",
|
|
3628
|
-
/** logobuilder */
|
|
3629
|
-
LOGO_BUILDER = "LOGO_BUILDER",
|
|
3630
|
-
/** WixExposure */
|
|
3631
|
-
ALBUMS_OLD = "ALBUMS_OLD",
|
|
3632
|
-
/** chat-mobile-uploads */
|
|
3633
|
-
CHAT_MOBILE = "CHAT_MOBILE",
|
|
3634
|
-
/** _nsWixForms */
|
|
3635
|
-
WIX_FORMS = "WIX_FORMS"
|
|
3636
|
-
}
|
|
3637
|
-
interface CreateFolderRequest {
|
|
3638
|
-
/** Folder name that appears in the Media Manager. */
|
|
3639
|
-
displayName: string;
|
|
3640
|
-
/** ID of the folder's parent folder. */
|
|
3641
|
-
parentFolderId?: string | null;
|
|
3642
|
-
}
|
|
3643
|
-
interface CreateFolderResponse {
|
|
3644
|
-
/** Information about the newly created folder. */
|
|
3645
|
-
folder?: Folder;
|
|
3646
|
-
}
|
|
3647
|
-
interface GetFolderRequest {
|
|
3648
|
-
/** Folder ID. */
|
|
3649
|
-
folderId: string;
|
|
3650
|
-
}
|
|
3651
|
-
interface GetFolderResponse {
|
|
3652
|
-
/** Information about the folder. */
|
|
3653
|
-
folder?: Folder;
|
|
3654
|
-
}
|
|
3655
|
-
interface ListFoldersRequest {
|
|
3656
|
-
/**
|
|
3657
|
-
* ID of the folder's parent folder.
|
|
3658
|
-
* <br /> Default: `media-root` folder.
|
|
3659
|
-
*/
|
|
3660
|
-
parentFolderId?: string | null;
|
|
3661
|
-
/**
|
|
3662
|
-
* Field name and order to sort by. One of: <br />
|
|
3663
|
-
* * `displayName`
|
|
3664
|
-
* * `updatedDate`
|
|
3665
|
-
* Default: `updatedDate` in `desc` order.
|
|
3666
|
-
*/
|
|
3667
|
-
sort?: Sorting;
|
|
3668
|
-
/** Cursor and paging information. */
|
|
3669
|
-
paging?: CursorPaging;
|
|
3670
|
-
}
|
|
3671
|
-
interface Sorting {
|
|
3672
|
-
/** Name of the field to sort by. */
|
|
3673
|
-
fieldName?: string;
|
|
3674
|
-
/** Sort order. */
|
|
3675
|
-
order?: SortOrder;
|
|
3676
|
-
}
|
|
3677
|
-
declare enum SortOrder {
|
|
3678
|
-
ASC = "ASC",
|
|
3679
|
-
DESC = "DESC"
|
|
3680
|
-
}
|
|
3681
|
-
interface CursorPaging {
|
|
3682
|
-
/** Maximum number of items to return in the results. */
|
|
3683
|
-
limit?: number | null;
|
|
3684
|
-
/**
|
|
3685
|
-
* Pointer to the next or previous page in the list of results.
|
|
3686
|
-
*
|
|
3687
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
3688
|
-
* Not relevant for the first request.
|
|
3689
|
-
*/
|
|
3690
|
-
cursor?: string | null;
|
|
3691
|
-
}
|
|
3692
|
-
interface ListFoldersResponse {
|
|
3693
|
-
/** Information about the folders in the requested folder. */
|
|
3694
|
-
folders?: Folder[];
|
|
3695
|
-
/** The next cursor if it exists. */
|
|
3696
|
-
nextCursor?: PagingMetadataV2;
|
|
3697
|
-
}
|
|
3698
|
-
interface PagingMetadataV2 {
|
|
3699
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
3700
|
-
total?: number | null;
|
|
3701
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3702
|
-
cursors?: Cursors;
|
|
3703
|
-
}
|
|
3704
|
-
interface Cursors {
|
|
3705
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
3706
|
-
next?: string | null;
|
|
3707
|
-
}
|
|
3708
|
-
interface SearchFoldersRequest {
|
|
3709
|
-
/**
|
|
3710
|
-
* A root folder in the Media Manager to search in. <br />
|
|
3711
|
-
* Default: `MEDIA_ROOT`.
|
|
3712
|
-
*/
|
|
3713
|
-
rootFolder?: RootFolder;
|
|
3714
|
-
/**
|
|
3715
|
-
* Field name and order to sort by. One of:
|
|
3716
|
-
* * `displayName`
|
|
3717
|
-
* * `updatedDate`
|
|
3718
|
-
* Default: `updatedDate` in `desc` order.
|
|
3719
|
-
*/
|
|
3720
|
-
sort?: Sorting;
|
|
3721
|
-
/** Cursor and paging information. */
|
|
3722
|
-
paging?: CursorPaging;
|
|
3723
|
-
/**
|
|
3724
|
-
* Term to search for, such as the value of a folder's `displayName`. <br />
|
|
3725
|
-
* For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
|
|
3726
|
-
*/
|
|
3727
|
-
search?: string | null;
|
|
3728
|
-
}
|
|
3729
|
-
declare enum RootFolder {
|
|
3730
|
-
/** Root of all site media */
|
|
3731
|
-
MEDIA_ROOT = "MEDIA_ROOT",
|
|
3732
|
-
/** Root of the trash system folder */
|
|
3733
|
-
TRASH_ROOT = "TRASH_ROOT",
|
|
3734
|
-
/** Root of all visitor uploads */
|
|
3735
|
-
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
3736
|
-
}
|
|
3737
|
-
interface SearchFoldersResponse {
|
|
3738
|
-
/** Information about the folders in the requested folder. */
|
|
3739
|
-
folders?: Folder[];
|
|
3740
|
-
/** The next cursor if it exists. */
|
|
3741
|
-
nextCursor?: PagingMetadataV2;
|
|
3742
|
-
}
|
|
3743
|
-
interface UpdateFolderRequest {
|
|
3744
|
-
/** Folder to update. */
|
|
3745
|
-
folder: Folder;
|
|
3746
|
-
}
|
|
3747
|
-
interface UpdateFolderResponse {
|
|
3748
|
-
/** Information about the updated folder. */
|
|
3749
|
-
folder?: Folder;
|
|
3750
|
-
}
|
|
3751
|
-
interface GenerateFolderDownloadUrlRequest {
|
|
3752
|
-
/** Folder ID. */
|
|
3753
|
-
folderId: string;
|
|
3754
|
-
}
|
|
3755
|
-
interface GenerateFolderDownloadUrlResponse {
|
|
3756
|
-
/** URL for downloading a specific folder in the Media Manager. */
|
|
3757
|
-
downloadUrl?: string;
|
|
3758
|
-
}
|
|
3759
|
-
interface BulkDeleteFoldersRequest {
|
|
3760
|
-
/** IDs of the folders to move to the Media Manager's trash bin. */
|
|
3761
|
-
folderIds: string[];
|
|
3762
|
-
/**
|
|
3763
|
-
* Whether the specified folders are permanently deleted. <br />
|
|
3764
|
-
* Default: `false`
|
|
3765
|
-
*/
|
|
3766
|
-
permanent?: boolean;
|
|
3767
|
-
}
|
|
3768
|
-
interface BulkDeleteFoldersResponse {
|
|
3769
|
-
}
|
|
3770
|
-
interface BulkRestoreFoldersFromTrashBinRequest {
|
|
3771
|
-
/** IDs of the folders to restore from the Media Manager's trash bin. */
|
|
3772
|
-
folderIds: string[];
|
|
3773
|
-
}
|
|
3774
|
-
interface BulkRestoreFoldersFromTrashBinResponse {
|
|
3775
|
-
}
|
|
3776
|
-
interface ListDeletedFoldersRequest {
|
|
3777
|
-
/** ID of the folder's parent folder. */
|
|
3778
|
-
parentFolderId?: string | null;
|
|
3779
|
-
/**
|
|
3780
|
-
* Field name and order to sort by. One of:
|
|
3781
|
-
* * `displayName`
|
|
3782
|
-
* * `updatedDate`
|
|
3783
|
-
* Default: `updatedDate` in `desc` order.
|
|
3784
|
-
*/
|
|
3785
|
-
sort?: Sorting;
|
|
3786
|
-
/** Cursor and paging information. */
|
|
3787
|
-
paging?: CursorPaging;
|
|
3788
|
-
}
|
|
3789
|
-
interface ListDeletedFoldersResponse {
|
|
3790
|
-
/** List of folders in the Media Manager's trash bin. */
|
|
3791
|
-
folders?: Folder[];
|
|
3792
|
-
/** The next cursor if it exists. */
|
|
3793
|
-
nextCursor?: PagingMetadataV2;
|
|
3794
|
-
}
|
|
3795
|
-
interface FolderNonNullableFields {
|
|
3796
|
-
_id: string;
|
|
3797
|
-
displayName: string;
|
|
3798
|
-
parentFolderId: string;
|
|
3799
|
-
state: State;
|
|
3800
|
-
namespace: Namespace;
|
|
3801
|
-
}
|
|
3802
|
-
interface CreateFolderResponseNonNullableFields {
|
|
3803
|
-
folder?: FolderNonNullableFields;
|
|
3804
|
-
}
|
|
3805
|
-
interface GetFolderResponseNonNullableFields {
|
|
3806
|
-
folder?: FolderNonNullableFields;
|
|
3807
|
-
}
|
|
3808
|
-
interface ListFoldersResponseNonNullableFields {
|
|
3809
|
-
folders: FolderNonNullableFields[];
|
|
3810
|
-
}
|
|
3811
|
-
interface SearchFoldersResponseNonNullableFields {
|
|
3812
|
-
folders: FolderNonNullableFields[];
|
|
3813
|
-
}
|
|
3814
|
-
interface UpdateFolderResponseNonNullableFields {
|
|
3815
|
-
folder?: FolderNonNullableFields;
|
|
3816
|
-
}
|
|
3817
|
-
interface GenerateFolderDownloadUrlResponseNonNullableFields {
|
|
3818
|
-
downloadUrl: string;
|
|
3819
|
-
}
|
|
3820
|
-
interface ListDeletedFoldersResponseNonNullableFields {
|
|
3821
|
-
folders: FolderNonNullableFields[];
|
|
3822
|
-
}
|
|
3823
|
-
|
|
3824
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3825
|
-
getUrl: (context: any) => string;
|
|
3826
|
-
httpMethod: K;
|
|
3827
|
-
path: string;
|
|
3828
|
-
pathParams: M;
|
|
3829
|
-
__requestType: T;
|
|
3830
|
-
__originalRequestType: S;
|
|
3831
|
-
__responseType: Q;
|
|
3832
|
-
__originalResponseType: R;
|
|
3833
|
-
};
|
|
3834
|
-
declare function createFolder(): __PublicMethodMetaInfo<'POST', {}, CreateFolderRequest, CreateFolderRequest$1, CreateFolderResponse & CreateFolderResponseNonNullableFields, CreateFolderResponse$1 & CreateFolderResponseNonNullableFields$1>;
|
|
3835
|
-
declare function getFolder(): __PublicMethodMetaInfo<'GET', {
|
|
3836
|
-
folderId: string;
|
|
3837
|
-
}, GetFolderRequest, GetFolderRequest$1, GetFolderResponse & GetFolderResponseNonNullableFields, GetFolderResponse$1 & GetFolderResponseNonNullableFields$1>;
|
|
3838
|
-
declare function listFolders(): __PublicMethodMetaInfo<'GET', {}, ListFoldersRequest, ListFoldersRequest$1, ListFoldersResponse & ListFoldersResponseNonNullableFields, ListFoldersResponse$1 & ListFoldersResponseNonNullableFields$1>;
|
|
3839
|
-
declare function searchFolders(): __PublicMethodMetaInfo<'POST', {}, SearchFoldersRequest, SearchFoldersRequest$1, SearchFoldersResponse & SearchFoldersResponseNonNullableFields, SearchFoldersResponse$1 & SearchFoldersResponseNonNullableFields$1>;
|
|
3840
|
-
declare function updateFolder(): __PublicMethodMetaInfo<'PATCH', {
|
|
3841
|
-
folderId: string;
|
|
3842
|
-
}, UpdateFolderRequest, UpdateFolderRequest$1, UpdateFolderResponse & UpdateFolderResponseNonNullableFields, UpdateFolderResponse$1 & UpdateFolderResponseNonNullableFields$1>;
|
|
3843
|
-
declare function generateFolderDownloadUrl(): __PublicMethodMetaInfo<'POST', {
|
|
3844
|
-
folderId: string;
|
|
3845
|
-
}, GenerateFolderDownloadUrlRequest, GenerateFolderDownloadUrlRequest$1, GenerateFolderDownloadUrlResponse & GenerateFolderDownloadUrlResponseNonNullableFields, GenerateFolderDownloadUrlResponse$1 & GenerateFolderDownloadUrlResponseNonNullableFields$1>;
|
|
3846
|
-
declare function bulkDeleteFolders(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteFoldersRequest, BulkDeleteFoldersRequest$1, BulkDeleteFoldersResponse, BulkDeleteFoldersResponse$1>;
|
|
3847
|
-
declare function bulkRestoreFoldersFromTrashBin(): __PublicMethodMetaInfo<'POST', {}, BulkRestoreFoldersFromTrashBinRequest, BulkRestoreFoldersFromTrashBinRequest$1, BulkRestoreFoldersFromTrashBinResponse, BulkRestoreFoldersFromTrashBinResponse$1>;
|
|
3848
|
-
declare function listDeletedFolders(): __PublicMethodMetaInfo<'GET', {}, ListDeletedFoldersRequest, ListDeletedFoldersRequest$1, ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields, ListDeletedFoldersResponse$1 & ListDeletedFoldersResponseNonNullableFields$1>;
|
|
3849
|
-
|
|
3850
|
-
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
3851
|
-
declare const meta_bulkDeleteFolders: typeof bulkDeleteFolders;
|
|
3852
|
-
declare const meta_bulkRestoreFoldersFromTrashBin: typeof bulkRestoreFoldersFromTrashBin;
|
|
3853
|
-
declare const meta_createFolder: typeof createFolder;
|
|
3854
|
-
declare const meta_generateFolderDownloadUrl: typeof generateFolderDownloadUrl;
|
|
3855
|
-
declare const meta_getFolder: typeof getFolder;
|
|
3856
|
-
declare const meta_listDeletedFolders: typeof listDeletedFolders;
|
|
3857
|
-
declare const meta_listFolders: typeof listFolders;
|
|
3858
|
-
declare const meta_searchFolders: typeof searchFolders;
|
|
3859
|
-
declare const meta_updateFolder: typeof updateFolder;
|
|
3860
|
-
declare namespace meta {
|
|
3861
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteFolders as bulkDeleteFolders, meta_bulkRestoreFoldersFromTrashBin as bulkRestoreFoldersFromTrashBin, meta_createFolder as createFolder, meta_generateFolderDownloadUrl as generateFolderDownloadUrl, meta_getFolder as getFolder, meta_listDeletedFolders as listDeletedFolders, meta_listFolders as listFolders, meta_searchFolders as searchFolders, meta_updateFolder as updateFolder };
|
|
3862
|
-
}
|
|
3863
|
-
|
|
3864
|
-
export { meta$3 as enterpriseMediaCategories, meta$2 as enterpriseMediaItems, meta$1 as files, meta as folders };
|