@wix/auto_sdk_media_files 1.0.21 → 1.0.23

package/build/cjs/meta.d.ts

@@ -784,8 +784,9 @@ interface BulkImportFileResult {
 }
 interface ListFilesRequest {
     /**
-     * ID of the file's parent folder. <br />
-     * Default:`media-root`.
+     * ID of the file's parent folder.
+     *
+     * Default: `media-root`.
      * @maxLength 100
      */
     parentFolderId?: string | null;
@@ -794,13 +795,22 @@ interface ListFilesRequest {
      * @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)). */
+    /**
+     * Whether to return only private or only public files.
+     * + `true`: Returns only private files.
+     * + `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)).
+     */
     private?: boolean | null;
     /**
-     * Field name and order to sort by. One of: <br />
-     * * `displayName`
-     * * `updatedDate`
-     * * `sizeInBytes`
+     * Field name and order to sort by. One of:
+     *
+     * `displayName`
+     * `updatedDate`
+     * `sizeInBytes`
+     *
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -861,14 +871,17 @@ interface Cursors {
 }
 interface SearchFilesRequest {
     /**
-     * Term to search for. Possible terms include the value of a file's
-     * `displayName`, `mimeType`, and `label`. <br />
-     * For example, if a file's label is cat, the search term is 'cat'.
+     * Free text to match in searchable fields.
+     *
+     * For example, search for specific values in a file's
+     * `displayName`, `mimeType`, or `label`.
      * @maxLength 200
      */
     search?: string | null;
     /**
-     * A root folder in the media manager to search in. <br />
+     * 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)).
+     *
      * Default: `MEDIA_ROOT`.
      */
     rootFolder?: RootFolderWithLiterals;
@@ -877,13 +890,23 @@ interface SearchFilesRequest {
      * @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)). */
+    /**
+     * Whether to return only private or only public files.
+     * + `true`: Returns only private files.
+     * + `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)).
+     */
     private?: boolean | null;
     /**
-     * Field name and order to sort by. One of: <br />
-     * * `displayName`
-     * * `updatedDate`
-     * * `sizeInBytes`
+     * Field name and order to sort by.
+     *
+     * One of:
+     * `displayName`
+     * `updatedDate`
+     * `sizeInBytes`
+     *
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -891,18 +914,20 @@ interface SearchFilesRequest {
     paging?: CursorPaging;
 }
 declare enum RootFolder {
-    /** Root of all site media */
+    /** Contains all files and folders in the Media Manager's **Site Files** tab in the UI. */
     MEDIA_ROOT = "MEDIA_ROOT",
-    /** Root of the trash system folder */
+    /** Contains all files and folders in the Media Manager's **Trash** tab in the UI. */
     TRASH_ROOT = "TRASH_ROOT",
-    /** Root of all visitor uploads */
+    /** Contains all files and folders created by site visitors or members. */
     VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
 }
 /** @enumType */
 type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
 interface SearchFilesResponse {
     /**
-     * Files matching the query.
+     * Retrieved files that match the search criteria specified in the request.
+     *
+     * Each file includes all standard file information.
      * @maxSize 200
      */
     files?: FileDescriptor[];