@wix/auto_sdk_media_files 1.0.76 → 1.0.77
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 +5 -5
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +44 -32
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +27 -18
- 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 +5 -5
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +44 -32
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +27 -18
- 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 +5 -5
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +44 -32
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +27 -18
- 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 +5 -5
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +44 -32
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +27 -18
- 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
|
@@ -666,7 +666,7 @@ interface GenerateFilesDownloadUrlRequest {
|
|
|
666
666
|
* IDs of the files to download.
|
|
667
667
|
*
|
|
668
668
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
669
|
-
* Learn more about the
|
|
669
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
670
670
|
* @minSize 1
|
|
671
671
|
* @maxSize 1000
|
|
672
672
|
* @maxLength 1000
|
|
@@ -685,7 +685,7 @@ interface GenerateFileDownloadUrlRequest {
|
|
|
685
685
|
* File ID.
|
|
686
686
|
*
|
|
687
687
|
* 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`.
|
|
688
|
-
* Learn more about the
|
|
688
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
689
689
|
* @maxLength 1000
|
|
690
690
|
*/
|
|
691
691
|
fileId: string;
|
|
@@ -774,7 +774,7 @@ interface GetFileDescriptorRequest {
|
|
|
774
774
|
* File ID.
|
|
775
775
|
*
|
|
776
776
|
* 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`.
|
|
777
|
-
* Learn more about the
|
|
777
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
778
778
|
*
|
|
779
779
|
* 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`.
|
|
780
780
|
* @maxLength 1000
|
|
@@ -790,7 +790,7 @@ interface GetFileDescriptorsRequest {
|
|
|
790
790
|
* File IDs.
|
|
791
791
|
*
|
|
792
792
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
793
|
-
* Learn more about the
|
|
793
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
794
794
|
* @minSize 1
|
|
795
795
|
* @maxSize 100
|
|
796
796
|
* @maxLength 1000
|
|
@@ -876,7 +876,7 @@ interface GenerateFileUploadUrlRequest {
|
|
|
876
876
|
* @maxLength 100
|
|
877
877
|
*/
|
|
878
878
|
parentFolderId?: string | null;
|
|
879
|
-
/** Whether the file will be public or private. Learn more about
|
|
879
|
+
/** 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). */
|
|
880
880
|
private?: boolean | null;
|
|
881
881
|
/**
|
|
882
882
|
* 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.
|
|
@@ -987,7 +987,7 @@ interface GenerateFileResumableUploadUrlRequest {
|
|
|
987
987
|
* @maxLength 100
|
|
988
988
|
*/
|
|
989
989
|
parentFolderId?: string | null;
|
|
990
|
-
/** Whether the file will be public or private. Learn more about
|
|
990
|
+
/** 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). */
|
|
991
991
|
private?: boolean | null;
|
|
992
992
|
/**
|
|
993
993
|
* 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.
|
|
@@ -1050,7 +1050,7 @@ interface ImportFileRequest {
|
|
|
1050
1050
|
* @maxLength 100
|
|
1051
1051
|
*/
|
|
1052
1052
|
parentFolderId?: string | null;
|
|
1053
|
-
/** Whether the file will be public or private. Learn more about
|
|
1053
|
+
/** 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). */
|
|
1054
1054
|
private?: boolean | null;
|
|
1055
1055
|
/**
|
|
1056
1056
|
* 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.
|
|
@@ -1263,7 +1263,7 @@ interface SearchFilesRequest {
|
|
|
1263
1263
|
* + `false`: Returns only public files.
|
|
1264
1264
|
* + `undefined`: Returns public and private files.
|
|
1265
1265
|
*
|
|
1266
|
-
* Learn more about
|
|
1266
|
+
* Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files).
|
|
1267
1267
|
*/
|
|
1268
1268
|
private?: boolean | null;
|
|
1269
1269
|
/**
|
|
@@ -1306,7 +1306,7 @@ interface GenerateVideoStreamingUrlRequest {
|
|
|
1306
1306
|
* File ID.
|
|
1307
1307
|
*
|
|
1308
1308
|
* 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`.
|
|
1309
|
-
* Learn more about the
|
|
1309
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1310
1310
|
* @maxLength 1000
|
|
1311
1311
|
*/
|
|
1312
1312
|
fileId: string;
|
|
@@ -1338,7 +1338,7 @@ interface BulkDeleteFilesRequest {
|
|
|
1338
1338
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1339
1339
|
*
|
|
1340
1340
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1341
|
-
* Learn more about the
|
|
1341
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1342
1342
|
* @maxSize 1000
|
|
1343
1343
|
* @maxLength 1000
|
|
1344
1344
|
*/
|
|
@@ -1356,7 +1356,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1356
1356
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1357
1357
|
*
|
|
1358
1358
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1359
|
-
* Learn more about the
|
|
1359
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1360
1360
|
* @maxSize 1000
|
|
1361
1361
|
* @maxLength 1000
|
|
1362
1362
|
*/
|
|
@@ -1376,7 +1376,7 @@ interface ListDeletedFilesRequest {
|
|
|
1376
1376
|
* @maxSize 30
|
|
1377
1377
|
*/
|
|
1378
1378
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
1379
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about
|
|
1379
|
+
/** \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). */
|
|
1380
1380
|
private?: boolean | null;
|
|
1381
1381
|
/**
|
|
1382
1382
|
* Field name and order to sort by. One of: <br />
|
|
@@ -1403,7 +1403,7 @@ interface BulkPublishDraftFilesRequest {
|
|
|
1403
1403
|
* IDs of the draft files to be published.
|
|
1404
1404
|
*
|
|
1405
1405
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1406
|
-
* Learn more about the
|
|
1406
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1407
1407
|
* @maxSize 100
|
|
1408
1408
|
* @maxLength 1000
|
|
1409
1409
|
*/
|
|
@@ -1451,7 +1451,7 @@ interface UpdateFileRequest {
|
|
|
1451
1451
|
* ID of the file to update.
|
|
1452
1452
|
*
|
|
1453
1453
|
* 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`.
|
|
1454
|
-
* Learn more about the
|
|
1454
|
+
* Learn more [about the file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1455
1455
|
* @maxLength 1000
|
|
1456
1456
|
*/
|
|
1457
1457
|
fileId?: string;
|
|
@@ -1478,7 +1478,12 @@ interface UpdateFileResponse {
|
|
|
1478
1478
|
file?: FileDescriptor;
|
|
1479
1479
|
}
|
|
1480
1480
|
interface QueryFileDescriptorsRequest {
|
|
1481
|
-
/**
|
|
1481
|
+
/**
|
|
1482
|
+
* Query options, including filter, sort, and cursor paging.
|
|
1483
|
+
*
|
|
1484
|
+
* 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
|
|
1485
|
+
* [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging) for more information.
|
|
1486
|
+
*/
|
|
1482
1487
|
query?: CursorQuery;
|
|
1483
1488
|
}
|
|
1484
1489
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -1517,7 +1522,11 @@ interface Sorting {
|
|
|
1517
1522
|
* @maxLength 512
|
|
1518
1523
|
*/
|
|
1519
1524
|
fieldName?: string;
|
|
1520
|
-
/**
|
|
1525
|
+
/**
|
|
1526
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
1527
|
+
*
|
|
1528
|
+
* Default: `ASC`
|
|
1529
|
+
*/
|
|
1521
1530
|
order?: SortOrderWithLiterals;
|
|
1522
1531
|
}
|
|
1523
1532
|
declare enum SortOrder {
|
|
@@ -1528,11 +1537,11 @@ declare enum SortOrder {
|
|
|
1528
1537
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1529
1538
|
interface QueryFileDescriptorsResponse {
|
|
1530
1539
|
/**
|
|
1531
|
-
*
|
|
1540
|
+
* Retrieved files that match the query.
|
|
1532
1541
|
* @maxSize 200
|
|
1533
1542
|
*/
|
|
1534
1543
|
files?: FileDescriptor[];
|
|
1535
|
-
/**
|
|
1544
|
+
/** Paging metadata, including the cursors for the next and previous pages. */
|
|
1536
1545
|
pagingMetadata?: PagingMetadataV2;
|
|
1537
1546
|
}
|
|
1538
1547
|
interface ListRecentItemsRequest {
|