@wix/media 1.0.96 → 1.0.98

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/media",
-  "version": "1.0.96",
+  "version": "1.0.98",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -20,7 +20,7 @@
   "dependencies": {
     "@wix/media_enterprise-media-categories": "1.0.23",
     "@wix/media_enterprise-media-items": "1.0.26",
-    "@wix/media_files": "1.0.33",
+    "@wix/media_files": "1.0.35",
     "@wix/media_folders": "1.0.26"
   },
   "devDependencies": {
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "be5ebe36cbf30845bd5aa469e6941572500ec99cc04ddc2de071b133"
+  "falconPackageHash": "f9a34a3b4dc15ab560164024784cf13fb08d6ce308cc9bb822e2b18e"
 }

package/type-bundles/index.bundle.d.ts

@@ -1843,7 +1843,12 @@ interface FileFailed {
     externalInfo?: ExternalInfo;
 }
 interface GenerateFilesDownloadUrlRequest {
-    /** IDs or Wix media URLs of the files to download. */
+    /**
+     * IDs of the files to download.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface GenerateFilesDownloadUrlResponse {
@@ -1851,7 +1856,12 @@ interface GenerateFilesDownloadUrlResponse {
     downloadUrl?: string;
 }
 interface GenerateFileDownloadUrlRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
@@ -1905,7 +1915,12 @@ interface DownloadUrl {
     assetKey?: string;
 }
 interface GetFileDescriptorRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
 }
 interface GetFileDescriptorResponse {
@@ -1913,7 +1928,12 @@ interface GetFileDescriptorResponse {
     file?: FileDescriptor;
 }
 interface GetFileDescriptorsRequest {
-    /** File IDs, or the files' Wix media URLs. */
+    /**
+     * File IDs.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface GetFileDescriptorsResponse {
@@ -2217,7 +2237,12 @@ interface SearchFilesResponse {
     nextCursor?: PagingMetadataV2$1;
 }
 interface GenerateVideoStreamingUrlRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
     /** Video stream format. */
     format?: StreamFormat;
@@ -2238,7 +2263,12 @@ interface GenerateWebSocketTokenResponse {
     token?: string;
 }
 interface BulkDeleteFilesRequest {
-    /** IDs or Wix media URLs of the files to move to the Media Manager's trash bin. */
+    /**
+     * IDs of the files to move to the Media Manager's trash bin.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
@@ -2249,7 +2279,12 @@ interface BulkDeleteFilesRequest {
 interface BulkDeleteFilesResponse {
 }
 interface BulkRestoreFilesFromTrashBinRequest {
-    /** IDs or Wix media URLs of the files to restore from the Media Manager's trash bin. */
+    /**
+     * IDs of the files to restore from the Media Manager's trash bin.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface BulkRestoreFilesFromTrashBinResponse {
@@ -2287,7 +2322,12 @@ interface ListDeletedFilesResponse {
     nextCursor?: PagingMetadataV2$1;
 }
 interface UpdateFileRequest {
-    /** ID or Wix media URL of the file to update. */
+    /**
+     * ID of the file to update.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId?: string;
     /** File name that appears in the Media Manager. */
     displayName?: string | null;

package/type-bundles/meta.bundle.d.ts

@@ -2143,7 +2143,12 @@ interface ExternalInfo$1 {
     externalIds?: string[];
 }
 interface GenerateFilesDownloadUrlRequest$1 {
-    /** IDs or Wix media URLs of the files to download. */
+    /**
+     * IDs of the files to download.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileIds: string[];
 }
 interface GenerateFilesDownloadUrlResponse$1 {
@@ -2151,7 +2156,12 @@ interface GenerateFilesDownloadUrlResponse$1 {
     downloadUrl?: string;
 }
 interface GenerateFileDownloadUrlRequest$1 {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileId: string;
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
@@ -2205,7 +2215,14 @@ interface DownloadUrl$1 {
     assetKey?: string;
 }
 interface GetFileDescriptorRequest$1 {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     *
+     * Note that you must encode the Wix media URL to pass 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`.
+     */
     fileId: string;
 }
 interface GetFileDescriptorResponse$1 {
@@ -2213,7 +2230,12 @@ interface GetFileDescriptorResponse$1 {
     file?: FileDescriptor$1;
 }
 interface GetFileDescriptorsRequest$1 {
-    /** File IDs, or the files' Wix media URLs. */
+    /**
+     * File IDs.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileIds: string[];
 }
 interface GetFileDescriptorsResponse$1 {
@@ -2331,7 +2353,7 @@ interface ImportFileRequest$1 {
     labels?: string[] | null;
     /** File mime type. */
     mimeType?: string;
-    /** Information sent to the [Descriptor File Ready](/files/descriptor-file-ready) and [Descriptor File Failed](/files/descriptor-file-failed) webhooks. See [Importing Files](/importing-files#using-externalinfo) to learn more. */
+    /** Information sent to the [Descriptor File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/descriptor-file-ready) and [Descriptor File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/descriptor-file-failed) webhooks. See [Importing Files](/importing-files#using-externalinfo) to learn more. */
     externalInfo?: ExternalInfo$1;
     /** Optional parameters that should be sent with the external URL. */
     urlParams?: Record<string, any> | null;
@@ -2512,7 +2534,12 @@ interface SearchFilesResponse$1 {
     nextCursor?: PagingMetadataV2$3;
 }
 interface GenerateVideoStreamingUrlRequest$1 {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileId: string;
     /** Video stream format. */
     format?: StreamFormat$1;
@@ -2527,7 +2554,12 @@ interface GenerateVideoStreamingUrlResponse$1 {
     downloadUrl?: DownloadUrl$1;
 }
 interface BulkDeleteFilesRequest$1 {
-    /** IDs or Wix media URLs of the files to move to the Media Manager's trash bin. */
+    /**
+     * IDs of the files to move to the Media Manager's trash bin.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileIds: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
@@ -2538,7 +2570,12 @@ interface BulkDeleteFilesRequest$1 {
 interface BulkDeleteFilesResponse$1 {
 }
 interface BulkRestoreFilesFromTrashBinRequest$1 {
-    /** IDs or Wix media URLs of the files to restore from the Media Manager's trash bin. */
+    /**
+     * IDs of the files to restore from the Media Manager's trash bin.
+     *
+     * You can also pass 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](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     */
     fileIds: string[];
 }
 interface BulkRestoreFilesFromTrashBinResponse$1 {
@@ -3960,7 +3997,12 @@ interface ExternalInfo {
     externalIds?: string[];
 }
 interface GenerateFilesDownloadUrlRequest {
-    /** IDs or Wix media URLs of the files to download. */
+    /**
+     * IDs of the files to download.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface GenerateFilesDownloadUrlResponse {
@@ -3968,7 +4010,12 @@ interface GenerateFilesDownloadUrlResponse {
     downloadUrl?: string;
 }
 interface GenerateFileDownloadUrlRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
@@ -4022,7 +4069,12 @@ interface DownloadUrl {
     assetKey?: string;
 }
 interface GetFileDescriptorRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
 }
 interface GetFileDescriptorResponse {
@@ -4030,7 +4082,12 @@ interface GetFileDescriptorResponse {
     file?: FileDescriptor;
 }
 interface GetFileDescriptorsRequest {
-    /** File IDs, or the files' Wix media URLs. */
+    /**
+     * File IDs.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface GetFileDescriptorsResponse {
@@ -4334,7 +4391,12 @@ interface SearchFilesResponse {
     nextCursor?: PagingMetadataV2$2;
 }
 interface GenerateVideoStreamingUrlRequest {
-    /** File ID, or the file's Wix media URL. */
+    /**
+     * File ID.
+     *
+     * You can also pass the file's Wix media URL. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileId: string;
     /** Video stream format. */
     format?: StreamFormat;
@@ -4349,7 +4411,12 @@ interface GenerateVideoStreamingUrlResponse {
     downloadUrl?: DownloadUrl;
 }
 interface BulkDeleteFilesRequest {
-    /** IDs or Wix media URLs of the files to move to the Media Manager's trash bin. */
+    /**
+     * IDs of the files to move to the Media Manager's trash bin.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
@@ -4360,7 +4427,12 @@ interface BulkDeleteFilesRequest {
 interface BulkDeleteFilesResponse {
 }
 interface BulkRestoreFilesFromTrashBinRequest {
-    /** IDs or Wix media URLs of the files to restore from the Media Manager's trash bin. */
+    /**
+     * IDs of the files to restore from the Media Manager's trash bin.
+     *
+     * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
+     * Learn more in the File and Folder IDs article.
+     */
     fileIds: string[];
 }
 interface BulkRestoreFilesFromTrashBinResponse {