@wix/auto_sdk_media_files 1.0.1 → 1.0.3
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/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +630 -187
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +73 -9
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +630 -187
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +72 -8
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +630 -187
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +73 -9
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +630 -187
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +72 -8
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -2,25 +2,36 @@ export interface FileDescriptor {
|
|
|
2
2
|
/**
|
|
3
3
|
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
4
4
|
* @readonly
|
|
5
|
+
* @maxLength 1000
|
|
5
6
|
*/
|
|
6
7
|
_id?: string;
|
|
7
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* File name as it appears in the Media Manager.
|
|
10
|
+
* @maxLength 200
|
|
11
|
+
*/
|
|
8
12
|
displayName?: string;
|
|
9
13
|
/**
|
|
10
14
|
* Static URL of the file.
|
|
11
15
|
* @readonly
|
|
16
|
+
* @format WEB_URL
|
|
12
17
|
*/
|
|
13
18
|
url?: string;
|
|
14
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* ID of the file's parent folder.
|
|
21
|
+
* @maxLength 100
|
|
22
|
+
*/
|
|
15
23
|
parentFolderId?: string | null;
|
|
16
24
|
/**
|
|
17
25
|
* File hash.
|
|
18
26
|
* @readonly
|
|
27
|
+
* @maxLength 100
|
|
19
28
|
*/
|
|
20
29
|
hash?: string;
|
|
21
30
|
/**
|
|
22
31
|
* Size of the uploaded file in bytes.
|
|
23
32
|
* @readonly
|
|
33
|
+
* @format DECIMAL_VALUE
|
|
34
|
+
* @decimalValue options { maxScale:0 }
|
|
24
35
|
*/
|
|
25
36
|
sizeInBytes?: string | null;
|
|
26
37
|
/**
|
|
@@ -49,14 +60,20 @@ export interface FileDescriptor {
|
|
|
49
60
|
/**
|
|
50
61
|
* URL where the file was uploaded from.
|
|
51
62
|
* @readonly
|
|
63
|
+
* @format WEB_URL
|
|
52
64
|
*/
|
|
53
65
|
sourceUrl?: string | null;
|
|
54
66
|
/**
|
|
55
67
|
* URL of the file's thumbnail.
|
|
56
68
|
* @readonly
|
|
69
|
+
* @format WEB_URL
|
|
57
70
|
*/
|
|
58
71
|
thumbnailUrl?: string | null;
|
|
59
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
* @maxSize 100
|
|
75
|
+
* @maxLength 200
|
|
76
|
+
*/
|
|
60
77
|
labels?: string[];
|
|
61
78
|
/**
|
|
62
79
|
* Date and time the file was created.
|
|
@@ -71,6 +88,7 @@ export interface FileDescriptor {
|
|
|
71
88
|
/**
|
|
72
89
|
* The Wix site ID where the media file is stored.
|
|
73
90
|
* @readonly
|
|
91
|
+
* @maxLength 100
|
|
74
92
|
*/
|
|
75
93
|
siteId?: string;
|
|
76
94
|
/**
|
|
@@ -128,7 +146,10 @@ export interface ImageMedia {
|
|
|
128
146
|
image?: string;
|
|
129
147
|
/** Image colors. */
|
|
130
148
|
colors?: Colors;
|
|
131
|
-
/**
|
|
149
|
+
/**
|
|
150
|
+
* Information about faces in the image. Use to crop images without cutting out faces.
|
|
151
|
+
* @maxSize 100
|
|
152
|
+
*/
|
|
132
153
|
faces?: FaceRecognition[];
|
|
133
154
|
/**
|
|
134
155
|
* Information about the image preview.
|
|
@@ -138,6 +159,7 @@ export interface ImageMedia {
|
|
|
138
159
|
/**
|
|
139
160
|
* Optional, An AI generated description of the image
|
|
140
161
|
* @readonly
|
|
162
|
+
* @maxLength 300
|
|
141
163
|
*/
|
|
142
164
|
caption?: string | null;
|
|
143
165
|
}
|
|
@@ -154,21 +176,36 @@ export interface FocalPoint {
|
|
|
154
176
|
export interface Colors {
|
|
155
177
|
/** Main color of the image. */
|
|
156
178
|
prominent?: Color;
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Color palette of the image.
|
|
181
|
+
* @maxSize 100
|
|
182
|
+
*/
|
|
158
183
|
palette?: Color[];
|
|
159
184
|
}
|
|
160
185
|
export interface Color {
|
|
161
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* HEX color.
|
|
188
|
+
* @format COLOR_HEX
|
|
189
|
+
*/
|
|
162
190
|
hex?: string | null;
|
|
163
191
|
/** RGB color. */
|
|
164
192
|
rgb?: ColorRGB;
|
|
165
193
|
}
|
|
166
194
|
export interface ColorRGB {
|
|
167
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* Red channel.
|
|
197
|
+
* @max 255
|
|
198
|
+
*/
|
|
168
199
|
r?: number | null;
|
|
169
|
-
/**
|
|
200
|
+
/**
|
|
201
|
+
* Green channel.
|
|
202
|
+
* @max 255
|
|
203
|
+
*/
|
|
170
204
|
g?: number | null;
|
|
171
|
-
/**
|
|
205
|
+
/**
|
|
206
|
+
* Blue channel.
|
|
207
|
+
* @max 255
|
|
208
|
+
*/
|
|
172
209
|
b?: number | null;
|
|
173
210
|
}
|
|
174
211
|
/**
|
|
@@ -213,9 +250,15 @@ export interface VideoResolution {
|
|
|
213
250
|
format?: string;
|
|
214
251
|
}
|
|
215
252
|
export interface AudioV2 {
|
|
216
|
-
/**
|
|
253
|
+
/**
|
|
254
|
+
* WixMedia ID.
|
|
255
|
+
* @maxLength 200
|
|
256
|
+
*/
|
|
217
257
|
_id?: string;
|
|
218
|
-
/**
|
|
258
|
+
/**
|
|
259
|
+
* Audio formats available for this file.
|
|
260
|
+
* @maxSize 100
|
|
261
|
+
*/
|
|
219
262
|
assets?: string[];
|
|
220
263
|
/**
|
|
221
264
|
* Audio bitrate.
|
|
@@ -225,6 +268,7 @@ export interface AudioV2 {
|
|
|
225
268
|
/**
|
|
226
269
|
* Audio format.
|
|
227
270
|
* @readonly
|
|
271
|
+
* @maxLength 100
|
|
228
272
|
*/
|
|
229
273
|
format?: string | null;
|
|
230
274
|
/**
|
|
@@ -235,6 +279,8 @@ export interface AudioV2 {
|
|
|
235
279
|
/**
|
|
236
280
|
* Audio size in bytes.
|
|
237
281
|
* @readonly
|
|
282
|
+
* @format DECIMAL_VALUE
|
|
283
|
+
* @decimalValue options { maxScale:0 }
|
|
238
284
|
*/
|
|
239
285
|
sizeInBytes?: string | null;
|
|
240
286
|
}
|
|
@@ -248,7 +294,10 @@ export interface Archive {
|
|
|
248
294
|
* @readonly
|
|
249
295
|
*/
|
|
250
296
|
urlExpirationDate?: Date | null;
|
|
251
|
-
/**
|
|
297
|
+
/**
|
|
298
|
+
* Archive size in bytes.
|
|
299
|
+
* @format DECIMAL_VALUE
|
|
300
|
+
*/
|
|
252
301
|
sizeInBytes?: string | null;
|
|
253
302
|
/** Archive filename. */
|
|
254
303
|
filename?: string | null;
|
|
@@ -275,51 +324,85 @@ export interface Model3D {
|
|
|
275
324
|
/**
|
|
276
325
|
* 3D size in bytes.
|
|
277
326
|
* @readonly
|
|
327
|
+
* @format DECIMAL_VALUE
|
|
278
328
|
*/
|
|
279
329
|
sizeInBytes?: string | null;
|
|
280
330
|
}
|
|
281
331
|
export interface OtherMedia {
|
|
282
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* WixMedia ID. for use with Site Media APIs only
|
|
334
|
+
* @maxLength 200
|
|
335
|
+
*/
|
|
283
336
|
_id?: string;
|
|
284
337
|
/**
|
|
285
338
|
* The media type of the file: 'package', 'raw'
|
|
286
339
|
* @readonly
|
|
340
|
+
* @maxLength 100
|
|
287
341
|
*/
|
|
288
342
|
internalMediaType?: string | null;
|
|
289
343
|
/**
|
|
290
344
|
* size in bytes. Optional.
|
|
291
345
|
* @readonly
|
|
346
|
+
* @format DECIMAL_VALUE
|
|
347
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
292
348
|
*/
|
|
293
349
|
sizeInBytes?: string | null;
|
|
294
|
-
/**
|
|
350
|
+
/**
|
|
351
|
+
* The file URL.
|
|
352
|
+
* @format WEB_URL
|
|
353
|
+
*/
|
|
295
354
|
url?: string;
|
|
296
355
|
}
|
|
297
356
|
export interface FontMedia {
|
|
298
|
-
/**
|
|
357
|
+
/**
|
|
358
|
+
* WixMedia ID. for use with Site Media APIs only
|
|
359
|
+
* @maxLength 200
|
|
360
|
+
*/
|
|
299
361
|
_id?: string | null;
|
|
300
362
|
/**
|
|
301
363
|
* size in bytes. Optional.
|
|
302
364
|
* @readonly
|
|
365
|
+
* @format DECIMAL_VALUE
|
|
366
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
303
367
|
*/
|
|
304
368
|
sizeInBytes?: string | null;
|
|
305
|
-
/**
|
|
369
|
+
/**
|
|
370
|
+
* The format of the font asset. ttf, woff, woff2
|
|
371
|
+
* @maxLength 200
|
|
372
|
+
*/
|
|
306
373
|
format?: string | null;
|
|
307
|
-
/**
|
|
374
|
+
/**
|
|
375
|
+
* The font family name.
|
|
376
|
+
* @maxLength 100
|
|
377
|
+
*/
|
|
308
378
|
family?: string | null;
|
|
309
|
-
/**
|
|
379
|
+
/**
|
|
380
|
+
* The font name
|
|
381
|
+
* @maxLength 100
|
|
382
|
+
*/
|
|
310
383
|
fontName?: string | null;
|
|
311
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* Font formats available for this file.
|
|
386
|
+
* @maxSize 5
|
|
387
|
+
*/
|
|
312
388
|
assets?: FontAsset[];
|
|
313
389
|
}
|
|
314
390
|
export interface FontAsset {
|
|
315
391
|
/**
|
|
316
392
|
* Keys for downloading different assets of a file.
|
|
317
393
|
* Default: `src`, key representing the original file's format and quality.
|
|
394
|
+
* @maxLength 100
|
|
318
395
|
*/
|
|
319
396
|
assetKey?: string | null;
|
|
320
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* The URL of the font asset.
|
|
399
|
+
* @maxLength 200
|
|
400
|
+
*/
|
|
321
401
|
url?: string | null;
|
|
322
|
-
/**
|
|
402
|
+
/**
|
|
403
|
+
* The format of the font asset. ttf, woff, woff2
|
|
404
|
+
* @maxLength 200
|
|
405
|
+
*/
|
|
323
406
|
format?: string | null;
|
|
324
407
|
}
|
|
325
408
|
export declare enum OperationStatus {
|
|
@@ -367,7 +450,10 @@ export declare enum Namespace {
|
|
|
367
450
|
export interface IdentityInfo {
|
|
368
451
|
/** The type of the user that uploaded the file */
|
|
369
452
|
identityType?: IdentityType;
|
|
370
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* User Id. empty when UNKNOWN
|
|
455
|
+
* @format GUID
|
|
456
|
+
*/
|
|
371
457
|
identityId?: string | null;
|
|
372
458
|
}
|
|
373
459
|
export declare enum IdentityType {
|
|
@@ -377,6 +463,173 @@ export declare enum IdentityType {
|
|
|
377
463
|
WIX_USER = "WIX_USER",
|
|
378
464
|
APP = "APP"
|
|
379
465
|
}
|
|
466
|
+
export interface DraftFilePublished {
|
|
467
|
+
/** The file after it was published */
|
|
468
|
+
file?: FileDescriptor;
|
|
469
|
+
/** The namespace the file was published to */
|
|
470
|
+
namespace?: Namespace;
|
|
471
|
+
}
|
|
472
|
+
export interface GetUploadUrlRequest {
|
|
473
|
+
/** file size in bytes */
|
|
474
|
+
fileSize?: number;
|
|
475
|
+
/**
|
|
476
|
+
* file name
|
|
477
|
+
* @maxLength 100
|
|
478
|
+
*/
|
|
479
|
+
fileName?: string;
|
|
480
|
+
/**
|
|
481
|
+
* file content type
|
|
482
|
+
* @maxLength 50
|
|
483
|
+
*/
|
|
484
|
+
contentType?: string;
|
|
485
|
+
}
|
|
486
|
+
export interface GetUploadUrlResponse {
|
|
487
|
+
/**
|
|
488
|
+
* file upload url
|
|
489
|
+
* @maxLength 3000
|
|
490
|
+
*/
|
|
491
|
+
uploadUrl?: string;
|
|
492
|
+
}
|
|
493
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
494
|
+
createdEvent?: EntityCreatedEvent;
|
|
495
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
496
|
+
deletedEvent?: EntityDeletedEvent;
|
|
497
|
+
actionEvent?: ActionEvent;
|
|
498
|
+
/**
|
|
499
|
+
* Unique event ID.
|
|
500
|
+
* Allows clients to ignore duplicate webhooks.
|
|
501
|
+
*/
|
|
502
|
+
_id?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Assumes actions are also always typed to an entity_type
|
|
505
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
506
|
+
*/
|
|
507
|
+
entityFqdn?: string;
|
|
508
|
+
/**
|
|
509
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
510
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
511
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
512
|
+
*/
|
|
513
|
+
slug?: string;
|
|
514
|
+
/** ID of the entity associated with the event. */
|
|
515
|
+
entityId?: string;
|
|
516
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
517
|
+
eventTime?: Date | null;
|
|
518
|
+
/**
|
|
519
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
520
|
+
* (for example, GDPR).
|
|
521
|
+
*/
|
|
522
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
523
|
+
/** If present, indicates the action that triggered the event. */
|
|
524
|
+
originatedFrom?: string | null;
|
|
525
|
+
/**
|
|
526
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
527
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
528
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
529
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
530
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
531
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
532
|
+
*/
|
|
533
|
+
entityEventSequence?: string | null;
|
|
534
|
+
}
|
|
535
|
+
/** @oneof */
|
|
536
|
+
export interface DomainEventBodyOneOf {
|
|
537
|
+
createdEvent?: EntityCreatedEvent;
|
|
538
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
539
|
+
deletedEvent?: EntityDeletedEvent;
|
|
540
|
+
actionEvent?: ActionEvent;
|
|
541
|
+
}
|
|
542
|
+
export interface EntityCreatedEvent {
|
|
543
|
+
entity?: string;
|
|
544
|
+
}
|
|
545
|
+
export interface RestoreInfo {
|
|
546
|
+
deletedDate?: Date | null;
|
|
547
|
+
}
|
|
548
|
+
export interface EntityUpdatedEvent {
|
|
549
|
+
/**
|
|
550
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
551
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
552
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
553
|
+
*/
|
|
554
|
+
currentEntity?: string;
|
|
555
|
+
}
|
|
556
|
+
export interface EntityDeletedEvent {
|
|
557
|
+
/** Entity that was deleted */
|
|
558
|
+
deletedEntity?: string | null;
|
|
559
|
+
}
|
|
560
|
+
export interface ActionEvent {
|
|
561
|
+
body?: string;
|
|
562
|
+
}
|
|
563
|
+
export interface MessageEnvelope {
|
|
564
|
+
/**
|
|
565
|
+
* App instance ID.
|
|
566
|
+
* @format GUID
|
|
567
|
+
*/
|
|
568
|
+
instanceId?: string | null;
|
|
569
|
+
/**
|
|
570
|
+
* Event type.
|
|
571
|
+
* @maxLength 150
|
|
572
|
+
*/
|
|
573
|
+
eventType?: string;
|
|
574
|
+
/** The identification type and identity data. */
|
|
575
|
+
identity?: IdentificationData;
|
|
576
|
+
/** Stringify payload. */
|
|
577
|
+
data?: string;
|
|
578
|
+
}
|
|
579
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
580
|
+
/**
|
|
581
|
+
* ID of a site visitor that has not logged in to the site.
|
|
582
|
+
* @format GUID
|
|
583
|
+
*/
|
|
584
|
+
anonymousVisitorId?: string;
|
|
585
|
+
/**
|
|
586
|
+
* ID of a site visitor that has logged in to the site.
|
|
587
|
+
* @format GUID
|
|
588
|
+
*/
|
|
589
|
+
memberId?: string;
|
|
590
|
+
/**
|
|
591
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
592
|
+
* @format GUID
|
|
593
|
+
*/
|
|
594
|
+
wixUserId?: string;
|
|
595
|
+
/**
|
|
596
|
+
* ID of an app.
|
|
597
|
+
* @format GUID
|
|
598
|
+
*/
|
|
599
|
+
appId?: string;
|
|
600
|
+
/** @readonly */
|
|
601
|
+
identityType?: WebhookIdentityType;
|
|
602
|
+
}
|
|
603
|
+
/** @oneof */
|
|
604
|
+
export interface IdentificationDataIdOneOf {
|
|
605
|
+
/**
|
|
606
|
+
* ID of a site visitor that has not logged in to the site.
|
|
607
|
+
* @format GUID
|
|
608
|
+
*/
|
|
609
|
+
anonymousVisitorId?: string;
|
|
610
|
+
/**
|
|
611
|
+
* ID of a site visitor that has logged in to the site.
|
|
612
|
+
* @format GUID
|
|
613
|
+
*/
|
|
614
|
+
memberId?: string;
|
|
615
|
+
/**
|
|
616
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
617
|
+
* @format GUID
|
|
618
|
+
*/
|
|
619
|
+
wixUserId?: string;
|
|
620
|
+
/**
|
|
621
|
+
* ID of an app.
|
|
622
|
+
* @format GUID
|
|
623
|
+
*/
|
|
624
|
+
appId?: string;
|
|
625
|
+
}
|
|
626
|
+
export declare enum WebhookIdentityType {
|
|
627
|
+
UNKNOWN = "UNKNOWN",
|
|
628
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
629
|
+
MEMBER = "MEMBER",
|
|
630
|
+
WIX_USER = "WIX_USER",
|
|
631
|
+
APP = "APP"
|
|
632
|
+
}
|
|
380
633
|
export interface FileReady {
|
|
381
634
|
/** File entity that is ready with full information. */
|
|
382
635
|
file?: FileDescriptor;
|
|
@@ -386,9 +639,16 @@ export interface FileReady {
|
|
|
386
639
|
triggeredByUndelete?: boolean;
|
|
387
640
|
}
|
|
388
641
|
export interface ExternalInfo {
|
|
389
|
-
/**
|
|
642
|
+
/**
|
|
643
|
+
* External information to specify in the File Ready or File Failed events.
|
|
644
|
+
* @maxLength 1000
|
|
645
|
+
*/
|
|
390
646
|
origin?: string;
|
|
391
|
-
/**
|
|
647
|
+
/**
|
|
648
|
+
* External IDs to specify in the File Ready or File Failed events.
|
|
649
|
+
* @maxSize 30
|
|
650
|
+
* @maxLength 4000
|
|
651
|
+
*/
|
|
392
652
|
externalIds?: string[];
|
|
393
653
|
}
|
|
394
654
|
export interface FileFailed {
|
|
@@ -405,16 +665,19 @@ export interface ApplicationError {
|
|
|
405
665
|
/** Data related to the error. */
|
|
406
666
|
data?: Record<string, any> | null;
|
|
407
667
|
}
|
|
408
|
-
export interface DraftFilePublished {
|
|
409
|
-
/** The file after it was published */
|
|
410
|
-
file?: FileDescriptor;
|
|
411
|
-
/** The namespace the file was published to */
|
|
412
|
-
namespace?: Namespace;
|
|
413
|
-
}
|
|
414
668
|
export interface BulkAnnotateImagesRequest {
|
|
415
|
-
/**
|
|
669
|
+
/**
|
|
670
|
+
* The file ids to run detection on
|
|
671
|
+
* @minSize 1
|
|
672
|
+
* @maxSize 10
|
|
673
|
+
* @maxLength 1000
|
|
674
|
+
*/
|
|
416
675
|
fileIds?: string[];
|
|
417
|
-
/**
|
|
676
|
+
/**
|
|
677
|
+
* A list of detections types to fill for the image
|
|
678
|
+
* @minSize 1
|
|
679
|
+
* @maxSize 10
|
|
680
|
+
*/
|
|
418
681
|
annotationTypes?: ImageAnnotationType[];
|
|
419
682
|
/** When true the endpoint will detect listed information even if the image has this information */
|
|
420
683
|
overwrite?: boolean | null;
|
|
@@ -469,11 +732,17 @@ export interface GenerateFilesDownloadUrlRequest {
|
|
|
469
732
|
*
|
|
470
733
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
471
734
|
* 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)).
|
|
735
|
+
* @minSize 1
|
|
736
|
+
* @maxSize 1000
|
|
737
|
+
* @maxLength 1000
|
|
472
738
|
*/
|
|
473
739
|
fileIds: string[];
|
|
474
740
|
}
|
|
475
741
|
export interface GenerateFilesDownloadUrlResponse {
|
|
476
|
-
/**
|
|
742
|
+
/**
|
|
743
|
+
* URL for downloading the compressed file containing the specified files in the Media Manager.
|
|
744
|
+
* @format WEB_URL
|
|
745
|
+
*/
|
|
477
746
|
downloadUrl?: string;
|
|
478
747
|
}
|
|
479
748
|
export interface GenerateFileDownloadUrlRequest {
|
|
@@ -482,28 +751,34 @@ export interface GenerateFileDownloadUrlRequest {
|
|
|
482
751
|
*
|
|
483
752
|
* 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`.
|
|
484
753
|
* 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)).
|
|
754
|
+
* @maxLength 1000
|
|
485
755
|
*/
|
|
486
756
|
fileId: string;
|
|
487
757
|
/**
|
|
488
758
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
489
759
|
*
|
|
490
760
|
* **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
761
|
+
* @maxLength 100
|
|
491
762
|
*/
|
|
492
763
|
downloadFileName?: string | null;
|
|
493
764
|
/**
|
|
494
765
|
* The time that it takes in minutes for the download URL to expire. <br />
|
|
495
766
|
* Default: `600`. <br />
|
|
496
767
|
* Limit: `525600` (1 year).
|
|
768
|
+
* @min 1
|
|
497
769
|
*/
|
|
498
770
|
expirationInMinutes?: number | null;
|
|
499
771
|
/**
|
|
500
772
|
* The redirect URL for when the temporary download URL with a token expires. <br />
|
|
501
773
|
* Default: A 403 Forbidden response page.
|
|
774
|
+
* @format WEB_URL
|
|
502
775
|
*/
|
|
503
776
|
expirationRedirectUrl?: string | null;
|
|
504
777
|
/**
|
|
505
778
|
* Keys for downloading different assets (format and quality) of a file.
|
|
506
779
|
* Default: `src`, key representing the original file's format and quality.
|
|
780
|
+
* @maxSize 100
|
|
781
|
+
* @maxLength 100
|
|
507
782
|
*/
|
|
508
783
|
assetKeys?: string[] | null;
|
|
509
784
|
/**
|
|
@@ -523,15 +798,22 @@ export declare enum ContentDisposition {
|
|
|
523
798
|
INLINE = "INLINE"
|
|
524
799
|
}
|
|
525
800
|
export interface GenerateFileDownloadUrlResponse {
|
|
526
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* URL for downloading a specific file in the Media Manager.
|
|
803
|
+
* @maxSize 100
|
|
804
|
+
*/
|
|
527
805
|
downloadUrls?: DownloadUrl[];
|
|
528
806
|
}
|
|
529
807
|
export interface DownloadUrl {
|
|
530
|
-
/**
|
|
808
|
+
/**
|
|
809
|
+
* The file download URL.
|
|
810
|
+
* @format WEB_URL
|
|
811
|
+
*/
|
|
531
812
|
url?: string;
|
|
532
813
|
/**
|
|
533
814
|
* Key for downloading a different asset (format and quality) of a file.
|
|
534
815
|
* Default: `src`, key representing the original file's format and quality.
|
|
816
|
+
* @maxLength 100
|
|
535
817
|
*/
|
|
536
818
|
assetKey?: string;
|
|
537
819
|
}
|
|
@@ -539,11 +821,15 @@ export interface ServiceError {
|
|
|
539
821
|
/**
|
|
540
822
|
* Error codes are groups of related errors
|
|
541
823
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
824
|
+
* @maxLength 200
|
|
542
825
|
*/
|
|
543
826
|
internalCode?: string | null;
|
|
544
827
|
/** Debugging information, http status code returned from wix media internal API */
|
|
545
828
|
internalHttpStatusCode?: number | null;
|
|
546
|
-
/**
|
|
829
|
+
/**
|
|
830
|
+
* Optional Debugging information, error key will represent the error "family" returned from wix media internal API
|
|
831
|
+
* @maxLength 200
|
|
832
|
+
*/
|
|
547
833
|
internalKey?: string | null;
|
|
548
834
|
}
|
|
549
835
|
export interface GetFileDescriptorRequest {
|
|
@@ -554,6 +840,7 @@ export interface GetFileDescriptorRequest {
|
|
|
554
840
|
* 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)).
|
|
555
841
|
*
|
|
556
842
|
* If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
|
|
843
|
+
* @maxLength 1000
|
|
557
844
|
*/
|
|
558
845
|
fileId: string;
|
|
559
846
|
}
|
|
@@ -567,11 +854,17 @@ export interface GetFileDescriptorsRequest {
|
|
|
567
854
|
*
|
|
568
855
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
569
856
|
* 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)).
|
|
857
|
+
* @minSize 1
|
|
858
|
+
* @maxSize 100
|
|
859
|
+
* @maxLength 1000
|
|
570
860
|
*/
|
|
571
861
|
fileIds: string[];
|
|
572
862
|
}
|
|
573
863
|
export interface GetFileDescriptorsResponse {
|
|
574
|
-
/**
|
|
864
|
+
/**
|
|
865
|
+
* Information about the requested files.
|
|
866
|
+
* @maxSize 100
|
|
867
|
+
*/
|
|
575
868
|
files?: FileDescriptor[];
|
|
576
869
|
}
|
|
577
870
|
export interface UpdateFileDescriptorRequest {
|
|
@@ -583,33 +876,51 @@ export interface UpdateFileDescriptorResponse {
|
|
|
583
876
|
file?: FileDescriptor;
|
|
584
877
|
}
|
|
585
878
|
export interface UnsupportedRequestValueError {
|
|
586
|
-
/**
|
|
879
|
+
/**
|
|
880
|
+
* Optional A list of allowed values
|
|
881
|
+
* @maxSize 100
|
|
882
|
+
* @maxLength 200
|
|
883
|
+
*/
|
|
587
884
|
allowedValues?: string[];
|
|
588
|
-
/**
|
|
885
|
+
/**
|
|
886
|
+
* The unsupported value send in the request
|
|
887
|
+
* @maxLength 200
|
|
888
|
+
*/
|
|
589
889
|
requestValue?: string;
|
|
590
890
|
}
|
|
591
891
|
export interface GenerateFileUploadUrlRequest {
|
|
592
|
-
/**
|
|
892
|
+
/**
|
|
893
|
+
* File mime type.
|
|
894
|
+
* @maxLength 100
|
|
895
|
+
*/
|
|
593
896
|
mimeType: string | null;
|
|
594
897
|
/**
|
|
595
898
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
596
899
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
900
|
+
* @maxLength 200
|
|
597
901
|
*/
|
|
598
902
|
fileName?: string | null;
|
|
599
903
|
/**
|
|
600
904
|
* File size in bytes.
|
|
601
905
|
* @readonly
|
|
906
|
+
* @format DECIMAL_VALUE
|
|
907
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
602
908
|
*/
|
|
603
909
|
sizeInBytes?: string | null;
|
|
604
910
|
/**
|
|
605
911
|
* ID of the file's parent folder. <br />
|
|
606
912
|
* This folder is the path root for the `filePath`.<br />
|
|
607
913
|
* Default: `media-root`.
|
|
914
|
+
* @maxLength 100
|
|
608
915
|
*/
|
|
609
916
|
parentFolderId?: string | null;
|
|
610
917
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
611
918
|
private?: boolean | null;
|
|
612
|
-
/**
|
|
919
|
+
/**
|
|
920
|
+
* 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.
|
|
921
|
+
* @maxSize 50
|
|
922
|
+
* @maxLength 200
|
|
923
|
+
*/
|
|
613
924
|
labels?: string[] | null;
|
|
614
925
|
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
615
926
|
externalInfo?: ExternalInfo;
|
|
@@ -618,6 +929,7 @@ export interface GenerateFileUploadUrlRequest {
|
|
|
618
929
|
* For example, `/videos/2024/december`. <br/>
|
|
619
930
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
620
931
|
* The folders in the path will be created if they don't already exist. <br />
|
|
932
|
+
* @maxLength 100
|
|
621
933
|
*/
|
|
622
934
|
filePath?: string | null;
|
|
623
935
|
}
|
|
@@ -628,22 +940,30 @@ export interface ImageAnnotationConfigurations {
|
|
|
628
940
|
* A list of detections types to fill for the image
|
|
629
941
|
* If specified at least one valid annotation type should be provided
|
|
630
942
|
* Default will be all detections
|
|
943
|
+
* @maxSize 10
|
|
631
944
|
*/
|
|
632
945
|
annotationTypes?: ImageAnnotationType[];
|
|
633
946
|
}
|
|
634
947
|
export interface GenerateFileUploadUrlResponse {
|
|
635
|
-
/**
|
|
948
|
+
/**
|
|
949
|
+
* The URL for uploading a file to the Media Manager.
|
|
950
|
+
* @format WEB_URL
|
|
951
|
+
*/
|
|
636
952
|
uploadUrl?: string;
|
|
637
953
|
}
|
|
638
954
|
export interface SiteQuotaExceededError {
|
|
639
955
|
/**
|
|
640
956
|
* Error codes are groups of related errors
|
|
641
957
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
958
|
+
* @maxLength 200
|
|
642
959
|
*/
|
|
643
960
|
internalCode?: string | null;
|
|
644
961
|
/** Debugging information, http status code returned from wix media internal API */
|
|
645
962
|
internalHttpStatusCode?: number | null;
|
|
646
|
-
/**
|
|
963
|
+
/**
|
|
964
|
+
* Optional Debugging information, error key will represent the error "family" returned from wix media internal API
|
|
965
|
+
* @maxLength 200
|
|
966
|
+
*/
|
|
647
967
|
internalKey?: string | null;
|
|
648
968
|
/** The quota details */
|
|
649
969
|
quota?: TotalQuota;
|
|
@@ -659,13 +979,17 @@ export interface TotalQuota {
|
|
|
659
979
|
export interface Plans {
|
|
660
980
|
/** Premium Plan */
|
|
661
981
|
premium?: Plan;
|
|
662
|
-
/**
|
|
982
|
+
/**
|
|
983
|
+
* Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available.
|
|
984
|
+
* @format WEB_URL
|
|
985
|
+
*/
|
|
663
986
|
upgradeUrl?: string;
|
|
664
987
|
}
|
|
665
988
|
export interface Plan {
|
|
666
989
|
/**
|
|
667
990
|
* Plan ID - Premium product ID
|
|
668
991
|
* @readonly
|
|
992
|
+
* @format GUID
|
|
669
993
|
*/
|
|
670
994
|
_id?: string;
|
|
671
995
|
/** Plan name */
|
|
@@ -676,27 +1000,38 @@ export interface Plan {
|
|
|
676
1000
|
expiresAt?: Date | null;
|
|
677
1001
|
}
|
|
678
1002
|
export interface GenerateFileResumableUploadUrlRequest {
|
|
679
|
-
/**
|
|
1003
|
+
/**
|
|
1004
|
+
* File mime type.
|
|
1005
|
+
* @maxLength 100
|
|
1006
|
+
*/
|
|
680
1007
|
mimeType: string | null;
|
|
681
1008
|
/**
|
|
682
1009
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
683
1010
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1011
|
+
* @maxLength 200
|
|
684
1012
|
*/
|
|
685
1013
|
fileName?: string | null;
|
|
686
1014
|
/**
|
|
687
1015
|
* File size in bytes.
|
|
688
1016
|
* @readonly
|
|
1017
|
+
* @format DECIMAL_VALUE
|
|
1018
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
689
1019
|
*/
|
|
690
1020
|
sizeInBytes?: string | null;
|
|
691
1021
|
/**
|
|
692
1022
|
* ID of the file's parent folder. <br />
|
|
693
1023
|
* This folder is the path root for the `filePath`.<br />
|
|
694
1024
|
* Default: `media-root`.
|
|
1025
|
+
* @maxLength 100
|
|
695
1026
|
*/
|
|
696
1027
|
parentFolderId?: string | null;
|
|
697
1028
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
698
1029
|
private?: boolean | null;
|
|
699
|
-
/**
|
|
1030
|
+
/**
|
|
1031
|
+
* 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.
|
|
1032
|
+
* @maxSize 500
|
|
1033
|
+
* @maxLength 200
|
|
1034
|
+
*/
|
|
700
1035
|
labels?: string[] | null;
|
|
701
1036
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
702
1037
|
uploadProtocol?: UploadProtocol;
|
|
@@ -705,6 +1040,7 @@ export interface GenerateFileResumableUploadUrlRequest {
|
|
|
705
1040
|
* For example, `/videos/2024/december`. <br/>
|
|
706
1041
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
707
1042
|
* The folders in the path will be created if they don't already exist. <br />
|
|
1043
|
+
* @maxLength 100
|
|
708
1044
|
*/
|
|
709
1045
|
filePath?: string | null;
|
|
710
1046
|
}
|
|
@@ -715,32 +1051,52 @@ export declare enum UploadProtocol {
|
|
|
715
1051
|
export interface GenerateFileResumableUploadUrlResponse {
|
|
716
1052
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
717
1053
|
uploadProtocol?: UploadProtocol;
|
|
718
|
-
/**
|
|
1054
|
+
/**
|
|
1055
|
+
* The URL for uploading a file to the Media Manager.
|
|
1056
|
+
* @format WEB_URL
|
|
1057
|
+
*/
|
|
719
1058
|
uploadUrl?: string;
|
|
720
|
-
/**
|
|
1059
|
+
/**
|
|
1060
|
+
* Single-use upload token.
|
|
1061
|
+
* @maxLength 2000
|
|
1062
|
+
*/
|
|
721
1063
|
uploadToken?: string;
|
|
722
1064
|
}
|
|
723
1065
|
export interface ImportFileRequest {
|
|
724
|
-
/**
|
|
1066
|
+
/**
|
|
1067
|
+
* Publicly accessible external file URL.
|
|
1068
|
+
* @format WEB_URL
|
|
1069
|
+
*/
|
|
725
1070
|
url: string;
|
|
726
1071
|
/**
|
|
727
1072
|
* Media type of the file to import.
|
|
728
1073
|
* excluding: OTHER media type
|
|
729
1074
|
*/
|
|
730
1075
|
mediaType?: MediaType;
|
|
731
|
-
/**
|
|
1076
|
+
/**
|
|
1077
|
+
* File name that appears in the Media Manager.
|
|
1078
|
+
* @maxLength 200
|
|
1079
|
+
*/
|
|
732
1080
|
displayName?: string | null;
|
|
733
1081
|
/**
|
|
734
1082
|
* ID of the file's parent folder. <br />
|
|
735
1083
|
* This folder is the path root for the `filePath`. <br />
|
|
736
1084
|
* Default: `media-root`.
|
|
1085
|
+
* @maxLength 100
|
|
737
1086
|
*/
|
|
738
1087
|
parentFolderId?: string | null;
|
|
739
1088
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
740
1089
|
private?: boolean | null;
|
|
741
|
-
/**
|
|
1090
|
+
/**
|
|
1091
|
+
* 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.
|
|
1092
|
+
* @maxSize 500
|
|
1093
|
+
* @maxLength 200
|
|
1094
|
+
*/
|
|
742
1095
|
labels?: string[] | null;
|
|
743
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
* File mime type.
|
|
1098
|
+
* @maxLength 100
|
|
1099
|
+
*/
|
|
744
1100
|
mimeType?: string;
|
|
745
1101
|
/** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
|
|
746
1102
|
externalInfo?: ExternalInfo;
|
|
@@ -753,6 +1109,7 @@ export interface ImportFileRequest {
|
|
|
753
1109
|
* For example, `/videos/2024/december`. <br/>
|
|
754
1110
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
755
1111
|
* The folders in the path will be created if they don't already exist. <br />
|
|
1112
|
+
* @maxLength 100
|
|
756
1113
|
*/
|
|
757
1114
|
filePath?: string | null;
|
|
758
1115
|
}
|
|
@@ -761,15 +1118,26 @@ export interface ImportFileResponse {
|
|
|
761
1118
|
file?: FileDescriptor;
|
|
762
1119
|
}
|
|
763
1120
|
export interface BulkImportFilesRequest {
|
|
764
|
-
/**
|
|
1121
|
+
/**
|
|
1122
|
+
* Information about the files to import.
|
|
1123
|
+
* @minSize 1
|
|
1124
|
+
* @maxSize 100
|
|
1125
|
+
*/
|
|
765
1126
|
importFileRequests: ImportFileRequest[];
|
|
766
1127
|
}
|
|
767
1128
|
export interface BulkImportFilesResponse {
|
|
768
|
-
/**
|
|
1129
|
+
/**
|
|
1130
|
+
* Information about the imported files.
|
|
1131
|
+
* @maxSize 100
|
|
1132
|
+
*/
|
|
769
1133
|
files?: FileDescriptor[];
|
|
770
1134
|
}
|
|
771
1135
|
export interface BulkImportFileRequest {
|
|
772
|
-
/**
|
|
1136
|
+
/**
|
|
1137
|
+
* Information about the files to import.
|
|
1138
|
+
* @minSize 1
|
|
1139
|
+
* @maxSize 100
|
|
1140
|
+
*/
|
|
773
1141
|
importFileRequests: ImportFileRequest[];
|
|
774
1142
|
/** Default: `true` */
|
|
775
1143
|
returnEntity?: boolean | null;
|
|
@@ -790,9 +1158,13 @@ export interface ListFilesRequest {
|
|
|
790
1158
|
/**
|
|
791
1159
|
* ID of the file's parent folder. <br />
|
|
792
1160
|
* Default:`media-root`.
|
|
1161
|
+
* @maxLength 100
|
|
793
1162
|
*/
|
|
794
1163
|
parentFolderId?: string | null;
|
|
795
|
-
/**
|
|
1164
|
+
/**
|
|
1165
|
+
* File media type.
|
|
1166
|
+
* @maxSize 30
|
|
1167
|
+
*/
|
|
796
1168
|
mediaTypes?: MediaType[];
|
|
797
1169
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
798
1170
|
private?: boolean | null;
|
|
@@ -808,7 +1180,10 @@ export interface ListFilesRequest {
|
|
|
808
1180
|
paging?: CursorPaging;
|
|
809
1181
|
}
|
|
810
1182
|
export interface Sorting {
|
|
811
|
-
/**
|
|
1183
|
+
/**
|
|
1184
|
+
* Name of the field to sort by.
|
|
1185
|
+
* @maxLength 512
|
|
1186
|
+
*/
|
|
812
1187
|
fieldName?: string;
|
|
813
1188
|
/** Sort order. */
|
|
814
1189
|
order?: SortOrder;
|
|
@@ -818,18 +1193,25 @@ export declare enum SortOrder {
|
|
|
818
1193
|
DESC = "DESC"
|
|
819
1194
|
}
|
|
820
1195
|
export interface CursorPaging {
|
|
821
|
-
/**
|
|
1196
|
+
/**
|
|
1197
|
+
* Maximum number of items to return in the results.
|
|
1198
|
+
* @max 100
|
|
1199
|
+
*/
|
|
822
1200
|
limit?: number | null;
|
|
823
1201
|
/**
|
|
824
1202
|
* Pointer to the next or previous page in the list of results.
|
|
825
1203
|
*
|
|
826
1204
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
827
1205
|
* Not relevant for the first request.
|
|
1206
|
+
* @maxLength 16000
|
|
828
1207
|
*/
|
|
829
1208
|
cursor?: string | null;
|
|
830
1209
|
}
|
|
831
1210
|
export interface ListFilesResponse {
|
|
832
|
-
/**
|
|
1211
|
+
/**
|
|
1212
|
+
* List of files in the Media Manager.
|
|
1213
|
+
* @maxSize 200
|
|
1214
|
+
*/
|
|
833
1215
|
files?: FileDescriptor[];
|
|
834
1216
|
/** The next cursor if it exists. */
|
|
835
1217
|
nextCursor?: PagingMetadataV2;
|
|
@@ -841,7 +1223,10 @@ export interface PagingMetadataV2 {
|
|
|
841
1223
|
cursors?: Cursors;
|
|
842
1224
|
}
|
|
843
1225
|
export interface Cursors {
|
|
844
|
-
/**
|
|
1226
|
+
/**
|
|
1227
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1228
|
+
* @maxLength 16000
|
|
1229
|
+
*/
|
|
845
1230
|
next?: string | null;
|
|
846
1231
|
}
|
|
847
1232
|
export interface SearchFilesRequest {
|
|
@@ -849,6 +1234,7 @@ export interface SearchFilesRequest {
|
|
|
849
1234
|
* Term to search for. Possible terms include the value of a file's
|
|
850
1235
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
851
1236
|
* For example, if a file's label is cat, the search term is 'cat'.
|
|
1237
|
+
* @maxLength 200
|
|
852
1238
|
*/
|
|
853
1239
|
search?: string | null;
|
|
854
1240
|
/**
|
|
@@ -856,7 +1242,10 @@ export interface SearchFilesRequest {
|
|
|
856
1242
|
* Default: `MEDIA_ROOT`.
|
|
857
1243
|
*/
|
|
858
1244
|
rootFolder?: RootFolder;
|
|
859
|
-
/**
|
|
1245
|
+
/**
|
|
1246
|
+
* File media type.
|
|
1247
|
+
* @maxSize 30
|
|
1248
|
+
*/
|
|
860
1249
|
mediaTypes?: MediaType[];
|
|
861
1250
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
862
1251
|
private?: boolean | null;
|
|
@@ -880,7 +1269,10 @@ export declare enum RootFolder {
|
|
|
880
1269
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
881
1270
|
}
|
|
882
1271
|
export interface SearchFilesResponse {
|
|
883
|
-
/**
|
|
1272
|
+
/**
|
|
1273
|
+
* Files matching the query.
|
|
1274
|
+
* @maxSize 200
|
|
1275
|
+
*/
|
|
884
1276
|
files?: FileDescriptor[];
|
|
885
1277
|
/** The next cursor if it exists. */
|
|
886
1278
|
nextCursor?: PagingMetadataV2;
|
|
@@ -891,6 +1283,7 @@ export interface GenerateVideoStreamingUrlRequest {
|
|
|
891
1283
|
*
|
|
892
1284
|
* 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`.
|
|
893
1285
|
* 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)).
|
|
1286
|
+
* @maxLength 1000
|
|
894
1287
|
*/
|
|
895
1288
|
fileId: string;
|
|
896
1289
|
/** Video stream format. */
|
|
@@ -908,7 +1301,10 @@ export interface GenerateVideoStreamingUrlResponse {
|
|
|
908
1301
|
export interface GenerateWebSocketTokenRequest {
|
|
909
1302
|
}
|
|
910
1303
|
export interface GenerateWebSocketTokenResponse {
|
|
911
|
-
/**
|
|
1304
|
+
/**
|
|
1305
|
+
* The web socket token for the identity in the request
|
|
1306
|
+
* @maxLength 2000
|
|
1307
|
+
*/
|
|
912
1308
|
token?: string;
|
|
913
1309
|
}
|
|
914
1310
|
export interface BulkDeleteFilesRequest {
|
|
@@ -917,6 +1313,8 @@ export interface BulkDeleteFilesRequest {
|
|
|
917
1313
|
*
|
|
918
1314
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
919
1315
|
* 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)).
|
|
1316
|
+
* @maxSize 1000
|
|
1317
|
+
* @maxLength 1000
|
|
920
1318
|
*/
|
|
921
1319
|
fileIds: string[];
|
|
922
1320
|
/**
|
|
@@ -933,6 +1331,8 @@ export interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
933
1331
|
*
|
|
934
1332
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
935
1333
|
* 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)).
|
|
1334
|
+
* @maxSize 1000
|
|
1335
|
+
* @maxLength 1000
|
|
936
1336
|
*/
|
|
937
1337
|
fileIds: string[];
|
|
938
1338
|
}
|
|
@@ -942,9 +1342,13 @@ export interface ListDeletedFilesRequest {
|
|
|
942
1342
|
/**
|
|
943
1343
|
* ID of the file's parent folder. <br />
|
|
944
1344
|
* Default: `media-root`.
|
|
1345
|
+
* @maxLength 100
|
|
945
1346
|
*/
|
|
946
1347
|
parentFolderId?: string | null;
|
|
947
|
-
/**
|
|
1348
|
+
/**
|
|
1349
|
+
* File media type.
|
|
1350
|
+
* @maxSize 30
|
|
1351
|
+
*/
|
|
948
1352
|
mediaTypes?: MediaType[];
|
|
949
1353
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
950
1354
|
private?: boolean | null;
|
|
@@ -960,7 +1364,10 @@ export interface ListDeletedFilesRequest {
|
|
|
960
1364
|
paging?: CursorPaging;
|
|
961
1365
|
}
|
|
962
1366
|
export interface ListDeletedFilesResponse {
|
|
963
|
-
/**
|
|
1367
|
+
/**
|
|
1368
|
+
* List of files in the Media Manager's trash bin.
|
|
1369
|
+
* @maxSize 200
|
|
1370
|
+
*/
|
|
964
1371
|
files?: FileDescriptor[];
|
|
965
1372
|
/** The next cursor if it exists. */
|
|
966
1373
|
nextCursor?: PagingMetadataV2;
|
|
@@ -971,6 +1378,8 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
971
1378
|
*
|
|
972
1379
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
973
1380
|
* 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)).
|
|
1381
|
+
* @maxSize 100
|
|
1382
|
+
* @maxLength 1000
|
|
974
1383
|
*/
|
|
975
1384
|
fileIds?: string[];
|
|
976
1385
|
/**
|
|
@@ -982,6 +1391,7 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
982
1391
|
* ID of the file's parent folder. <br />
|
|
983
1392
|
* This folder is the path root for the `filePath`. <br />
|
|
984
1393
|
* Default: `media-root`.
|
|
1394
|
+
* @maxLength 100
|
|
985
1395
|
*/
|
|
986
1396
|
parentFolderId?: string | null;
|
|
987
1397
|
/**
|
|
@@ -989,6 +1399,7 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
989
1399
|
* For example, `/videos/2024/december`. <br/>
|
|
990
1400
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
991
1401
|
* The folders in the path will be created if they don't already exist. <br />
|
|
1402
|
+
* @maxLength 100
|
|
992
1403
|
*/
|
|
993
1404
|
filePath?: string | null;
|
|
994
1405
|
/** Should the response return the item following the operation */
|
|
@@ -1015,132 +1426,31 @@ export interface UpdateFileRequest {
|
|
|
1015
1426
|
*
|
|
1016
1427
|
* 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`.
|
|
1017
1428
|
* 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)).
|
|
1429
|
+
* @maxLength 1000
|
|
1018
1430
|
*/
|
|
1019
1431
|
fileId?: string;
|
|
1020
|
-
/**
|
|
1432
|
+
/**
|
|
1433
|
+
* File name that appears in the Media Manager.
|
|
1434
|
+
* @maxLength 200
|
|
1435
|
+
*/
|
|
1021
1436
|
displayName?: string | null;
|
|
1022
1437
|
/**
|
|
1023
1438
|
* ID of the file's parent folder. <br />
|
|
1024
1439
|
* Default: `media-root`.
|
|
1440
|
+
* @maxLength 100
|
|
1025
1441
|
*/
|
|
1026
1442
|
parentFolderId?: string | null;
|
|
1027
|
-
/**
|
|
1443
|
+
/**
|
|
1444
|
+
* 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.
|
|
1445
|
+
* @maxSize 500
|
|
1446
|
+
* @maxLength 200
|
|
1447
|
+
*/
|
|
1028
1448
|
labels?: string[] | null;
|
|
1029
1449
|
}
|
|
1030
1450
|
export interface UpdateFileResponse {
|
|
1031
1451
|
/** Information about the updated file. */
|
|
1032
1452
|
file?: FileDescriptor;
|
|
1033
1453
|
}
|
|
1034
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1035
|
-
createdEvent?: EntityCreatedEvent;
|
|
1036
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1037
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1038
|
-
actionEvent?: ActionEvent;
|
|
1039
|
-
/**
|
|
1040
|
-
* Unique event ID.
|
|
1041
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1042
|
-
*/
|
|
1043
|
-
_id?: string;
|
|
1044
|
-
/**
|
|
1045
|
-
* Assumes actions are also always typed to an entity_type
|
|
1046
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1047
|
-
*/
|
|
1048
|
-
entityFqdn?: string;
|
|
1049
|
-
/**
|
|
1050
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1051
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1052
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1053
|
-
*/
|
|
1054
|
-
slug?: string;
|
|
1055
|
-
/** ID of the entity associated with the event. */
|
|
1056
|
-
entityId?: string;
|
|
1057
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1058
|
-
eventTime?: Date | null;
|
|
1059
|
-
/**
|
|
1060
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1061
|
-
* (for example, GDPR).
|
|
1062
|
-
*/
|
|
1063
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1064
|
-
/** If present, indicates the action that triggered the event. */
|
|
1065
|
-
originatedFrom?: string | null;
|
|
1066
|
-
/**
|
|
1067
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1068
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1069
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1070
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1071
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1072
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1073
|
-
*/
|
|
1074
|
-
entityEventSequence?: string | null;
|
|
1075
|
-
}
|
|
1076
|
-
/** @oneof */
|
|
1077
|
-
export interface DomainEventBodyOneOf {
|
|
1078
|
-
createdEvent?: EntityCreatedEvent;
|
|
1079
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1080
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1081
|
-
actionEvent?: ActionEvent;
|
|
1082
|
-
}
|
|
1083
|
-
export interface EntityCreatedEvent {
|
|
1084
|
-
entity?: string;
|
|
1085
|
-
}
|
|
1086
|
-
export interface RestoreInfo {
|
|
1087
|
-
deletedDate?: Date | null;
|
|
1088
|
-
}
|
|
1089
|
-
export interface EntityUpdatedEvent {
|
|
1090
|
-
/**
|
|
1091
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1092
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1093
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1094
|
-
*/
|
|
1095
|
-
currentEntity?: string;
|
|
1096
|
-
}
|
|
1097
|
-
export interface EntityDeletedEvent {
|
|
1098
|
-
/** Entity that was deleted */
|
|
1099
|
-
deletedEntity?: string | null;
|
|
1100
|
-
}
|
|
1101
|
-
export interface ActionEvent {
|
|
1102
|
-
body?: string;
|
|
1103
|
-
}
|
|
1104
|
-
export interface MessageEnvelope {
|
|
1105
|
-
/** App instance ID. */
|
|
1106
|
-
instanceId?: string | null;
|
|
1107
|
-
/** Event type. */
|
|
1108
|
-
eventType?: string;
|
|
1109
|
-
/** The identification type and identity data. */
|
|
1110
|
-
identity?: IdentificationData;
|
|
1111
|
-
/** Stringify payload. */
|
|
1112
|
-
data?: string;
|
|
1113
|
-
}
|
|
1114
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1115
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1116
|
-
anonymousVisitorId?: string;
|
|
1117
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1118
|
-
memberId?: string;
|
|
1119
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1120
|
-
wixUserId?: string;
|
|
1121
|
-
/** ID of an app. */
|
|
1122
|
-
appId?: string;
|
|
1123
|
-
/** @readonly */
|
|
1124
|
-
identityType?: WebhookIdentityType;
|
|
1125
|
-
}
|
|
1126
|
-
/** @oneof */
|
|
1127
|
-
export interface IdentificationDataIdOneOf {
|
|
1128
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1129
|
-
anonymousVisitorId?: string;
|
|
1130
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1131
|
-
memberId?: string;
|
|
1132
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1133
|
-
wixUserId?: string;
|
|
1134
|
-
/** ID of an app. */
|
|
1135
|
-
appId?: string;
|
|
1136
|
-
}
|
|
1137
|
-
export declare enum WebhookIdentityType {
|
|
1138
|
-
UNKNOWN = "UNKNOWN",
|
|
1139
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1140
|
-
MEMBER = "MEMBER",
|
|
1141
|
-
WIX_USER = "WIX_USER",
|
|
1142
|
-
APP = "APP"
|
|
1143
|
-
}
|
|
1144
1454
|
export interface GenerateFilesDownloadUrlResponseNonNullableFields {
|
|
1145
1455
|
downloadUrl: string;
|
|
1146
1456
|
}
|
|
@@ -1269,9 +1579,15 @@ export interface ListDeletedFilesResponseNonNullableFields {
|
|
|
1269
1579
|
files: FileDescriptorNonNullableFields[];
|
|
1270
1580
|
}
|
|
1271
1581
|
export interface BaseEventMetadata {
|
|
1272
|
-
/**
|
|
1582
|
+
/**
|
|
1583
|
+
* App instance ID.
|
|
1584
|
+
* @format GUID
|
|
1585
|
+
*/
|
|
1273
1586
|
instanceId?: string | null;
|
|
1274
|
-
/**
|
|
1587
|
+
/**
|
|
1588
|
+
* Event type.
|
|
1589
|
+
* @maxLength 150
|
|
1590
|
+
*/
|
|
1275
1591
|
eventType?: string;
|
|
1276
1592
|
/** The identification type and identity data. */
|
|
1277
1593
|
identity?: IdentificationData;
|
|
@@ -1325,6 +1641,8 @@ export interface FileDescriptorDeletedEnvelope {
|
|
|
1325
1641
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1326
1642
|
* @permissionScope Manage Events
|
|
1327
1643
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1644
|
+
* @permissionScope Manage Challenges
|
|
1645
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1328
1646
|
* @permissionScope Read Media Manager
|
|
1329
1647
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1330
1648
|
* @permissionScope Manage Media Manager
|
|
@@ -1335,6 +1653,8 @@ export interface FileDescriptorDeletedEnvelope {
|
|
|
1335
1653
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1336
1654
|
* @permissionScope Manage Restaurants - all permissions
|
|
1337
1655
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1656
|
+
* @permissionScope Set Up Automations
|
|
1657
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1338
1658
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1339
1659
|
* @webhook
|
|
1340
1660
|
* @eventType wix.media.site_media.v1.file_descriptor_deleted
|
|
@@ -1352,6 +1672,8 @@ export interface FileDescriptorFileFailedEnvelope {
|
|
|
1352
1672
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1353
1673
|
* @permissionScope Manage Events
|
|
1354
1674
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1675
|
+
* @permissionScope Manage Challenges
|
|
1676
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1355
1677
|
* @permissionScope Read Media Manager
|
|
1356
1678
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1357
1679
|
* @permissionScope Manage Media Manager
|
|
@@ -1362,6 +1684,8 @@ export interface FileDescriptorFileFailedEnvelope {
|
|
|
1362
1684
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1363
1685
|
* @permissionScope Manage Restaurants - all permissions
|
|
1364
1686
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1687
|
+
* @permissionScope Set Up Automations
|
|
1688
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1365
1689
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1366
1690
|
* @webhook
|
|
1367
1691
|
* @eventType wix.media.site_media.v1.file_descriptor_file_failed
|
|
@@ -1381,6 +1705,8 @@ export interface FileDescriptorFileReadyEnvelope {
|
|
|
1381
1705
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1382
1706
|
* @permissionScope Manage Events
|
|
1383
1707
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1708
|
+
* @permissionScope Manage Challenges
|
|
1709
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1384
1710
|
* @permissionScope Read Media Manager
|
|
1385
1711
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1386
1712
|
* @permissionScope Manage Media Manager
|
|
@@ -1391,6 +1717,8 @@ export interface FileDescriptorFileReadyEnvelope {
|
|
|
1391
1717
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1392
1718
|
* @permissionScope Manage Restaurants - all permissions
|
|
1393
1719
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1720
|
+
* @permissionScope Set Up Automations
|
|
1721
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1394
1722
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1395
1723
|
* @webhook
|
|
1396
1724
|
* @eventType wix.media.site_media.v1.file_descriptor_file_ready
|
|
@@ -1408,6 +1736,8 @@ export interface FileDescriptorUpdatedEnvelope {
|
|
|
1408
1736
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1409
1737
|
* @permissionScope Manage Events
|
|
1410
1738
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1739
|
+
* @permissionScope Manage Challenges
|
|
1740
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1411
1741
|
* @permissionScope Read Media Manager
|
|
1412
1742
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1413
1743
|
* @permissionScope Manage Media Manager
|
|
@@ -1418,6 +1748,8 @@ export interface FileDescriptorUpdatedEnvelope {
|
|
|
1418
1748
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1419
1749
|
* @permissionScope Manage Restaurants - all permissions
|
|
1420
1750
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1751
|
+
* @permissionScope Set Up Automations
|
|
1752
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1421
1753
|
* @permissionId MEDIA.SITE_MEDIA_FILES_READ
|
|
1422
1754
|
* @webhook
|
|
1423
1755
|
* @eventType wix.media.site_media.v1.file_descriptor_updated
|
|
@@ -1444,6 +1776,8 @@ export declare function onFileDescriptorUpdated(handler: (event: FileDescriptorU
|
|
|
1444
1776
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1445
1777
|
* @permissionScope Manage Events
|
|
1446
1778
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1779
|
+
* @permissionScope Manage Challenges
|
|
1780
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1447
1781
|
* @permissionScope Manage Media Manager
|
|
1448
1782
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1449
1783
|
* @permissionScope Manage Portfolio
|
|
@@ -1452,6 +1786,8 @@ export declare function onFileDescriptorUpdated(handler: (event: FileDescriptorU
|
|
|
1452
1786
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1453
1787
|
* @permissionScope Manage Restaurants - all permissions
|
|
1454
1788
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1789
|
+
* @permissionScope Set Up Automations
|
|
1790
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1455
1791
|
* @applicableIdentity APP
|
|
1456
1792
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
|
|
1457
1793
|
*/
|
|
@@ -1479,6 +1815,8 @@ export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<Gen
|
|
|
1479
1815
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1480
1816
|
* @permissionScope Manage Events
|
|
1481
1817
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1818
|
+
* @permissionScope Manage Challenges
|
|
1819
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1482
1820
|
* @permissionScope Manage Media Manager
|
|
1483
1821
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1484
1822
|
* @permissionScope Manage Portfolio
|
|
@@ -1487,6 +1825,8 @@ export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<Gen
|
|
|
1487
1825
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1488
1826
|
* @permissionScope Manage Restaurants - all permissions
|
|
1489
1827
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1828
|
+
* @permissionScope Set Up Automations
|
|
1829
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1490
1830
|
* @applicableIdentity APP
|
|
1491
1831
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
|
|
1492
1832
|
*/
|
|
@@ -1496,22 +1836,27 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1496
1836
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
1497
1837
|
*
|
|
1498
1838
|
* **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1839
|
+
* @maxLength 100
|
|
1499
1840
|
*/
|
|
1500
1841
|
downloadFileName?: string | null;
|
|
1501
1842
|
/**
|
|
1502
1843
|
* The time that it takes in minutes for the download URL to expire. <br />
|
|
1503
1844
|
* Default: `600`. <br />
|
|
1504
1845
|
* Limit: `525600` (1 year).
|
|
1846
|
+
* @min 1
|
|
1505
1847
|
*/
|
|
1506
1848
|
expirationInMinutes?: number | null;
|
|
1507
1849
|
/**
|
|
1508
1850
|
* The redirect URL for when the temporary download URL with a token expires. <br />
|
|
1509
1851
|
* Default: A 403 Forbidden response page.
|
|
1852
|
+
* @format WEB_URL
|
|
1510
1853
|
*/
|
|
1511
1854
|
expirationRedirectUrl?: string | null;
|
|
1512
1855
|
/**
|
|
1513
1856
|
* Keys for downloading different assets (format and quality) of a file.
|
|
1514
1857
|
* Default: `src`, key representing the original file's format and quality.
|
|
1858
|
+
* @maxSize 100
|
|
1859
|
+
* @maxLength 100
|
|
1515
1860
|
*/
|
|
1516
1861
|
assetKeys?: string[] | null;
|
|
1517
1862
|
/**
|
|
@@ -1537,6 +1882,8 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1537
1882
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1538
1883
|
* @permissionScope Manage Events
|
|
1539
1884
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1885
|
+
* @permissionScope Manage Challenges
|
|
1886
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1540
1887
|
* @permissionScope Read Media Manager
|
|
1541
1888
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1542
1889
|
* @permissionScope Manage Media Manager
|
|
@@ -1547,6 +1894,8 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1547
1894
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1548
1895
|
* @permissionScope Manage Restaurants - all permissions
|
|
1549
1896
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1897
|
+
* @permissionScope Set Up Automations
|
|
1898
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1550
1899
|
* @applicableIdentity APP
|
|
1551
1900
|
* @returns Information about the file.
|
|
1552
1901
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
|
|
@@ -1565,6 +1914,8 @@ export declare function getFileDescriptor(fileId: string): Promise<FileDescripto
|
|
|
1565
1914
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1566
1915
|
* @permissionScope Manage Events
|
|
1567
1916
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1917
|
+
* @permissionScope Manage Challenges
|
|
1918
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1568
1919
|
* @permissionScope Read Media Manager
|
|
1569
1920
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1570
1921
|
* @permissionScope Manage Media Manager
|
|
@@ -1575,6 +1926,8 @@ export declare function getFileDescriptor(fileId: string): Promise<FileDescripto
|
|
|
1575
1926
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1576
1927
|
* @permissionScope Manage Restaurants - all permissions
|
|
1577
1928
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1929
|
+
* @permissionScope Set Up Automations
|
|
1930
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1578
1931
|
* @applicableIdentity APP
|
|
1579
1932
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
|
|
1580
1933
|
*/
|
|
@@ -1592,6 +1945,8 @@ export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDe
|
|
|
1592
1945
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1593
1946
|
* @permissionScope Manage Events
|
|
1594
1947
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1948
|
+
* @permissionScope Manage Challenges
|
|
1949
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1595
1950
|
* @permissionScope Manage Media Manager
|
|
1596
1951
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1597
1952
|
* @permissionScope Manage Portfolio
|
|
@@ -1600,6 +1955,8 @@ export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDe
|
|
|
1600
1955
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1601
1956
|
* @permissionScope Manage Restaurants - all permissions
|
|
1602
1957
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1958
|
+
* @permissionScope Set Up Automations
|
|
1959
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1603
1960
|
* @applicableIdentity APP
|
|
1604
1961
|
* @returns Information about the updated file.
|
|
1605
1962
|
* @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
|
|
@@ -1621,6 +1978,8 @@ export declare function updateFileDescriptor(file: FileDescriptor): Promise<File
|
|
|
1621
1978
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1622
1979
|
* @permissionScope Manage Events
|
|
1623
1980
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1981
|
+
* @permissionScope Manage Challenges
|
|
1982
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1624
1983
|
* @permissionScope Manage Media Manager
|
|
1625
1984
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1626
1985
|
* @permissionScope Manage Portfolio
|
|
@@ -1629,6 +1988,8 @@ export declare function updateFileDescriptor(file: FileDescriptor): Promise<File
|
|
|
1629
1988
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1630
1989
|
* @permissionScope Manage Restaurants - all permissions
|
|
1631
1990
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1991
|
+
* @permissionScope Set Up Automations
|
|
1992
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1632
1993
|
* @applicableIdentity APP
|
|
1633
1994
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
|
|
1634
1995
|
*/
|
|
@@ -1637,22 +1998,30 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1637
1998
|
/**
|
|
1638
1999
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1639
2000
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
2001
|
+
* @maxLength 200
|
|
1640
2002
|
*/
|
|
1641
2003
|
fileName?: string | null;
|
|
1642
2004
|
/**
|
|
1643
2005
|
* File size in bytes.
|
|
1644
2006
|
* @readonly
|
|
2007
|
+
* @format DECIMAL_VALUE
|
|
2008
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
1645
2009
|
*/
|
|
1646
2010
|
sizeInBytes?: string | null;
|
|
1647
2011
|
/**
|
|
1648
2012
|
* ID of the file's parent folder. <br />
|
|
1649
2013
|
* This folder is the path root for the `filePath`.<br />
|
|
1650
2014
|
* Default: `media-root`.
|
|
2015
|
+
* @maxLength 100
|
|
1651
2016
|
*/
|
|
1652
2017
|
parentFolderId?: string | null;
|
|
1653
2018
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1654
2019
|
private?: boolean | null;
|
|
1655
|
-
/**
|
|
2020
|
+
/**
|
|
2021
|
+
* 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.
|
|
2022
|
+
* @maxSize 50
|
|
2023
|
+
* @maxLength 200
|
|
2024
|
+
*/
|
|
1656
2025
|
labels?: string[] | null;
|
|
1657
2026
|
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
1658
2027
|
externalInfo?: ExternalInfo;
|
|
@@ -1661,6 +2030,7 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1661
2030
|
* For example, `/videos/2024/december`. <br/>
|
|
1662
2031
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1663
2032
|
* The folders in the path will be created if they don't already exist. <br />
|
|
2033
|
+
* @maxLength 100
|
|
1664
2034
|
*/
|
|
1665
2035
|
filePath?: string | null;
|
|
1666
2036
|
}
|
|
@@ -1680,6 +2050,8 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1680
2050
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1681
2051
|
* @permissionScope Manage Events
|
|
1682
2052
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2053
|
+
* @permissionScope Manage Challenges
|
|
2054
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1683
2055
|
* @permissionScope Manage Media Manager
|
|
1684
2056
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1685
2057
|
* @permissionScope Manage Portfolio
|
|
@@ -1688,6 +2060,8 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1688
2060
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1689
2061
|
* @permissionScope Manage Restaurants - all permissions
|
|
1690
2062
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2063
|
+
* @permissionScope Set Up Automations
|
|
2064
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1691
2065
|
* @applicableIdentity APP
|
|
1692
2066
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
|
|
1693
2067
|
*/
|
|
@@ -1696,22 +2070,30 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
1696
2070
|
/**
|
|
1697
2071
|
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1698
2072
|
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
2073
|
+
* @maxLength 200
|
|
1699
2074
|
*/
|
|
1700
2075
|
fileName?: string | null;
|
|
1701
2076
|
/**
|
|
1702
2077
|
* File size in bytes.
|
|
1703
2078
|
* @readonly
|
|
2079
|
+
* @format DECIMAL_VALUE
|
|
2080
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
1704
2081
|
*/
|
|
1705
2082
|
sizeInBytes?: string | null;
|
|
1706
2083
|
/**
|
|
1707
2084
|
* ID of the file's parent folder. <br />
|
|
1708
2085
|
* This folder is the path root for the `filePath`.<br />
|
|
1709
2086
|
* Default: `media-root`.
|
|
2087
|
+
* @maxLength 100
|
|
1710
2088
|
*/
|
|
1711
2089
|
parentFolderId?: string | null;
|
|
1712
2090
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1713
2091
|
private?: boolean | null;
|
|
1714
|
-
/**
|
|
2092
|
+
/**
|
|
2093
|
+
* 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.
|
|
2094
|
+
* @maxSize 500
|
|
2095
|
+
* @maxLength 200
|
|
2096
|
+
*/
|
|
1715
2097
|
labels?: string[] | null;
|
|
1716
2098
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
1717
2099
|
uploadProtocol?: UploadProtocol;
|
|
@@ -1720,6 +2102,7 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
1720
2102
|
* For example, `/videos/2024/december`. <br/>
|
|
1721
2103
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1722
2104
|
* The folders in the path will be created if they don't already exist. <br />
|
|
2105
|
+
* @maxLength 100
|
|
1723
2106
|
*/
|
|
1724
2107
|
filePath?: string | null;
|
|
1725
2108
|
}
|
|
@@ -1748,6 +2131,8 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
1748
2131
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1749
2132
|
* @permissionScope Manage Events
|
|
1750
2133
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2134
|
+
* @permissionScope Manage Challenges
|
|
2135
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1751
2136
|
* @permissionScope Manage Media Manager
|
|
1752
2137
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1753
2138
|
* @permissionScope Manage Portfolio
|
|
@@ -1756,6 +2141,8 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
1756
2141
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1757
2142
|
* @permissionScope Manage Restaurants - all permissions
|
|
1758
2143
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2144
|
+
* @permissionScope Set Up Automations
|
|
2145
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1759
2146
|
* @applicableIdentity APP
|
|
1760
2147
|
* @fqn com.wix.media.site_media.v1.FilesService.ImportFile
|
|
1761
2148
|
*/
|
|
@@ -1766,19 +2153,30 @@ export interface ImportFileOptions {
|
|
|
1766
2153
|
* excluding: OTHER media type
|
|
1767
2154
|
*/
|
|
1768
2155
|
mediaType?: MediaType;
|
|
1769
|
-
/**
|
|
2156
|
+
/**
|
|
2157
|
+
* File name that appears in the Media Manager.
|
|
2158
|
+
* @maxLength 200
|
|
2159
|
+
*/
|
|
1770
2160
|
displayName?: string | null;
|
|
1771
2161
|
/**
|
|
1772
2162
|
* ID of the file's parent folder. <br />
|
|
1773
2163
|
* This folder is the path root for the `filePath`. <br />
|
|
1774
2164
|
* Default: `media-root`.
|
|
2165
|
+
* @maxLength 100
|
|
1775
2166
|
*/
|
|
1776
2167
|
parentFolderId?: string | null;
|
|
1777
2168
|
/** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1778
2169
|
private?: boolean | null;
|
|
1779
|
-
/**
|
|
2170
|
+
/**
|
|
2171
|
+
* 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.
|
|
2172
|
+
* @maxSize 500
|
|
2173
|
+
* @maxLength 200
|
|
2174
|
+
*/
|
|
1780
2175
|
labels?: string[] | null;
|
|
1781
|
-
/**
|
|
2176
|
+
/**
|
|
2177
|
+
* File mime type.
|
|
2178
|
+
* @maxLength 100
|
|
2179
|
+
*/
|
|
1782
2180
|
mimeType?: string;
|
|
1783
2181
|
/** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
|
|
1784
2182
|
externalInfo?: ExternalInfo;
|
|
@@ -1791,6 +2189,7 @@ export interface ImportFileOptions {
|
|
|
1791
2189
|
* For example, `/videos/2024/december`. <br/>
|
|
1792
2190
|
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1793
2191
|
* The folders in the path will be created if they don't already exist. <br />
|
|
2192
|
+
* @maxLength 100
|
|
1794
2193
|
*/
|
|
1795
2194
|
filePath?: string | null;
|
|
1796
2195
|
}
|
|
@@ -1821,6 +2220,8 @@ export interface ImportFileOptions {
|
|
|
1821
2220
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1822
2221
|
* @permissionScope Manage Events
|
|
1823
2222
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2223
|
+
* @permissionScope Manage Challenges
|
|
2224
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1824
2225
|
* @permissionScope Manage Media Manager
|
|
1825
2226
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1826
2227
|
* @permissionScope Manage Portfolio
|
|
@@ -1829,6 +2230,8 @@ export interface ImportFileOptions {
|
|
|
1829
2230
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1830
2231
|
* @permissionScope Manage Restaurants - all permissions
|
|
1831
2232
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2233
|
+
* @permissionScope Set Up Automations
|
|
2234
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1832
2235
|
* @applicableIdentity APP
|
|
1833
2236
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkImportFiles
|
|
1834
2237
|
* @deprecated
|
|
@@ -1863,6 +2266,8 @@ export declare function bulkImportFiles(importFileRequests: ImportFileRequest[])
|
|
|
1863
2266
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1864
2267
|
* @permissionScope Manage Events
|
|
1865
2268
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2269
|
+
* @permissionScope Manage Challenges
|
|
2270
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1866
2271
|
* @permissionScope Manage Media Manager
|
|
1867
2272
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1868
2273
|
* @permissionScope Manage Portfolio
|
|
@@ -1871,6 +2276,8 @@ export declare function bulkImportFiles(importFileRequests: ImportFileRequest[])
|
|
|
1871
2276
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1872
2277
|
* @permissionScope Manage Restaurants - all permissions
|
|
1873
2278
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2279
|
+
* @permissionScope Set Up Automations
|
|
2280
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1874
2281
|
* @applicableIdentity APP
|
|
1875
2282
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
|
|
1876
2283
|
*/
|
|
@@ -1890,6 +2297,8 @@ export interface BulkImportFileOptions {
|
|
|
1890
2297
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1891
2298
|
* @permissionScope Manage Events
|
|
1892
2299
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2300
|
+
* @permissionScope Manage Challenges
|
|
2301
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1893
2302
|
* @permissionScope Read Media Manager
|
|
1894
2303
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1895
2304
|
* @permissionScope Manage Media Manager
|
|
@@ -1900,6 +2309,8 @@ export interface BulkImportFileOptions {
|
|
|
1900
2309
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1901
2310
|
* @permissionScope Manage Restaurants - all permissions
|
|
1902
2311
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2312
|
+
* @permissionScope Set Up Automations
|
|
2313
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1903
2314
|
* @applicableIdentity APP
|
|
1904
2315
|
* @fqn com.wix.media.site_media.v1.FilesService.ListFiles
|
|
1905
2316
|
*/
|
|
@@ -1908,9 +2319,13 @@ export interface ListFilesOptions {
|
|
|
1908
2319
|
/**
|
|
1909
2320
|
* ID of the file's parent folder. <br />
|
|
1910
2321
|
* Default:`media-root`.
|
|
2322
|
+
* @maxLength 100
|
|
1911
2323
|
*/
|
|
1912
2324
|
parentFolderId?: string | null;
|
|
1913
|
-
/**
|
|
2325
|
+
/**
|
|
2326
|
+
* File media type.
|
|
2327
|
+
* @maxSize 30
|
|
2328
|
+
*/
|
|
1914
2329
|
mediaTypes?: MediaType[];
|
|
1915
2330
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1916
2331
|
private?: boolean | null;
|
|
@@ -1936,6 +2351,8 @@ export interface ListFilesOptions {
|
|
|
1936
2351
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1937
2352
|
* @permissionScope Manage Events
|
|
1938
2353
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2354
|
+
* @permissionScope Manage Challenges
|
|
2355
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1939
2356
|
* @permissionScope Read Media Manager
|
|
1940
2357
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1941
2358
|
* @permissionScope Manage Media Manager
|
|
@@ -1946,6 +2363,8 @@ export interface ListFilesOptions {
|
|
|
1946
2363
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1947
2364
|
* @permissionScope Manage Restaurants - all permissions
|
|
1948
2365
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2366
|
+
* @permissionScope Set Up Automations
|
|
2367
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1949
2368
|
* @applicableIdentity APP
|
|
1950
2369
|
* @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
|
|
1951
2370
|
*/
|
|
@@ -1955,6 +2374,7 @@ export interface SearchFilesOptions {
|
|
|
1955
2374
|
* Term to search for. Possible terms include the value of a file's
|
|
1956
2375
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
1957
2376
|
* For example, if a file's label is cat, the search term is 'cat'.
|
|
2377
|
+
* @maxLength 200
|
|
1958
2378
|
*/
|
|
1959
2379
|
search?: string | null;
|
|
1960
2380
|
/**
|
|
@@ -1962,7 +2382,10 @@ export interface SearchFilesOptions {
|
|
|
1962
2382
|
* Default: `MEDIA_ROOT`.
|
|
1963
2383
|
*/
|
|
1964
2384
|
rootFolder?: RootFolder;
|
|
1965
|
-
/**
|
|
2385
|
+
/**
|
|
2386
|
+
* File media type.
|
|
2387
|
+
* @maxSize 30
|
|
2388
|
+
*/
|
|
1966
2389
|
mediaTypes?: MediaType[];
|
|
1967
2390
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
1968
2391
|
private?: boolean | null;
|
|
@@ -1993,6 +2416,8 @@ export interface SearchFilesOptions {
|
|
|
1993
2416
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1994
2417
|
* @permissionScope Manage Events
|
|
1995
2418
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2419
|
+
* @permissionScope Manage Challenges
|
|
2420
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1996
2421
|
* @permissionScope Read Media Manager
|
|
1997
2422
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
1998
2423
|
* @permissionScope Manage Media Manager
|
|
@@ -2003,6 +2428,8 @@ export interface SearchFilesOptions {
|
|
|
2003
2428
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2004
2429
|
* @permissionScope Manage Restaurants - all permissions
|
|
2005
2430
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2431
|
+
* @permissionScope Set Up Automations
|
|
2432
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2006
2433
|
* @applicableIdentity APP
|
|
2007
2434
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
|
|
2008
2435
|
*/
|
|
@@ -2034,6 +2461,8 @@ export interface GenerateVideoStreamingUrlOptions {
|
|
|
2034
2461
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2035
2462
|
* @permissionScope Manage Events
|
|
2036
2463
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2464
|
+
* @permissionScope Manage Challenges
|
|
2465
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2037
2466
|
* @permissionScope Manage Media Manager
|
|
2038
2467
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2039
2468
|
* @permissionScope Manage Portfolio
|
|
@@ -2042,6 +2471,8 @@ export interface GenerateVideoStreamingUrlOptions {
|
|
|
2042
2471
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2043
2472
|
* @permissionScope Manage Restaurants - all permissions
|
|
2044
2473
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2474
|
+
* @permissionScope Set Up Automations
|
|
2475
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2045
2476
|
* @applicableIdentity APP
|
|
2046
2477
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkDeleteFiles
|
|
2047
2478
|
*/
|
|
@@ -2066,6 +2497,8 @@ export interface BulkDeleteFilesOptions {
|
|
|
2066
2497
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2067
2498
|
* @permissionScope Manage Events
|
|
2068
2499
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2500
|
+
* @permissionScope Manage Challenges
|
|
2501
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2069
2502
|
* @permissionScope Manage Media Manager
|
|
2070
2503
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
2071
2504
|
* @permissionScope Manage Portfolio
|
|
@@ -2074,6 +2507,8 @@ export interface BulkDeleteFilesOptions {
|
|
|
2074
2507
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2075
2508
|
* @permissionScope Manage Restaurants - all permissions
|
|
2076
2509
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2510
|
+
* @permissionScope Set Up Automations
|
|
2511
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2077
2512
|
* @applicableIdentity APP
|
|
2078
2513
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkRestoreFilesFromTrashBin
|
|
2079
2514
|
*/
|
|
@@ -2089,6 +2524,8 @@ export declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise
|
|
|
2089
2524
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2090
2525
|
* @permissionScope Manage Events
|
|
2091
2526
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2527
|
+
* @permissionScope Manage Challenges
|
|
2528
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2092
2529
|
* @permissionScope Read Media Manager
|
|
2093
2530
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
2094
2531
|
* @permissionScope Manage Media Manager
|
|
@@ -2099,6 +2536,8 @@ export declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise
|
|
|
2099
2536
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2100
2537
|
* @permissionScope Manage Restaurants - all permissions
|
|
2101
2538
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2539
|
+
* @permissionScope Set Up Automations
|
|
2540
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2102
2541
|
* @applicableIdentity APP
|
|
2103
2542
|
* @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
|
|
2104
2543
|
*/
|
|
@@ -2107,9 +2546,13 @@ export interface ListDeletedFilesOptions {
|
|
|
2107
2546
|
/**
|
|
2108
2547
|
* ID of the file's parent folder. <br />
|
|
2109
2548
|
* Default: `media-root`.
|
|
2549
|
+
* @maxLength 100
|
|
2110
2550
|
*/
|
|
2111
2551
|
parentFolderId?: string | null;
|
|
2112
|
-
/**
|
|
2552
|
+
/**
|
|
2553
|
+
* File media type.
|
|
2554
|
+
* @maxSize 30
|
|
2555
|
+
*/
|
|
2113
2556
|
mediaTypes?: MediaType[];
|
|
2114
2557
|
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
|
|
2115
2558
|
private?: boolean | null;
|