@wix/auto_sdk_media_files 1.0.50 → 1.0.52
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 +9 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +38 -43
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +21 -24
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +9 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +38 -43
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +21 -24
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +9 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +38 -43
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +21 -24
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +9 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +38 -43
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +21 -24
- 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 private files
|
|
40
|
+
* Whether the file is public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
41
41
|
* @readonly
|
|
42
42
|
*/
|
|
43
43
|
private?: boolean;
|
|
@@ -53,9 +53,6 @@ interface FileDescriptor {
|
|
|
53
53
|
media?: FileMedia;
|
|
54
54
|
/**
|
|
55
55
|
* Status of the file that was uploaded.
|
|
56
|
-
* * `FAILED`: The file failed to upload, for example, during media post processing.
|
|
57
|
-
* * `READY`: The file uploaded, finished all processing, and is ready for use.
|
|
58
|
-
* * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
|
|
59
56
|
* @readonly
|
|
60
57
|
*/
|
|
61
58
|
operationStatus?: OperationStatusWithLiterals;
|
|
@@ -410,11 +407,11 @@ interface FontAsset {
|
|
|
410
407
|
format?: string | null;
|
|
411
408
|
}
|
|
412
409
|
declare enum OperationStatus {
|
|
413
|
-
/**
|
|
410
|
+
/** The file failed to upload, for example, during media post processing. */
|
|
414
411
|
FAILED = "FAILED",
|
|
415
|
-
/**
|
|
412
|
+
/** The file uploaded, finished all processing, and is ready for use. */
|
|
416
413
|
READY = "READY",
|
|
417
|
-
/**
|
|
414
|
+
/** The file is processing and the URLs are not yet available. This response is returned when importing a file. */
|
|
418
415
|
PENDING = "PENDING"
|
|
419
416
|
}
|
|
420
417
|
/** @enumType */
|
|
@@ -609,7 +606,7 @@ interface GenerateFilesDownloadUrlRequest {
|
|
|
609
606
|
* IDs of the files to download.
|
|
610
607
|
*
|
|
611
608
|
* 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 file ID parameter
|
|
609
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
613
610
|
* @minSize 1
|
|
614
611
|
* @maxSize 1000
|
|
615
612
|
* @maxLength 1000
|
|
@@ -628,7 +625,7 @@ interface GenerateFileDownloadUrlRequest {
|
|
|
628
625
|
* File ID.
|
|
629
626
|
*
|
|
630
627
|
* 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 file ID parameter
|
|
628
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
632
629
|
* @maxLength 1000
|
|
633
630
|
*/
|
|
634
631
|
fileId: string;
|
|
@@ -717,7 +714,7 @@ interface GetFileDescriptorRequest {
|
|
|
717
714
|
* File ID.
|
|
718
715
|
*
|
|
719
716
|
* 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 file ID parameter
|
|
717
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
721
718
|
*
|
|
722
719
|
* 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
720
|
* @maxLength 1000
|
|
@@ -733,7 +730,7 @@ interface GetFileDescriptorsRequest {
|
|
|
733
730
|
* File IDs.
|
|
734
731
|
*
|
|
735
732
|
* 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 file ID parameter
|
|
733
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
737
734
|
* @minSize 1
|
|
738
735
|
* @maxSize 100
|
|
739
736
|
* @maxLength 1000
|
|
@@ -794,7 +791,7 @@ interface GenerateFileUploadUrlRequest {
|
|
|
794
791
|
* @maxLength 100
|
|
795
792
|
*/
|
|
796
793
|
parentFolderId?: string | null;
|
|
797
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
794
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
798
795
|
private?: boolean | null;
|
|
799
796
|
/**
|
|
800
797
|
* 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 +902,7 @@ interface GenerateFileResumableUploadUrlRequest {
|
|
|
905
902
|
* @maxLength 100
|
|
906
903
|
*/
|
|
907
904
|
parentFolderId?: string | null;
|
|
908
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
905
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
909
906
|
private?: boolean | null;
|
|
910
907
|
/**
|
|
911
908
|
* 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 +964,7 @@ interface ImportFileRequest {
|
|
|
967
964
|
* @maxLength 100
|
|
968
965
|
*/
|
|
969
966
|
parentFolderId?: string | null;
|
|
970
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
967
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
971
968
|
private?: boolean | null;
|
|
972
969
|
/**
|
|
973
970
|
* 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 +977,7 @@ interface ImportFileRequest {
|
|
|
980
977
|
* @maxLength 100
|
|
981
978
|
*/
|
|
982
979
|
mimeType?: string;
|
|
983
|
-
/** Information sent to the File Ready and File Failed events. See Importing Files
|
|
980
|
+
/** Information sent to the File Ready and File Failed events. See [Importing Files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files) to learn more. */
|
|
984
981
|
externalInfo?: ExternalInfo;
|
|
985
982
|
/** Optional parameters that should be sent with the external URL. */
|
|
986
983
|
urlParams?: Record<string, any> | null;
|
|
@@ -1069,7 +1066,7 @@ interface ListFilesRequest {
|
|
|
1069
1066
|
* + `false`: Returns only public files.
|
|
1070
1067
|
* + `undefined`: Returns public and private files.
|
|
1071
1068
|
*
|
|
1072
|
-
* Learn more about private files
|
|
1069
|
+
* Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
1073
1070
|
*/
|
|
1074
1071
|
private?: boolean | null;
|
|
1075
1072
|
/**
|
|
@@ -1148,7 +1145,7 @@ interface SearchFilesRequest {
|
|
|
1148
1145
|
search?: string | null;
|
|
1149
1146
|
/**
|
|
1150
1147
|
* The root folder in the media manager to search in.
|
|
1151
|
-
* For more information, see Root Folders in Terminology
|
|
1148
|
+
* For more information, see Root Folders in [Terminology](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology).
|
|
1152
1149
|
*
|
|
1153
1150
|
* Default: `MEDIA_ROOT`.
|
|
1154
1151
|
*/
|
|
@@ -1164,7 +1161,7 @@ interface SearchFilesRequest {
|
|
|
1164
1161
|
* + `false`: Returns only public files.
|
|
1165
1162
|
* + `undefined`: Returns public and private files.
|
|
1166
1163
|
*
|
|
1167
|
-
* Learn more about private files
|
|
1164
|
+
* Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
1168
1165
|
*/
|
|
1169
1166
|
private?: boolean | null;
|
|
1170
1167
|
/**
|
|
@@ -1207,7 +1204,7 @@ interface GenerateVideoStreamingUrlRequest {
|
|
|
1207
1204
|
* File ID.
|
|
1208
1205
|
*
|
|
1209
1206
|
* 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 file ID parameter
|
|
1207
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1211
1208
|
* @maxLength 1000
|
|
1212
1209
|
*/
|
|
1213
1210
|
fileId: string;
|
|
@@ -1239,7 +1236,7 @@ interface BulkDeleteFilesRequest {
|
|
|
1239
1236
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1240
1237
|
*
|
|
1241
1238
|
* 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 file ID parameter
|
|
1239
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1243
1240
|
* @maxSize 1000
|
|
1244
1241
|
* @maxLength 1000
|
|
1245
1242
|
*/
|
|
@@ -1257,7 +1254,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1257
1254
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1258
1255
|
*
|
|
1259
1256
|
* 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 file ID parameter
|
|
1257
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1261
1258
|
* @maxSize 1000
|
|
1262
1259
|
* @maxLength 1000
|
|
1263
1260
|
*/
|
|
@@ -1277,7 +1274,7 @@ interface ListDeletedFilesRequest {
|
|
|
1277
1274
|
* @maxSize 30
|
|
1278
1275
|
*/
|
|
1279
1276
|
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 private files
|
|
1277
|
+
/** \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/rest/assets/media/media-manager/files/private-files). */
|
|
1281
1278
|
private?: boolean | null;
|
|
1282
1279
|
/**
|
|
1283
1280
|
* Field name and order to sort by. One of: <br />
|
|
@@ -1304,7 +1301,7 @@ interface BulkPublishDraftFilesRequest {
|
|
|
1304
1301
|
* IDs of the draft files to be published.
|
|
1305
1302
|
*
|
|
1306
1303
|
* 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 file ID parameter
|
|
1304
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1308
1305
|
* @maxSize 100
|
|
1309
1306
|
* @maxLength 1000
|
|
1310
1307
|
*/
|
|
@@ -1352,7 +1349,7 @@ interface UpdateFileRequest {
|
|
|
1352
1349
|
* ID of the file to update.
|
|
1353
1350
|
*
|
|
1354
1351
|
* 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 file ID parameter
|
|
1352
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
|
|
1356
1353
|
* @maxLength 1000
|
|
1357
1354
|
*/
|
|
1358
1355
|
fileId?: string;
|
|
@@ -1816,9 +1813,9 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
|
|
|
1816
1813
|
/**
|
|
1817
1814
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
1818
1815
|
*
|
|
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
|
|
1816
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the [Upload API](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api).
|
|
1820
1817
|
* > **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 knowing when a file is ready
|
|
1818
|
+
* > - 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#knowing-when-a-file-is-ready).
|
|
1822
1819
|
* > - 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
1820
|
* @param mimeType - File mime type.
|
|
1824
1821
|
* @public
|
|
@@ -1852,7 +1849,7 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1852
1849
|
* @maxLength 100
|
|
1853
1850
|
*/
|
|
1854
1851
|
parentFolderId?: string | null;
|
|
1855
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
1852
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
1856
1853
|
private?: boolean | null;
|
|
1857
1854
|
/**
|
|
1858
1855
|
* 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 +1872,9 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1875
1872
|
* Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
|
|
1876
1873
|
*
|
|
1877
1874
|
* 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 Resumable Upload API
|
|
1875
|
+
* 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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api).
|
|
1879
1876
|
*
|
|
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
|
|
1877
|
+
* > **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).
|
|
1881
1878
|
* @param mimeType - File mime type.
|
|
1882
1879
|
* @public
|
|
1883
1880
|
* @requiredField mimeType
|
|
@@ -1910,7 +1907,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
1910
1907
|
* @maxLength 100
|
|
1911
1908
|
*/
|
|
1912
1909
|
parentFolderId?: string | null;
|
|
1913
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
1910
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
1914
1911
|
private?: boolean | null;
|
|
1915
1912
|
/**
|
|
1916
1913
|
* 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 +1935,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
1938
1935
|
*
|
|
1939
1936
|
* >**Notes:**
|
|
1940
1937
|
* > - 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 knowing when a file is ready
|
|
1938
|
+
* > - 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#knowing-when-a-file-is-ready).
|
|
1942
1939
|
*
|
|
1943
1940
|
* To import a file, you need to do one of the following:
|
|
1944
1941
|
* - 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 +1971,7 @@ interface ImportFileOptions {
|
|
|
1974
1971
|
* @maxLength 100
|
|
1975
1972
|
*/
|
|
1976
1973
|
parentFolderId?: string | null;
|
|
1977
|
-
/** Whether the file will be public or private. Learn more about private files
|
|
1974
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
1978
1975
|
private?: boolean | null;
|
|
1979
1976
|
/**
|
|
1980
1977
|
* 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 +1984,7 @@ interface ImportFileOptions {
|
|
|
1987
1984
|
* @maxLength 100
|
|
1988
1985
|
*/
|
|
1989
1986
|
mimeType?: string;
|
|
1990
|
-
/** Information sent to the File Ready and File Failed events. See Importing Files
|
|
1987
|
+
/** Information sent to the File Ready and File Failed events. See [Importing Files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files) to learn more. */
|
|
1991
1988
|
externalInfo?: ExternalInfo;
|
|
1992
1989
|
/** Optional parameters that should be sent with the external URL. */
|
|
1993
1990
|
urlParams?: Record<string, any> | null;
|
|
@@ -2012,7 +2009,7 @@ interface ImportFileOptions {
|
|
|
2012
2009
|
*
|
|
2013
2010
|
* >**Notes:**
|
|
2014
2011
|
* > - 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 knowing when a file is ready
|
|
2012
|
+
* > - 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#knowing-when-a-file-is-ready).
|
|
2016
2013
|
*
|
|
2017
2014
|
* To import files, you need to do one of the following for each file:
|
|
2018
2015
|
* - 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 +2039,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
|
|
|
2042
2039
|
*
|
|
2043
2040
|
* >**Notes:**
|
|
2044
2041
|
* > - 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 knowing when a file is ready
|
|
2042
|
+
* > - 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#knowing-when-a-file-is-ready).
|
|
2046
2043
|
*
|
|
2047
2044
|
* To import files, you need to do one of the following for each file:
|
|
2048
2045
|
* - 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 +2092,7 @@ interface ListFilesOptions {
|
|
|
2095
2092
|
* + `false`: Returns only public files.
|
|
2096
2093
|
* + `undefined`: Returns public and private files.
|
|
2097
2094
|
*
|
|
2098
|
-
* Learn more about private files
|
|
2095
|
+
* Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
2099
2096
|
*/
|
|
2100
2097
|
private?: boolean | null;
|
|
2101
2098
|
/**
|
|
@@ -2129,10 +2126,8 @@ interface ListFilesOptions {
|
|
|
2129
2126
|
* ## See also
|
|
2130
2127
|
*
|
|
2131
2128
|
* To learn about working with *Search* methods, see
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
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)).
|
|
2129
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language)
|
|
2130
|
+
* and [*Sorting and Paging*](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
|
|
2136
2131
|
* @public
|
|
2137
2132
|
* @param options - Options to specify which folders to search.
|
|
2138
2133
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST
|
|
@@ -2153,7 +2148,7 @@ interface SearchFilesOptions {
|
|
|
2153
2148
|
search?: string | null;
|
|
2154
2149
|
/**
|
|
2155
2150
|
* The root folder in the media manager to search in.
|
|
2156
|
-
* For more information, see Root Folders in Terminology
|
|
2151
|
+
* For more information, see Root Folders in [Terminology](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology).
|
|
2157
2152
|
*
|
|
2158
2153
|
* Default: `MEDIA_ROOT`.
|
|
2159
2154
|
*/
|
|
@@ -2169,7 +2164,7 @@ interface SearchFilesOptions {
|
|
|
2169
2164
|
* + `false`: Returns only public files.
|
|
2170
2165
|
* + `undefined`: Returns public and private files.
|
|
2171
2166
|
*
|
|
2172
|
-
* Learn more about private files
|
|
2167
|
+
* Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
2173
2168
|
*/
|
|
2174
2169
|
private?: boolean | null;
|
|
2175
2170
|
/**
|
|
@@ -2274,7 +2269,7 @@ interface ListDeletedFilesOptions {
|
|
|
2274
2269
|
* @maxSize 30
|
|
2275
2270
|
*/
|
|
2276
2271
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
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
|
|
2272
|
+
/** \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/rest/assets/media/media-manager/files/private-files). */
|
|
2278
2273
|
private?: boolean | null;
|
|
2279
2274
|
/**
|
|
2280
2275
|
* Field name and order to sort by. One of: <br />
|