@wix/auto_sdk_media_files 1.0.76 → 1.0.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +6 -6
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +222 -33
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +205 -19
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +11 -9
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +6 -6
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +222 -33
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +205 -19
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +11 -9
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +6 -6
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +222 -33
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +205 -19
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +11 -9
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +6 -6
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +222 -33
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +205 -19
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +11 -9
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -479,6 +479,183 @@ declare enum IdentityType {
|
|
|
479
479
|
}
|
|
480
480
|
/** @enumType */
|
|
481
481
|
type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
482
|
+
/**
|
|
483
|
+
* Internal-only metadata preserved from the raw PM contract that has no
|
|
484
|
+
* representation in the domain model. Populated during toDomain and used
|
|
485
|
+
* by fromDomain to reconstruct a lossless raw PM file.
|
|
486
|
+
*/
|
|
487
|
+
interface FileAdditionalProperties extends FileAdditionalPropertiesMediaAdditionalPropertiesOneOf {
|
|
488
|
+
/** Set when the file is an audio file; preserves PM-specific audio fields. */
|
|
489
|
+
audio?: AudioAdditionalProperties;
|
|
490
|
+
/** Set when the file is a video file; preserves PM-specific video fields. */
|
|
491
|
+
video?: VideoAdditionalProperties;
|
|
492
|
+
/** Set when the file is a font file; preserves PM-specific font fields. */
|
|
493
|
+
font?: FontAdditionalProperties;
|
|
494
|
+
/** Set when the file is a document file; preserves PM-specific document fields. */
|
|
495
|
+
document?: DocumentAdditionalProperties;
|
|
496
|
+
/** Set when the file is a 3D model file; preserves PM-specific model3d fields. */
|
|
497
|
+
model3d?: Model3dAdditionalProperties;
|
|
498
|
+
/** Set when the file is an image file; preserves PM-specific image fields. */
|
|
499
|
+
image?: ImageAdditionalProperties;
|
|
500
|
+
}
|
|
501
|
+
/** @oneof */
|
|
502
|
+
interface FileAdditionalPropertiesMediaAdditionalPropertiesOneOf {
|
|
503
|
+
/** Set when the file is an audio file; preserves PM-specific audio fields. */
|
|
504
|
+
audio?: AudioAdditionalProperties;
|
|
505
|
+
/** Set when the file is a video file; preserves PM-specific video fields. */
|
|
506
|
+
video?: VideoAdditionalProperties;
|
|
507
|
+
/** Set when the file is a font file; preserves PM-specific font fields. */
|
|
508
|
+
font?: FontAdditionalProperties;
|
|
509
|
+
/** Set when the file is a document file; preserves PM-specific document fields. */
|
|
510
|
+
document?: DocumentAdditionalProperties;
|
|
511
|
+
/** Set when the file is a 3D model file; preserves PM-specific model3d fields. */
|
|
512
|
+
model3d?: Model3dAdditionalProperties;
|
|
513
|
+
/** Set when the file is an image file; preserves PM-specific image fields. */
|
|
514
|
+
image?: ImageAdditionalProperties;
|
|
515
|
+
}
|
|
516
|
+
interface AudioAdditionalProperties {
|
|
517
|
+
/** From PmAudioInfo.file_input.sample_rate, in Hz (e.g. 44100). */
|
|
518
|
+
sampleRate?: number | null;
|
|
519
|
+
/** From PmAudioInfo.file_input.channels (e.g. 2 for stereo). */
|
|
520
|
+
channels?: number | null;
|
|
521
|
+
/**
|
|
522
|
+
* Parallel array to AudioV2.assets, same sort order.
|
|
523
|
+
* @maxSize 10
|
|
524
|
+
*/
|
|
525
|
+
assets?: AudioAssetAdditionalProperties[];
|
|
526
|
+
}
|
|
527
|
+
interface AudioAssetAdditionalProperties {
|
|
528
|
+
/**
|
|
529
|
+
* From PmAudioInfo.file_output.audio[].tag (e.g. "high").
|
|
530
|
+
* @maxLength 100
|
|
531
|
+
*/
|
|
532
|
+
tag?: string | null;
|
|
533
|
+
/** From PmAudioInfo.file_output.audio[].audio_bitrate, in bits per second. */
|
|
534
|
+
audioBitrate?: number | null;
|
|
535
|
+
/**
|
|
536
|
+
* From PmAudioInfo.file_output.audio[].status (e.g. "READY").
|
|
537
|
+
* @maxLength 30
|
|
538
|
+
*/
|
|
539
|
+
status?: string | null;
|
|
540
|
+
/**
|
|
541
|
+
* From PmAudioInfo.file_output.audio[].url (only populated for secure assets where PM omits the URL).
|
|
542
|
+
* @format WEB_URL
|
|
543
|
+
*/
|
|
544
|
+
url?: string | null;
|
|
545
|
+
}
|
|
546
|
+
interface VideoAdditionalProperties {
|
|
547
|
+
/**
|
|
548
|
+
* From PmVideoInfo.file_input.fps (e.g. "25/1").
|
|
549
|
+
* @maxLength 10
|
|
550
|
+
*/
|
|
551
|
+
fps?: string | null;
|
|
552
|
+
/** From PmVideoInfo.file_input.video_bitrate, in bits per second. */
|
|
553
|
+
videoBitrate?: number | null;
|
|
554
|
+
/** From PmVideoInfo.file_input.rotation, in degrees (e.g. 0, 90, 180, 270). */
|
|
555
|
+
rotation?: number | null;
|
|
556
|
+
/**
|
|
557
|
+
* From PmVideoInfo.file_input.display_aspect_ratio (e.g. "16:9").
|
|
558
|
+
* @maxLength 10
|
|
559
|
+
*/
|
|
560
|
+
displayAspectRatio?: string | null;
|
|
561
|
+
/** From PmVideoInfo.file_input.audio_bitrate, in bits per second. */
|
|
562
|
+
audioBitrate?: number | null;
|
|
563
|
+
/**
|
|
564
|
+
* From PmVideoInfo.file_input.sample_aspect_ration (e.g. "1:1").
|
|
565
|
+
* @maxLength 10
|
|
566
|
+
*/
|
|
567
|
+
sampleAspectRatio?: string | null;
|
|
568
|
+
/**
|
|
569
|
+
* Keyed by VideoResolution.assetKey (e.g. "720p.mp4", "storyboard-00001.jpg").
|
|
570
|
+
* Covers both file_output.video[] and file_output.storyboard[] on the raw side.
|
|
571
|
+
*/
|
|
572
|
+
resolutions?: Record<string, VideoResolutionAdditionalProperties>;
|
|
573
|
+
/**
|
|
574
|
+
* Parallel array to VideoV2.posters, same sort order.
|
|
575
|
+
* @maxSize 10
|
|
576
|
+
*/
|
|
577
|
+
posters?: ImageOutputAdditionalProperties[];
|
|
578
|
+
}
|
|
579
|
+
interface VideoResolutionAdditionalProperties {
|
|
580
|
+
/** From PmVideoInfo.file_output.video[].audio_bitrate or storyboard[].audio_bitrate, in bits per second. */
|
|
581
|
+
audioBitrate?: number | null;
|
|
582
|
+
/**
|
|
583
|
+
* From PmVideoInfo.file_output.video[].display_aspect_ratio or storyboard[].display_aspect_ratio (e.g. "16:9").
|
|
584
|
+
* @maxLength 10
|
|
585
|
+
*/
|
|
586
|
+
displayAspectRatio?: string | null;
|
|
587
|
+
/**
|
|
588
|
+
* From PmVideoInfo.file_output.video[].fps or storyboard[].fps (e.g. "25/1").
|
|
589
|
+
* @maxLength 10
|
|
590
|
+
*/
|
|
591
|
+
fps?: string | null;
|
|
592
|
+
/**
|
|
593
|
+
* From PmVideoInfo.file_output.video[].status or storyboard[].status (e.g. "READY").
|
|
594
|
+
* @maxLength 20
|
|
595
|
+
*/
|
|
596
|
+
status?: string | null;
|
|
597
|
+
/**
|
|
598
|
+
* From PmVideoInfo.file_output.video[].tag or storyboard[].tag (e.g. "HD").
|
|
599
|
+
* @maxLength 100
|
|
600
|
+
*/
|
|
601
|
+
tag?: string | null;
|
|
602
|
+
/** From PmVideoInfo.file_output.video[].video_bitrate or storyboard[].video_bitrate, in bits per second. */
|
|
603
|
+
videoBitrate?: number | null;
|
|
604
|
+
}
|
|
605
|
+
/**
|
|
606
|
+
* Shared additional properties for any ImageOutput in the raw PM contract
|
|
607
|
+
* (video poster outputs and preview outputs for document/model3d/image files).
|
|
608
|
+
*/
|
|
609
|
+
interface ImageOutputAdditionalProperties {
|
|
610
|
+
/**
|
|
611
|
+
* From ImageOutput.key (e.g. "poster.0", "image.preview").
|
|
612
|
+
* @maxLength 100
|
|
613
|
+
*/
|
|
614
|
+
key?: string | null;
|
|
615
|
+
/** From ImageOutput.secure. */
|
|
616
|
+
secure?: boolean | null;
|
|
617
|
+
/**
|
|
618
|
+
* From ImageOutput.status (e.g. "READY").
|
|
619
|
+
* @maxLength 30
|
|
620
|
+
*/
|
|
621
|
+
status?: string | null;
|
|
622
|
+
/**
|
|
623
|
+
* From ImageOutput.format (e.g. "jpg", "png"). Absent when original raw had no format field.
|
|
624
|
+
* @maxLength 10
|
|
625
|
+
*/
|
|
626
|
+
format?: string | null;
|
|
627
|
+
/**
|
|
628
|
+
* From ImageOutput.name. Present for model3d and some document previews; absent for video posters.
|
|
629
|
+
* @maxLength 200
|
|
630
|
+
*/
|
|
631
|
+
name?: string | null;
|
|
632
|
+
}
|
|
633
|
+
interface FontAdditionalProperties {
|
|
634
|
+
/**
|
|
635
|
+
* Parallel array to FontMedia.assets, same sort order.
|
|
636
|
+
* @maxSize 10
|
|
637
|
+
*/
|
|
638
|
+
assets?: FontAssetAdditionalProperties[];
|
|
639
|
+
}
|
|
640
|
+
interface FontAssetAdditionalProperties {
|
|
641
|
+
/**
|
|
642
|
+
* From PmFontInfo.file_output.font[].status (e.g. "READY").
|
|
643
|
+
* @maxLength 30
|
|
644
|
+
*/
|
|
645
|
+
status?: string | null;
|
|
646
|
+
}
|
|
647
|
+
interface DocumentAdditionalProperties {
|
|
648
|
+
/** From PmDocumentInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
|
|
649
|
+
preview?: ImageOutputAdditionalProperties;
|
|
650
|
+
}
|
|
651
|
+
interface Model3dAdditionalProperties {
|
|
652
|
+
/** From PmModel3dInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
|
|
653
|
+
preview?: ImageOutputAdditionalProperties;
|
|
654
|
+
}
|
|
655
|
+
interface ImageAdditionalProperties {
|
|
656
|
+
/** From PmImageInfo.file_output.image[] preview entry; preserves raw PM image-output metadata. */
|
|
657
|
+
preview?: ImageOutputAdditionalProperties;
|
|
658
|
+
}
|
|
482
659
|
interface DraftFilePublished {
|
|
483
660
|
/** The file after it was published */
|
|
484
661
|
file?: FileDescriptor;
|
|
@@ -609,7 +786,7 @@ interface GenerateFilesDownloadUrlRequest {
|
|
|
609
786
|
* IDs of the files to download.
|
|
610
787
|
*
|
|
611
788
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
612
|
-
* Learn more about the
|
|
789
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
613
790
|
* @minSize 1
|
|
614
791
|
* @maxSize 1000
|
|
615
792
|
* @maxLength 1000
|
|
@@ -628,7 +805,7 @@ interface GenerateFileDownloadUrlRequest {
|
|
|
628
805
|
* File ID.
|
|
629
806
|
*
|
|
630
807
|
* 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`.
|
|
631
|
-
* Learn more about the
|
|
808
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
632
809
|
* @maxLength 1000
|
|
633
810
|
*/
|
|
634
811
|
fileId: string;
|
|
@@ -717,7 +894,7 @@ interface GetFileDescriptorRequest {
|
|
|
717
894
|
* File ID.
|
|
718
895
|
*
|
|
719
896
|
* 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`.
|
|
720
|
-
* Learn more about the
|
|
897
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
721
898
|
*
|
|
722
899
|
* 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`.
|
|
723
900
|
* @maxLength 1000
|
|
@@ -733,7 +910,7 @@ interface GetFileDescriptorsRequest {
|
|
|
733
910
|
* File IDs.
|
|
734
911
|
*
|
|
735
912
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
736
|
-
* Learn more about the
|
|
913
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
737
914
|
* @minSize 1
|
|
738
915
|
* @maxSize 100
|
|
739
916
|
* @maxLength 1000
|
|
@@ -819,7 +996,7 @@ interface GenerateFileUploadUrlRequest {
|
|
|
819
996
|
* @maxLength 100
|
|
820
997
|
*/
|
|
821
998
|
parentFolderId?: string | null;
|
|
822
|
-
/** Whether the file will be public or private. Learn more about
|
|
999
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
823
1000
|
private?: boolean | null;
|
|
824
1001
|
/**
|
|
825
1002
|
* 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.
|
|
@@ -930,7 +1107,7 @@ interface GenerateFileResumableUploadUrlRequest {
|
|
|
930
1107
|
* @maxLength 100
|
|
931
1108
|
*/
|
|
932
1109
|
parentFolderId?: string | null;
|
|
933
|
-
/** Whether the file will be public or private. Learn more about
|
|
1110
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
934
1111
|
private?: boolean | null;
|
|
935
1112
|
/**
|
|
936
1113
|
* 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.
|
|
@@ -993,7 +1170,7 @@ interface ImportFileRequest {
|
|
|
993
1170
|
* @maxLength 100
|
|
994
1171
|
*/
|
|
995
1172
|
parentFolderId?: string | null;
|
|
996
|
-
/** Whether the file will be public or private. Learn more about
|
|
1173
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
997
1174
|
private?: boolean | null;
|
|
998
1175
|
/**
|
|
999
1176
|
* 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.
|
|
@@ -1206,7 +1383,7 @@ interface SearchFilesRequest {
|
|
|
1206
1383
|
* + `false`: Returns only public files.
|
|
1207
1384
|
* + `undefined`: Returns public and private files.
|
|
1208
1385
|
*
|
|
1209
|
-
* Learn more about
|
|
1386
|
+
* Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files).
|
|
1210
1387
|
*/
|
|
1211
1388
|
private?: boolean | null;
|
|
1212
1389
|
/**
|
|
@@ -1249,7 +1426,7 @@ interface GenerateVideoStreamingUrlRequest {
|
|
|
1249
1426
|
* File ID.
|
|
1250
1427
|
*
|
|
1251
1428
|
* 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`.
|
|
1252
|
-
* Learn more about the
|
|
1429
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1253
1430
|
* @maxLength 1000
|
|
1254
1431
|
*/
|
|
1255
1432
|
fileId: string;
|
|
@@ -1281,7 +1458,7 @@ interface BulkDeleteFilesRequest {
|
|
|
1281
1458
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1282
1459
|
*
|
|
1283
1460
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1284
|
-
* Learn more about the
|
|
1461
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1285
1462
|
* @maxSize 1000
|
|
1286
1463
|
* @maxLength 1000
|
|
1287
1464
|
*/
|
|
@@ -1299,7 +1476,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1299
1476
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1300
1477
|
*
|
|
1301
1478
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1302
|
-
* Learn more about the
|
|
1479
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1303
1480
|
* @maxSize 1000
|
|
1304
1481
|
* @maxLength 1000
|
|
1305
1482
|
*/
|
|
@@ -1319,7 +1496,7 @@ interface ListDeletedFilesRequest {
|
|
|
1319
1496
|
* @maxSize 30
|
|
1320
1497
|
*/
|
|
1321
1498
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
1322
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about
|
|
1499
|
+
/** \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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
1323
1500
|
private?: boolean | null;
|
|
1324
1501
|
/**
|
|
1325
1502
|
* Field name and order to sort by. One of: <br />
|
|
@@ -1346,7 +1523,7 @@ interface BulkPublishDraftFilesRequest {
|
|
|
1346
1523
|
* IDs of the draft files to be published.
|
|
1347
1524
|
*
|
|
1348
1525
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1349
|
-
* Learn more about the
|
|
1526
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1350
1527
|
* @maxSize 100
|
|
1351
1528
|
* @maxLength 1000
|
|
1352
1529
|
*/
|
|
@@ -1394,7 +1571,7 @@ interface UpdateFileRequest {
|
|
|
1394
1571
|
* ID of the file to update.
|
|
1395
1572
|
*
|
|
1396
1573
|
* 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`.
|
|
1397
|
-
* Learn more about the
|
|
1574
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1398
1575
|
* @maxLength 1000
|
|
1399
1576
|
*/
|
|
1400
1577
|
fileId?: string;
|
|
@@ -1421,7 +1598,12 @@ interface UpdateFileResponse {
|
|
|
1421
1598
|
file?: FileDescriptor;
|
|
1422
1599
|
}
|
|
1423
1600
|
interface QueryFileDescriptorsRequest {
|
|
1424
|
-
/**
|
|
1601
|
+
/**
|
|
1602
|
+
* Query options, including filter, sort, and cursor paging.
|
|
1603
|
+
*
|
|
1604
|
+
* See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and
|
|
1605
|
+
* [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging) for more information.
|
|
1606
|
+
*/
|
|
1425
1607
|
query?: CursorQuery;
|
|
1426
1608
|
}
|
|
1427
1609
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -1460,7 +1642,11 @@ interface Sorting {
|
|
|
1460
1642
|
* @maxLength 512
|
|
1461
1643
|
*/
|
|
1462
1644
|
fieldName?: string;
|
|
1463
|
-
/**
|
|
1645
|
+
/**
|
|
1646
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
1647
|
+
*
|
|
1648
|
+
* Default: `ASC`
|
|
1649
|
+
*/
|
|
1464
1650
|
order?: SortOrderWithLiterals;
|
|
1465
1651
|
}
|
|
1466
1652
|
declare enum SortOrder {
|
|
@@ -1471,11 +1657,11 @@ declare enum SortOrder {
|
|
|
1471
1657
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1472
1658
|
interface QueryFileDescriptorsResponse {
|
|
1473
1659
|
/**
|
|
1474
|
-
*
|
|
1660
|
+
* Retrieved files that match the query.
|
|
1475
1661
|
* @maxSize 200
|
|
1476
1662
|
*/
|
|
1477
1663
|
files?: FileDescriptor[];
|
|
1478
|
-
/**
|
|
1664
|
+
/** Paging metadata, including the cursors for the next and previous pages. */
|
|
1479
1665
|
pagingMetadata?: PagingMetadataV2;
|
|
1480
1666
|
}
|
|
1481
1667
|
interface ListRecentItemsRequest {
|
|
@@ -1963,9 +2149,9 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
|
|
|
1963
2149
|
/**
|
|
1964
2150
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
1965
2151
|
*
|
|
1966
|
-
*
|
|
2152
|
+
* Learn how to use the generated upload URL to [upload a file to the Media Manager](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api).
|
|
1967
2153
|
* > **Notes:**
|
|
1968
|
-
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files
|
|
2154
|
+
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files).
|
|
1969
2155
|
* > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, call Generate File Resumable Upload URL instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
|
|
1970
2156
|
* @param mimeType - File mime type.
|
|
1971
2157
|
* @public
|
|
@@ -1999,7 +2185,7 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1999
2185
|
* @maxLength 100
|
|
2000
2186
|
*/
|
|
2001
2187
|
parentFolderId?: string | null;
|
|
2002
|
-
/** Whether the file will be public or private. Learn more about
|
|
2188
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
2003
2189
|
private?: boolean | null;
|
|
2004
2190
|
/**
|
|
2005
2191
|
* 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,7 +2208,7 @@ interface GenerateFileUploadUrlOptions {
|
|
|
2022
2208
|
* Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
|
|
2023
2209
|
*
|
|
2024
2210
|
* With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.
|
|
2025
|
-
*
|
|
2211
|
+
* Learn how to use the generated upload URL in the response to [upload large files to the Media Manager](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/resumable-upload-api).
|
|
2026
2212
|
*
|
|
2027
2213
|
* > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
2028
2214
|
* @param mimeType - File mime type.
|
|
@@ -2057,7 +2243,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
2057
2243
|
* @maxLength 100
|
|
2058
2244
|
*/
|
|
2059
2245
|
parentFolderId?: string | null;
|
|
2060
|
-
/** Whether the file will be public or private. Learn more about
|
|
2246
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
2061
2247
|
private?: boolean | null;
|
|
2062
2248
|
/**
|
|
2063
2249
|
* 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.
|
|
@@ -2121,7 +2307,7 @@ interface ImportFileOptions {
|
|
|
2121
2307
|
* @maxLength 100
|
|
2122
2308
|
*/
|
|
2123
2309
|
parentFolderId?: string | null;
|
|
2124
|
-
/** Whether the file will be public or private. Learn more about
|
|
2310
|
+
/** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
2125
2311
|
private?: boolean | null;
|
|
2126
2312
|
/**
|
|
2127
2313
|
* 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.
|
|
@@ -2159,7 +2345,7 @@ interface ImportFileOptions {
|
|
|
2159
2345
|
*
|
|
2160
2346
|
* >**Notes:**
|
|
2161
2347
|
* > - The `media` property isn't returned in the `files` response object.
|
|
2162
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files
|
|
2348
|
+
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files).
|
|
2163
2349
|
*
|
|
2164
2350
|
* To import files, you need to do one of the following for each file:
|
|
2165
2351
|
* - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
@@ -2189,7 +2375,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
|
|
|
2189
2375
|
*
|
|
2190
2376
|
* >**Notes:**
|
|
2191
2377
|
* > - The `media` property isn't returned in the `files` response object.
|
|
2192
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files
|
|
2378
|
+
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files).
|
|
2193
2379
|
*
|
|
2194
2380
|
* To import files, you need to do one of the following for each file:
|
|
2195
2381
|
* - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
@@ -2314,7 +2500,7 @@ interface SearchFilesOptions {
|
|
|
2314
2500
|
* + `false`: Returns only public files.
|
|
2315
2501
|
* + `undefined`: Returns public and private files.
|
|
2316
2502
|
*
|
|
2317
|
-
* Learn more about
|
|
2503
|
+
* Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files).
|
|
2318
2504
|
*/
|
|
2319
2505
|
private?: boolean | null;
|
|
2320
2506
|
/**
|
|
@@ -2419,7 +2605,7 @@ interface ListDeletedFilesOptions {
|
|
|
2419
2605
|
* @maxSize 30
|
|
2420
2606
|
*/
|
|
2421
2607
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
2422
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about
|
|
2608
|
+
/** \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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files). */
|
|
2423
2609
|
private?: boolean | null;
|
|
2424
2610
|
/**
|
|
2425
2611
|
* Field name and order to sort by. One of: <br />
|
|
@@ -2433,14 +2619,15 @@ interface ListDeletedFilesOptions {
|
|
|
2433
2619
|
paging?: CursorPaging;
|
|
2434
2620
|
}
|
|
2435
2621
|
/**
|
|
2436
|
-
* Retrieves a list of files in the Media Manager, given the provided [cursor paging](https://dev.wix.com/docs/
|
|
2622
|
+
* Retrieves a list of files in the Media Manager, given the provided [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging), filtering, and sorting.
|
|
2437
2623
|
*
|
|
2438
2624
|
* Up to 200 files can be returned per request.
|
|
2625
|
+
*
|
|
2439
2626
|
* When filtering by `mediaType`, supported values are: `IMAGE`, `VIDEO`, `AUDIO`, `DOCUMENT`, `VECTOR`, `ARCHIVE`, and `MODEL3D`.
|
|
2440
2627
|
*
|
|
2441
2628
|
* To learn about working with *Query* methods, see
|
|
2442
|
-
* [API Query Language](https://dev.wix.com/docs/
|
|
2443
|
-
* [Sorting and Paging](https://dev.wix.com/docs/
|
|
2629
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and
|
|
2630
|
+
* [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
2444
2631
|
* @public
|
|
2445
2632
|
* @permissionId media:site_media:v1:file_descriptor:query_file_descriptors
|
|
2446
2633
|
* @applicableIdentity APP
|
|
@@ -2558,7 +2745,9 @@ type FileDescriptorQuery = {
|
|
|
2558
2745
|
*/
|
|
2559
2746
|
fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
|
|
2560
2747
|
/**
|
|
2561
|
-
Sort order.
|
|
2748
|
+
Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
2749
|
+
|
|
2750
|
+
Default: `ASC`
|
|
2562
2751
|
*/
|
|
2563
2752
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
2564
2753
|
}[];
|
|
@@ -2571,4 +2760,4 @@ declare const utils: {
|
|
|
2571
2760
|
};
|
|
2572
2761
|
};
|
|
2573
2762
|
|
|
2574
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkInternalImportFilesRequest, type BulkInternalImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, type CommonQueryWithEntityContext, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorQuery, type FileDescriptorQuerySpec, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FilesQueryBuilder, type FilesQueryResult, type FocalPoint, type FontAsset, type FontMedia, type GenerateAnimatedVectorRequest, type GenerateAnimatedVectorResponse, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type GetSiteFileDescriptorsRequest, type GetSiteFileDescriptorsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, type ListRecentItemsRequest, type ListRecentItemsResponse, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type QueryFileDescriptorsRequest, type QueryFileDescriptorsResponse, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type SyncImportFileDescriptorRequest, type SyncImportFileDescriptorResponse, type SyncImportFileRequest, type SyncImportFileResponse, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorFileFailed, onFileDescriptorFileReady, queryFileDescriptors, searchFiles, typedQueryFileDescriptors, updateFileDescriptor, utils };
|
|
2763
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type Archive, type AudioAdditionalProperties, type AudioAssetAdditionalProperties, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkInternalImportFilesRequest, type BulkInternalImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, type CommonQueryWithEntityContext, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DocumentAdditionalProperties, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileAdditionalProperties, type FileAdditionalPropertiesMediaAdditionalPropertiesOneOf, type FileDescriptor, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorQuery, type FileDescriptorQuerySpec, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FilesQueryBuilder, type FilesQueryResult, type FocalPoint, type FontAdditionalProperties, type FontAsset, type FontAssetAdditionalProperties, type FontMedia, type GenerateAnimatedVectorRequest, type GenerateAnimatedVectorResponse, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type GetSiteFileDescriptorsRequest, type GetSiteFileDescriptorsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAdditionalProperties, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImageOutputAdditionalProperties, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, type ListRecentItemsRequest, type ListRecentItemsResponse, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, type Model3dAdditionalProperties, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type QueryFileDescriptorsRequest, type QueryFileDescriptorsResponse, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type SyncImportFileDescriptorRequest, type SyncImportFileDescriptorResponse, type SyncImportFileRequest, type SyncImportFileResponse, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoAdditionalProperties, type VideoResolution, type VideoResolutionAdditionalProperties, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorFileFailed, onFileDescriptorFileReady, queryFileDescriptors, searchFiles, typedQueryFileDescriptors, updateFileDescriptor, utils };
|