@wix/auto_sdk_media_files 1.0.19 → 1.0.21

package/build/cjs/{media-site-media-v1-file-descriptor-files.universal-C5dCrbUZ.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface FileDescriptor {
     /**
      * File ID. Generated when a file is uploaded to the Media Manager.
@@ -1446,6 +1448,56 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type GenerateFileDownloadUrlValidationErrors = {
+    ruleName?: 'INVALID_ASSET_KEY';
+};
+type GetFileDescriptorValidationErrors = {
+    ruleName?: 'RESOURCE_NOT_FOUND';
+};
+type GetFileDescriptorsValidationErrors = {
+    ruleName?: 'RESOURCE_NOT_FOUND';
+};
+type UpdateFileDescriptorValidationErrors = {
+    ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
+};
+type GenerateFileUploadUrlValidationErrors = {
+    ruleName?: 'MISMATCH_MIME_TYPE';
+} | {
+    ruleName?: 'ZERO_FILE_SIZE';
+} | {
+    ruleName?: 'UNSUPPORTED_FILE_FORMAT';
+} | {
+    ruleName?: 'FILE_SIZE_OVER_LIMIT';
+} | {
+    ruleName?: 'SITE_QUOTA_EXCEEDED';
+};
+type GenerateFileResumableUploadUrlValidationErrors = {
+    ruleName?: 'MISMATCH_MIME_TYPE';
+} | {
+    ruleName?: 'ZERO_FILE_SIZE';
+} | {
+    ruleName?: 'UNSUPPORTED_FILE_FORMAT';
+} | {
+    ruleName?: 'FILE_SIZE_OVER_LIMIT';
+};
+type ImportFileValidationErrors = {
+    ruleName?: 'SITE_QUOTA_EXCEEDED';
+};
+type ListFilesValidationErrors = {
+    ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
+} | {
+    ruleName?: 'UNSUPPORTED_SORT_VALUE';
+};
+type SearchFilesValidationErrors = {
+    ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
+} | {
+    ruleName?: 'UNSUPPORTED_SORT_VALUE';
+};
+type ListDeletedFilesValidationErrors = {
+    ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
+} | {
+    ruleName?: 'UNSUPPORTED_SORT_VALUE';
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1493,18 +1545,191 @@ interface EventMetadata extends BaseEventMetadata {
 interface FileDescriptorDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a file is deleted.
+ *
+ * If the `movedToTrash` property in the event object `true`, the file was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the file was permanently deleted.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.file_descriptor_deleted
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
+ * @slug deleted
+ */
+declare function onFileDescriptorDeleted(handler: (event: FileDescriptorDeletedEnvelope) => void | Promise<void>): void;
 interface FileDescriptorFileFailedEnvelope {
     data: FileFailed;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a file fails during essential post-upload processing.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.file_descriptor_file_failed
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
+ * @slug file_failed
+ */
+declare function onFileDescriptorFileFailed(handler: (event: FileDescriptorFileFailedEnvelope) => void | Promise<void>): void;
 interface FileDescriptorFileReadyEnvelope {
     data: FileReady;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a file is ready to be used, after any post-upload processing.
+ *
+ * This event is also triggred when a file is restored from the Media Manager's trash bin.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.file_descriptor_file_ready
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
+ * @slug file_ready
+ */
+declare function onFileDescriptorFileReady(handler: (event: FileDescriptorFileReadyEnvelope) => void | Promise<void>): void;
 interface FileDescriptorUpdatedEnvelope {
     entity: FileDescriptor;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a file is updated, including when a file is moved to a different folder.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.file_descriptor_updated
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
+ * @slug updated
+ */
+declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
+type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`;
+/**
+ * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
+ *
+ * The compressed file can contain up to 1000 files.
+ *
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
+ * Since this is a permanent URL, it is less secure.
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
+ * @public
+ * @requiredField fileIds
+ * @param fileIds - 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
+ */
+declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`>>;
+/**
+ * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
+ *
+ * To download different assets of the file, specify the `assetKeys` parameter which generates a download URL for each asset.
+ * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
+ *
+ * Call this endpoint to grant external clients access to a private media file. Specify the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect url when the URL expires.
+ *
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
+ * Since this is a permanent URL, it is less secure.
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
+ * @public
+ * @requiredField fileId
+ * @param options - Options to use when generating a file's download URL.
+ * @param fileId - File ID.
+ *
+ * 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD_URL
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
+ */
+declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
+    __validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
+}>;
 interface GenerateFileDownloadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
@@ -1543,6 +1768,73 @@ interface GenerateFileDownloadUrlOptions {
      */
     contentDisposition?: ContentDispositionWithLiterals;
 }
+/**
+ * Gets information about a specific file in the Media Manager.
+ * @public
+ * @requiredField fileId
+ * @param fileId - File ID.
+ *
+ * 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @applicableIdentity APP
+ * @returns Information about the file.
+ * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
+ */
+declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+    __validationErrorsType?: GetFileDescriptorValidationErrors;
+}>;
+/**
+ * Gets information about specific files in the Media Manager.
+ * @public
+ * @requiredField fileIds
+ * @param fileIds - 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
+ */
+declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
+    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+}[FileDescriptorNonNullablePaths]> & {
+    __validationErrorsType?: GetFileDescriptorsValidationErrors;
+}>;
+/**
+ * Updates a file. <br />
+ *
+ * Specify the `parentFolderId` parameter to move a file from its current folder to a different folder.
+ * @param file - The file to update.
+ * @public
+ * @requiredField file
+ * @requiredField file._id
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPDATE
+ * @applicableIdentity APP
+ * @returns Information about the updated file.
+ * @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
+ */
+declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+    __validationErrorsType?: UpdateFileDescriptorValidationErrors;
+}>;
+/**
+ * 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 Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
+ * > - 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
+ * @requiredField mimeType
+ * @param options - Options to use when generating a file's upload URL.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
+ */
+declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
+    __validationErrorsType?: GenerateFileUploadUrlValidationErrors;
+}>;
 interface GenerateFileUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
@@ -1583,6 +1875,24 @@ interface GenerateFileUploadUrlOptions {
      */
     filePath?: string | null;
 }
+/**
+ * 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/resumable-upload-api) | [REST](https://dev.wix.com/docs/rest/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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
+ * @param mimeType - File mime type.
+ * @public
+ * @requiredField mimeType
+ * @param options - Options to use when generating a resumable upload URL.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
+ */
+declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
+    __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
+}>;
 interface GenerateFileResumableUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
@@ -1623,6 +1933,35 @@ interface GenerateFileResumableUploadUrlOptions {
      */
     filePath?: string | null;
 }
+/**
+ * Imports a file to the Media Manager using an external url.
+ *
+ * Returns information about the imported file.
+ * Specify the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.
+ * If no folder is specified, the file is imported to the `media-root` folder.
+ *
+ * >**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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
+ *
+ * To import a file, you need to do one of the following:
+ * - 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'`.
+ * - Specify its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request.  For example, `mediaType: 'IMAGE'`.
+ * @param url - Publicly accessible external file URL.
+ * @public
+ * @requiredField url
+ * @param options - Options to use when importing a single file.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.ImportFile
+ */
+declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
+    [P in FileDescriptorNonNullablePaths]: `file.${P}`;
+}[FileDescriptorNonNullablePaths]> & {
+    __validationErrorsType?: ImportFileValidationErrors;
+}>;
 interface ImportFileOptions {
     /**
      * Media type of the file to import.
@@ -1669,10 +2008,86 @@ interface ImportFileOptions {
      */
     filePath?: string | null;
 }
+/**
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
+ *
+ * Returns information about the imported files.
+ *
+ * Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
+ * If no folder is specified, the file is imported to the `media-root` folder.
+ *
+ * >**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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
+ *
+ * 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'`.
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request.  For example, `mediaType: 'IMAGE'`.
+ * @param importFileRequests - Information about the files to import.
+ * @public
+ * @requiredField importFileRequests
+ * @requiredField importFileRequests.url
+ * @param options - Options to use when uploading multiple files.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFiles
+ * @deprecated
+ * @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile
+ * @targetRemovalDate 2024-03-31
+ */
+declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[]): Promise<NonNullablePaths<BulkImportFilesResponse, {
+    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+}[FileDescriptorNonNullablePaths]>>;
+/**
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
+ *
+ * Returns information about the imported files.
+ *
+ * Specify the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
+ * If no folder is specified, the file is imported to the `media-root` folder.
+ *
+ * >**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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
+ *
+ * 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'`.
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request.  For example, `mediaType: 'IMAGE'`.
+ * @param importFileRequests - Information about the files to import.
+ * @public
+ * @requiredField importFileRequests
+ * @requiredField importFileRequests.url
+ * @param options - Options to include the file descriptor in the response.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
+ */
+declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in FileDescriptorNonNullablePaths]: `results.${number}.item.${P}`;
+}[FileDescriptorNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkImportFileOptions {
     /** Default: `true` */
     returnEntity?: boolean | null;
 }
+/**
+ * Retrieves a list of files in the Media Manager.
+ *
+ * To retrieve a list of files within a specific folder in the Media Manager, specify the folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves the list of files in the root folder of the Media Manager.
+ * @public
+ * @param options - Options to use when listing media files.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.ListFiles
+ */
+declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
+    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+}[FileDescriptorNonNullablePaths]> & {
+    __validationErrorsType?: ListFilesValidationErrors;
+}>;
 interface ListFilesOptions {
     /**
      * ID of the file's parent folder. <br />
@@ -1698,6 +2113,21 @@ interface ListFilesOptions {
     /** Cursor and paging information. */
     paging?: CursorPaging;
 }
+/**
+ * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
+ *
+ * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
+ * @public
+ * @param options - Options to specify which folders to search.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
+ */
+declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
+    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+}[FileDescriptorNonNullablePaths]> & {
+    __validationErrorsType?: SearchFilesValidationErrors;
+}>;
 interface SearchFilesOptions {
     /**
      * Term to search for. Possible terms include the value of a file's
@@ -1729,10 +2159,49 @@ interface SearchFilesOptions {
     /** Cursor and paging information. */
     paging?: CursorPaging;
 }
+/**
+ * Generates a URL for streaming a specific video file in the Media Manager. <br/>
+ *
+ * To stream different assets of the file, specify the `assetKeys` parameter which generates a video streaming URL for each asset. If no assetKey is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.
+ * @public
+ * @requiredField fileId
+ * @param options - Options to use when generating a video file's streaming URL.
+ * @param fileId - File ID.
+ *
+ * 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
+ */
+declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
 interface GenerateVideoStreamingUrlOptions {
     /** Video stream format. */
     format?: StreamFormatWithLiterals;
 }
+/**
+ * Deletes the specified files from the Media Manager. <br/>
+ *
+ * The deleted files are moved to the Media Manager's trash bin (`TRASH-ROOT` folder) unless permanently deleted. To permanently delete files, specify the `permanent` parameter with the value `true`. Permanently deleting files isn't reversible, so make sure that these files aren't being used in a site or in any other way as the files will no longer be accessible.
+ *
+ * Note the following:
+ * * The specified files can be from different folders.
+ * * Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
+ * * Attempting to delete files that are already in the trash bin doesn't result in an error.
+ * * If a site contains deleted media files, the deleted media files still appear on the site as the files are still in the Media Manager (in the trash bin).
+ * * You can use Bulk Restore Files From Trash Bin to restore files from the Media Manager's trash bin.
+ * @public
+ * @requiredField fileIds
+ * @param options - Options to use when deleting files.
+ * @param fileIds - 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_MOVE_TO_TRASH
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkDeleteFiles
+ */
+declare function bulkDeleteFiles(fileIds: string[], options?: BulkDeleteFilesOptions): Promise<void>;
 interface BulkDeleteFilesOptions {
     /**
      * Whether the specified files are permanently deleted. <br />
@@ -1740,6 +2209,34 @@ interface BulkDeleteFilesOptions {
      */
     permanent?: boolean;
 }
+/**
+ * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
+ * @public
+ * @requiredField fileIds
+ * @param fileIds - 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.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_RESTORE_FROM_TRASH
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkRestoreFilesFromTrashBin
+ */
+declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise<void>;
+/**
+ * Retrieves a list of files in the Media Manager's trash bin. <br/>
+ *
+ * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
+ * @public
+ * @param options - Options to use when listing deleted files from the trash bin.
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST_DELETED
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
+ */
+declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
+    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+}[FileDescriptorNonNullablePaths]> & {
+    __validationErrorsType?: ListDeletedFilesValidationErrors;
+}>;
 interface ListDeletedFilesOptions {
     /**
      * ID of the file's parent folder. <br />
@@ -1766,4 +2263,4 @@ interface ListDeletedFilesOptions {
     paging?: CursorPaging;
 }
 
-export { type FontMedia as $, StreamFormat as A, type BulkImportFilesResponse as B, ContentDisposition as C, type FileMedia as D, type FileMediaMediaOneOf as E, type FileDescriptor as F, type GenerateFilesDownloadUrlResponse as G, type ImageMedia as H, type ImportFileOptions as I, type FocalPoint as J, type Colors as K, type ListFilesOptions as L, MediaType as M, Namespace as N, OperationStatus as O, type Color as P, type ColorRGB as Q, RootFolder as R, type SearchFilesOptions as S, type FaceRecognition as T, UploadProtocol as U, type VideoResolution as V, WebhookIdentityType as W, type AudioV2 as X, type Archive as Y, type Model3D as Z, type OtherMedia as _, type GenerateFileDownloadUrlOptions as a, type FontAsset as a0, type IdentityInfo as a1, type FileReady as a2, type ExternalInfo as a3, type FileFailed as a4, type ApplicationError as a5, type DraftFilePublished as a6, type BulkAnnotateImagesRequest as a7, type BulkAnnotateImagesResponse as a8, type BulkAnnotateImageResult as a9, type Cursors as aA, type SearchFilesRequest as aB, type GenerateVideoStreamingUrlRequest as aC, type GenerateWebSocketTokenRequest as aD, type GenerateWebSocketTokenResponse as aE, type BulkDeleteFilesRequest as aF, type BulkDeleteFilesResponse as aG, type BulkRestoreFilesFromTrashBinRequest as aH, type BulkRestoreFilesFromTrashBinResponse as aI, type ListDeletedFilesRequest as aJ, type BulkPublishDraftFilesRequest as aK, type BulkPublishDraftFilesResponse as aL, type BulkPublishDraftFileResult as aM, type UpdateFileRequest as aN, type UpdateFileResponse as aO, type DomainEvent as aP, type DomainEventBodyOneOf as aQ, type EntityCreatedEvent as aR, type RestoreInfo as aS, type EntityUpdatedEvent as aT, type EntityDeletedEvent as aU, type ActionEvent as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type ItemMetadata as aa, type BulkActionMetadata as ab, type GenerateFilesDownloadUrlRequest as ac, type GenerateFileDownloadUrlRequest as ad, type DownloadUrl as ae, type ServiceError as af, type GetFileDescriptorRequest as ag, type GetFileDescriptorResponse as ah, type GetFileDescriptorsRequest as ai, type UpdateFileDescriptorRequest as aj, type UpdateFileDescriptorResponse as ak, type UnsupportedRequestValueError as al, type GenerateFileUploadUrlRequest as am, type ImageAnnotationConfigurations as an, type SiteQuotaExceededError as ao, type TotalQuota as ap, type Plans as aq, type Plan as ar, type GenerateFileResumableUploadUrlRequest as as, type BulkImportFilesRequest as at, type BulkImportFileRequest as au, type BulkImportFileResult as av, type ListFilesRequest as aw, type Sorting as ax, type CursorPaging as ay, type PagingMetadataV2 as az, type GenerateFileDownloadUrlResponse as b, type GetFileDescriptorsResponse as c, type GenerateFileUploadUrlOptions as d, type GenerateFileUploadUrlResponse as e, type GenerateFileResumableUploadUrlOptions as f, type GenerateFileResumableUploadUrlResponse as g, type ImportFileResponse as h, type ImportFileRequest as i, type BulkImportFileOptions as j, type BulkImportFileResponse as k, type ListFilesResponse as l, type SearchFilesResponse as m, type GenerateVideoStreamingUrlOptions as n, type GenerateVideoStreamingUrlResponse as o, type BulkDeleteFilesOptions as p, type ListDeletedFilesOptions as q, type ListDeletedFilesResponse as r, type FileDescriptorDeletedEnvelope as s, type FileDescriptorFileFailedEnvelope as t, type FileDescriptorFileReadyEnvelope as u, type FileDescriptorUpdatedEnvelope as v, State as w, IdentityType as x, ImageAnnotationType as y, SortOrder as z };
+export { type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorDeletedEnvelope, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorUpdatedEnvelope, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FocalPoint, type FontAsset, type FontMedia, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorDeleted, onFileDescriptorFileFailed, onFileDescriptorFileReady, onFileDescriptorUpdated, searchFiles, updateFileDescriptor };