@wix/auto_sdk_media_files 1.0.18 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +315 -1
- package/build/cjs/index.js +2264 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2266 -1
- package/build/cjs/index.typings.js +1935 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1053 -1
- package/build/cjs/meta.js +1326 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → es/index.d.mts} +93 -36
- package/build/es/index.mjs +2212 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts → es/index.typings.d.mts} +227 -487
- package/build/es/index.typings.mjs +1887 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/{internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts → es/meta.d.mts} +106 -585
- package/build/es/meta.mjs +1287 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +315 -1
- package/build/internal/cjs/index.js +2264 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2266 -1
- package/build/internal/cjs/index.typings.js +1935 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1053 -1
- package/build/internal/cjs/meta.js +1326 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → internal/es/index.d.mts} +93 -36
- package/build/internal/es/index.mjs +2212 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/media-site-media-v1-file-descriptor-files.universal.d.ts → index.typings.d.mts} +227 -487
- package/build/internal/es/index.typings.mjs +1887 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/{es/src/media-site-media-v1-file-descriptor-files.types.d.ts → internal/es/meta.d.mts} +106 -585
- package/build/internal/es/meta.mjs +1287 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
package/build/{es/src/media-site-media-v1-file-descriptor-files.types.d.ts → internal/es/meta.d.mts}
RENAMED
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest$1, GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse$1, GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest$1, GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse$1, GetFileDescriptorRequest as GetFileDescriptorRequest$1, GetFileDescriptorResponse as GetFileDescriptorResponse$1, GetFileDescriptorsRequest as GetFileDescriptorsRequest$1, GetFileDescriptorsResponse as GetFileDescriptorsResponse$1, UpdateFileDescriptorRequest as UpdateFileDescriptorRequest$1, UpdateFileDescriptorResponse as UpdateFileDescriptorResponse$1, GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest$1, GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse$1, GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest$1, GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse$1, ImportFileRequest as ImportFileRequest$1, ImportFileResponse as ImportFileResponse$1, BulkImportFilesRequest as BulkImportFilesRequest$1, BulkImportFilesResponse as BulkImportFilesResponse$1, BulkImportFileRequest as BulkImportFileRequest$1, BulkImportFileResponse as BulkImportFileResponse$1, ListFilesRequest as ListFilesRequest$1, ListFilesResponse as ListFilesResponse$1, SearchFilesRequest as SearchFilesRequest$1, SearchFilesResponse as SearchFilesResponse$1, GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest$1, GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse$1, BulkDeleteFilesRequest as BulkDeleteFilesRequest$1, BulkDeleteFilesResponse as BulkDeleteFilesResponse$1, BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest$1, BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse$1, ListDeletedFilesRequest as ListDeletedFilesRequest$1, ListDeletedFilesResponse as ListDeletedFilesResponse$1 } from './index.typings.mjs';
|
|
2
|
+
import '@wix/sdk-types';
|
|
3
|
+
|
|
4
|
+
interface FileDescriptor {
|
|
2
5
|
/**
|
|
3
6
|
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
4
7
|
* @readonly
|
|
@@ -97,7 +100,7 @@ export interface FileDescriptor {
|
|
|
97
100
|
*/
|
|
98
101
|
state?: StateWithLiterals;
|
|
99
102
|
}
|
|
100
|
-
|
|
103
|
+
declare enum MediaType {
|
|
101
104
|
UNKNOWN = "UNKNOWN",
|
|
102
105
|
IMAGE = "IMAGE",
|
|
103
106
|
VIDEO = "VIDEO",
|
|
@@ -109,8 +112,8 @@ export declare enum MediaType {
|
|
|
109
112
|
OTHER = "OTHER"
|
|
110
113
|
}
|
|
111
114
|
/** @enumType */
|
|
112
|
-
|
|
113
|
-
|
|
115
|
+
type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
|
|
116
|
+
interface FileMedia extends FileMediaMediaOneOf {
|
|
114
117
|
/** Information about the image. */
|
|
115
118
|
image?: ImageMedia;
|
|
116
119
|
/** Information about the video. */
|
|
@@ -127,7 +130,7 @@ export interface FileMedia extends FileMediaMediaOneOf {
|
|
|
127
130
|
model3d?: Model3D;
|
|
128
131
|
}
|
|
129
132
|
/** @oneof */
|
|
130
|
-
|
|
133
|
+
interface FileMediaMediaOneOf {
|
|
131
134
|
/** Information about the image. */
|
|
132
135
|
image?: ImageMedia;
|
|
133
136
|
/** Information about the video. */
|
|
@@ -143,7 +146,7 @@ export interface FileMediaMediaOneOf {
|
|
|
143
146
|
/** Information about the 3D Model. */
|
|
144
147
|
model3d?: Model3D;
|
|
145
148
|
}
|
|
146
|
-
|
|
149
|
+
interface ImageMedia {
|
|
147
150
|
/** Image data. */
|
|
148
151
|
image?: Image;
|
|
149
152
|
/** Image colors. */
|
|
@@ -165,7 +168,7 @@ export interface ImageMedia {
|
|
|
165
168
|
*/
|
|
166
169
|
caption?: string | null;
|
|
167
170
|
}
|
|
168
|
-
|
|
171
|
+
interface Image {
|
|
169
172
|
/**
|
|
170
173
|
* enum TextDetection{
|
|
171
174
|
* // No detection was made
|
|
@@ -213,17 +216,7 @@ export interface Image {
|
|
|
213
216
|
*/
|
|
214
217
|
filename?: string | null;
|
|
215
218
|
}
|
|
216
|
-
|
|
217
|
-
/** X-coordinate of the focal point. */
|
|
218
|
-
x?: number;
|
|
219
|
-
/** Y-coordinate of the focal point. */
|
|
220
|
-
y?: number;
|
|
221
|
-
/** crop by height */
|
|
222
|
-
height?: number | null;
|
|
223
|
-
/** crop by width */
|
|
224
|
-
width?: number | null;
|
|
225
|
-
}
|
|
226
|
-
export interface Colors {
|
|
219
|
+
interface Colors {
|
|
227
220
|
/** Main color of the image. */
|
|
228
221
|
prominent?: Color;
|
|
229
222
|
/**
|
|
@@ -232,7 +225,7 @@ export interface Colors {
|
|
|
232
225
|
*/
|
|
233
226
|
palette?: Color[];
|
|
234
227
|
}
|
|
235
|
-
|
|
228
|
+
interface Color {
|
|
236
229
|
/**
|
|
237
230
|
* HEX color.
|
|
238
231
|
* @format COLOR_HEX
|
|
@@ -241,7 +234,7 @@ export interface Color {
|
|
|
241
234
|
/** RGB color. */
|
|
242
235
|
rgb?: ColorRGB;
|
|
243
236
|
}
|
|
244
|
-
|
|
237
|
+
interface ColorRGB {
|
|
245
238
|
/**
|
|
246
239
|
* Red channel.
|
|
247
240
|
* @max 255
|
|
@@ -273,7 +266,7 @@ export interface ColorRGB {
|
|
|
273
266
|
* | |
|
|
274
267
|
* |______________________|
|
|
275
268
|
*/
|
|
276
|
-
|
|
269
|
+
interface FaceRecognition {
|
|
277
270
|
/** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
|
|
278
271
|
confidence?: number;
|
|
279
272
|
/** Top left x pixel coordinate of the face. */
|
|
@@ -285,7 +278,7 @@ export interface FaceRecognition {
|
|
|
285
278
|
/** Face pixel width. */
|
|
286
279
|
width?: number;
|
|
287
280
|
}
|
|
288
|
-
|
|
281
|
+
interface VideoV2 {
|
|
289
282
|
/** WixMedia ID. */
|
|
290
283
|
id?: string;
|
|
291
284
|
/**
|
|
@@ -300,7 +293,7 @@ export interface VideoV2 {
|
|
|
300
293
|
*/
|
|
301
294
|
filename?: string | null;
|
|
302
295
|
}
|
|
303
|
-
|
|
296
|
+
interface VideoResolution {
|
|
304
297
|
/** Video URL. */
|
|
305
298
|
url?: string;
|
|
306
299
|
/** Video height. */
|
|
@@ -314,7 +307,7 @@ export interface VideoResolution {
|
|
|
314
307
|
*/
|
|
315
308
|
format?: string;
|
|
316
309
|
}
|
|
317
|
-
|
|
310
|
+
interface AudioV2 {
|
|
318
311
|
/**
|
|
319
312
|
* WixMedia ID.
|
|
320
313
|
* @maxLength 200
|
|
@@ -349,7 +342,7 @@ export interface AudioV2 {
|
|
|
349
342
|
*/
|
|
350
343
|
sizeInBytes?: string | null;
|
|
351
344
|
}
|
|
352
|
-
|
|
345
|
+
interface Audio {
|
|
353
346
|
/** WixMedia ID. */
|
|
354
347
|
id?: string;
|
|
355
348
|
/** Audio URL. */
|
|
@@ -360,7 +353,7 @@ export interface Audio {
|
|
|
360
353
|
*/
|
|
361
354
|
filename?: string | null;
|
|
362
355
|
}
|
|
363
|
-
|
|
356
|
+
interface Document {
|
|
364
357
|
/** WixMedia ID. */
|
|
365
358
|
id?: string;
|
|
366
359
|
/** Document URL. */
|
|
@@ -368,7 +361,7 @@ export interface Document {
|
|
|
368
361
|
/** Document filename. */
|
|
369
362
|
filename?: string | null;
|
|
370
363
|
}
|
|
371
|
-
|
|
364
|
+
interface Archive {
|
|
372
365
|
/** WixMedia ID. */
|
|
373
366
|
id?: string;
|
|
374
367
|
/** Archive URL. */
|
|
@@ -386,7 +379,7 @@ export interface Archive {
|
|
|
386
379
|
/** Archive filename. */
|
|
387
380
|
filename?: string | null;
|
|
388
381
|
}
|
|
389
|
-
|
|
382
|
+
interface Model3D {
|
|
390
383
|
/** WixMedia 3D ID. */
|
|
391
384
|
id?: string;
|
|
392
385
|
/** 3D URL. */
|
|
@@ -412,84 +405,7 @@ export interface Model3D {
|
|
|
412
405
|
*/
|
|
413
406
|
sizeInBytes?: string | null;
|
|
414
407
|
}
|
|
415
|
-
|
|
416
|
-
/**
|
|
417
|
-
* WixMedia ID. for use with Site Media APIs only
|
|
418
|
-
* @maxLength 200
|
|
419
|
-
*/
|
|
420
|
-
id?: string;
|
|
421
|
-
/**
|
|
422
|
-
* The media type of the file: 'package', 'raw'
|
|
423
|
-
* @readonly
|
|
424
|
-
* @maxLength 100
|
|
425
|
-
*/
|
|
426
|
-
internalMediaType?: string | null;
|
|
427
|
-
/**
|
|
428
|
-
* size in bytes. Optional.
|
|
429
|
-
* @readonly
|
|
430
|
-
* @format DECIMAL_VALUE
|
|
431
|
-
* @decimalValue options { gte:0, maxScale:0 }
|
|
432
|
-
*/
|
|
433
|
-
sizeInBytes?: string | null;
|
|
434
|
-
/**
|
|
435
|
-
* The file URL.
|
|
436
|
-
* @format WEB_URL
|
|
437
|
-
*/
|
|
438
|
-
url?: string;
|
|
439
|
-
}
|
|
440
|
-
export interface FontMedia {
|
|
441
|
-
/**
|
|
442
|
-
* WixMedia ID. for use with Site Media APIs only
|
|
443
|
-
* @maxLength 200
|
|
444
|
-
*/
|
|
445
|
-
id?: string | null;
|
|
446
|
-
/**
|
|
447
|
-
* size in bytes. Optional.
|
|
448
|
-
* @readonly
|
|
449
|
-
* @format DECIMAL_VALUE
|
|
450
|
-
* @decimalValue options { gte:0, maxScale:0 }
|
|
451
|
-
*/
|
|
452
|
-
sizeInBytes?: string | null;
|
|
453
|
-
/**
|
|
454
|
-
* The format of the font asset. ttf, woff, woff2
|
|
455
|
-
* @maxLength 200
|
|
456
|
-
*/
|
|
457
|
-
format?: string | null;
|
|
458
|
-
/**
|
|
459
|
-
* The font family name.
|
|
460
|
-
* @maxLength 100
|
|
461
|
-
*/
|
|
462
|
-
family?: string | null;
|
|
463
|
-
/**
|
|
464
|
-
* The font name
|
|
465
|
-
* @maxLength 100
|
|
466
|
-
*/
|
|
467
|
-
fontName?: string | null;
|
|
468
|
-
/**
|
|
469
|
-
* Font formats available for this file.
|
|
470
|
-
* @maxSize 5
|
|
471
|
-
*/
|
|
472
|
-
assets?: FontAsset[];
|
|
473
|
-
}
|
|
474
|
-
export interface FontAsset {
|
|
475
|
-
/**
|
|
476
|
-
* Keys for downloading different assets of a file.
|
|
477
|
-
* Default: `src`, key representing the original file's format and quality.
|
|
478
|
-
* @maxLength 100
|
|
479
|
-
*/
|
|
480
|
-
assetKey?: string | null;
|
|
481
|
-
/**
|
|
482
|
-
* The URL of the font asset.
|
|
483
|
-
* @maxLength 200
|
|
484
|
-
*/
|
|
485
|
-
url?: string | null;
|
|
486
|
-
/**
|
|
487
|
-
* The format of the font asset. ttf, woff, woff2
|
|
488
|
-
* @maxLength 200
|
|
489
|
-
*/
|
|
490
|
-
format?: string | null;
|
|
491
|
-
}
|
|
492
|
-
export declare enum OperationStatus {
|
|
408
|
+
declare enum OperationStatus {
|
|
493
409
|
/** File upload or processing failed */
|
|
494
410
|
FAILED = "FAILED",
|
|
495
411
|
/** File is ready for consumption */
|
|
@@ -498,72 +414,16 @@ export declare enum OperationStatus {
|
|
|
498
414
|
PENDING = "PENDING"
|
|
499
415
|
}
|
|
500
416
|
/** @enumType */
|
|
501
|
-
|
|
502
|
-
|
|
417
|
+
type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
|
|
418
|
+
declare enum State {
|
|
503
419
|
/** File is ready for consumption */
|
|
504
420
|
OK = "OK",
|
|
505
421
|
/** Deleted file */
|
|
506
422
|
DELETED = "DELETED"
|
|
507
423
|
}
|
|
508
424
|
/** @enumType */
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
NO_NAMESPACE = "NO_NAMESPACE",
|
|
512
|
-
OTHERS = "OTHERS",
|
|
513
|
-
/** ANY = 2; */
|
|
514
|
-
WIX_VIDEO = "WIX_VIDEO",
|
|
515
|
-
/** _nsWixMusic */
|
|
516
|
-
WIX_MUSIC = "WIX_MUSIC",
|
|
517
|
-
/** _nsArtStore */
|
|
518
|
-
ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
|
|
519
|
-
/** _nsDigitalProduct */
|
|
520
|
-
WIX_ECOM = "WIX_ECOM",
|
|
521
|
-
/** _nsPhotoShareApp */
|
|
522
|
-
PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
|
|
523
|
-
/** _nsSharingApp, */
|
|
524
|
-
SHARING_APP = "SHARING_APP",
|
|
525
|
-
/** engage */
|
|
526
|
-
CHAT = "CHAT",
|
|
527
|
-
/** logobuilder */
|
|
528
|
-
LOGO_BUILDER = "LOGO_BUILDER",
|
|
529
|
-
/** WixExposure */
|
|
530
|
-
ALBUMS_OLD = "ALBUMS_OLD",
|
|
531
|
-
/** chat-mobile-uploads */
|
|
532
|
-
CHAT_MOBILE = "CHAT_MOBILE",
|
|
533
|
-
/** _nsWixForms */
|
|
534
|
-
WIX_FORMS = "WIX_FORMS",
|
|
535
|
-
/** _nsWixLegends */
|
|
536
|
-
WIX_LEGENDS = "WIX_LEGENDS"
|
|
537
|
-
}
|
|
538
|
-
/** @enumType */
|
|
539
|
-
export type NamespaceWithLiterals = Namespace | 'NO_NAMESPACE' | 'OTHERS' | 'WIX_VIDEO' | 'WIX_MUSIC' | 'ALBUMS_AND_ART_STORE' | 'WIX_ECOM' | 'PHOTO_SHARE_APP' | 'SHARING_APP' | 'CHAT' | 'LOGO_BUILDER' | 'ALBUMS_OLD' | 'CHAT_MOBILE' | 'WIX_FORMS' | 'WIX_LEGENDS';
|
|
540
|
-
export interface IdentityInfo {
|
|
541
|
-
/** The type of the user that uploaded the file */
|
|
542
|
-
identityType?: IdentityTypeWithLiterals;
|
|
543
|
-
/**
|
|
544
|
-
* User Id. empty when UNKNOWN
|
|
545
|
-
* @format GUID
|
|
546
|
-
*/
|
|
547
|
-
identityId?: string | null;
|
|
548
|
-
}
|
|
549
|
-
export declare enum IdentityType {
|
|
550
|
-
UNKNOWN = "UNKNOWN",
|
|
551
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
552
|
-
MEMBER = "MEMBER",
|
|
553
|
-
WIX_USER = "WIX_USER",
|
|
554
|
-
APP = "APP"
|
|
555
|
-
}
|
|
556
|
-
/** @enumType */
|
|
557
|
-
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
558
|
-
export interface FileReady {
|
|
559
|
-
/** File entity that is ready with full information. */
|
|
560
|
-
file?: FileDescriptor;
|
|
561
|
-
/** External information specified in the file import or upload. */
|
|
562
|
-
externalInfo?: ExternalInfo;
|
|
563
|
-
/** File was restored from the trash-bin. */
|
|
564
|
-
triggeredByUndelete?: boolean;
|
|
565
|
-
}
|
|
566
|
-
export interface ExternalInfo {
|
|
425
|
+
type StateWithLiterals = State | 'OK' | 'DELETED';
|
|
426
|
+
interface ExternalInfo {
|
|
567
427
|
/**
|
|
568
428
|
* External information to specify in the File Ready or File Failed events.
|
|
569
429
|
* @maxLength 1000
|
|
@@ -576,13 +436,7 @@ export interface ExternalInfo {
|
|
|
576
436
|
*/
|
|
577
437
|
externalIds?: string[];
|
|
578
438
|
}
|
|
579
|
-
|
|
580
|
-
/** External information specified in the file import or upload. */
|
|
581
|
-
externalInfo?: ExternalInfo;
|
|
582
|
-
/** Error information. */
|
|
583
|
-
error?: ApplicationError;
|
|
584
|
-
}
|
|
585
|
-
export interface ApplicationError {
|
|
439
|
+
interface ApplicationError {
|
|
586
440
|
/** Error code. */
|
|
587
441
|
code?: string;
|
|
588
442
|
/** Description of the error. */
|
|
@@ -590,58 +444,7 @@ export interface ApplicationError {
|
|
|
590
444
|
/** Data related to the error. */
|
|
591
445
|
data?: Record<string, any> | null;
|
|
592
446
|
}
|
|
593
|
-
|
|
594
|
-
/** The file after it was published */
|
|
595
|
-
file?: FileDescriptor;
|
|
596
|
-
/** The namespace the file was published to */
|
|
597
|
-
namespace?: NamespaceWithLiterals;
|
|
598
|
-
}
|
|
599
|
-
export interface BulkAnnotateImagesRequest {
|
|
600
|
-
/**
|
|
601
|
-
* The file ids to run detection on
|
|
602
|
-
* @minSize 1
|
|
603
|
-
* @maxSize 10
|
|
604
|
-
* @maxLength 1000
|
|
605
|
-
*/
|
|
606
|
-
fileIds?: string[];
|
|
607
|
-
/**
|
|
608
|
-
* A list of detections types to fill for the image
|
|
609
|
-
* @minSize 1
|
|
610
|
-
* @maxSize 10
|
|
611
|
-
*/
|
|
612
|
-
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
613
|
-
/** When true the endpoint will detect listed information even if the image has this information */
|
|
614
|
-
overwrite?: boolean | null;
|
|
615
|
-
/** Should the response return the item following the operation */
|
|
616
|
-
returnEntity?: boolean;
|
|
617
|
-
}
|
|
618
|
-
export declare enum ImageAnnotationType {
|
|
619
|
-
UNKNOWN_IMAGE_ANNOTATION_TYPE = "UNKNOWN_IMAGE_ANNOTATION_TYPE",
|
|
620
|
-
CONTAINS_TEXT = "CONTAINS_TEXT",
|
|
621
|
-
IS_ANIMATED = "IS_ANIMATED",
|
|
622
|
-
FACES = "FACES",
|
|
623
|
-
LABELS = "LABELS",
|
|
624
|
-
COLORS = "COLORS",
|
|
625
|
-
CAPTION = "CAPTION"
|
|
626
|
-
}
|
|
627
|
-
/** @enumType */
|
|
628
|
-
export type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
|
|
629
|
-
export interface BulkAnnotateImagesResponse {
|
|
630
|
-
/** Results of individual items */
|
|
631
|
-
results?: BulkAnnotateImageResult[];
|
|
632
|
-
/** Metadata of the operation */
|
|
633
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
634
|
-
}
|
|
635
|
-
export interface BulkAnnotateImageResult {
|
|
636
|
-
/** Item metadata */
|
|
637
|
-
itemMetadata?: ItemMetadata;
|
|
638
|
-
/**
|
|
639
|
-
* The item following the operation
|
|
640
|
-
* Only returned if operation was successful and if returnEntity flag was on
|
|
641
|
-
*/
|
|
642
|
-
item?: FileDescriptor;
|
|
643
|
-
}
|
|
644
|
-
export interface ItemMetadata {
|
|
447
|
+
interface ItemMetadata {
|
|
645
448
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
646
449
|
id?: string | null;
|
|
647
450
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -651,7 +454,7 @@ export interface ItemMetadata {
|
|
|
651
454
|
/** Details about the error in case of failure. */
|
|
652
455
|
error?: ApplicationError;
|
|
653
456
|
}
|
|
654
|
-
|
|
457
|
+
interface BulkActionMetadata {
|
|
655
458
|
/** Number of items that were successfully processed. */
|
|
656
459
|
totalSuccesses?: number;
|
|
657
460
|
/** Number of items that couldn't be processed. */
|
|
@@ -659,7 +462,7 @@ export interface BulkActionMetadata {
|
|
|
659
462
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
660
463
|
undetailedFailures?: number;
|
|
661
464
|
}
|
|
662
|
-
|
|
465
|
+
interface GenerateFilesDownloadUrlRequest {
|
|
663
466
|
/**
|
|
664
467
|
* IDs of the files to download.
|
|
665
468
|
*
|
|
@@ -671,14 +474,14 @@ export interface GenerateFilesDownloadUrlRequest {
|
|
|
671
474
|
*/
|
|
672
475
|
fileIds: string[];
|
|
673
476
|
}
|
|
674
|
-
|
|
477
|
+
interface GenerateFilesDownloadUrlResponse {
|
|
675
478
|
/**
|
|
676
479
|
* URL for downloading the compressed file containing the specified files in the Media Manager.
|
|
677
480
|
* @format WEB_URL
|
|
678
481
|
*/
|
|
679
482
|
downloadUrl?: string;
|
|
680
483
|
}
|
|
681
|
-
|
|
484
|
+
interface GenerateFileDownloadUrlRequest {
|
|
682
485
|
/**
|
|
683
486
|
* File ID.
|
|
684
487
|
*
|
|
@@ -724,22 +527,22 @@ export interface GenerateFileDownloadUrlRequest {
|
|
|
724
527
|
*/
|
|
725
528
|
contentDisposition?: ContentDispositionWithLiterals;
|
|
726
529
|
}
|
|
727
|
-
|
|
530
|
+
declare enum ContentDisposition {
|
|
728
531
|
/** Using the link in the browser will download the file */
|
|
729
532
|
ATTACHMENT = "ATTACHMENT",
|
|
730
533
|
/** Using the link in the browser will open the file in the browser */
|
|
731
534
|
INLINE = "INLINE"
|
|
732
535
|
}
|
|
733
536
|
/** @enumType */
|
|
734
|
-
|
|
735
|
-
|
|
537
|
+
type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
|
|
538
|
+
interface GenerateFileDownloadUrlResponse {
|
|
736
539
|
/**
|
|
737
540
|
* URL for downloading a specific file in the Media Manager.
|
|
738
541
|
* @maxSize 100
|
|
739
542
|
*/
|
|
740
543
|
downloadUrls?: DownloadUrl[];
|
|
741
544
|
}
|
|
742
|
-
|
|
545
|
+
interface DownloadUrl {
|
|
743
546
|
/**
|
|
744
547
|
* The file download URL.
|
|
745
548
|
* @format WEB_URL
|
|
@@ -752,22 +555,7 @@ export interface DownloadUrl {
|
|
|
752
555
|
*/
|
|
753
556
|
assetKey?: string;
|
|
754
557
|
}
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* Error codes are groups of related errors
|
|
758
|
-
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
759
|
-
* @maxLength 200
|
|
760
|
-
*/
|
|
761
|
-
internalCode?: string | null;
|
|
762
|
-
/** Debugging information, http status code returned from wix media internal API */
|
|
763
|
-
internalHttpStatusCode?: number | null;
|
|
764
|
-
/**
|
|
765
|
-
* Optional Debugging information, error key will represent the error "family" returned from wix media internal API
|
|
766
|
-
* @maxLength 200
|
|
767
|
-
*/
|
|
768
|
-
internalKey?: string | null;
|
|
769
|
-
}
|
|
770
|
-
export interface GetFileDescriptorRequest {
|
|
558
|
+
interface GetFileDescriptorRequest {
|
|
771
559
|
/**
|
|
772
560
|
* File ID.
|
|
773
561
|
*
|
|
@@ -779,11 +567,11 @@ export interface GetFileDescriptorRequest {
|
|
|
779
567
|
*/
|
|
780
568
|
fileId: string;
|
|
781
569
|
}
|
|
782
|
-
|
|
570
|
+
interface GetFileDescriptorResponse {
|
|
783
571
|
/** Information about the file. */
|
|
784
572
|
file?: FileDescriptor;
|
|
785
573
|
}
|
|
786
|
-
|
|
574
|
+
interface GetFileDescriptorsRequest {
|
|
787
575
|
/**
|
|
788
576
|
* File IDs.
|
|
789
577
|
*
|
|
@@ -795,35 +583,22 @@ export interface GetFileDescriptorsRequest {
|
|
|
795
583
|
*/
|
|
796
584
|
fileIds: string[];
|
|
797
585
|
}
|
|
798
|
-
|
|
586
|
+
interface GetFileDescriptorsResponse {
|
|
799
587
|
/**
|
|
800
588
|
* Information about the requested files.
|
|
801
589
|
* @maxSize 100
|
|
802
590
|
*/
|
|
803
591
|
files?: FileDescriptor[];
|
|
804
592
|
}
|
|
805
|
-
|
|
593
|
+
interface UpdateFileDescriptorRequest {
|
|
806
594
|
/** The file to update. */
|
|
807
595
|
file: FileDescriptor;
|
|
808
596
|
}
|
|
809
|
-
|
|
597
|
+
interface UpdateFileDescriptorResponse {
|
|
810
598
|
/** Information about the updated file. */
|
|
811
599
|
file?: FileDescriptor;
|
|
812
600
|
}
|
|
813
|
-
|
|
814
|
-
/**
|
|
815
|
-
* Optional A list of allowed values
|
|
816
|
-
* @maxSize 100
|
|
817
|
-
* @maxLength 200
|
|
818
|
-
*/
|
|
819
|
-
allowedValues?: string[];
|
|
820
|
-
/**
|
|
821
|
-
* The unsupported value send in the request
|
|
822
|
-
* @maxLength 200
|
|
823
|
-
*/
|
|
824
|
-
requestValue?: string;
|
|
825
|
-
}
|
|
826
|
-
export interface GenerateFileUploadUrlRequest {
|
|
601
|
+
interface GenerateFileUploadUrlRequest {
|
|
827
602
|
/**
|
|
828
603
|
* File mime type.
|
|
829
604
|
* @maxLength 100
|
|
@@ -868,73 +643,14 @@ export interface GenerateFileUploadUrlRequest {
|
|
|
868
643
|
*/
|
|
869
644
|
filePath?: string | null;
|
|
870
645
|
}
|
|
871
|
-
|
|
872
|
-
/** Whether to skip detection for the image */
|
|
873
|
-
skipDetection?: boolean | null;
|
|
874
|
-
/**
|
|
875
|
-
* A list of detections types to fill for the image
|
|
876
|
-
* If specified at least one valid annotation type should be provided
|
|
877
|
-
* Default will be all detections
|
|
878
|
-
* @maxSize 10
|
|
879
|
-
*/
|
|
880
|
-
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
881
|
-
}
|
|
882
|
-
export interface GenerateFileUploadUrlResponse {
|
|
646
|
+
interface GenerateFileUploadUrlResponse {
|
|
883
647
|
/**
|
|
884
648
|
* The URL for uploading a file to the Media Manager.
|
|
885
649
|
* @format WEB_URL
|
|
886
650
|
*/
|
|
887
651
|
uploadUrl?: string;
|
|
888
652
|
}
|
|
889
|
-
|
|
890
|
-
/**
|
|
891
|
-
* Error codes are groups of related errors
|
|
892
|
-
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
893
|
-
* @maxLength 200
|
|
894
|
-
*/
|
|
895
|
-
internalCode?: string | null;
|
|
896
|
-
/** Debugging information, http status code returned from wix media internal API */
|
|
897
|
-
internalHttpStatusCode?: number | null;
|
|
898
|
-
/**
|
|
899
|
-
* Optional Debugging information, error key will represent the error "family" returned from wix media internal API
|
|
900
|
-
* @maxLength 200
|
|
901
|
-
*/
|
|
902
|
-
internalKey?: string | null;
|
|
903
|
-
/** The quota details */
|
|
904
|
-
quota?: TotalQuota;
|
|
905
|
-
}
|
|
906
|
-
export interface TotalQuota {
|
|
907
|
-
/** Storage quota in bytes */
|
|
908
|
-
storage?: string | null;
|
|
909
|
-
/** Plans that are related to the quota */
|
|
910
|
-
plans?: Plans;
|
|
911
|
-
/** Time for which the quota is relevant - When the plans were retrieved from premium */
|
|
912
|
-
timestamp?: Date | null;
|
|
913
|
-
}
|
|
914
|
-
export interface Plans {
|
|
915
|
-
/** Premium Plan */
|
|
916
|
-
premium?: Plan;
|
|
917
|
-
/**
|
|
918
|
-
* Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available.
|
|
919
|
-
* @format WEB_URL
|
|
920
|
-
*/
|
|
921
|
-
upgradeUrl?: string;
|
|
922
|
-
}
|
|
923
|
-
export interface Plan {
|
|
924
|
-
/**
|
|
925
|
-
* Plan ID - Premium product ID
|
|
926
|
-
* @readonly
|
|
927
|
-
* @format GUID
|
|
928
|
-
*/
|
|
929
|
-
id?: string;
|
|
930
|
-
/** Plan name */
|
|
931
|
-
name?: string;
|
|
932
|
-
/** When the plan was created */
|
|
933
|
-
createdAt?: Date | null;
|
|
934
|
-
/** When then plan expires */
|
|
935
|
-
expiresAt?: Date | null;
|
|
936
|
-
}
|
|
937
|
-
export interface GenerateFileResumableUploadUrlRequest {
|
|
653
|
+
interface GenerateFileResumableUploadUrlRequest {
|
|
938
654
|
/**
|
|
939
655
|
* File mime type.
|
|
940
656
|
* @maxLength 100
|
|
@@ -979,13 +695,13 @@ export interface GenerateFileResumableUploadUrlRequest {
|
|
|
979
695
|
*/
|
|
980
696
|
filePath?: string | null;
|
|
981
697
|
}
|
|
982
|
-
|
|
698
|
+
declare enum UploadProtocol {
|
|
983
699
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
984
700
|
TUS = "TUS"
|
|
985
701
|
}
|
|
986
702
|
/** @enumType */
|
|
987
|
-
|
|
988
|
-
|
|
703
|
+
type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
|
|
704
|
+
interface GenerateFileResumableUploadUrlResponse {
|
|
989
705
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
990
706
|
uploadProtocol?: UploadProtocolWithLiterals;
|
|
991
707
|
/**
|
|
@@ -999,7 +715,7 @@ export interface GenerateFileResumableUploadUrlResponse {
|
|
|
999
715
|
*/
|
|
1000
716
|
uploadToken?: string;
|
|
1001
717
|
}
|
|
1002
|
-
|
|
718
|
+
interface ImportFileRequest {
|
|
1003
719
|
/**
|
|
1004
720
|
* Publicly accessible external file URL.
|
|
1005
721
|
* @format WEB_URL
|
|
@@ -1050,11 +766,11 @@ export interface ImportFileRequest {
|
|
|
1050
766
|
*/
|
|
1051
767
|
filePath?: string | null;
|
|
1052
768
|
}
|
|
1053
|
-
|
|
769
|
+
interface ImportFileResponse {
|
|
1054
770
|
/** Information about the imported file. */
|
|
1055
771
|
file?: FileDescriptor;
|
|
1056
772
|
}
|
|
1057
|
-
|
|
773
|
+
interface BulkImportFilesRequest {
|
|
1058
774
|
/**
|
|
1059
775
|
* Information about the files to import.
|
|
1060
776
|
* @minSize 1
|
|
@@ -1062,14 +778,14 @@ export interface BulkImportFilesRequest {
|
|
|
1062
778
|
*/
|
|
1063
779
|
importFileRequests: ImportFileRequest[];
|
|
1064
780
|
}
|
|
1065
|
-
|
|
781
|
+
interface BulkImportFilesResponse {
|
|
1066
782
|
/**
|
|
1067
783
|
* Information about the imported files.
|
|
1068
784
|
* @maxSize 100
|
|
1069
785
|
*/
|
|
1070
786
|
files?: FileDescriptor[];
|
|
1071
787
|
}
|
|
1072
|
-
|
|
788
|
+
interface BulkImportFileRequest {
|
|
1073
789
|
/**
|
|
1074
790
|
* Information about the files to import.
|
|
1075
791
|
* @minSize 1
|
|
@@ -1079,19 +795,19 @@ export interface BulkImportFileRequest {
|
|
|
1079
795
|
/** Default: `true` */
|
|
1080
796
|
returnEntity?: boolean | null;
|
|
1081
797
|
}
|
|
1082
|
-
|
|
798
|
+
interface BulkImportFileResponse {
|
|
1083
799
|
/** Items created by bulk action. */
|
|
1084
800
|
results?: BulkImportFileResult[];
|
|
1085
801
|
/** Bulk action metadata. */
|
|
1086
802
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1087
803
|
}
|
|
1088
|
-
|
|
804
|
+
interface BulkImportFileResult {
|
|
1089
805
|
/** Item metadata. */
|
|
1090
806
|
itemMetadata?: ItemMetadata;
|
|
1091
807
|
/** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
|
|
1092
808
|
item?: FileDescriptor;
|
|
1093
809
|
}
|
|
1094
|
-
|
|
810
|
+
interface ListFilesRequest {
|
|
1095
811
|
/**
|
|
1096
812
|
* ID of the file's parent folder. <br />
|
|
1097
813
|
* Default:`media-root`.
|
|
@@ -1116,7 +832,7 @@ export interface ListFilesRequest {
|
|
|
1116
832
|
/** Cursor and paging information. */
|
|
1117
833
|
paging?: CursorPaging;
|
|
1118
834
|
}
|
|
1119
|
-
|
|
835
|
+
interface Sorting {
|
|
1120
836
|
/**
|
|
1121
837
|
* Name of the field to sort by.
|
|
1122
838
|
* @maxLength 512
|
|
@@ -1125,13 +841,13 @@ export interface Sorting {
|
|
|
1125
841
|
/** Sort order. */
|
|
1126
842
|
order?: SortOrderWithLiterals;
|
|
1127
843
|
}
|
|
1128
|
-
|
|
844
|
+
declare enum SortOrder {
|
|
1129
845
|
ASC = "ASC",
|
|
1130
846
|
DESC = "DESC"
|
|
1131
847
|
}
|
|
1132
848
|
/** @enumType */
|
|
1133
|
-
|
|
1134
|
-
|
|
849
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
850
|
+
interface CursorPaging {
|
|
1135
851
|
/**
|
|
1136
852
|
* Maximum number of items to return in the results.
|
|
1137
853
|
* @max 100
|
|
@@ -1146,7 +862,7 @@ export interface CursorPaging {
|
|
|
1146
862
|
*/
|
|
1147
863
|
cursor?: string | null;
|
|
1148
864
|
}
|
|
1149
|
-
|
|
865
|
+
interface ListFilesResponse {
|
|
1150
866
|
/**
|
|
1151
867
|
* List of files in the Media Manager.
|
|
1152
868
|
* @maxSize 200
|
|
@@ -1155,20 +871,20 @@ export interface ListFilesResponse {
|
|
|
1155
871
|
/** The next cursor if it exists. */
|
|
1156
872
|
nextCursor?: PagingMetadataV2;
|
|
1157
873
|
}
|
|
1158
|
-
|
|
874
|
+
interface PagingMetadataV2 {
|
|
1159
875
|
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1160
876
|
total?: number | null;
|
|
1161
877
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1162
878
|
cursors?: Cursors;
|
|
1163
879
|
}
|
|
1164
|
-
|
|
880
|
+
interface Cursors {
|
|
1165
881
|
/**
|
|
1166
882
|
* Cursor string pointing to the next page in the list of results.
|
|
1167
883
|
* @maxLength 16000
|
|
1168
884
|
*/
|
|
1169
885
|
next?: string | null;
|
|
1170
886
|
}
|
|
1171
|
-
|
|
887
|
+
interface SearchFilesRequest {
|
|
1172
888
|
/**
|
|
1173
889
|
* Term to search for. Possible terms include the value of a file's
|
|
1174
890
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
@@ -1199,7 +915,7 @@ export interface SearchFilesRequest {
|
|
|
1199
915
|
/** Cursor and paging information. */
|
|
1200
916
|
paging?: CursorPaging;
|
|
1201
917
|
}
|
|
1202
|
-
|
|
918
|
+
declare enum RootFolder {
|
|
1203
919
|
/** Root of all site media */
|
|
1204
920
|
MEDIA_ROOT = "MEDIA_ROOT",
|
|
1205
921
|
/** Root of the trash system folder */
|
|
@@ -1208,8 +924,8 @@ export declare enum RootFolder {
|
|
|
1208
924
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
1209
925
|
}
|
|
1210
926
|
/** @enumType */
|
|
1211
|
-
|
|
1212
|
-
|
|
927
|
+
type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
|
|
928
|
+
interface SearchFilesResponse {
|
|
1213
929
|
/**
|
|
1214
930
|
* Files matching the query.
|
|
1215
931
|
* @maxSize 200
|
|
@@ -1218,7 +934,7 @@ export interface SearchFilesResponse {
|
|
|
1218
934
|
/** The next cursor if it exists. */
|
|
1219
935
|
nextCursor?: PagingMetadataV2;
|
|
1220
936
|
}
|
|
1221
|
-
|
|
937
|
+
interface GenerateVideoStreamingUrlRequest {
|
|
1222
938
|
/**
|
|
1223
939
|
* File ID.
|
|
1224
940
|
*
|
|
@@ -1230,27 +946,18 @@ export interface GenerateVideoStreamingUrlRequest {
|
|
|
1230
946
|
/** Video stream format. */
|
|
1231
947
|
format?: StreamFormatWithLiterals;
|
|
1232
948
|
}
|
|
1233
|
-
|
|
949
|
+
declare enum StreamFormat {
|
|
1234
950
|
UNKNOWN = "UNKNOWN",
|
|
1235
951
|
HLS = "HLS",
|
|
1236
952
|
DASH = "DASH"
|
|
1237
953
|
}
|
|
1238
954
|
/** @enumType */
|
|
1239
|
-
|
|
1240
|
-
|
|
955
|
+
type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
|
|
956
|
+
interface GenerateVideoStreamingUrlResponse {
|
|
1241
957
|
/** URL for streaming a specific file in the Media Manager. */
|
|
1242
958
|
downloadUrl?: DownloadUrl;
|
|
1243
959
|
}
|
|
1244
|
-
|
|
1245
|
-
}
|
|
1246
|
-
export interface GenerateWebSocketTokenResponse {
|
|
1247
|
-
/**
|
|
1248
|
-
* The web socket token for the identity in the request
|
|
1249
|
-
* @maxLength 2000
|
|
1250
|
-
*/
|
|
1251
|
-
token?: string;
|
|
1252
|
-
}
|
|
1253
|
-
export interface BulkDeleteFilesRequest {
|
|
960
|
+
interface BulkDeleteFilesRequest {
|
|
1254
961
|
/**
|
|
1255
962
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1256
963
|
*
|
|
@@ -1266,9 +973,9 @@ export interface BulkDeleteFilesRequest {
|
|
|
1266
973
|
*/
|
|
1267
974
|
permanent?: boolean;
|
|
1268
975
|
}
|
|
1269
|
-
|
|
976
|
+
interface BulkDeleteFilesResponse {
|
|
1270
977
|
}
|
|
1271
|
-
|
|
978
|
+
interface BulkRestoreFilesFromTrashBinRequest {
|
|
1272
979
|
/**
|
|
1273
980
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1274
981
|
*
|
|
@@ -1279,9 +986,9 @@ export interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1279
986
|
*/
|
|
1280
987
|
fileIds: string[];
|
|
1281
988
|
}
|
|
1282
|
-
|
|
989
|
+
interface BulkRestoreFilesFromTrashBinResponse {
|
|
1283
990
|
}
|
|
1284
|
-
|
|
991
|
+
interface ListDeletedFilesRequest {
|
|
1285
992
|
/**
|
|
1286
993
|
* ID of the file's parent folder. <br />
|
|
1287
994
|
* Default: `media-root`.
|
|
@@ -1306,7 +1013,7 @@ export interface ListDeletedFilesRequest {
|
|
|
1306
1013
|
/** Cursor and paging information. */
|
|
1307
1014
|
paging?: CursorPaging;
|
|
1308
1015
|
}
|
|
1309
|
-
|
|
1016
|
+
interface ListDeletedFilesResponse {
|
|
1310
1017
|
/**
|
|
1311
1018
|
* List of files in the Media Manager's trash bin.
|
|
1312
1019
|
* @maxSize 200
|
|
@@ -1315,218 +1022,32 @@ export interface ListDeletedFilesResponse {
|
|
|
1315
1022
|
/** The next cursor if it exists. */
|
|
1316
1023
|
nextCursor?: PagingMetadataV2;
|
|
1317
1024
|
}
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
filePath?: string | null;
|
|
1348
|
-
/** Should the response return the item following the operation */
|
|
1349
|
-
returnEntity?: boolean;
|
|
1350
|
-
}
|
|
1351
|
-
export interface BulkPublishDraftFilesResponse {
|
|
1352
|
-
/** Results of individual items */
|
|
1353
|
-
results?: BulkPublishDraftFileResult[];
|
|
1354
|
-
/** Metadata of the operation */
|
|
1355
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1356
|
-
}
|
|
1357
|
-
export interface BulkPublishDraftFileResult {
|
|
1358
|
-
/** Item metadata */
|
|
1359
|
-
itemMetadata?: ItemMetadata;
|
|
1360
|
-
/**
|
|
1361
|
-
* The item following the operation
|
|
1362
|
-
* Only returned if operation was successful and if returnEntity flag was on
|
|
1363
|
-
*/
|
|
1364
|
-
item?: FileDescriptor;
|
|
1365
|
-
}
|
|
1366
|
-
export interface UpdateFileRequest {
|
|
1367
|
-
/**
|
|
1368
|
-
* ID of the file to update.
|
|
1369
|
-
*
|
|
1370
|
-
* 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`.
|
|
1371
|
-
* 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)).
|
|
1372
|
-
* @maxLength 1000
|
|
1373
|
-
*/
|
|
1374
|
-
fileId?: string;
|
|
1375
|
-
/**
|
|
1376
|
-
* File name that appears in the Media Manager.
|
|
1377
|
-
* @maxLength 200
|
|
1378
|
-
*/
|
|
1379
|
-
displayName?: string | null;
|
|
1380
|
-
/**
|
|
1381
|
-
* ID of the file's parent folder. <br />
|
|
1382
|
-
* Default: `media-root`.
|
|
1383
|
-
* @maxLength 100
|
|
1384
|
-
*/
|
|
1385
|
-
parentFolderId?: string | null;
|
|
1386
|
-
/**
|
|
1387
|
-
* 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.
|
|
1388
|
-
* @maxSize 500
|
|
1389
|
-
* @maxLength 200
|
|
1390
|
-
*/
|
|
1391
|
-
labels?: string[] | null;
|
|
1392
|
-
}
|
|
1393
|
-
export interface UpdateFileResponse {
|
|
1394
|
-
/** Information about the updated file. */
|
|
1395
|
-
file?: FileDescriptor;
|
|
1396
|
-
}
|
|
1397
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1398
|
-
createdEvent?: EntityCreatedEvent;
|
|
1399
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1400
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1401
|
-
actionEvent?: ActionEvent;
|
|
1402
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1403
|
-
id?: string;
|
|
1404
|
-
/**
|
|
1405
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1406
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1407
|
-
*/
|
|
1408
|
-
entityFqdn?: string;
|
|
1409
|
-
/**
|
|
1410
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1411
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1412
|
-
*/
|
|
1413
|
-
slug?: string;
|
|
1414
|
-
/** ID of the entity associated with the event. */
|
|
1415
|
-
entityId?: string;
|
|
1416
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1417
|
-
eventTime?: Date | null;
|
|
1418
|
-
/**
|
|
1419
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1420
|
-
* (for example, GDPR).
|
|
1421
|
-
*/
|
|
1422
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1423
|
-
/** If present, indicates the action that triggered the event. */
|
|
1424
|
-
originatedFrom?: string | null;
|
|
1425
|
-
/**
|
|
1426
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1427
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1428
|
-
*/
|
|
1429
|
-
entityEventSequence?: string | null;
|
|
1430
|
-
}
|
|
1431
|
-
/** @oneof */
|
|
1432
|
-
export interface DomainEventBodyOneOf {
|
|
1433
|
-
createdEvent?: EntityCreatedEvent;
|
|
1434
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1435
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1436
|
-
actionEvent?: ActionEvent;
|
|
1437
|
-
}
|
|
1438
|
-
export interface EntityCreatedEvent {
|
|
1439
|
-
entityAsJson?: string;
|
|
1440
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1441
|
-
restoreInfo?: RestoreInfo;
|
|
1442
|
-
}
|
|
1443
|
-
export interface RestoreInfo {
|
|
1444
|
-
deletedDate?: Date | null;
|
|
1445
|
-
}
|
|
1446
|
-
export interface EntityUpdatedEvent {
|
|
1447
|
-
/**
|
|
1448
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1449
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1450
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1451
|
-
*/
|
|
1452
|
-
currentEntityAsJson?: string;
|
|
1453
|
-
}
|
|
1454
|
-
export interface EntityDeletedEvent {
|
|
1455
|
-
/** Entity that was deleted. */
|
|
1456
|
-
deletedEntityAsJson?: string | null;
|
|
1457
|
-
}
|
|
1458
|
-
export interface ActionEvent {
|
|
1459
|
-
bodyAsJson?: string;
|
|
1460
|
-
}
|
|
1461
|
-
export interface MessageEnvelope {
|
|
1462
|
-
/**
|
|
1463
|
-
* App instance ID.
|
|
1464
|
-
* @format GUID
|
|
1465
|
-
*/
|
|
1466
|
-
instanceId?: string | null;
|
|
1467
|
-
/**
|
|
1468
|
-
* Event type.
|
|
1469
|
-
* @maxLength 150
|
|
1470
|
-
*/
|
|
1471
|
-
eventType?: string;
|
|
1472
|
-
/** The identification type and identity data. */
|
|
1473
|
-
identity?: IdentificationData;
|
|
1474
|
-
/** Stringify payload. */
|
|
1475
|
-
data?: string;
|
|
1476
|
-
}
|
|
1477
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1478
|
-
/**
|
|
1479
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1480
|
-
* @format GUID
|
|
1481
|
-
*/
|
|
1482
|
-
anonymousVisitorId?: string;
|
|
1483
|
-
/**
|
|
1484
|
-
* ID of a site visitor that has logged in to the site.
|
|
1485
|
-
* @format GUID
|
|
1486
|
-
*/
|
|
1487
|
-
memberId?: string;
|
|
1488
|
-
/**
|
|
1489
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1490
|
-
* @format GUID
|
|
1491
|
-
*/
|
|
1492
|
-
wixUserId?: string;
|
|
1493
|
-
/**
|
|
1494
|
-
* ID of an app.
|
|
1495
|
-
* @format GUID
|
|
1496
|
-
*/
|
|
1497
|
-
appId?: string;
|
|
1498
|
-
/** @readonly */
|
|
1499
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1500
|
-
}
|
|
1501
|
-
/** @oneof */
|
|
1502
|
-
export interface IdentificationDataIdOneOf {
|
|
1503
|
-
/**
|
|
1504
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1505
|
-
* @format GUID
|
|
1506
|
-
*/
|
|
1507
|
-
anonymousVisitorId?: string;
|
|
1508
|
-
/**
|
|
1509
|
-
* ID of a site visitor that has logged in to the site.
|
|
1510
|
-
* @format GUID
|
|
1511
|
-
*/
|
|
1512
|
-
memberId?: string;
|
|
1513
|
-
/**
|
|
1514
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1515
|
-
* @format GUID
|
|
1516
|
-
*/
|
|
1517
|
-
wixUserId?: string;
|
|
1518
|
-
/**
|
|
1519
|
-
* ID of an app.
|
|
1520
|
-
* @format GUID
|
|
1521
|
-
*/
|
|
1522
|
-
appId?: string;
|
|
1523
|
-
}
|
|
1524
|
-
export declare enum WebhookIdentityType {
|
|
1525
|
-
UNKNOWN = "UNKNOWN",
|
|
1526
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1527
|
-
MEMBER = "MEMBER",
|
|
1528
|
-
WIX_USER = "WIX_USER",
|
|
1529
|
-
APP = "APP"
|
|
1530
|
-
}
|
|
1531
|
-
/** @enumType */
|
|
1532
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1025
|
+
|
|
1026
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1027
|
+
getUrl: (context: any) => string;
|
|
1028
|
+
httpMethod: K;
|
|
1029
|
+
path: string;
|
|
1030
|
+
pathParams: M;
|
|
1031
|
+
__requestType: T;
|
|
1032
|
+
__originalRequestType: S;
|
|
1033
|
+
__responseType: Q;
|
|
1034
|
+
__originalResponseType: R;
|
|
1035
|
+
};
|
|
1036
|
+
declare function generateFilesDownloadUrl(): __PublicMethodMetaInfo<'POST', {}, GenerateFilesDownloadUrlRequest$1, GenerateFilesDownloadUrlRequest, GenerateFilesDownloadUrlResponse$1, GenerateFilesDownloadUrlResponse>;
|
|
1037
|
+
declare function generateFileDownloadUrl(): __PublicMethodMetaInfo<'POST', {}, GenerateFileDownloadUrlRequest$1, GenerateFileDownloadUrlRequest, GenerateFileDownloadUrlResponse$1, GenerateFileDownloadUrlResponse>;
|
|
1038
|
+
declare function getFileDescriptor(): __PublicMethodMetaInfo<'GET', {}, GetFileDescriptorRequest$1, GetFileDescriptorRequest, GetFileDescriptorResponse$1, GetFileDescriptorResponse>;
|
|
1039
|
+
declare function getFileDescriptors(): __PublicMethodMetaInfo<'POST', {}, GetFileDescriptorsRequest$1, GetFileDescriptorsRequest, GetFileDescriptorsResponse$1, GetFileDescriptorsResponse>;
|
|
1040
|
+
declare function updateFileDescriptor(): __PublicMethodMetaInfo<'PATCH', {}, UpdateFileDescriptorRequest$1, UpdateFileDescriptorRequest, UpdateFileDescriptorResponse$1, UpdateFileDescriptorResponse>;
|
|
1041
|
+
declare function generateFileUploadUrl(): __PublicMethodMetaInfo<'POST', {}, GenerateFileUploadUrlRequest$1, GenerateFileUploadUrlRequest, GenerateFileUploadUrlResponse$1, GenerateFileUploadUrlResponse>;
|
|
1042
|
+
declare function generateFileResumableUploadUrl(): __PublicMethodMetaInfo<'POST', {}, GenerateFileResumableUploadUrlRequest$1, GenerateFileResumableUploadUrlRequest, GenerateFileResumableUploadUrlResponse$1, GenerateFileResumableUploadUrlResponse>;
|
|
1043
|
+
declare function importFile(): __PublicMethodMetaInfo<'POST', {}, ImportFileRequest$1, ImportFileRequest, ImportFileResponse$1, ImportFileResponse>;
|
|
1044
|
+
declare function bulkImportFiles(): __PublicMethodMetaInfo<'POST', {}, BulkImportFilesRequest$1, BulkImportFilesRequest, BulkImportFilesResponse$1, BulkImportFilesResponse>;
|
|
1045
|
+
declare function bulkImportFile(): __PublicMethodMetaInfo<'POST', {}, BulkImportFileRequest$1, BulkImportFileRequest, BulkImportFileResponse$1, BulkImportFileResponse>;
|
|
1046
|
+
declare function listFiles(): __PublicMethodMetaInfo<'GET', {}, ListFilesRequest$1, ListFilesRequest, ListFilesResponse$1, ListFilesResponse>;
|
|
1047
|
+
declare function searchFiles(): __PublicMethodMetaInfo<'POST', {}, SearchFilesRequest$1, SearchFilesRequest, SearchFilesResponse$1, SearchFilesResponse>;
|
|
1048
|
+
declare function generateVideoStreamingUrl(): __PublicMethodMetaInfo<'POST', {}, GenerateVideoStreamingUrlRequest$1, GenerateVideoStreamingUrlRequest, GenerateVideoStreamingUrlResponse$1, GenerateVideoStreamingUrlResponse>;
|
|
1049
|
+
declare function bulkDeleteFiles(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteFilesRequest$1, BulkDeleteFilesRequest, BulkDeleteFilesResponse$1, BulkDeleteFilesResponse>;
|
|
1050
|
+
declare function bulkRestoreFilesFromTrashBin(): __PublicMethodMetaInfo<'POST', {}, BulkRestoreFilesFromTrashBinRequest$1, BulkRestoreFilesFromTrashBinRequest, BulkRestoreFilesFromTrashBinResponse$1, BulkRestoreFilesFromTrashBinResponse>;
|
|
1051
|
+
declare function listDeletedFiles(): __PublicMethodMetaInfo<'GET', {}, ListDeletedFilesRequest$1, ListDeletedFilesRequest, ListDeletedFilesResponse$1, ListDeletedFilesResponse>;
|
|
1052
|
+
|
|
1053
|
+
export { type __PublicMethodMetaInfo, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, searchFiles, updateFileDescriptor };
|