@wix/auto_sdk_media_files 1.0.49 → 1.0.50
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 +11 -9
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +37 -35
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +18 -18
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -9
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +37 -35
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +18 -18
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -9
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +37 -35
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +18 -18
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -9
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +37 -35
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +18 -18
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -37,7 +37,7 @@ interface FileDescriptor {
|
|
|
37
37
|
*/
|
|
38
38
|
sizeInBytes?: string | null;
|
|
39
39
|
/**
|
|
40
|
-
* Whether the file is public or private. Learn more about
|
|
40
|
+
* Whether the file is 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)).
|
|
41
41
|
* @readonly
|
|
42
42
|
*/
|
|
43
43
|
private?: boolean;
|
|
@@ -609,7 +609,7 @@ interface GenerateFilesDownloadUrlRequest {
|
|
|
609
609
|
* IDs of the files to download.
|
|
610
610
|
*
|
|
611
611
|
* 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
|
|
612
|
+
* 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)).
|
|
613
613
|
* @minSize 1
|
|
614
614
|
* @maxSize 1000
|
|
615
615
|
* @maxLength 1000
|
|
@@ -628,7 +628,7 @@ interface GenerateFileDownloadUrlRequest {
|
|
|
628
628
|
* File ID.
|
|
629
629
|
*
|
|
630
630
|
* 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
|
|
631
|
+
* 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)).
|
|
632
632
|
* @maxLength 1000
|
|
633
633
|
*/
|
|
634
634
|
fileId: string;
|
|
@@ -717,7 +717,7 @@ interface GetFileDescriptorRequest {
|
|
|
717
717
|
* File ID.
|
|
718
718
|
*
|
|
719
719
|
* 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
|
|
720
|
+
* 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)).
|
|
721
721
|
*
|
|
722
722
|
* 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
723
|
* @maxLength 1000
|
|
@@ -733,7 +733,7 @@ interface GetFileDescriptorsRequest {
|
|
|
733
733
|
* File IDs.
|
|
734
734
|
*
|
|
735
735
|
* 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
|
|
736
|
+
* 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)).
|
|
737
737
|
* @minSize 1
|
|
738
738
|
* @maxSize 100
|
|
739
739
|
* @maxLength 1000
|
|
@@ -794,7 +794,7 @@ interface GenerateFileUploadUrlRequest {
|
|
|
794
794
|
* @maxLength 100
|
|
795
795
|
*/
|
|
796
796
|
parentFolderId?: string | null;
|
|
797
|
-
/** Whether the file will be public or private. Learn more about
|
|
797
|
+
/** 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)). */
|
|
798
798
|
private?: boolean | null;
|
|
799
799
|
/**
|
|
800
800
|
* 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.
|
|
@@ -905,7 +905,7 @@ interface GenerateFileResumableUploadUrlRequest {
|
|
|
905
905
|
* @maxLength 100
|
|
906
906
|
*/
|
|
907
907
|
parentFolderId?: string | null;
|
|
908
|
-
/** Whether the file will be public or private. Learn more about
|
|
908
|
+
/** 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)). */
|
|
909
909
|
private?: boolean | null;
|
|
910
910
|
/**
|
|
911
911
|
* 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.
|
|
@@ -967,7 +967,7 @@ interface ImportFileRequest {
|
|
|
967
967
|
* @maxLength 100
|
|
968
968
|
*/
|
|
969
969
|
parentFolderId?: string | null;
|
|
970
|
-
/** Whether the file will be public or private. Learn more about
|
|
970
|
+
/** 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)). */
|
|
971
971
|
private?: boolean | null;
|
|
972
972
|
/**
|
|
973
973
|
* 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.
|
|
@@ -980,7 +980,7 @@ interface ImportFileRequest {
|
|
|
980
980
|
* @maxLength 100
|
|
981
981
|
*/
|
|
982
982
|
mimeType?: string;
|
|
983
|
-
/** Information sent to the File Ready and File Failed events. See
|
|
983
|
+
/** 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. */
|
|
984
984
|
externalInfo?: ExternalInfo;
|
|
985
985
|
/** Optional parameters that should be sent with the external URL. */
|
|
986
986
|
urlParams?: Record<string, any> | null;
|
|
@@ -1069,7 +1069,7 @@ interface ListFilesRequest {
|
|
|
1069
1069
|
* + `false`: Returns only public files.
|
|
1070
1070
|
* + `undefined`: Returns public and private files.
|
|
1071
1071
|
*
|
|
1072
|
-
* Learn more about
|
|
1072
|
+
* 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)).
|
|
1073
1073
|
*/
|
|
1074
1074
|
private?: boolean | null;
|
|
1075
1075
|
/**
|
|
@@ -1148,7 +1148,7 @@ interface SearchFilesRequest {
|
|
|
1148
1148
|
search?: string | null;
|
|
1149
1149
|
/**
|
|
1150
1150
|
* The root folder in the media manager to search in.
|
|
1151
|
-
* For more information, see Root Folders in [
|
|
1151
|
+
* For more information, see Root Folders in Terminology ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/introduction#terminology) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology)).
|
|
1152
1152
|
*
|
|
1153
1153
|
* Default: `MEDIA_ROOT`.
|
|
1154
1154
|
*/
|
|
@@ -1164,7 +1164,7 @@ interface SearchFilesRequest {
|
|
|
1164
1164
|
* + `false`: Returns only public files.
|
|
1165
1165
|
* + `undefined`: Returns public and private files.
|
|
1166
1166
|
*
|
|
1167
|
-
* Learn more about
|
|
1167
|
+
* 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)).
|
|
1168
1168
|
*/
|
|
1169
1169
|
private?: boolean | null;
|
|
1170
1170
|
/**
|
|
@@ -1207,7 +1207,7 @@ interface GenerateVideoStreamingUrlRequest {
|
|
|
1207
1207
|
* File ID.
|
|
1208
1208
|
*
|
|
1209
1209
|
* 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`.
|
|
1210
|
-
* Learn more about the
|
|
1210
|
+
* 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)).
|
|
1211
1211
|
* @maxLength 1000
|
|
1212
1212
|
*/
|
|
1213
1213
|
fileId: string;
|
|
@@ -1239,7 +1239,7 @@ interface BulkDeleteFilesRequest {
|
|
|
1239
1239
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1240
1240
|
*
|
|
1241
1241
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1242
|
-
* Learn more about the
|
|
1242
|
+
* 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)).
|
|
1243
1243
|
* @maxSize 1000
|
|
1244
1244
|
* @maxLength 1000
|
|
1245
1245
|
*/
|
|
@@ -1257,7 +1257,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1257
1257
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1258
1258
|
*
|
|
1259
1259
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1260
|
-
* Learn more about the
|
|
1260
|
+
* 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)).
|
|
1261
1261
|
* @maxSize 1000
|
|
1262
1262
|
* @maxLength 1000
|
|
1263
1263
|
*/
|
|
@@ -1277,7 +1277,7 @@ interface ListDeletedFilesRequest {
|
|
|
1277
1277
|
* @maxSize 30
|
|
1278
1278
|
*/
|
|
1279
1279
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
1280
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about
|
|
1280
|
+
/** \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)). */
|
|
1281
1281
|
private?: boolean | null;
|
|
1282
1282
|
/**
|
|
1283
1283
|
* Field name and order to sort by. One of: <br />
|
|
@@ -1304,7 +1304,7 @@ interface BulkPublishDraftFilesRequest {
|
|
|
1304
1304
|
* IDs of the draft files to be published.
|
|
1305
1305
|
*
|
|
1306
1306
|
* You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
1307
|
-
* Learn more about the
|
|
1307
|
+
* 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)).
|
|
1308
1308
|
* @maxSize 100
|
|
1309
1309
|
* @maxLength 1000
|
|
1310
1310
|
*/
|
|
@@ -1352,7 +1352,7 @@ interface UpdateFileRequest {
|
|
|
1352
1352
|
* ID of the file to update.
|
|
1353
1353
|
*
|
|
1354
1354
|
* 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`.
|
|
1355
|
-
* Learn more about the
|
|
1355
|
+
* 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)).
|
|
1356
1356
|
* @maxLength 1000
|
|
1357
1357
|
*/
|
|
1358
1358
|
fileId?: string;
|
|
@@ -1816,9 +1816,9 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
|
|
|
1816
1816
|
/**
|
|
1817
1817
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
1818
1818
|
*
|
|
1819
|
-
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see
|
|
1819
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
|
|
1820
1820
|
* > **Notes:**
|
|
1821
|
-
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about
|
|
1821
|
+
* > - 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
|
|
1822
1822
|
* > - 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.
|
|
1823
1823
|
* @param mimeType - File mime type.
|
|
1824
1824
|
* @public
|
|
@@ -1852,7 +1852,7 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1852
1852
|
* @maxLength 100
|
|
1853
1853
|
*/
|
|
1854
1854
|
parentFolderId?: string | null;
|
|
1855
|
-
/** Whether the file will be public or private. Learn more about
|
|
1855
|
+
/** 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)). */
|
|
1856
1856
|
private?: boolean | null;
|
|
1857
1857
|
/**
|
|
1858
1858
|
* 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.
|
|
@@ -1875,9 +1875,9 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1875
1875
|
* Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
|
|
1876
1876
|
*
|
|
1877
1877
|
* 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.
|
|
1878
|
-
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see
|
|
1878
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see Resumable Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/resumable-upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api)).
|
|
1879
1879
|
*
|
|
1880
|
-
* > **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
|
|
1880
|
+
* > **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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
|
|
1881
1881
|
* @param mimeType - File mime type.
|
|
1882
1882
|
* @public
|
|
1883
1883
|
* @requiredField mimeType
|
|
@@ -1910,7 +1910,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
1910
1910
|
* @maxLength 100
|
|
1911
1911
|
*/
|
|
1912
1912
|
parentFolderId?: string | null;
|
|
1913
|
-
/** Whether the file will be public or private. Learn more about
|
|
1913
|
+
/** 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)). */
|
|
1914
1914
|
private?: boolean | null;
|
|
1915
1915
|
/**
|
|
1916
1916
|
* 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.
|
|
@@ -1938,7 +1938,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
1938
1938
|
*
|
|
1939
1939
|
* >**Notes:**
|
|
1940
1940
|
* > - The `media` property isn't returned in the `files` response object.
|
|
1941
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about
|
|
1941
|
+
* > - 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
|
|
1942
1942
|
*
|
|
1943
1943
|
* To import a file, you need to do one of the following:
|
|
1944
1944
|
* - 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'`.
|
|
@@ -1974,7 +1974,7 @@ interface ImportFileOptions {
|
|
|
1974
1974
|
* @maxLength 100
|
|
1975
1975
|
*/
|
|
1976
1976
|
parentFolderId?: string | null;
|
|
1977
|
-
/** Whether the file will be public or private. Learn more about
|
|
1977
|
+
/** 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)). */
|
|
1978
1978
|
private?: boolean | null;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* 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.
|
|
@@ -1987,7 +1987,7 @@ interface ImportFileOptions {
|
|
|
1987
1987
|
* @maxLength 100
|
|
1988
1988
|
*/
|
|
1989
1989
|
mimeType?: string;
|
|
1990
|
-
/** Information sent to the File Ready and File Failed events. See
|
|
1990
|
+
/** 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. */
|
|
1991
1991
|
externalInfo?: ExternalInfo;
|
|
1992
1992
|
/** Optional parameters that should be sent with the external URL. */
|
|
1993
1993
|
urlParams?: Record<string, any> | null;
|
|
@@ -2012,7 +2012,7 @@ interface ImportFileOptions {
|
|
|
2012
2012
|
*
|
|
2013
2013
|
* >**Notes:**
|
|
2014
2014
|
* > - The `media` property isn't returned in the `files` response object.
|
|
2015
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about
|
|
2015
|
+
* > - 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
|
|
2016
2016
|
*
|
|
2017
2017
|
* To import files, you need to do one of the following for each file:
|
|
2018
2018
|
* - 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'`.
|
|
@@ -2042,7 +2042,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
|
|
|
2042
2042
|
*
|
|
2043
2043
|
* >**Notes:**
|
|
2044
2044
|
* > - The `media` property isn't returned in the `files` response object.
|
|
2045
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about
|
|
2045
|
+
* > - 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
|
|
2046
2046
|
*
|
|
2047
2047
|
* To import files, you need to do one of the following for each file:
|
|
2048
2048
|
* - 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'`.
|
|
@@ -2095,7 +2095,7 @@ interface ListFilesOptions {
|
|
|
2095
2095
|
* + `false`: Returns only public files.
|
|
2096
2096
|
* + `undefined`: Returns public and private files.
|
|
2097
2097
|
*
|
|
2098
|
-
* Learn more about
|
|
2098
|
+
* 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)).
|
|
2099
2099
|
*/
|
|
2100
2100
|
private?: boolean | null;
|
|
2101
2101
|
/**
|
|
@@ -2129,8 +2129,10 @@ interface ListFilesOptions {
|
|
|
2129
2129
|
* ## See also
|
|
2130
2130
|
*
|
|
2131
2131
|
* To learn about working with *Search* methods, see
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
2132
|
+
* _API Query Language_
|
|
2133
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/get-started/api-query-language))
|
|
2134
|
+
* and *Sorting and Paging*
|
|
2135
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language#the-sort-array) | [REST](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging)).
|
|
2134
2136
|
* @public
|
|
2135
2137
|
* @param options - Options to specify which folders to search.
|
|
2136
2138
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST
|
|
@@ -2151,7 +2153,7 @@ interface SearchFilesOptions {
|
|
|
2151
2153
|
search?: string | null;
|
|
2152
2154
|
/**
|
|
2153
2155
|
* The root folder in the media manager to search in.
|
|
2154
|
-
* For more information, see Root Folders in [
|
|
2156
|
+
* For more information, see Root Folders in Terminology ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/introduction#terminology) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology)).
|
|
2155
2157
|
*
|
|
2156
2158
|
* Default: `MEDIA_ROOT`.
|
|
2157
2159
|
*/
|
|
@@ -2167,7 +2169,7 @@ interface SearchFilesOptions {
|
|
|
2167
2169
|
* + `false`: Returns only public files.
|
|
2168
2170
|
* + `undefined`: Returns public and private files.
|
|
2169
2171
|
*
|
|
2170
|
-
* Learn more about
|
|
2172
|
+
* 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)).
|
|
2171
2173
|
*/
|
|
2172
2174
|
private?: boolean | null;
|
|
2173
2175
|
/**
|
|
@@ -2272,7 +2274,7 @@ interface ListDeletedFilesOptions {
|
|
|
2272
2274
|
* @maxSize 30
|
|
2273
2275
|
*/
|
|
2274
2276
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
2275
|
-
/** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about
|
|
2277
|
+
/** \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)). */
|
|
2276
2278
|
private?: boolean | null;
|
|
2277
2279
|
/**
|
|
2278
2280
|
* Field name and order to sort by. One of: <br />
|