@wix/media 1.0.131 → 1.0.132

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

@@ -2434,7 +2434,7 @@ interface FileDescriptor {
      */
     sizeInBytes?: string | null;
     /**
-     * Whether the file is public or private. For more, see the Private Files article.
+     * 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;
@@ -2712,9 +2712,9 @@ declare enum IdentityType {
     APP = "APP"
 }
 interface ExternalInfo {
-    /** External information to pass in the File Ready or File Failed events. */
+    /** External information to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
     origin?: string;
-    /** External IDs to pass in the File Ready or File Failed events. */
+    /** External IDs to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
     externalIds?: string[];
 }
 interface ApplicationError {
@@ -2730,7 +2730,7 @@ interface GenerateFilesDownloadUrlRequest {
      * 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.
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
      */
     fileIds: string[];
 }
@@ -2742,8 +2742,8 @@ interface GenerateFileDownloadUrlRequest {
     /**
      * 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.
+     * 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/files/file-id#file-id-as-a-parameter).
      */
     fileId: string;
     /**
@@ -2801,8 +2801,10 @@ interface GetFileDescriptorRequest {
     /**
      * 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.
+     * 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/files/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;
 }
@@ -2815,7 +2817,7 @@ interface GetFileDescriptorsRequest {
      * 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.
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
      */
     fileIds: string[];
 }
@@ -2850,11 +2852,11 @@ interface GenerateFileUploadUrlRequest {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the file will be public or private. For more, see the Private Files article. */
+    /** 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 user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
     labels?: string[] | null;
-    /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */
+    /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
     externalInfo?: ExternalInfo;
     /**
      * Path to the folder where the file will be stored.
@@ -2887,7 +2889,7 @@ interface GenerateFileResumableUploadUrlRequest {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the file will be public or private. For more, see the Private Files article. */
+    /** 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 user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
     labels?: string[] | null;
@@ -2906,11 +2908,7 @@ declare enum UploadProtocol {
     TUS = "TUS"
 }
 interface GenerateFileResumableUploadUrlResponse {
-    /**
-     * The upload protocol to use for implementing the resumable upload.
-     *
-     * Supported values: `"TUS"`
-     */
+    /** The upload protocol to use for implementing the resumable upload. */
     uploadProtocol?: UploadProtocol;
     /** The URL for uploading a file to the Media Manager. */
     uploadUrl?: string;
@@ -2920,7 +2918,10 @@ interface GenerateFileResumableUploadUrlResponse {
 interface ImportFileRequest {
     /** Publicly accessible external file URL. */
     url: string;
-    /** Media type of the file to import. */
+    /**
+     * Media type of the file to import.
+     * excluding: OTHER media type
+     */
     mediaType?: MediaType;
     /** File name that appears in the Media Manager. */
     displayName?: string | null;
@@ -2930,13 +2931,13 @@ interface ImportFileRequest {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the file will be public or private. For more, see the Private Files article. */
+    /** 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 user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
     labels?: string[] | null;
     /** File mime type. */
     mimeType?: string;
-    /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */
+    /** Information sent to the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) and [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) webhooks. See [Importing Files](/files/importing-files#using-externalinfo) to learn more. */
     externalInfo?: ExternalInfo;
     /** Optional parameters that should be sent with the external URL. */
     urlParams?: Record<string, any> | null;
@@ -3013,21 +3014,14 @@ interface ListFilesRequest {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType[];
-    /**
-     * `true`: Returns only private files.
-     * `false`: Returns only public files.
-     * `undefined`: Returns public and private files.
-     *  For more, see the Private Files article.
-     */
+    /** \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:
-     *
-     * - `displayName`
-     * - `_updatedDate`
-     * - `sizeInBytes`
-     *
-     * Default: `_updatedDate` in `"DESC"` order.
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * * `sizeInBytes`
+     * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting$2;
     /** Cursor and paging information. */
@@ -3087,21 +3081,14 @@ interface SearchFilesRequest {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType[];
-    /**
-     * `true`: Returns only private files.
-     * `false`: Returns only public files.
-     * `undefined`: Returns public and private files.
-     *  For more, see the Private Files article.
-     */
+    /** \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:
-     *
-     * - `displayName`
-     * - `_updatedDate`
-     * - `sizeInBytes`
-     *
-     * Default: `_updatedDate` in `"DESC"` order.
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * * `sizeInBytes`
+     * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting$2;
     /** Cursor and paging information. */
@@ -3125,8 +3112,8 @@ interface GenerateVideoStreamingUrlRequest {
     /**
      * 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.
+     * 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/files/file-id#file-id-as-a-parameter).
      */
     fileId: string;
     /** Video stream format. */
@@ -3146,7 +3133,7 @@ interface BulkDeleteFilesRequest {
      * 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.
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
      */
     fileIds: string[];
     /**
@@ -3162,7 +3149,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
      * 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.
+     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
      */
     fileIds: string[];
 }
@@ -3179,21 +3166,14 @@ interface ListDeletedFilesRequest {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType[];
-    /**
-     * `true`: Returns only private files.
-     * `false`: Returns only public files.
-     * `undefined`: Returns public and private files.
-     *  For more, see the Private Files article.
-     */
+    /** \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:
-     *
-     * - `displayName`
-     * - `_updatedDate`
-     * - `sizeInBytes`
-     *
-     * Default: `_updatedDate` in `"DESC"` order.
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * * `sizeInBytes`
+     * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting$2;
     /** Cursor and paging information. */