@wix/auto_sdk_media_files 1.0.50 → 1.0.52

package/build/es/meta.d.mts

@@ -38,7 +38,7 @@ interface FileDescriptor {
      */
     sizeInBytes?: string | null;
     /**
-     * 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)).
+     * 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).
      * @readonly
      */
     private?: boolean;
@@ -54,9 +54,6 @@ interface FileDescriptor {
     media?: FileMedia;
     /**
      * Status of the file that was uploaded.
-     * * `FAILED`: The file failed to upload, for example, during media post processing.
-     * * `READY`: The file uploaded, finished all processing, and is ready for use.
-     * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
      * @readonly
      */
     operationStatus?: OperationStatusWithLiterals;
@@ -468,11 +465,11 @@ interface FontAsset {
     format?: string | null;
 }
 declare enum OperationStatus {
-    /** File upload or processing failed */
+    /** The file failed to upload, for example, during media post processing. */
     FAILED = "FAILED",
-    /** File is ready for consumption */
+    /** The file uploaded, finished all processing, and is ready for use. */
     READY = "READY",
-    /** File is waiting for processing or currently being processed */
+    /** The file is processing and the URLs are not yet available. This response is returned when importing a file. */
     PENDING = "PENDING"
 }
 /** @enumType */
@@ -667,7 +664,7 @@ interface GenerateFilesDownloadUrlRequest {
      * IDs of the files to download.
      *
      * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @minSize 1
      * @maxSize 1000
      * @maxLength 1000
@@ -686,7 +683,7 @@ interface GenerateFileDownloadUrlRequest {
      * File ID.
      *
      * 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`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxLength 1000
      */
     fileId: string;
@@ -775,7 +772,7 @@ interface GetFileDescriptorRequest {
      * File ID.
      *
      * 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`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      *
      * 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`.
      * @maxLength 1000
@@ -791,7 +788,7 @@ interface GetFileDescriptorsRequest {
      * File IDs.
      *
      * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @minSize 1
      * @maxSize 100
      * @maxLength 1000
@@ -852,7 +849,7 @@ interface GenerateFileUploadUrlRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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)). */
+    /** 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). */
     private?: boolean | null;
     /**
      * 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.
@@ -963,7 +960,7 @@ interface GenerateFileResumableUploadUrlRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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)). */
+    /** 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). */
     private?: boolean | null;
     /**
      * 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.
@@ -1025,7 +1022,7 @@ interface ImportFileRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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)). */
+    /** 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). */
     private?: boolean | null;
     /**
      * 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.
@@ -1038,7 +1035,7 @@ interface ImportFileRequest {
      * @maxLength 100
      */
     mimeType?: string;
-    /** 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. */
+    /** 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. */
     externalInfo?: ExternalInfo;
     /** Optional parameters that should be sent with the external URL. */
     urlParams?: Record<string, any> | null;
@@ -1127,7 +1124,7 @@ interface ListFilesRequest {
      * + `false`: Returns only public files.
      * + `undefined`: Returns public and private files.
      *
-     * 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)).
+     * Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
      */
     private?: boolean | null;
     /**
@@ -1206,7 +1203,7 @@ interface SearchFilesRequest {
     search?: string | null;
     /**
      * The root folder in the media manager to search in.
-     * 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)).
+     * For more information, see Root Folders in [Terminology](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology).
      *
      * Default: `MEDIA_ROOT`.
      */
@@ -1222,7 +1219,7 @@ interface SearchFilesRequest {
      * + `false`: Returns only public files.
      * + `undefined`: Returns public and private files.
      *
-     * 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)).
+     * Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
      */
     private?: boolean | null;
     /**
@@ -1265,7 +1262,7 @@ interface GenerateVideoStreamingUrlRequest {
      * File ID.
      *
      * 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`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxLength 1000
      */
     fileId: string;
@@ -1297,7 +1294,7 @@ interface BulkDeleteFilesRequest {
      * IDs of the files to move to the Media Manager's trash bin.
      *
      * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxSize 1000
      * @maxLength 1000
      */
@@ -1315,7 +1312,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
      * IDs of the files to restore from the Media Manager's trash bin.
      *
      * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxSize 1000
      * @maxLength 1000
      */
@@ -1335,7 +1332,7 @@ interface ListDeletedFilesRequest {
      * @maxSize 30
      */
     mediaTypes?: MediaTypeWithLiterals[];
-    /** \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)). */
+    /** \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). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />
@@ -1362,7 +1359,7 @@ interface BulkPublishDraftFilesRequest {
      * IDs of the draft files to be published.
      *
      * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxSize 100
      * @maxLength 1000
      */
@@ -1410,7 +1407,7 @@ interface UpdateFileRequest {
      * ID of the file to update.
      *
      * 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`.
-     * 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)).
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
      * @maxLength 1000
      */
     fileId?: string;