@wix/auto_sdk_media_files 1.0.1 → 1.0.2

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.
Files changed (45) hide show
  1. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
  2. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
  3. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
  4. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
  5. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
  6. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
  7. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
  8. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
  9. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +590 -187
  10. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +41 -9
  11. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
  12. package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
  13. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
  14. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
  15. package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
  16. package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
  17. package/build/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
  18. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
  19. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
  20. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +590 -187
  21. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +40 -8
  22. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
  23. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
  24. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
  25. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
  26. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
  27. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
  28. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
  29. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
  30. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
  31. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +590 -187
  32. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +41 -9
  33. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
  34. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
  35. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
  36. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
  37. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
  38. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
  39. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +490 -179
  40. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
  41. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
  42. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +590 -187
  43. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +40 -8
  44. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
  45. 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
- /** File name as it appears in the Media Manager. */
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
- /** ID of the file's parent folder. */
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
- /** 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. */
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
- /** Information about faces in the image. Use to crop images without cutting out faces. */
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
- /** Color palette of the image. */
179
+ /**
180
+ * Color palette of the image.
181
+ * @maxSize 100
182
+ */
158
183
  palette?: Color[];
159
184
  }
160
185
  export interface Color {
161
- /** HEX color. */
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
- /** Red channel. */
195
+ /**
196
+ * Red channel.
197
+ * @max 255
198
+ */
168
199
  r?: number | null;
169
- /** Green channel. */
200
+ /**
201
+ * Green channel.
202
+ * @max 255
203
+ */
170
204
  g?: number | null;
171
- /** Blue channel. */
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
- /** WixMedia ID. */
253
+ /**
254
+ * WixMedia ID.
255
+ * @maxLength 200
256
+ */
217
257
  _id?: string;
218
- /** Audio formats available for this file. */
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
- /** Archive size in bytes. */
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
- /** WixMedia ID. for use with Site Media APIs only */
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
- /** The file URL. */
350
+ /**
351
+ * The file URL.
352
+ * @format WEB_URL
353
+ */
295
354
  url?: string;
296
355
  }
297
356
  export interface FontMedia {
298
- /** WixMedia ID. for use with Site Media APIs only */
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
- /** The format of the font asset. ttf, woff, woff2 */
369
+ /**
370
+ * The format of the font asset. ttf, woff, woff2
371
+ * @maxLength 200
372
+ */
306
373
  format?: string | null;
307
- /** The font family name. */
374
+ /**
375
+ * The font family name.
376
+ * @maxLength 100
377
+ */
308
378
  family?: string | null;
309
- /** The font name */
379
+ /**
380
+ * The font name
381
+ * @maxLength 100
382
+ */
310
383
  fontName?: string | null;
311
- /** Font formats available for this file. */
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
- /** The URL of the font asset. */
397
+ /**
398
+ * The URL of the font asset.
399
+ * @maxLength 200
400
+ */
321
401
  url?: string | null;
322
- /** The format of the font asset. ttf, woff, woff2 */
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
- /** User Id. empty when UNKNOWN */
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
- /** External information to specify in the File Ready or File Failed events. */
642
+ /**
643
+ * External information to specify in the File Ready or File Failed events.
644
+ * @maxLength 1000
645
+ */
390
646
  origin?: string;
391
- /** External IDs to specify in the File Ready or File Failed events. */
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
- /** The file ids to run detection on */
669
+ /**
670
+ * The file ids to run detection on
671
+ * @minSize 1
672
+ * @maxSize 10
673
+ * @maxLength 1000
674
+ */
416
675
  fileIds?: string[];
417
- /** A list of detections types to fill for the image */
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
- /** URL for downloading the compressed file containing the specified files in the Media Manager. */
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
- /** URL for downloading a specific file in the Media Manager. */
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
- /** The file download URL. */
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
- /** Optional Debugging information, error key will represent the error "family" returned from wix media internal API */
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
- /** Information about the requested files. */
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
- /** Optional A list of allowed values */
879
+ /**
880
+ * Optional A list of allowed values
881
+ * @maxSize 100
882
+ * @maxLength 200
883
+ */
587
884
  allowedValues?: string[];
588
- /** The unsupported value send in the request */
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
- /** File mime type. */
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
- /** 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. */
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
- /** The URL for uploading a file to the Media Manager. */
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
- /** Optional Debugging information, error key will represent the error "family" returned from wix media internal API */
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
- /** Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available. */
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
- /** File mime type. */
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
- /** 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. */
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
- /** The URL for uploading a file to the Media Manager. */
1054
+ /**
1055
+ * The URL for uploading a file to the Media Manager.
1056
+ * @format WEB_URL
1057
+ */
719
1058
  uploadUrl?: string;
720
- /** Single-use upload token. */
1059
+ /**
1060
+ * Single-use upload token.
1061
+ * @maxLength 2000
1062
+ */
721
1063
  uploadToken?: string;
722
1064
  }
723
1065
  export interface ImportFileRequest {
724
- /** Publicly accessible external file URL. */
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
- /** File name that appears in the Media Manager. */
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
- /** 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. */
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
- /** File mime type. */
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
- /** Information about the files to import. */
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
- /** Information about the imported files. */
1129
+ /**
1130
+ * Information about the imported files.
1131
+ * @maxSize 100
1132
+ */
769
1133
  files?: FileDescriptor[];
770
1134
  }
771
1135
  export interface BulkImportFileRequest {
772
- /** Information about the files to import. */
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
- /** File media type. */
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
- /** Name of the field to sort by. */
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
- /** Maximum number of items to return in the results. */
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
- /** List of files in the Media Manager. */
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
- /** Cursor string pointing to the next page in the list of results. */
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
- /** File media type. */
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
- /** Files matching the query. */
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
- /** The web socket token for the identity in the request */
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
- /** File media type. */
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
- /** List of files in the Media Manager's trash bin. */
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
- /** File name that appears in the Media Manager. */
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
- /** 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. */
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
- /** App instance ID. */
1582
+ /**
1583
+ * App instance ID.
1584
+ * @format GUID
1585
+ */
1273
1586
  instanceId?: string | null;
1274
- /** Event type. */
1587
+ /**
1588
+ * Event type.
1589
+ * @maxLength 150
1590
+ */
1275
1591
  eventType?: string;
1276
1592
  /** The identification type and identity data. */
1277
1593
  identity?: IdentificationData;
@@ -1335,6 +1651,8 @@ export interface FileDescriptorDeletedEnvelope {
1335
1651
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1336
1652
  * @permissionScope Manage Restaurants - all permissions
1337
1653
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1654
+ * @permissionScope Set Up Automations
1655
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1338
1656
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1339
1657
  * @webhook
1340
1658
  * @eventType wix.media.site_media.v1.file_descriptor_deleted
@@ -1362,6 +1680,8 @@ export interface FileDescriptorFileFailedEnvelope {
1362
1680
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1363
1681
  * @permissionScope Manage Restaurants - all permissions
1364
1682
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1683
+ * @permissionScope Set Up Automations
1684
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1365
1685
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1366
1686
  * @webhook
1367
1687
  * @eventType wix.media.site_media.v1.file_descriptor_file_failed
@@ -1391,6 +1711,8 @@ export interface FileDescriptorFileReadyEnvelope {
1391
1711
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1392
1712
  * @permissionScope Manage Restaurants - all permissions
1393
1713
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1714
+ * @permissionScope Set Up Automations
1715
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1394
1716
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1395
1717
  * @webhook
1396
1718
  * @eventType wix.media.site_media.v1.file_descriptor_file_ready
@@ -1418,6 +1740,8 @@ export interface FileDescriptorUpdatedEnvelope {
1418
1740
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1419
1741
  * @permissionScope Manage Restaurants - all permissions
1420
1742
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1743
+ * @permissionScope Set Up Automations
1744
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1421
1745
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1422
1746
  * @webhook
1423
1747
  * @eventType wix.media.site_media.v1.file_descriptor_updated
@@ -1452,6 +1776,8 @@ export declare function onFileDescriptorUpdated(handler: (event: FileDescriptorU
1452
1776
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1453
1777
  * @permissionScope Manage Restaurants - all permissions
1454
1778
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1779
+ * @permissionScope Set Up Automations
1780
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1455
1781
  * @applicableIdentity APP
1456
1782
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
1457
1783
  */
@@ -1487,6 +1813,8 @@ export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<Gen
1487
1813
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1488
1814
  * @permissionScope Manage Restaurants - all permissions
1489
1815
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1816
+ * @permissionScope Set Up Automations
1817
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1490
1818
  * @applicableIdentity APP
1491
1819
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
1492
1820
  */
@@ -1496,22 +1824,27 @@ export interface GenerateFileDownloadUrlOptions {
1496
1824
  * 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
1825
  *
1498
1826
  * **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1827
+ * @maxLength 100
1499
1828
  */
1500
1829
  downloadFileName?: string | null;
1501
1830
  /**
1502
1831
  * The time that it takes in minutes for the download URL to expire. <br />
1503
1832
  * Default: `600`. <br />
1504
1833
  * Limit: `525600` (1 year).
1834
+ * @min 1
1505
1835
  */
1506
1836
  expirationInMinutes?: number | null;
1507
1837
  /**
1508
1838
  * The redirect URL for when the temporary download URL with a token expires. <br />
1509
1839
  * Default: A 403 Forbidden response page.
1840
+ * @format WEB_URL
1510
1841
  */
1511
1842
  expirationRedirectUrl?: string | null;
1512
1843
  /**
1513
1844
  * Keys for downloading different assets (format and quality) of a file.
1514
1845
  * Default: `src`, key representing the original file's format and quality.
1846
+ * @maxSize 100
1847
+ * @maxLength 100
1515
1848
  */
1516
1849
  assetKeys?: string[] | null;
1517
1850
  /**
@@ -1547,6 +1880,8 @@ export interface GenerateFileDownloadUrlOptions {
1547
1880
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1548
1881
  * @permissionScope Manage Restaurants - all permissions
1549
1882
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1883
+ * @permissionScope Set Up Automations
1884
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1550
1885
  * @applicableIdentity APP
1551
1886
  * @returns Information about the file.
1552
1887
  * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
@@ -1575,6 +1910,8 @@ export declare function getFileDescriptor(fileId: string): Promise<FileDescripto
1575
1910
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1576
1911
  * @permissionScope Manage Restaurants - all permissions
1577
1912
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1913
+ * @permissionScope Set Up Automations
1914
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1578
1915
  * @applicableIdentity APP
1579
1916
  * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
1580
1917
  */
@@ -1600,6 +1937,8 @@ export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDe
1600
1937
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1601
1938
  * @permissionScope Manage Restaurants - all permissions
1602
1939
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1940
+ * @permissionScope Set Up Automations
1941
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1603
1942
  * @applicableIdentity APP
1604
1943
  * @returns Information about the updated file.
1605
1944
  * @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
@@ -1629,6 +1968,8 @@ export declare function updateFileDescriptor(file: FileDescriptor): Promise<File
1629
1968
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1630
1969
  * @permissionScope Manage Restaurants - all permissions
1631
1970
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1971
+ * @permissionScope Set Up Automations
1972
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1632
1973
  * @applicableIdentity APP
1633
1974
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
1634
1975
  */
@@ -1637,22 +1978,30 @@ export interface GenerateFileUploadUrlOptions {
1637
1978
  /**
1638
1979
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1639
1980
  * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1981
+ * @maxLength 200
1640
1982
  */
1641
1983
  fileName?: string | null;
1642
1984
  /**
1643
1985
  * File size in bytes.
1644
1986
  * @readonly
1987
+ * @format DECIMAL_VALUE
1988
+ * @decimalValue options { gte:0, maxScale:0 }
1645
1989
  */
1646
1990
  sizeInBytes?: string | null;
1647
1991
  /**
1648
1992
  * ID of the file's parent folder. <br />
1649
1993
  * This folder is the path root for the `filePath`.<br />
1650
1994
  * Default: `media-root`.
1995
+ * @maxLength 100
1651
1996
  */
1652
1997
  parentFolderId?: string | null;
1653
1998
  /** 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
1999
  private?: boolean | null;
1655
- /** 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. */
2000
+ /**
2001
+ * 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.
2002
+ * @maxSize 50
2003
+ * @maxLength 200
2004
+ */
1656
2005
  labels?: string[] | null;
1657
2006
  /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
1658
2007
  externalInfo?: ExternalInfo;
@@ -1661,6 +2010,7 @@ export interface GenerateFileUploadUrlOptions {
1661
2010
  * For example, `/videos/2024/december`. <br/>
1662
2011
  * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1663
2012
  * The folders in the path will be created if they don't already exist. <br />
2013
+ * @maxLength 100
1664
2014
  */
1665
2015
  filePath?: string | null;
1666
2016
  }
@@ -1688,6 +2038,8 @@ export interface GenerateFileUploadUrlOptions {
1688
2038
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1689
2039
  * @permissionScope Manage Restaurants - all permissions
1690
2040
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2041
+ * @permissionScope Set Up Automations
2042
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1691
2043
  * @applicableIdentity APP
1692
2044
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
1693
2045
  */
@@ -1696,22 +2048,30 @@ export interface GenerateFileResumableUploadUrlOptions {
1696
2048
  /**
1697
2049
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1698
2050
  * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
2051
+ * @maxLength 200
1699
2052
  */
1700
2053
  fileName?: string | null;
1701
2054
  /**
1702
2055
  * File size in bytes.
1703
2056
  * @readonly
2057
+ * @format DECIMAL_VALUE
2058
+ * @decimalValue options { gte:0, maxScale:0 }
1704
2059
  */
1705
2060
  sizeInBytes?: string | null;
1706
2061
  /**
1707
2062
  * ID of the file's parent folder. <br />
1708
2063
  * This folder is the path root for the `filePath`.<br />
1709
2064
  * Default: `media-root`.
2065
+ * @maxLength 100
1710
2066
  */
1711
2067
  parentFolderId?: string | null;
1712
2068
  /** 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
2069
  private?: boolean | null;
1714
- /** 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. */
2070
+ /**
2071
+ * 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.
2072
+ * @maxSize 500
2073
+ * @maxLength 200
2074
+ */
1715
2075
  labels?: string[] | null;
1716
2076
  /** The upload protocol to use for implementing the resumable upload. */
1717
2077
  uploadProtocol?: UploadProtocol;
@@ -1720,6 +2080,7 @@ export interface GenerateFileResumableUploadUrlOptions {
1720
2080
  * For example, `/videos/2024/december`. <br/>
1721
2081
  * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1722
2082
  * The folders in the path will be created if they don't already exist. <br />
2083
+ * @maxLength 100
1723
2084
  */
1724
2085
  filePath?: string | null;
1725
2086
  }
@@ -1756,6 +2117,8 @@ export interface GenerateFileResumableUploadUrlOptions {
1756
2117
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1757
2118
  * @permissionScope Manage Restaurants - all permissions
1758
2119
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2120
+ * @permissionScope Set Up Automations
2121
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1759
2122
  * @applicableIdentity APP
1760
2123
  * @fqn com.wix.media.site_media.v1.FilesService.ImportFile
1761
2124
  */
@@ -1766,19 +2129,30 @@ export interface ImportFileOptions {
1766
2129
  * excluding: OTHER media type
1767
2130
  */
1768
2131
  mediaType?: MediaType;
1769
- /** File name that appears in the Media Manager. */
2132
+ /**
2133
+ * File name that appears in the Media Manager.
2134
+ * @maxLength 200
2135
+ */
1770
2136
  displayName?: string | null;
1771
2137
  /**
1772
2138
  * ID of the file's parent folder. <br />
1773
2139
  * This folder is the path root for the `filePath`. <br />
1774
2140
  * Default: `media-root`.
2141
+ * @maxLength 100
1775
2142
  */
1776
2143
  parentFolderId?: string | null;
1777
2144
  /** 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
2145
  private?: boolean | null;
1779
- /** 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. */
2146
+ /**
2147
+ * 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.
2148
+ * @maxSize 500
2149
+ * @maxLength 200
2150
+ */
1780
2151
  labels?: string[] | null;
1781
- /** File mime type. */
2152
+ /**
2153
+ * File mime type.
2154
+ * @maxLength 100
2155
+ */
1782
2156
  mimeType?: string;
1783
2157
  /** 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
2158
  externalInfo?: ExternalInfo;
@@ -1791,6 +2165,7 @@ export interface ImportFileOptions {
1791
2165
  * For example, `/videos/2024/december`. <br/>
1792
2166
  * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1793
2167
  * The folders in the path will be created if they don't already exist. <br />
2168
+ * @maxLength 100
1794
2169
  */
1795
2170
  filePath?: string | null;
1796
2171
  }
@@ -1829,6 +2204,8 @@ export interface ImportFileOptions {
1829
2204
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1830
2205
  * @permissionScope Manage Restaurants - all permissions
1831
2206
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2207
+ * @permissionScope Set Up Automations
2208
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1832
2209
  * @applicableIdentity APP
1833
2210
  * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFiles
1834
2211
  * @deprecated
@@ -1871,6 +2248,8 @@ export declare function bulkImportFiles(importFileRequests: ImportFileRequest[])
1871
2248
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1872
2249
  * @permissionScope Manage Restaurants - all permissions
1873
2250
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2251
+ * @permissionScope Set Up Automations
2252
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1874
2253
  * @applicableIdentity APP
1875
2254
  * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
1876
2255
  */
@@ -1900,6 +2279,8 @@ export interface BulkImportFileOptions {
1900
2279
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1901
2280
  * @permissionScope Manage Restaurants - all permissions
1902
2281
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2282
+ * @permissionScope Set Up Automations
2283
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1903
2284
  * @applicableIdentity APP
1904
2285
  * @fqn com.wix.media.site_media.v1.FilesService.ListFiles
1905
2286
  */
@@ -1908,9 +2289,13 @@ export interface ListFilesOptions {
1908
2289
  /**
1909
2290
  * ID of the file's parent folder. <br />
1910
2291
  * Default:`media-root`.
2292
+ * @maxLength 100
1911
2293
  */
1912
2294
  parentFolderId?: string | null;
1913
- /** File media type. */
2295
+ /**
2296
+ * File media type.
2297
+ * @maxSize 30
2298
+ */
1914
2299
  mediaTypes?: MediaType[];
1915
2300
  /** \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
2301
  private?: boolean | null;
@@ -1946,6 +2331,8 @@ export interface ListFilesOptions {
1946
2331
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1947
2332
  * @permissionScope Manage Restaurants - all permissions
1948
2333
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2334
+ * @permissionScope Set Up Automations
2335
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1949
2336
  * @applicableIdentity APP
1950
2337
  * @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
1951
2338
  */
@@ -1955,6 +2342,7 @@ export interface SearchFilesOptions {
1955
2342
  * Term to search for. Possible terms include the value of a file's
1956
2343
  * `displayName`, `mimeType`, and `label`. <br />
1957
2344
  * For example, if a file's label is cat, the search term is 'cat'.
2345
+ * @maxLength 200
1958
2346
  */
1959
2347
  search?: string | null;
1960
2348
  /**
@@ -1962,7 +2350,10 @@ export interface SearchFilesOptions {
1962
2350
  * Default: `MEDIA_ROOT`.
1963
2351
  */
1964
2352
  rootFolder?: RootFolder;
1965
- /** File media type. */
2353
+ /**
2354
+ * File media type.
2355
+ * @maxSize 30
2356
+ */
1966
2357
  mediaTypes?: MediaType[];
1967
2358
  /** \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
2359
  private?: boolean | null;
@@ -2003,6 +2394,8 @@ export interface SearchFilesOptions {
2003
2394
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2004
2395
  * @permissionScope Manage Restaurants - all permissions
2005
2396
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2397
+ * @permissionScope Set Up Automations
2398
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2006
2399
  * @applicableIdentity APP
2007
2400
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
2008
2401
  */
@@ -2042,6 +2435,8 @@ export interface GenerateVideoStreamingUrlOptions {
2042
2435
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2043
2436
  * @permissionScope Manage Restaurants - all permissions
2044
2437
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2438
+ * @permissionScope Set Up Automations
2439
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2045
2440
  * @applicableIdentity APP
2046
2441
  * @fqn com.wix.media.site_media.v1.FilesService.BulkDeleteFiles
2047
2442
  */
@@ -2074,6 +2469,8 @@ export interface BulkDeleteFilesOptions {
2074
2469
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2075
2470
  * @permissionScope Manage Restaurants - all permissions
2076
2471
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2472
+ * @permissionScope Set Up Automations
2473
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2077
2474
  * @applicableIdentity APP
2078
2475
  * @fqn com.wix.media.site_media.v1.FilesService.BulkRestoreFilesFromTrashBin
2079
2476
  */
@@ -2099,6 +2496,8 @@ export declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise
2099
2496
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2100
2497
  * @permissionScope Manage Restaurants - all permissions
2101
2498
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2499
+ * @permissionScope Set Up Automations
2500
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2102
2501
  * @applicableIdentity APP
2103
2502
  * @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
2104
2503
  */
@@ -2107,9 +2506,13 @@ export interface ListDeletedFilesOptions {
2107
2506
  /**
2108
2507
  * ID of the file's parent folder. <br />
2109
2508
  * Default: `media-root`.
2509
+ * @maxLength 100
2110
2510
  */
2111
2511
  parentFolderId?: string | null;
2112
- /** File media type. */
2512
+ /**
2513
+ * File media type.
2514
+ * @maxSize 30
2515
+ */
2113
2516
  mediaTypes?: MediaType[];
2114
2517
  /** \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
2518
  private?: boolean | null;