@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
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
interface FileDescriptor {
|
|
3
4
|
/**
|
|
4
5
|
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
5
6
|
* @readonly
|
|
@@ -98,7 +99,7 @@ export interface FileDescriptor {
|
|
|
98
99
|
*/
|
|
99
100
|
state?: StateWithLiterals;
|
|
100
101
|
}
|
|
101
|
-
|
|
102
|
+
declare enum MediaType {
|
|
102
103
|
UNKNOWN = "UNKNOWN",
|
|
103
104
|
IMAGE = "IMAGE",
|
|
104
105
|
VIDEO = "VIDEO",
|
|
@@ -110,8 +111,8 @@ export declare enum MediaType {
|
|
|
110
111
|
OTHER = "OTHER"
|
|
111
112
|
}
|
|
112
113
|
/** @enumType */
|
|
113
|
-
|
|
114
|
-
|
|
114
|
+
type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
|
|
115
|
+
interface FileMedia extends FileMediaMediaOneOf {
|
|
115
116
|
/** Information about the image. */
|
|
116
117
|
image?: ImageMedia;
|
|
117
118
|
/** Information about the video. */
|
|
@@ -128,7 +129,7 @@ export interface FileMedia extends FileMediaMediaOneOf {
|
|
|
128
129
|
model3d?: Model3D;
|
|
129
130
|
}
|
|
130
131
|
/** @oneof */
|
|
131
|
-
|
|
132
|
+
interface FileMediaMediaOneOf {
|
|
132
133
|
/** Information about the image. */
|
|
133
134
|
image?: ImageMedia;
|
|
134
135
|
/** Information about the video. */
|
|
@@ -144,7 +145,7 @@ export interface FileMediaMediaOneOf {
|
|
|
144
145
|
/** Information about the 3D Model. */
|
|
145
146
|
model3d?: Model3D;
|
|
146
147
|
}
|
|
147
|
-
|
|
148
|
+
interface ImageMedia {
|
|
148
149
|
/** Image data. */
|
|
149
150
|
image?: string;
|
|
150
151
|
/** Image colors. */
|
|
@@ -166,7 +167,7 @@ export interface ImageMedia {
|
|
|
166
167
|
*/
|
|
167
168
|
caption?: string | null;
|
|
168
169
|
}
|
|
169
|
-
|
|
170
|
+
interface FocalPoint {
|
|
170
171
|
/** X-coordinate of the focal point. */
|
|
171
172
|
x?: number;
|
|
172
173
|
/** Y-coordinate of the focal point. */
|
|
@@ -176,7 +177,7 @@ export interface FocalPoint {
|
|
|
176
177
|
/** crop by width */
|
|
177
178
|
width?: number | null;
|
|
178
179
|
}
|
|
179
|
-
|
|
180
|
+
interface Colors {
|
|
180
181
|
/** Main color of the image. */
|
|
181
182
|
prominent?: Color;
|
|
182
183
|
/**
|
|
@@ -185,7 +186,7 @@ export interface Colors {
|
|
|
185
186
|
*/
|
|
186
187
|
palette?: Color[];
|
|
187
188
|
}
|
|
188
|
-
|
|
189
|
+
interface Color {
|
|
189
190
|
/**
|
|
190
191
|
* HEX color.
|
|
191
192
|
* @format COLOR_HEX
|
|
@@ -194,7 +195,7 @@ export interface Color {
|
|
|
194
195
|
/** RGB color. */
|
|
195
196
|
rgb?: ColorRGB;
|
|
196
197
|
}
|
|
197
|
-
|
|
198
|
+
interface ColorRGB {
|
|
198
199
|
/**
|
|
199
200
|
* Red channel.
|
|
200
201
|
* @max 255
|
|
@@ -226,7 +227,7 @@ export interface ColorRGB {
|
|
|
226
227
|
* | |
|
|
227
228
|
* |______________________|
|
|
228
229
|
*/
|
|
229
|
-
|
|
230
|
+
interface FaceRecognition {
|
|
230
231
|
/** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
|
|
231
232
|
confidence?: number;
|
|
232
233
|
/** Top left x pixel coordinate of the face. */
|
|
@@ -238,7 +239,7 @@ export interface FaceRecognition {
|
|
|
238
239
|
/** Face pixel width. */
|
|
239
240
|
width?: number;
|
|
240
241
|
}
|
|
241
|
-
|
|
242
|
+
interface VideoResolution {
|
|
242
243
|
/** Video URL. */
|
|
243
244
|
url?: string;
|
|
244
245
|
/** Video height. */
|
|
@@ -252,7 +253,7 @@ export interface VideoResolution {
|
|
|
252
253
|
*/
|
|
253
254
|
format?: string;
|
|
254
255
|
}
|
|
255
|
-
|
|
256
|
+
interface AudioV2 {
|
|
256
257
|
/**
|
|
257
258
|
* WixMedia ID.
|
|
258
259
|
* @maxLength 200
|
|
@@ -287,7 +288,7 @@ export interface AudioV2 {
|
|
|
287
288
|
*/
|
|
288
289
|
sizeInBytes?: string | null;
|
|
289
290
|
}
|
|
290
|
-
|
|
291
|
+
interface Archive {
|
|
291
292
|
/** WixMedia ID. */
|
|
292
293
|
_id?: string;
|
|
293
294
|
/** Archive URL. */
|
|
@@ -305,7 +306,7 @@ export interface Archive {
|
|
|
305
306
|
/** Archive filename. */
|
|
306
307
|
filename?: string | null;
|
|
307
308
|
}
|
|
308
|
-
|
|
309
|
+
interface Model3D {
|
|
309
310
|
/** WixMedia 3D ID. */
|
|
310
311
|
_id?: string;
|
|
311
312
|
/** 3D URL. */
|
|
@@ -331,7 +332,7 @@ export interface Model3D {
|
|
|
331
332
|
*/
|
|
332
333
|
sizeInBytes?: string | null;
|
|
333
334
|
}
|
|
334
|
-
|
|
335
|
+
interface OtherMedia {
|
|
335
336
|
/**
|
|
336
337
|
* WixMedia ID. for use with Site Media APIs only
|
|
337
338
|
* @maxLength 200
|
|
@@ -356,7 +357,7 @@ export interface OtherMedia {
|
|
|
356
357
|
*/
|
|
357
358
|
url?: string;
|
|
358
359
|
}
|
|
359
|
-
|
|
360
|
+
interface FontMedia {
|
|
360
361
|
/**
|
|
361
362
|
* WixMedia ID. for use with Site Media APIs only
|
|
362
363
|
* @maxLength 200
|
|
@@ -390,7 +391,7 @@ export interface FontMedia {
|
|
|
390
391
|
*/
|
|
391
392
|
assets?: FontAsset[];
|
|
392
393
|
}
|
|
393
|
-
|
|
394
|
+
interface FontAsset {
|
|
394
395
|
/**
|
|
395
396
|
* Keys for downloading different assets of a file.
|
|
396
397
|
* Default: `src`, key representing the original file's format and quality.
|
|
@@ -408,7 +409,7 @@ export interface FontAsset {
|
|
|
408
409
|
*/
|
|
409
410
|
format?: string | null;
|
|
410
411
|
}
|
|
411
|
-
|
|
412
|
+
declare enum OperationStatus {
|
|
412
413
|
/** File upload or processing failed */
|
|
413
414
|
FAILED = "FAILED",
|
|
414
415
|
/** File is ready for consumption */
|
|
@@ -417,16 +418,16 @@ export declare enum OperationStatus {
|
|
|
417
418
|
PENDING = "PENDING"
|
|
418
419
|
}
|
|
419
420
|
/** @enumType */
|
|
420
|
-
|
|
421
|
-
|
|
421
|
+
type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
|
|
422
|
+
declare enum State {
|
|
422
423
|
/** File is ready for consumption */
|
|
423
424
|
OK = "OK",
|
|
424
425
|
/** Deleted file */
|
|
425
426
|
DELETED = "DELETED"
|
|
426
427
|
}
|
|
427
428
|
/** @enumType */
|
|
428
|
-
|
|
429
|
-
|
|
429
|
+
type StateWithLiterals = State | 'OK' | 'DELETED';
|
|
430
|
+
declare enum Namespace {
|
|
430
431
|
NO_NAMESPACE = "NO_NAMESPACE",
|
|
431
432
|
OTHERS = "OTHERS",
|
|
432
433
|
/** ANY = 2; */
|
|
@@ -455,8 +456,8 @@ export declare enum Namespace {
|
|
|
455
456
|
WIX_LEGENDS = "WIX_LEGENDS"
|
|
456
457
|
}
|
|
457
458
|
/** @enumType */
|
|
458
|
-
|
|
459
|
-
|
|
459
|
+
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';
|
|
460
|
+
interface IdentityInfo {
|
|
460
461
|
/** The type of the user that uploaded the file */
|
|
461
462
|
identityType?: IdentityTypeWithLiterals;
|
|
462
463
|
/**
|
|
@@ -465,7 +466,7 @@ export interface IdentityInfo {
|
|
|
465
466
|
*/
|
|
466
467
|
identityId?: string | null;
|
|
467
468
|
}
|
|
468
|
-
|
|
469
|
+
declare enum IdentityType {
|
|
469
470
|
UNKNOWN = "UNKNOWN",
|
|
470
471
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
471
472
|
MEMBER = "MEMBER",
|
|
@@ -473,8 +474,8 @@ export declare enum IdentityType {
|
|
|
473
474
|
APP = "APP"
|
|
474
475
|
}
|
|
475
476
|
/** @enumType */
|
|
476
|
-
|
|
477
|
-
|
|
477
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
478
|
+
interface FileReady {
|
|
478
479
|
/** File entity that is ready with full information. */
|
|
479
480
|
file?: FileDescriptor;
|
|
480
481
|
/** External information specified in the file import or upload. */
|
|
@@ -482,7 +483,7 @@ export interface FileReady {
|
|
|
482
483
|
/** File was restored from the trash-bin. */
|
|
483
484
|
triggeredByUndelete?: boolean;
|
|
484
485
|
}
|
|
485
|
-
|
|
486
|
+
interface ExternalInfo {
|
|
486
487
|
/**
|
|
487
488
|
* External information to specify in the File Ready or File Failed events.
|
|
488
489
|
* @maxLength 1000
|
|
@@ -495,13 +496,13 @@ export interface ExternalInfo {
|
|
|
495
496
|
*/
|
|
496
497
|
externalIds?: string[];
|
|
497
498
|
}
|
|
498
|
-
|
|
499
|
+
interface FileFailed {
|
|
499
500
|
/** External information specified in the file import or upload. */
|
|
500
501
|
externalInfo?: ExternalInfo;
|
|
501
502
|
/** Error information. */
|
|
502
503
|
error?: ApplicationError;
|
|
503
504
|
}
|
|
504
|
-
|
|
505
|
+
interface ApplicationError {
|
|
505
506
|
/** Error code. */
|
|
506
507
|
code?: string;
|
|
507
508
|
/** Description of the error. */
|
|
@@ -509,13 +510,13 @@ export interface ApplicationError {
|
|
|
509
510
|
/** Data related to the error. */
|
|
510
511
|
data?: Record<string, any> | null;
|
|
511
512
|
}
|
|
512
|
-
|
|
513
|
+
interface DraftFilePublished {
|
|
513
514
|
/** The file after it was published */
|
|
514
515
|
file?: FileDescriptor;
|
|
515
516
|
/** The namespace the file was published to */
|
|
516
517
|
namespace?: NamespaceWithLiterals;
|
|
517
518
|
}
|
|
518
|
-
|
|
519
|
+
interface BulkAnnotateImagesRequest {
|
|
519
520
|
/**
|
|
520
521
|
* The file ids to run detection on
|
|
521
522
|
* @minSize 1
|
|
@@ -534,7 +535,7 @@ export interface BulkAnnotateImagesRequest {
|
|
|
534
535
|
/** Should the response return the item following the operation */
|
|
535
536
|
returnEntity?: boolean;
|
|
536
537
|
}
|
|
537
|
-
|
|
538
|
+
declare enum ImageAnnotationType {
|
|
538
539
|
UNKNOWN_IMAGE_ANNOTATION_TYPE = "UNKNOWN_IMAGE_ANNOTATION_TYPE",
|
|
539
540
|
CONTAINS_TEXT = "CONTAINS_TEXT",
|
|
540
541
|
IS_ANIMATED = "IS_ANIMATED",
|
|
@@ -544,14 +545,14 @@ export declare enum ImageAnnotationType {
|
|
|
544
545
|
CAPTION = "CAPTION"
|
|
545
546
|
}
|
|
546
547
|
/** @enumType */
|
|
547
|
-
|
|
548
|
-
|
|
548
|
+
type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
|
|
549
|
+
interface BulkAnnotateImagesResponse {
|
|
549
550
|
/** Results of individual items */
|
|
550
551
|
results?: BulkAnnotateImageResult[];
|
|
551
552
|
/** Metadata of the operation */
|
|
552
553
|
bulkActionMetadata?: BulkActionMetadata;
|
|
553
554
|
}
|
|
554
|
-
|
|
555
|
+
interface BulkAnnotateImageResult {
|
|
555
556
|
/** Item metadata */
|
|
556
557
|
itemMetadata?: ItemMetadata;
|
|
557
558
|
/**
|
|
@@ -560,7 +561,7 @@ export interface BulkAnnotateImageResult {
|
|
|
560
561
|
*/
|
|
561
562
|
item?: FileDescriptor;
|
|
562
563
|
}
|
|
563
|
-
|
|
564
|
+
interface ItemMetadata {
|
|
564
565
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
565
566
|
_id?: string | null;
|
|
566
567
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -570,7 +571,7 @@ export interface ItemMetadata {
|
|
|
570
571
|
/** Details about the error in case of failure. */
|
|
571
572
|
error?: ApplicationError;
|
|
572
573
|
}
|
|
573
|
-
|
|
574
|
+
interface BulkActionMetadata {
|
|
574
575
|
/** Number of items that were successfully processed. */
|
|
575
576
|
totalSuccesses?: number;
|
|
576
577
|
/** Number of items that couldn't be processed. */
|
|
@@ -578,7 +579,7 @@ export interface BulkActionMetadata {
|
|
|
578
579
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
579
580
|
undetailedFailures?: number;
|
|
580
581
|
}
|
|
581
|
-
|
|
582
|
+
interface GenerateFilesDownloadUrlRequest {
|
|
582
583
|
/**
|
|
583
584
|
* IDs of the files to download.
|
|
584
585
|
*
|
|
@@ -590,14 +591,14 @@ export interface GenerateFilesDownloadUrlRequest {
|
|
|
590
591
|
*/
|
|
591
592
|
fileIds: string[];
|
|
592
593
|
}
|
|
593
|
-
|
|
594
|
+
interface GenerateFilesDownloadUrlResponse {
|
|
594
595
|
/**
|
|
595
596
|
* URL for downloading the compressed file containing the specified files in the Media Manager.
|
|
596
597
|
* @format WEB_URL
|
|
597
598
|
*/
|
|
598
599
|
downloadUrl?: string;
|
|
599
600
|
}
|
|
600
|
-
|
|
601
|
+
interface GenerateFileDownloadUrlRequest {
|
|
601
602
|
/**
|
|
602
603
|
* File ID.
|
|
603
604
|
*
|
|
@@ -643,22 +644,22 @@ export interface GenerateFileDownloadUrlRequest {
|
|
|
643
644
|
*/
|
|
644
645
|
contentDisposition?: ContentDispositionWithLiterals;
|
|
645
646
|
}
|
|
646
|
-
|
|
647
|
+
declare enum ContentDisposition {
|
|
647
648
|
/** Using the link in the browser will download the file */
|
|
648
649
|
ATTACHMENT = "ATTACHMENT",
|
|
649
650
|
/** Using the link in the browser will open the file in the browser */
|
|
650
651
|
INLINE = "INLINE"
|
|
651
652
|
}
|
|
652
653
|
/** @enumType */
|
|
653
|
-
|
|
654
|
-
|
|
654
|
+
type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
|
|
655
|
+
interface GenerateFileDownloadUrlResponse {
|
|
655
656
|
/**
|
|
656
657
|
* URL for downloading a specific file in the Media Manager.
|
|
657
658
|
* @maxSize 100
|
|
658
659
|
*/
|
|
659
660
|
downloadUrls?: DownloadUrl[];
|
|
660
661
|
}
|
|
661
|
-
|
|
662
|
+
interface DownloadUrl {
|
|
662
663
|
/**
|
|
663
664
|
* The file download URL.
|
|
664
665
|
* @format WEB_URL
|
|
@@ -671,7 +672,7 @@ export interface DownloadUrl {
|
|
|
671
672
|
*/
|
|
672
673
|
assetKey?: string;
|
|
673
674
|
}
|
|
674
|
-
|
|
675
|
+
interface ServiceError {
|
|
675
676
|
/**
|
|
676
677
|
* Error codes are groups of related errors
|
|
677
678
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
@@ -686,7 +687,7 @@ export interface ServiceError {
|
|
|
686
687
|
*/
|
|
687
688
|
internalKey?: string | null;
|
|
688
689
|
}
|
|
689
|
-
|
|
690
|
+
interface GetFileDescriptorRequest {
|
|
690
691
|
/**
|
|
691
692
|
* File ID.
|
|
692
693
|
*
|
|
@@ -698,11 +699,11 @@ export interface GetFileDescriptorRequest {
|
|
|
698
699
|
*/
|
|
699
700
|
fileId: string;
|
|
700
701
|
}
|
|
701
|
-
|
|
702
|
+
interface GetFileDescriptorResponse {
|
|
702
703
|
/** Information about the file. */
|
|
703
704
|
file?: FileDescriptor;
|
|
704
705
|
}
|
|
705
|
-
|
|
706
|
+
interface GetFileDescriptorsRequest {
|
|
706
707
|
/**
|
|
707
708
|
* File IDs.
|
|
708
709
|
*
|
|
@@ -714,22 +715,22 @@ export interface GetFileDescriptorsRequest {
|
|
|
714
715
|
*/
|
|
715
716
|
fileIds: string[];
|
|
716
717
|
}
|
|
717
|
-
|
|
718
|
+
interface GetFileDescriptorsResponse {
|
|
718
719
|
/**
|
|
719
720
|
* Information about the requested files.
|
|
720
721
|
* @maxSize 100
|
|
721
722
|
*/
|
|
722
723
|
files?: FileDescriptor[];
|
|
723
724
|
}
|
|
724
|
-
|
|
725
|
+
interface UpdateFileDescriptorRequest {
|
|
725
726
|
/** The file to update. */
|
|
726
727
|
file: FileDescriptor;
|
|
727
728
|
}
|
|
728
|
-
|
|
729
|
+
interface UpdateFileDescriptorResponse {
|
|
729
730
|
/** Information about the updated file. */
|
|
730
731
|
file?: FileDescriptor;
|
|
731
732
|
}
|
|
732
|
-
|
|
733
|
+
interface UnsupportedRequestValueError {
|
|
733
734
|
/**
|
|
734
735
|
* Optional A list of allowed values
|
|
735
736
|
* @maxSize 100
|
|
@@ -742,7 +743,7 @@ export interface UnsupportedRequestValueError {
|
|
|
742
743
|
*/
|
|
743
744
|
requestValue?: string;
|
|
744
745
|
}
|
|
745
|
-
|
|
746
|
+
interface GenerateFileUploadUrlRequest {
|
|
746
747
|
/**
|
|
747
748
|
* File mime type.
|
|
748
749
|
* @maxLength 100
|
|
@@ -787,7 +788,7 @@ export interface GenerateFileUploadUrlRequest {
|
|
|
787
788
|
*/
|
|
788
789
|
filePath?: string | null;
|
|
789
790
|
}
|
|
790
|
-
|
|
791
|
+
interface ImageAnnotationConfigurations {
|
|
791
792
|
/** Whether to skip detection for the image */
|
|
792
793
|
skipDetection?: boolean | null;
|
|
793
794
|
/**
|
|
@@ -798,14 +799,14 @@ export interface ImageAnnotationConfigurations {
|
|
|
798
799
|
*/
|
|
799
800
|
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
800
801
|
}
|
|
801
|
-
|
|
802
|
+
interface GenerateFileUploadUrlResponse {
|
|
802
803
|
/**
|
|
803
804
|
* The URL for uploading a file to the Media Manager.
|
|
804
805
|
* @format WEB_URL
|
|
805
806
|
*/
|
|
806
807
|
uploadUrl?: string;
|
|
807
808
|
}
|
|
808
|
-
|
|
809
|
+
interface SiteQuotaExceededError {
|
|
809
810
|
/**
|
|
810
811
|
* Error codes are groups of related errors
|
|
811
812
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
@@ -822,7 +823,7 @@ export interface SiteQuotaExceededError {
|
|
|
822
823
|
/** The quota details */
|
|
823
824
|
quota?: TotalQuota;
|
|
824
825
|
}
|
|
825
|
-
|
|
826
|
+
interface TotalQuota {
|
|
826
827
|
/** Storage quota in bytes */
|
|
827
828
|
storage?: string | null;
|
|
828
829
|
/** Plans that are related to the quota */
|
|
@@ -830,7 +831,7 @@ export interface TotalQuota {
|
|
|
830
831
|
/** Time for which the quota is relevant - When the plans were retrieved from premium */
|
|
831
832
|
timestamp?: Date | null;
|
|
832
833
|
}
|
|
833
|
-
|
|
834
|
+
interface Plans {
|
|
834
835
|
/** Premium Plan */
|
|
835
836
|
premium?: Plan;
|
|
836
837
|
/**
|
|
@@ -839,7 +840,7 @@ export interface Plans {
|
|
|
839
840
|
*/
|
|
840
841
|
upgradeUrl?: string;
|
|
841
842
|
}
|
|
842
|
-
|
|
843
|
+
interface Plan {
|
|
843
844
|
/**
|
|
844
845
|
* Plan ID - Premium product ID
|
|
845
846
|
* @readonly
|
|
@@ -853,7 +854,7 @@ export interface Plan {
|
|
|
853
854
|
/** When then plan expires */
|
|
854
855
|
expiresAt?: Date | null;
|
|
855
856
|
}
|
|
856
|
-
|
|
857
|
+
interface GenerateFileResumableUploadUrlRequest {
|
|
857
858
|
/**
|
|
858
859
|
* File mime type.
|
|
859
860
|
* @maxLength 100
|
|
@@ -898,13 +899,13 @@ export interface GenerateFileResumableUploadUrlRequest {
|
|
|
898
899
|
*/
|
|
899
900
|
filePath?: string | null;
|
|
900
901
|
}
|
|
901
|
-
|
|
902
|
+
declare enum UploadProtocol {
|
|
902
903
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
903
904
|
TUS = "TUS"
|
|
904
905
|
}
|
|
905
906
|
/** @enumType */
|
|
906
|
-
|
|
907
|
-
|
|
907
|
+
type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
|
|
908
|
+
interface GenerateFileResumableUploadUrlResponse {
|
|
908
909
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
909
910
|
uploadProtocol?: UploadProtocolWithLiterals;
|
|
910
911
|
/**
|
|
@@ -918,7 +919,7 @@ export interface GenerateFileResumableUploadUrlResponse {
|
|
|
918
919
|
*/
|
|
919
920
|
uploadToken?: string;
|
|
920
921
|
}
|
|
921
|
-
|
|
922
|
+
interface ImportFileRequest {
|
|
922
923
|
/**
|
|
923
924
|
* Publicly accessible external file URL.
|
|
924
925
|
* @format WEB_URL
|
|
@@ -969,11 +970,11 @@ export interface ImportFileRequest {
|
|
|
969
970
|
*/
|
|
970
971
|
filePath?: string | null;
|
|
971
972
|
}
|
|
972
|
-
|
|
973
|
+
interface ImportFileResponse {
|
|
973
974
|
/** Information about the imported file. */
|
|
974
975
|
file?: FileDescriptor;
|
|
975
976
|
}
|
|
976
|
-
|
|
977
|
+
interface BulkImportFilesRequest {
|
|
977
978
|
/**
|
|
978
979
|
* Information about the files to import.
|
|
979
980
|
* @minSize 1
|
|
@@ -981,14 +982,14 @@ export interface BulkImportFilesRequest {
|
|
|
981
982
|
*/
|
|
982
983
|
importFileRequests: ImportFileRequest[];
|
|
983
984
|
}
|
|
984
|
-
|
|
985
|
+
interface BulkImportFilesResponse {
|
|
985
986
|
/**
|
|
986
987
|
* Information about the imported files.
|
|
987
988
|
* @maxSize 100
|
|
988
989
|
*/
|
|
989
990
|
files?: FileDescriptor[];
|
|
990
991
|
}
|
|
991
|
-
|
|
992
|
+
interface BulkImportFileRequest {
|
|
992
993
|
/**
|
|
993
994
|
* Information about the files to import.
|
|
994
995
|
* @minSize 1
|
|
@@ -998,19 +999,19 @@ export interface BulkImportFileRequest {
|
|
|
998
999
|
/** Default: `true` */
|
|
999
1000
|
returnEntity?: boolean | null;
|
|
1000
1001
|
}
|
|
1001
|
-
|
|
1002
|
+
interface BulkImportFileResponse {
|
|
1002
1003
|
/** Items created by bulk action. */
|
|
1003
1004
|
results?: BulkImportFileResult[];
|
|
1004
1005
|
/** Bulk action metadata. */
|
|
1005
1006
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1006
1007
|
}
|
|
1007
|
-
|
|
1008
|
+
interface BulkImportFileResult {
|
|
1008
1009
|
/** Item metadata. */
|
|
1009
1010
|
itemMetadata?: ItemMetadata;
|
|
1010
1011
|
/** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
|
|
1011
1012
|
item?: FileDescriptor;
|
|
1012
1013
|
}
|
|
1013
|
-
|
|
1014
|
+
interface ListFilesRequest {
|
|
1014
1015
|
/**
|
|
1015
1016
|
* ID of the file's parent folder. <br />
|
|
1016
1017
|
* Default:`media-root`.
|
|
@@ -1035,7 +1036,7 @@ export interface ListFilesRequest {
|
|
|
1035
1036
|
/** Cursor and paging information. */
|
|
1036
1037
|
paging?: CursorPaging;
|
|
1037
1038
|
}
|
|
1038
|
-
|
|
1039
|
+
interface Sorting {
|
|
1039
1040
|
/**
|
|
1040
1041
|
* Name of the field to sort by.
|
|
1041
1042
|
* @maxLength 512
|
|
@@ -1044,13 +1045,13 @@ export interface Sorting {
|
|
|
1044
1045
|
/** Sort order. */
|
|
1045
1046
|
order?: SortOrderWithLiterals;
|
|
1046
1047
|
}
|
|
1047
|
-
|
|
1048
|
+
declare enum SortOrder {
|
|
1048
1049
|
ASC = "ASC",
|
|
1049
1050
|
DESC = "DESC"
|
|
1050
1051
|
}
|
|
1051
1052
|
/** @enumType */
|
|
1052
|
-
|
|
1053
|
-
|
|
1053
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1054
|
+
interface CursorPaging {
|
|
1054
1055
|
/**
|
|
1055
1056
|
* Maximum number of items to return in the results.
|
|
1056
1057
|
* @max 100
|
|
@@ -1065,7 +1066,7 @@ export interface CursorPaging {
|
|
|
1065
1066
|
*/
|
|
1066
1067
|
cursor?: string | null;
|
|
1067
1068
|
}
|
|
1068
|
-
|
|
1069
|
+
interface ListFilesResponse {
|
|
1069
1070
|
/**
|
|
1070
1071
|
* List of files in the Media Manager.
|
|
1071
1072
|
* @maxSize 200
|
|
@@ -1074,20 +1075,20 @@ export interface ListFilesResponse {
|
|
|
1074
1075
|
/** The next cursor if it exists. */
|
|
1075
1076
|
nextCursor?: PagingMetadataV2;
|
|
1076
1077
|
}
|
|
1077
|
-
|
|
1078
|
+
interface PagingMetadataV2 {
|
|
1078
1079
|
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1079
1080
|
total?: number | null;
|
|
1080
1081
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1081
1082
|
cursors?: Cursors;
|
|
1082
1083
|
}
|
|
1083
|
-
|
|
1084
|
+
interface Cursors {
|
|
1084
1085
|
/**
|
|
1085
1086
|
* Cursor string pointing to the next page in the list of results.
|
|
1086
1087
|
* @maxLength 16000
|
|
1087
1088
|
*/
|
|
1088
1089
|
next?: string | null;
|
|
1089
1090
|
}
|
|
1090
|
-
|
|
1091
|
+
interface SearchFilesRequest {
|
|
1091
1092
|
/**
|
|
1092
1093
|
* Term to search for. Possible terms include the value of a file's
|
|
1093
1094
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
@@ -1118,7 +1119,7 @@ export interface SearchFilesRequest {
|
|
|
1118
1119
|
/** Cursor and paging information. */
|
|
1119
1120
|
paging?: CursorPaging;
|
|
1120
1121
|
}
|
|
1121
|
-
|
|
1122
|
+
declare enum RootFolder {
|
|
1122
1123
|
/** Root of all site media */
|
|
1123
1124
|
MEDIA_ROOT = "MEDIA_ROOT",
|
|
1124
1125
|
/** Root of the trash system folder */
|
|
@@ -1127,8 +1128,8 @@ export declare enum RootFolder {
|
|
|
1127
1128
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
1128
1129
|
}
|
|
1129
1130
|
/** @enumType */
|
|
1130
|
-
|
|
1131
|
-
|
|
1131
|
+
type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
|
|
1132
|
+
interface SearchFilesResponse {
|
|
1132
1133
|
/**
|
|
1133
1134
|
* Files matching the query.
|
|
1134
1135
|
* @maxSize 200
|
|
@@ -1137,7 +1138,7 @@ export interface SearchFilesResponse {
|
|
|
1137
1138
|
/** The next cursor if it exists. */
|
|
1138
1139
|
nextCursor?: PagingMetadataV2;
|
|
1139
1140
|
}
|
|
1140
|
-
|
|
1141
|
+
interface GenerateVideoStreamingUrlRequest {
|
|
1141
1142
|
/**
|
|
1142
1143
|
* File ID.
|
|
1143
1144
|
*
|
|
@@ -1149,27 +1150,27 @@ export interface GenerateVideoStreamingUrlRequest {
|
|
|
1149
1150
|
/** Video stream format. */
|
|
1150
1151
|
format?: StreamFormatWithLiterals;
|
|
1151
1152
|
}
|
|
1152
|
-
|
|
1153
|
+
declare enum StreamFormat {
|
|
1153
1154
|
UNKNOWN = "UNKNOWN",
|
|
1154
1155
|
HLS = "HLS",
|
|
1155
1156
|
DASH = "DASH"
|
|
1156
1157
|
}
|
|
1157
1158
|
/** @enumType */
|
|
1158
|
-
|
|
1159
|
-
|
|
1159
|
+
type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
|
|
1160
|
+
interface GenerateVideoStreamingUrlResponse {
|
|
1160
1161
|
/** URL for streaming a specific file in the Media Manager. */
|
|
1161
1162
|
downloadUrl?: DownloadUrl;
|
|
1162
1163
|
}
|
|
1163
|
-
|
|
1164
|
+
interface GenerateWebSocketTokenRequest {
|
|
1164
1165
|
}
|
|
1165
|
-
|
|
1166
|
+
interface GenerateWebSocketTokenResponse {
|
|
1166
1167
|
/**
|
|
1167
1168
|
* The web socket token for the identity in the request
|
|
1168
1169
|
* @maxLength 2000
|
|
1169
1170
|
*/
|
|
1170
1171
|
token?: string;
|
|
1171
1172
|
}
|
|
1172
|
-
|
|
1173
|
+
interface BulkDeleteFilesRequest {
|
|
1173
1174
|
/**
|
|
1174
1175
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1175
1176
|
*
|
|
@@ -1185,9 +1186,9 @@ export interface BulkDeleteFilesRequest {
|
|
|
1185
1186
|
*/
|
|
1186
1187
|
permanent?: boolean;
|
|
1187
1188
|
}
|
|
1188
|
-
|
|
1189
|
+
interface BulkDeleteFilesResponse {
|
|
1189
1190
|
}
|
|
1190
|
-
|
|
1191
|
+
interface BulkRestoreFilesFromTrashBinRequest {
|
|
1191
1192
|
/**
|
|
1192
1193
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1193
1194
|
*
|
|
@@ -1198,9 +1199,9 @@ export interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1198
1199
|
*/
|
|
1199
1200
|
fileIds: string[];
|
|
1200
1201
|
}
|
|
1201
|
-
|
|
1202
|
+
interface BulkRestoreFilesFromTrashBinResponse {
|
|
1202
1203
|
}
|
|
1203
|
-
|
|
1204
|
+
interface ListDeletedFilesRequest {
|
|
1204
1205
|
/**
|
|
1205
1206
|
* ID of the file's parent folder. <br />
|
|
1206
1207
|
* Default: `media-root`.
|
|
@@ -1225,7 +1226,7 @@ export interface ListDeletedFilesRequest {
|
|
|
1225
1226
|
/** Cursor and paging information. */
|
|
1226
1227
|
paging?: CursorPaging;
|
|
1227
1228
|
}
|
|
1228
|
-
|
|
1229
|
+
interface ListDeletedFilesResponse {
|
|
1229
1230
|
/**
|
|
1230
1231
|
* List of files in the Media Manager's trash bin.
|
|
1231
1232
|
* @maxSize 200
|
|
@@ -1234,7 +1235,7 @@ export interface ListDeletedFilesResponse {
|
|
|
1234
1235
|
/** The next cursor if it exists. */
|
|
1235
1236
|
nextCursor?: PagingMetadataV2;
|
|
1236
1237
|
}
|
|
1237
|
-
|
|
1238
|
+
interface BulkPublishDraftFilesRequest {
|
|
1238
1239
|
/**
|
|
1239
1240
|
* IDs of the draft files to be published.
|
|
1240
1241
|
*
|
|
@@ -1267,13 +1268,13 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
1267
1268
|
/** Should the response return the item following the operation */
|
|
1268
1269
|
returnEntity?: boolean;
|
|
1269
1270
|
}
|
|
1270
|
-
|
|
1271
|
+
interface BulkPublishDraftFilesResponse {
|
|
1271
1272
|
/** Results of individual items */
|
|
1272
1273
|
results?: BulkPublishDraftFileResult[];
|
|
1273
1274
|
/** Metadata of the operation */
|
|
1274
1275
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1275
1276
|
}
|
|
1276
|
-
|
|
1277
|
+
interface BulkPublishDraftFileResult {
|
|
1277
1278
|
/** Item metadata */
|
|
1278
1279
|
itemMetadata?: ItemMetadata;
|
|
1279
1280
|
/**
|
|
@@ -1282,7 +1283,7 @@ export interface BulkPublishDraftFileResult {
|
|
|
1282
1283
|
*/
|
|
1283
1284
|
item?: FileDescriptor;
|
|
1284
1285
|
}
|
|
1285
|
-
|
|
1286
|
+
interface UpdateFileRequest {
|
|
1286
1287
|
/**
|
|
1287
1288
|
* ID of the file to update.
|
|
1288
1289
|
*
|
|
@@ -1309,11 +1310,11 @@ export interface UpdateFileRequest {
|
|
|
1309
1310
|
*/
|
|
1310
1311
|
labels?: string[] | null;
|
|
1311
1312
|
}
|
|
1312
|
-
|
|
1313
|
+
interface UpdateFileResponse {
|
|
1313
1314
|
/** Information about the updated file. */
|
|
1314
1315
|
file?: FileDescriptor;
|
|
1315
1316
|
}
|
|
1316
|
-
|
|
1317
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1317
1318
|
createdEvent?: EntityCreatedEvent;
|
|
1318
1319
|
updatedEvent?: EntityUpdatedEvent;
|
|
1319
1320
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1348,19 +1349,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1348
1349
|
entityEventSequence?: string | null;
|
|
1349
1350
|
}
|
|
1350
1351
|
/** @oneof */
|
|
1351
|
-
|
|
1352
|
+
interface DomainEventBodyOneOf {
|
|
1352
1353
|
createdEvent?: EntityCreatedEvent;
|
|
1353
1354
|
updatedEvent?: EntityUpdatedEvent;
|
|
1354
1355
|
deletedEvent?: EntityDeletedEvent;
|
|
1355
1356
|
actionEvent?: ActionEvent;
|
|
1356
1357
|
}
|
|
1357
|
-
|
|
1358
|
+
interface EntityCreatedEvent {
|
|
1358
1359
|
entity?: string;
|
|
1359
1360
|
}
|
|
1360
|
-
|
|
1361
|
+
interface RestoreInfo {
|
|
1361
1362
|
deletedDate?: Date | null;
|
|
1362
1363
|
}
|
|
1363
|
-
|
|
1364
|
+
interface EntityUpdatedEvent {
|
|
1364
1365
|
/**
|
|
1365
1366
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1366
1367
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1368,14 +1369,14 @@ export interface EntityUpdatedEvent {
|
|
|
1368
1369
|
*/
|
|
1369
1370
|
currentEntity?: string;
|
|
1370
1371
|
}
|
|
1371
|
-
|
|
1372
|
+
interface EntityDeletedEvent {
|
|
1372
1373
|
/** Entity that was deleted. */
|
|
1373
1374
|
deletedEntity?: string | null;
|
|
1374
1375
|
}
|
|
1375
|
-
|
|
1376
|
+
interface ActionEvent {
|
|
1376
1377
|
body?: string;
|
|
1377
1378
|
}
|
|
1378
|
-
|
|
1379
|
+
interface MessageEnvelope {
|
|
1379
1380
|
/**
|
|
1380
1381
|
* App instance ID.
|
|
1381
1382
|
* @format GUID
|
|
@@ -1391,7 +1392,7 @@ export interface MessageEnvelope {
|
|
|
1391
1392
|
/** Stringify payload. */
|
|
1392
1393
|
data?: string;
|
|
1393
1394
|
}
|
|
1394
|
-
|
|
1395
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1395
1396
|
/**
|
|
1396
1397
|
* ID of a site visitor that has not logged in to the site.
|
|
1397
1398
|
* @format GUID
|
|
@@ -1416,7 +1417,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1416
1417
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1417
1418
|
}
|
|
1418
1419
|
/** @oneof */
|
|
1419
|
-
|
|
1420
|
+
interface IdentificationDataIdOneOf {
|
|
1420
1421
|
/**
|
|
1421
1422
|
* ID of a site visitor that has not logged in to the site.
|
|
1422
1423
|
* @format GUID
|
|
@@ -1438,7 +1439,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1438
1439
|
*/
|
|
1439
1440
|
appId?: string;
|
|
1440
1441
|
}
|
|
1441
|
-
|
|
1442
|
+
declare enum WebhookIdentityType {
|
|
1442
1443
|
UNKNOWN = "UNKNOWN",
|
|
1443
1444
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1444
1445
|
MEMBER = "MEMBER",
|
|
@@ -1446,8 +1447,58 @@ export declare enum WebhookIdentityType {
|
|
|
1446
1447
|
APP = "APP"
|
|
1447
1448
|
}
|
|
1448
1449
|
/** @enumType */
|
|
1449
|
-
|
|
1450
|
-
|
|
1450
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1451
|
+
type GenerateFileDownloadUrlValidationErrors = {
|
|
1452
|
+
ruleName?: 'INVALID_ASSET_KEY';
|
|
1453
|
+
};
|
|
1454
|
+
type GetFileDescriptorValidationErrors = {
|
|
1455
|
+
ruleName?: 'RESOURCE_NOT_FOUND';
|
|
1456
|
+
};
|
|
1457
|
+
type GetFileDescriptorsValidationErrors = {
|
|
1458
|
+
ruleName?: 'RESOURCE_NOT_FOUND';
|
|
1459
|
+
};
|
|
1460
|
+
type UpdateFileDescriptorValidationErrors = {
|
|
1461
|
+
ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
|
|
1462
|
+
};
|
|
1463
|
+
type GenerateFileUploadUrlValidationErrors = {
|
|
1464
|
+
ruleName?: 'MISMATCH_MIME_TYPE';
|
|
1465
|
+
} | {
|
|
1466
|
+
ruleName?: 'ZERO_FILE_SIZE';
|
|
1467
|
+
} | {
|
|
1468
|
+
ruleName?: 'UNSUPPORTED_FILE_FORMAT';
|
|
1469
|
+
} | {
|
|
1470
|
+
ruleName?: 'FILE_SIZE_OVER_LIMIT';
|
|
1471
|
+
} | {
|
|
1472
|
+
ruleName?: 'SITE_QUOTA_EXCEEDED';
|
|
1473
|
+
};
|
|
1474
|
+
type GenerateFileResumableUploadUrlValidationErrors = {
|
|
1475
|
+
ruleName?: 'MISMATCH_MIME_TYPE';
|
|
1476
|
+
} | {
|
|
1477
|
+
ruleName?: 'ZERO_FILE_SIZE';
|
|
1478
|
+
} | {
|
|
1479
|
+
ruleName?: 'UNSUPPORTED_FILE_FORMAT';
|
|
1480
|
+
} | {
|
|
1481
|
+
ruleName?: 'FILE_SIZE_OVER_LIMIT';
|
|
1482
|
+
};
|
|
1483
|
+
type ImportFileValidationErrors = {
|
|
1484
|
+
ruleName?: 'SITE_QUOTA_EXCEEDED';
|
|
1485
|
+
};
|
|
1486
|
+
type ListFilesValidationErrors = {
|
|
1487
|
+
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1488
|
+
} | {
|
|
1489
|
+
ruleName?: 'UNSUPPORTED_SORT_VALUE';
|
|
1490
|
+
};
|
|
1491
|
+
type SearchFilesValidationErrors = {
|
|
1492
|
+
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1493
|
+
} | {
|
|
1494
|
+
ruleName?: 'UNSUPPORTED_SORT_VALUE';
|
|
1495
|
+
};
|
|
1496
|
+
type ListDeletedFilesValidationErrors = {
|
|
1497
|
+
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1498
|
+
} | {
|
|
1499
|
+
ruleName?: 'UNSUPPORTED_SORT_VALUE';
|
|
1500
|
+
};
|
|
1501
|
+
interface BaseEventMetadata {
|
|
1451
1502
|
/**
|
|
1452
1503
|
* App instance ID.
|
|
1453
1504
|
* @format GUID
|
|
@@ -1461,7 +1512,7 @@ export interface BaseEventMetadata {
|
|
|
1461
1512
|
/** The identification type and identity data. */
|
|
1462
1513
|
identity?: IdentificationData;
|
|
1463
1514
|
}
|
|
1464
|
-
|
|
1515
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1465
1516
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1466
1517
|
_id?: string;
|
|
1467
1518
|
/**
|
|
@@ -1491,7 +1542,7 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1491
1542
|
*/
|
|
1492
1543
|
entityEventSequence?: string | null;
|
|
1493
1544
|
}
|
|
1494
|
-
|
|
1545
|
+
interface FileDescriptorDeletedEnvelope {
|
|
1495
1546
|
metadata: EventMetadata;
|
|
1496
1547
|
}
|
|
1497
1548
|
/**
|
|
@@ -1526,8 +1577,8 @@ export interface FileDescriptorDeletedEnvelope {
|
|
|
1526
1577
|
* @serviceIdentifier com.wix.media.site_media.v1.FilesService
|
|
1527
1578
|
* @slug deleted
|
|
1528
1579
|
*/
|
|
1529
|
-
|
|
1530
|
-
|
|
1580
|
+
declare function onFileDescriptorDeleted(handler: (event: FileDescriptorDeletedEnvelope) => void | Promise<void>): void;
|
|
1581
|
+
interface FileDescriptorFileFailedEnvelope {
|
|
1531
1582
|
data: FileFailed;
|
|
1532
1583
|
metadata: EventMetadata;
|
|
1533
1584
|
}
|
|
@@ -1561,8 +1612,8 @@ export interface FileDescriptorFileFailedEnvelope {
|
|
|
1561
1612
|
* @serviceIdentifier com.wix.media.site_media.v1.FilesService
|
|
1562
1613
|
* @slug file_failed
|
|
1563
1614
|
*/
|
|
1564
|
-
|
|
1565
|
-
|
|
1615
|
+
declare function onFileDescriptorFileFailed(handler: (event: FileDescriptorFileFailedEnvelope) => void | Promise<void>): void;
|
|
1616
|
+
interface FileDescriptorFileReadyEnvelope {
|
|
1566
1617
|
data: FileReady;
|
|
1567
1618
|
metadata: EventMetadata;
|
|
1568
1619
|
}
|
|
@@ -1598,8 +1649,8 @@ export interface FileDescriptorFileReadyEnvelope {
|
|
|
1598
1649
|
* @serviceIdentifier com.wix.media.site_media.v1.FilesService
|
|
1599
1650
|
* @slug file_ready
|
|
1600
1651
|
*/
|
|
1601
|
-
|
|
1602
|
-
|
|
1652
|
+
declare function onFileDescriptorFileReady(handler: (event: FileDescriptorFileReadyEnvelope) => void | Promise<void>): void;
|
|
1653
|
+
interface FileDescriptorUpdatedEnvelope {
|
|
1603
1654
|
entity: FileDescriptor;
|
|
1604
1655
|
metadata: EventMetadata;
|
|
1605
1656
|
}
|
|
@@ -1633,7 +1684,7 @@ export interface FileDescriptorUpdatedEnvelope {
|
|
|
1633
1684
|
* @serviceIdentifier com.wix.media.site_media.v1.FilesService
|
|
1634
1685
|
* @slug updated
|
|
1635
1686
|
*/
|
|
1636
|
-
|
|
1687
|
+
declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
|
|
1637
1688
|
type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`;
|
|
1638
1689
|
/**
|
|
1639
1690
|
* Generates a URL for downloading a compressed file containing specific files in the Media Manager.
|
|
@@ -1650,30 +1701,10 @@ type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `
|
|
|
1650
1701
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1651
1702
|
* Learn more in the File and Folder IDs article.
|
|
1652
1703
|
* @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD
|
|
1653
|
-
* @permissionScope Manage Stores
|
|
1654
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1655
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1656
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1657
|
-
* @permissionScope Manage Events
|
|
1658
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1659
|
-
* @permissionScope Manage Challenges
|
|
1660
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1661
|
-
* @permissionScope Manage Media Manager
|
|
1662
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1663
|
-
* @permissionScope Manage Portfolio
|
|
1664
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1665
|
-
* @permissionScope Manage Blog
|
|
1666
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1667
|
-
* @permissionScope Access Verticals by Automations
|
|
1668
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1669
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1670
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1671
|
-
* @permissionScope Set Up Automations
|
|
1672
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1673
1704
|
* @applicableIdentity APP
|
|
1674
1705
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
|
|
1675
1706
|
*/
|
|
1676
|
-
|
|
1707
|
+
declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`>>;
|
|
1677
1708
|
/**
|
|
1678
1709
|
* Generates one or more temporary URLs for downloading a specific file in the Media Manager.
|
|
1679
1710
|
*
|
|
@@ -1693,31 +1724,13 @@ export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<Non
|
|
|
1693
1724
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1694
1725
|
* Learn more in the File and Folder IDs article.
|
|
1695
1726
|
* @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD_URL
|
|
1696
|
-
* @permissionScope Manage Stores
|
|
1697
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1698
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1699
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1700
|
-
* @permissionScope Manage Events
|
|
1701
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1702
|
-
* @permissionScope Manage Challenges
|
|
1703
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1704
|
-
* @permissionScope Manage Media Manager
|
|
1705
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1706
|
-
* @permissionScope Manage Portfolio
|
|
1707
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1708
|
-
* @permissionScope Manage Blog
|
|
1709
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1710
|
-
* @permissionScope Access Verticals by Automations
|
|
1711
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1712
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1713
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1714
|
-
* @permissionScope Set Up Automations
|
|
1715
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1716
1727
|
* @applicableIdentity APP
|
|
1717
1728
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
|
|
1718
1729
|
*/
|
|
1719
|
-
|
|
1720
|
-
|
|
1730
|
+
declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
|
|
1731
|
+
__validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
|
|
1732
|
+
}>;
|
|
1733
|
+
interface GenerateFileDownloadUrlOptions {
|
|
1721
1734
|
/**
|
|
1722
1735
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
1723
1736
|
*
|
|
@@ -1764,33 +1777,13 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1764
1777
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1765
1778
|
* Learn more in the File and Folder IDs article.
|
|
1766
1779
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1767
|
-
* @permissionScope Manage Stores
|
|
1768
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1769
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1770
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1771
|
-
* @permissionScope Manage Events
|
|
1772
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1773
|
-
* @permissionScope Manage Challenges
|
|
1774
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1775
|
-
* @permissionScope Read Media Manager
|
|
1776
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1777
|
-
* @permissionScope Manage Media Manager
|
|
1778
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1779
|
-
* @permissionScope Manage Portfolio
|
|
1780
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1781
|
-
* @permissionScope Manage Blog
|
|
1782
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1783
|
-
* @permissionScope Access Verticals by Automations
|
|
1784
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1785
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1786
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1787
|
-
* @permissionScope Set Up Automations
|
|
1788
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1789
1780
|
* @applicableIdentity APP
|
|
1790
1781
|
* @returns Information about the file.
|
|
1791
1782
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
|
|
1792
1783
|
*/
|
|
1793
|
-
|
|
1784
|
+
declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
|
|
1785
|
+
__validationErrorsType?: GetFileDescriptorValidationErrors;
|
|
1786
|
+
}>;
|
|
1794
1787
|
/**
|
|
1795
1788
|
* Gets information about specific files in the Media Manager.
|
|
1796
1789
|
* @public
|
|
@@ -1800,34 +1793,14 @@ export declare function getFileDescriptor(fileId: string): Promise<NonNullablePa
|
|
|
1800
1793
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1801
1794
|
* Learn more in the File and Folder IDs article.
|
|
1802
1795
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1803
|
-
* @permissionScope Manage Stores
|
|
1804
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1805
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1806
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1807
|
-
* @permissionScope Manage Events
|
|
1808
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1809
|
-
* @permissionScope Manage Challenges
|
|
1810
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1811
|
-
* @permissionScope Read Media Manager
|
|
1812
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1813
|
-
* @permissionScope Manage Media Manager
|
|
1814
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1815
|
-
* @permissionScope Manage Portfolio
|
|
1816
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1817
|
-
* @permissionScope Manage Blog
|
|
1818
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1819
|
-
* @permissionScope Access Verticals by Automations
|
|
1820
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1821
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1822
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1823
|
-
* @permissionScope Set Up Automations
|
|
1824
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1825
1796
|
* @applicableIdentity APP
|
|
1826
1797
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
|
|
1827
1798
|
*/
|
|
1828
|
-
|
|
1799
|
+
declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
|
|
1829
1800
|
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
1830
|
-
}[FileDescriptorNonNullablePaths]
|
|
1801
|
+
}[FileDescriptorNonNullablePaths]> & {
|
|
1802
|
+
__validationErrorsType?: GetFileDescriptorsValidationErrors;
|
|
1803
|
+
}>;
|
|
1831
1804
|
/**
|
|
1832
1805
|
* Updates a file. <br />
|
|
1833
1806
|
*
|
|
@@ -1837,31 +1810,13 @@ export declare function getFileDescriptors(fileIds: string[]): Promise<NonNullab
|
|
|
1837
1810
|
* @requiredField file
|
|
1838
1811
|
* @requiredField file._id
|
|
1839
1812
|
* @permissionId MEDIA.SITE_MEDIA_FILES_UPDATE
|
|
1840
|
-
* @permissionScope Manage Stores
|
|
1841
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1842
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1843
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1844
|
-
* @permissionScope Manage Events
|
|
1845
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1846
|
-
* @permissionScope Manage Challenges
|
|
1847
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1848
|
-
* @permissionScope Manage Media Manager
|
|
1849
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1850
|
-
* @permissionScope Manage Portfolio
|
|
1851
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1852
|
-
* @permissionScope Manage Blog
|
|
1853
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1854
|
-
* @permissionScope Access Verticals by Automations
|
|
1855
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1856
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1857
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1858
|
-
* @permissionScope Set Up Automations
|
|
1859
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1860
1813
|
* @applicableIdentity APP
|
|
1861
1814
|
* @returns Information about the updated file.
|
|
1862
1815
|
* @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
|
|
1863
1816
|
*/
|
|
1864
|
-
|
|
1817
|
+
declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
|
|
1818
|
+
__validationErrorsType?: UpdateFileDescriptorValidationErrors;
|
|
1819
|
+
}>;
|
|
1865
1820
|
/**
|
|
1866
1821
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
1867
1822
|
*
|
|
@@ -1874,31 +1829,13 @@ export declare function updateFileDescriptor(file: NonNullablePaths<FileDescript
|
|
|
1874
1829
|
* @requiredField mimeType
|
|
1875
1830
|
* @param options - Options to use when generating a file's upload URL.
|
|
1876
1831
|
* @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
|
|
1877
|
-
* @permissionScope Manage Stores
|
|
1878
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1879
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1880
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1881
|
-
* @permissionScope Manage Events
|
|
1882
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1883
|
-
* @permissionScope Manage Challenges
|
|
1884
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1885
|
-
* @permissionScope Manage Media Manager
|
|
1886
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1887
|
-
* @permissionScope Manage Portfolio
|
|
1888
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1889
|
-
* @permissionScope Manage Blog
|
|
1890
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1891
|
-
* @permissionScope Access Verticals by Automations
|
|
1892
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1893
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1894
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1895
|
-
* @permissionScope Set Up Automations
|
|
1896
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1897
1832
|
* @applicableIdentity APP
|
|
1898
1833
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
|
|
1899
1834
|
*/
|
|
1900
|
-
|
|
1901
|
-
|
|
1835
|
+
declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
|
|
1836
|
+
__validationErrorsType?: GenerateFileUploadUrlValidationErrors;
|
|
1837
|
+
}>;
|
|
1838
|
+
interface GenerateFileUploadUrlOptions {
|
|
1902
1839
|
/**
|
|
1903
1840
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1904
1841
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
@@ -1950,31 +1887,13 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1950
1887
|
* @requiredField mimeType
|
|
1951
1888
|
* @param options - Options to use when generating a resumable upload URL.
|
|
1952
1889
|
* @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
|
|
1953
|
-
* @permissionScope Manage Stores
|
|
1954
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1955
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1956
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1957
|
-
* @permissionScope Manage Events
|
|
1958
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1959
|
-
* @permissionScope Manage Challenges
|
|
1960
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1961
|
-
* @permissionScope Manage Media Manager
|
|
1962
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1963
|
-
* @permissionScope Manage Portfolio
|
|
1964
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1965
|
-
* @permissionScope Manage Blog
|
|
1966
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1967
|
-
* @permissionScope Access Verticals by Automations
|
|
1968
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1969
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1970
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1971
|
-
* @permissionScope Set Up Automations
|
|
1972
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1973
1890
|
* @applicableIdentity APP
|
|
1974
1891
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
|
|
1975
1892
|
*/
|
|
1976
|
-
|
|
1977
|
-
|
|
1893
|
+
declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
|
|
1894
|
+
__validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
|
|
1895
|
+
}>;
|
|
1896
|
+
interface GenerateFileResumableUploadUrlOptions {
|
|
1978
1897
|
/**
|
|
1979
1898
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1980
1899
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
@@ -2035,33 +1954,15 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
2035
1954
|
* @requiredField url
|
|
2036
1955
|
* @param options - Options to use when importing a single file.
|
|
2037
1956
|
* @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
|
|
2038
|
-
* @permissionScope Manage Stores
|
|
2039
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2040
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2041
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2042
|
-
* @permissionScope Manage Events
|
|
2043
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2044
|
-
* @permissionScope Manage Challenges
|
|
2045
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2046
|
-
* @permissionScope Manage Media Manager
|
|
2047
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2048
|
-
* @permissionScope Manage Portfolio
|
|
2049
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2050
|
-
* @permissionScope Manage Blog
|
|
2051
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2052
|
-
* @permissionScope Access Verticals by Automations
|
|
2053
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2054
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2055
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2056
|
-
* @permissionScope Set Up Automations
|
|
2057
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2058
1957
|
* @applicableIdentity APP
|
|
2059
1958
|
* @fqn com.wix.media.site_media.v1.FilesService.ImportFile
|
|
2060
1959
|
*/
|
|
2061
|
-
|
|
1960
|
+
declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
|
|
2062
1961
|
[P in FileDescriptorNonNullablePaths]: `file.${P}`;
|
|
2063
|
-
}[FileDescriptorNonNullablePaths]
|
|
2064
|
-
|
|
1962
|
+
}[FileDescriptorNonNullablePaths]> & {
|
|
1963
|
+
__validationErrorsType?: ImportFileValidationErrors;
|
|
1964
|
+
}>;
|
|
1965
|
+
interface ImportFileOptions {
|
|
2065
1966
|
/**
|
|
2066
1967
|
* Media type of the file to import.
|
|
2067
1968
|
* excluding: OTHER media type
|
|
@@ -2130,33 +2031,13 @@ export interface ImportFileOptions {
|
|
|
2130
2031
|
* @requiredField importFileRequests.url
|
|
2131
2032
|
* @param options - Options to use when uploading multiple files.
|
|
2132
2033
|
* @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
|
|
2133
|
-
* @permissionScope Manage Stores
|
|
2134
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2135
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2136
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2137
|
-
* @permissionScope Manage Events
|
|
2138
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2139
|
-
* @permissionScope Manage Challenges
|
|
2140
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2141
|
-
* @permissionScope Manage Media Manager
|
|
2142
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2143
|
-
* @permissionScope Manage Portfolio
|
|
2144
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2145
|
-
* @permissionScope Manage Blog
|
|
2146
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2147
|
-
* @permissionScope Access Verticals by Automations
|
|
2148
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2149
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2150
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2151
|
-
* @permissionScope Set Up Automations
|
|
2152
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2153
2034
|
* @applicableIdentity APP
|
|
2154
2035
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkImportFiles
|
|
2155
2036
|
* @deprecated
|
|
2156
2037
|
* @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile
|
|
2157
2038
|
* @targetRemovalDate 2024-03-31
|
|
2158
2039
|
*/
|
|
2159
|
-
|
|
2040
|
+
declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[]): Promise<NonNullablePaths<BulkImportFilesResponse, {
|
|
2160
2041
|
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2161
2042
|
}[FileDescriptorNonNullablePaths]>>;
|
|
2162
2043
|
/**
|
|
@@ -2182,33 +2063,13 @@ export declare function bulkImportFiles(importFileRequests: NonNullablePaths<Imp
|
|
|
2182
2063
|
* @requiredField importFileRequests.url
|
|
2183
2064
|
* @param options - Options to include the file descriptor in the response.
|
|
2184
2065
|
* @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
|
|
2185
|
-
* @permissionScope Manage Stores
|
|
2186
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2187
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2188
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2189
|
-
* @permissionScope Manage Events
|
|
2190
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2191
|
-
* @permissionScope Manage Challenges
|
|
2192
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2193
|
-
* @permissionScope Manage Media Manager
|
|
2194
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2195
|
-
* @permissionScope Manage Portfolio
|
|
2196
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2197
|
-
* @permissionScope Manage Blog
|
|
2198
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2199
|
-
* @permissionScope Access Verticals by Automations
|
|
2200
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2201
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2202
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2203
|
-
* @permissionScope Set Up Automations
|
|
2204
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2205
2066
|
* @applicableIdentity APP
|
|
2206
2067
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
|
|
2207
2068
|
*/
|
|
2208
|
-
|
|
2069
|
+
declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
2209
2070
|
[P in FileDescriptorNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2210
2071
|
}[FileDescriptorNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2211
|
-
|
|
2072
|
+
interface BulkImportFileOptions {
|
|
2212
2073
|
/** Default: `true` */
|
|
2213
2074
|
returnEntity?: boolean | null;
|
|
2214
2075
|
}
|
|
@@ -2219,35 +2080,15 @@ export interface BulkImportFileOptions {
|
|
|
2219
2080
|
* @public
|
|
2220
2081
|
* @param options - Options to use when listing media files.
|
|
2221
2082
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST
|
|
2222
|
-
* @permissionScope Manage Stores
|
|
2223
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2224
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2225
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2226
|
-
* @permissionScope Manage Events
|
|
2227
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2228
|
-
* @permissionScope Manage Challenges
|
|
2229
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2230
|
-
* @permissionScope Read Media Manager
|
|
2231
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
2232
|
-
* @permissionScope Manage Media Manager
|
|
2233
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2234
|
-
* @permissionScope Manage Portfolio
|
|
2235
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2236
|
-
* @permissionScope Manage Blog
|
|
2237
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2238
|
-
* @permissionScope Access Verticals by Automations
|
|
2239
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2240
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2241
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2242
|
-
* @permissionScope Set Up Automations
|
|
2243
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2244
2083
|
* @applicableIdentity APP
|
|
2245
2084
|
* @fqn com.wix.media.site_media.v1.FilesService.ListFiles
|
|
2246
2085
|
*/
|
|
2247
|
-
|
|
2086
|
+
declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
|
|
2248
2087
|
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2249
|
-
}[FileDescriptorNonNullablePaths]
|
|
2250
|
-
|
|
2088
|
+
}[FileDescriptorNonNullablePaths]> & {
|
|
2089
|
+
__validationErrorsType?: ListFilesValidationErrors;
|
|
2090
|
+
}>;
|
|
2091
|
+
interface ListFilesOptions {
|
|
2251
2092
|
/**
|
|
2252
2093
|
* ID of the file's parent folder. <br />
|
|
2253
2094
|
* Default:`media-root`.
|
|
@@ -2279,35 +2120,15 @@ export interface ListFilesOptions {
|
|
|
2279
2120
|
* @public
|
|
2280
2121
|
* @param options - Options to specify which folders to search.
|
|
2281
2122
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST
|
|
2282
|
-
* @permissionScope Manage Stores
|
|
2283
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2284
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2285
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2286
|
-
* @permissionScope Manage Events
|
|
2287
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2288
|
-
* @permissionScope Manage Challenges
|
|
2289
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2290
|
-
* @permissionScope Read Media Manager
|
|
2291
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
2292
|
-
* @permissionScope Manage Media Manager
|
|
2293
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2294
|
-
* @permissionScope Manage Portfolio
|
|
2295
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2296
|
-
* @permissionScope Manage Blog
|
|
2297
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2298
|
-
* @permissionScope Access Verticals by Automations
|
|
2299
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2300
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2301
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2302
|
-
* @permissionScope Set Up Automations
|
|
2303
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2304
2123
|
* @applicableIdentity APP
|
|
2305
2124
|
* @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
|
|
2306
2125
|
*/
|
|
2307
|
-
|
|
2126
|
+
declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
|
|
2308
2127
|
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2309
|
-
}[FileDescriptorNonNullablePaths]
|
|
2310
|
-
|
|
2128
|
+
}[FileDescriptorNonNullablePaths]> & {
|
|
2129
|
+
__validationErrorsType?: SearchFilesValidationErrors;
|
|
2130
|
+
}>;
|
|
2131
|
+
interface SearchFilesOptions {
|
|
2311
2132
|
/**
|
|
2312
2133
|
* Term to search for. Possible terms include the value of a file's
|
|
2313
2134
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
@@ -2350,33 +2171,11 @@ export interface SearchFilesOptions {
|
|
|
2350
2171
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2351
2172
|
* Learn more in the File and Folder IDs article.
|
|
2352
2173
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
2353
|
-
* @permissionScope Manage Stores
|
|
2354
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2355
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2356
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2357
|
-
* @permissionScope Manage Events
|
|
2358
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2359
|
-
* @permissionScope Manage Challenges
|
|
2360
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2361
|
-
* @permissionScope Read Media Manager
|
|
2362
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
2363
|
-
* @permissionScope Manage Media Manager
|
|
2364
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2365
|
-
* @permissionScope Manage Portfolio
|
|
2366
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2367
|
-
* @permissionScope Manage Blog
|
|
2368
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2369
|
-
* @permissionScope Access Verticals by Automations
|
|
2370
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2371
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2372
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2373
|
-
* @permissionScope Set Up Automations
|
|
2374
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2375
2174
|
* @applicableIdentity APP
|
|
2376
2175
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
|
|
2377
2176
|
*/
|
|
2378
|
-
|
|
2379
|
-
|
|
2177
|
+
declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
|
|
2178
|
+
interface GenerateVideoStreamingUrlOptions {
|
|
2380
2179
|
/** Video stream format. */
|
|
2381
2180
|
format?: StreamFormatWithLiterals;
|
|
2382
2181
|
}
|
|
@@ -2399,31 +2198,11 @@ export interface GenerateVideoStreamingUrlOptions {
|
|
|
2399
2198
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2400
2199
|
* Learn more in the File and Folder IDs article.
|
|
2401
2200
|
* @permissionId MEDIA.SITE_MEDIA_FILES_MOVE_TO_TRASH
|
|
2402
|
-
* @permissionScope Manage Stores
|
|
2403
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2404
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2405
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2406
|
-
* @permissionScope Manage Events
|
|
2407
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2408
|
-
* @permissionScope Manage Challenges
|
|
2409
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2410
|
-
* @permissionScope Manage Media Manager
|
|
2411
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2412
|
-
* @permissionScope Manage Portfolio
|
|
2413
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2414
|
-
* @permissionScope Manage Blog
|
|
2415
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2416
|
-
* @permissionScope Access Verticals by Automations
|
|
2417
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2418
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2419
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2420
|
-
* @permissionScope Set Up Automations
|
|
2421
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2422
2201
|
* @applicableIdentity APP
|
|
2423
2202
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkDeleteFiles
|
|
2424
2203
|
*/
|
|
2425
|
-
|
|
2426
|
-
|
|
2204
|
+
declare function bulkDeleteFiles(fileIds: string[], options?: BulkDeleteFilesOptions): Promise<void>;
|
|
2205
|
+
interface BulkDeleteFilesOptions {
|
|
2427
2206
|
/**
|
|
2428
2207
|
* Whether the specified files are permanently deleted. <br />
|
|
2429
2208
|
* Default: `false`
|
|
@@ -2439,30 +2218,10 @@ export interface BulkDeleteFilesOptions {
|
|
|
2439
2218
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2440
2219
|
* Learn more in the File and Folder IDs article.
|
|
2441
2220
|
* @permissionId MEDIA.SITE_MEDIA_FILES_RESTORE_FROM_TRASH
|
|
2442
|
-
* @permissionScope Manage Stores
|
|
2443
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2444
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2445
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2446
|
-
* @permissionScope Manage Events
|
|
2447
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2448
|
-
* @permissionScope Manage Challenges
|
|
2449
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2450
|
-
* @permissionScope Manage Media Manager
|
|
2451
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2452
|
-
* @permissionScope Manage Portfolio
|
|
2453
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2454
|
-
* @permissionScope Manage Blog
|
|
2455
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2456
|
-
* @permissionScope Access Verticals by Automations
|
|
2457
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2458
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2459
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2460
|
-
* @permissionScope Set Up Automations
|
|
2461
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2462
2221
|
* @applicableIdentity APP
|
|
2463
2222
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkRestoreFilesFromTrashBin
|
|
2464
2223
|
*/
|
|
2465
|
-
|
|
2224
|
+
declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise<void>;
|
|
2466
2225
|
/**
|
|
2467
2226
|
* Retrieves a list of files in the Media Manager's trash bin. <br/>
|
|
2468
2227
|
*
|
|
@@ -2470,35 +2229,15 @@ export declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise
|
|
|
2470
2229
|
* @public
|
|
2471
2230
|
* @param options - Options to use when listing deleted files from the trash bin.
|
|
2472
2231
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST_DELETED
|
|
2473
|
-
* @permissionScope Manage Stores
|
|
2474
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2475
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2476
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2477
|
-
* @permissionScope Manage Events
|
|
2478
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2479
|
-
* @permissionScope Manage Challenges
|
|
2480
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2481
|
-
* @permissionScope Read Media Manager
|
|
2482
|
-
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
2483
|
-
* @permissionScope Manage Media Manager
|
|
2484
|
-
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2485
|
-
* @permissionScope Manage Portfolio
|
|
2486
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2487
|
-
* @permissionScope Manage Blog
|
|
2488
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2489
|
-
* @permissionScope Access Verticals by Automations
|
|
2490
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2491
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2492
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2493
|
-
* @permissionScope Set Up Automations
|
|
2494
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2495
2232
|
* @applicableIdentity APP
|
|
2496
2233
|
* @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
|
|
2497
2234
|
*/
|
|
2498
|
-
|
|
2235
|
+
declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
|
|
2499
2236
|
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2500
|
-
}[FileDescriptorNonNullablePaths]
|
|
2501
|
-
|
|
2237
|
+
}[FileDescriptorNonNullablePaths]> & {
|
|
2238
|
+
__validationErrorsType?: ListDeletedFilesValidationErrors;
|
|
2239
|
+
}>;
|
|
2240
|
+
interface ListDeletedFilesOptions {
|
|
2502
2241
|
/**
|
|
2503
2242
|
* ID of the file's parent folder. <br />
|
|
2504
2243
|
* Default: `media-root`.
|
|
@@ -2523,4 +2262,5 @@ export interface ListDeletedFilesOptions {
|
|
|
2523
2262
|
/** Cursor and paging information. */
|
|
2524
2263
|
paging?: CursorPaging;
|
|
2525
2264
|
}
|
|
2526
|
-
|
|
2265
|
+
|
|
2266
|
+
export { type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorDeletedEnvelope, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorUpdatedEnvelope, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FocalPoint, type FontAsset, type FontMedia, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorDeleted, onFileDescriptorFileFailed, onFileDescriptorFileReady, onFileDescriptorUpdated, searchFiles, updateFileDescriptor };
|