@wix/auto_sdk_media_files 1.0.76 → 1.0.77

package/build/cjs/index.typings.d.ts

@@ -609,7 +609,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
@@ -628,7 +628,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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;
@@ -717,7 +717,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
@@ -733,7 +733,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
@@ -819,7 +819,7 @@ interface GenerateFileUploadUrlRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -930,7 +930,7 @@ interface GenerateFileResumableUploadUrlRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -993,7 +993,7 @@ interface ImportFileRequest {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -1206,7 +1206,7 @@ interface SearchFilesRequest {
      * + `false`: Returns only public files.
      * + `undefined`: Returns public and private files.
      *
-     * Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
+     * Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files).
      */
     private?: boolean | null;
     /**
@@ -1249,7 +1249,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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;
@@ -1281,7 +1281,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
      */
@@ -1299,7 +1299,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
      */
@@ -1319,7 +1319,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](https://dev.wix.com/docs/rest/assets/media/media-manager/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/api-reference/assets/media/media-manager/files/private-files). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />
@@ -1346,7 +1346,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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
      */
@@ -1394,7 +1394,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](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-id).
+     * 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;
@@ -1421,7 +1421,12 @@ interface UpdateFileResponse {
     file?: FileDescriptor;
 }
 interface QueryFileDescriptorsRequest {
-    /** Query object */
+    /**
+     * Query options, including filter, sort, and cursor paging.
+     *
+     * See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and
+     * [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging) for more information.
+     */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -1460,7 +1465,11 @@ interface Sorting {
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrderWithLiterals;
 }
 declare enum SortOrder {
@@ -1471,11 +1480,11 @@ declare enum SortOrder {
 type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
 interface QueryFileDescriptorsResponse {
     /**
-     * The retrieved files that match the query
+     * Retrieved files that match the query.
      * @maxSize 200
      */
     files?: FileDescriptor[];
-    /** The metadata for the page including the next cursor if one exist */
+    /** Paging metadata, including the cursors for the next and previous pages. */
     pagingMetadata?: PagingMetadataV2;
 }
 interface ListRecentItemsRequest {
@@ -1963,9 +1972,9 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
 /**
  * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
  *
- * 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).
+ * Learn how to use the generated upload URL to [upload a file to the Media Manager](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api).
  * > **Notes:**
- * > - 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).
+ * > - 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).
  * > - 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.
  * @param mimeType - File mime type.
  * @public
@@ -1999,7 +2008,7 @@ interface GenerateFileUploadUrlOptions {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -2022,7 +2031,7 @@ interface GenerateFileUploadUrlOptions {
  * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
  *
  * 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.
- * 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).
+ * Learn how to use the generated upload URL in the response to [upload large files to the Media Manager](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/resumable-upload-api).
  *
  * > **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).
  * @param mimeType - File mime type.
@@ -2057,7 +2066,7 @@ interface GenerateFileResumableUploadUrlOptions {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -2121,7 +2130,7 @@ interface ImportFileOptions {
      * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** 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). */
+    /** Whether the file will be public or private. Learn more [about private files](https://dev.wix.com/docs/api-reference/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.
@@ -2159,7 +2168,7 @@ interface ImportFileOptions {
  *
  * >**Notes:**
  * > - The `media` property isn't returned in the `files` response object.
- * > - 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).
+ * > - 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).
  *
  * To import files, you need to do one of the following for each file:
  * - 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'`.
@@ -2189,7 +2198,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
  *
  * >**Notes:**
  * > - The `media` property isn't returned in the `files` response object.
- * > - 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).
+ * > - 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).
  *
  * To import files, you need to do one of the following for each file:
  * - 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'`.
@@ -2314,7 +2323,7 @@ interface SearchFilesOptions {
      * + `false`: Returns only public files.
      * + `undefined`: Returns public and private files.
      *
-     * Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
+     * Learn more [about private files](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/private-files).
      */
     private?: boolean | null;
     /**
@@ -2419,7 +2428,7 @@ interface ListDeletedFilesOptions {
      * @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](https://dev.wix.com/docs/rest/assets/media/media-manager/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/api-reference/assets/media/media-manager/files/private-files). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />
@@ -2433,14 +2442,15 @@ interface ListDeletedFilesOptions {
     paging?: CursorPaging;
 }
 /**
- * Retrieves a list of files in the Media Manager, given the provided [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging), filtering, and sorting.
+ * Retrieves a list of files in the Media Manager, given the provided [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging), filtering, and sorting.
  *
  * Up to 200 files can be returned per request.
+ *
  * When filtering by `mediaType`, supported values are: `IMAGE`, `VIDEO`, `AUDIO`, `DOCUMENT`, `VECTOR`, `ARCHIVE`, and `MODEL3D`.
  *
  * To learn about working with *Query* methods, see
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and
- * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+ * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and
+ * [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
  * @public
  * @permissionId media:site_media:v1:file_descriptor:query_file_descriptors
  * @applicableIdentity APP
@@ -2558,7 +2568,9 @@ type FileDescriptorQuery = {
       */
         fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
         /**
-      Sort order.
+      Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+    
+      Default: `ASC`
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
     }[];