@wix/auto_sdk_media_files 1.0.22 → 1.0.23

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

@@ -1013,8 +1013,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;
@@ -1023,13 +1024,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;
@@ -1090,14 +1100,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;
@@ -1106,13 +1119,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;
@@ -1120,18 +1143,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[];
@@ -1448,18 +1473,23 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
 type GenerateFileDownloadUrlValidationErrors = {
     ruleName?: 'INVALID_ASSET_KEY';
 };
+/** @docsIgnore */
 type GetFileDescriptorValidationErrors = {
     ruleName?: 'RESOURCE_NOT_FOUND';
 };
+/** @docsIgnore */
 type GetFileDescriptorsValidationErrors = {
     ruleName?: 'RESOURCE_NOT_FOUND';
 };
+/** @docsIgnore */
 type UpdateFileDescriptorValidationErrors = {
     ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
 };
+/** @docsIgnore */
 type GenerateFileUploadUrlValidationErrors = {
     ruleName?: 'MISMATCH_MIME_TYPE';
 } | {
@@ -1471,6 +1501,7 @@ type GenerateFileUploadUrlValidationErrors = {
 } | {
     ruleName?: 'SITE_QUOTA_EXCEEDED';
 };
+/** @docsIgnore */
 type GenerateFileResumableUploadUrlValidationErrors = {
     ruleName?: 'MISMATCH_MIME_TYPE';
 } | {
@@ -1480,19 +1511,23 @@ type GenerateFileResumableUploadUrlValidationErrors = {
 } | {
     ruleName?: 'FILE_SIZE_OVER_LIMIT';
 };
+/** @docsIgnore */
 type ImportFileValidationErrors = {
     ruleName?: 'SITE_QUOTA_EXCEEDED';
 };
+/** @docsIgnore */
 type ListFilesValidationErrors = {
     ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
 } | {
     ruleName?: 'UNSUPPORTED_SORT_VALUE';
 };
+/** @docsIgnore */
 type SearchFilesValidationErrors = {
     ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
 } | {
     ruleName?: 'UNSUPPORTED_SORT_VALUE';
 };
+/** @docsIgnore */
 type ListDeletedFilesValidationErrors = {
     ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
 } | {
@@ -2087,8 +2122,9 @@ declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths
 }>;
 interface ListFilesOptions {
     /**
-     * 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;
@@ -2097,13 +2133,22 @@ interface ListFilesOptions {
      * @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;
@@ -2111,9 +2156,27 @@ interface ListFilesOptions {
     paging?: CursorPaging;
 }
 /**
- * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
+ * Retrieves a list of up to 200 files with the specified filtering, sorting, and cursor paging.
+ *
+ * If no parameters are specified, the method returns all files in the `MEDIA_ROOT` folder.
+ *
+ * ## Defaults
+ *
+ * Search Files has the following default setting, which you can override:
+ * + Sorted by `updatedDate` in descending order.
+ *
+ * ## Filters
  *
- * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
+ * When using filters for dates, you must use
+ * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
+ *
+ * ## See also
+ *
+ * To learn about working with *Search* methods, see
+ * _API Query Language_
+ * ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/get-started/api-query-language))
+ * and *Sorting and Paging*
+ * ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language#the-sort-array) | [REST](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging)).
  * @public
  * @param options - Options to specify which folders to search.
  * @permissionId MEDIA.SITE_MEDIA_FILES_LIST
@@ -2125,14 +2188,17 @@ declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullableP
 }>;
 interface SearchFilesOptions {
     /**
-     * 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;
@@ -2141,13 +2207,23 @@ interface SearchFilesOptions {
      * @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;