Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@wix/media_files
Advanced tools
@wix/media_files - npm Package Compare versions
Comparing version 1.0.62 to 1.0.63
@@ -5,9 +5,7 @@ import { RequestOptionsFactory } from '@wix/sdk-types'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -18,37 +16,19 @@ export declare function generateFilesDownloadUrl(payload: object): RequestOptionsFactory<any>; | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
| export declare function generateFileDownloadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| */ | ||
| /** Gets information about a specific file in the Media Manager. */ | ||
| export declare function getFileDescriptor(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| */ | ||
| /** Gets information about specific files in the Media Manager. */ | ||
| export declare function getFileDescriptors(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -58,35 +38,29 @@ */ | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
| */ | ||
| export declare function generateFileUploadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| */ | ||
| export declare function generateFileResumableUploadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -97,15 +71,17 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
| export declare function importFile(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -119,3 +95,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @deprecated It has been replaced with com.wix.media.site_media.v1.FilesService.BulkImportFile(), and will be removed on 2024-03-31. | ||
@@ -125,10 +102,12 @@ */ | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -139,3 +118,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -146,57 +125,37 @@ export declare function bulkImportFile(payload: object): RequestOptionsFactory<any>; | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| */ | ||
| export declare function listFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| */ | ||
| export declare function searchFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| */ | ||
| export declare function generateVideoStreamingUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| */ | ||
| export declare function bulkDeleteFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| */ | ||
| /** Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. */ | ||
| export declare function bulkRestoreFilesFromTrashBin(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| */ | ||
| export declare function listDeletedFiles(payload: object): RequestOptionsFactory<any>; |
@@ -97,9 +97,7 @@ "use strict"; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -128,11 +126,10 @@ function generateFilesDownloadUrl(payload) { | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -158,10 +155,3 @@ function generateFileDownloadUrl(payload) { | ||
| exports.generateFileDownloadUrl = generateFileDownloadUrl; | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| */ | ||
| /** Gets information about a specific file in the Media Manager. */ | ||
| function getFileDescriptor(payload) { | ||
@@ -227,10 +217,3 @@ function __getFileDescriptor({ host }) { | ||
| exports.getFileDescriptor = getFileDescriptor; | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| */ | ||
| /** Gets information about specific files in the Media Manager. */ | ||
| function getFileDescriptors(payload) { | ||
@@ -288,7 +271,4 @@ function __getFileDescriptors({ host }) { | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -380,11 +360,8 @@ */ | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
| */ | ||
@@ -411,11 +388,8 @@ function generateFileUploadUrl(payload) { | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| */ | ||
@@ -442,11 +416,11 @@ function generateFileResumableUploadUrl(payload) { | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -457,3 +431,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -510,11 +484,13 @@ function importFile(payload) { | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -528,3 +504,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @deprecated It has been replaced with com.wix.media.site_media.v1.FilesService.BulkImportFile(), and will be removed on 2024-03-31. | ||
@@ -584,10 +561,12 @@ */ | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -598,3 +577,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -663,7 +642,3 @@ function bulkImportFile(payload) { | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| */ | ||
@@ -722,7 +697,5 @@ function listFiles(payload) { | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| */ | ||
@@ -781,8 +754,5 @@ function searchFiles(payload) { | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| */ | ||
@@ -809,15 +779,12 @@ function generateVideoStreamingUrl(payload) { | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| */ | ||
@@ -843,7 +810,3 @@ function bulkDeleteFiles(payload) { | ||
| exports.bulkDeleteFiles = bulkDeleteFiles; | ||
| /** | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| */ | ||
| /** Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. */ | ||
| function bulkRestoreFilesFromTrashBin(payload) { | ||
@@ -869,9 +832,5 @@ function __bulkRestoreFilesFromTrashBin({ host }) { | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| */ | ||
@@ -878,0 +837,0 @@ function listDeletedFiles(payload) { |
@@ -11,9 +11,7 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @param - IDs of the files to download. | ||
@@ -31,11 +29,10 @@ * | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @param - Options to use when generating a file's download URL. | ||
@@ -52,8 +49,3 @@ * @param - File ID. | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| * Gets information about a specific file in the Media Manager. | ||
| * @param - File ID. | ||
@@ -70,8 +62,3 @@ * | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| * Gets information about specific files in the Media Manager. | ||
| * @param - File IDs. | ||
@@ -87,7 +74,4 @@ * | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -102,11 +86,8 @@ * @param - The file to update. | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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 - File mime type. | ||
@@ -120,11 +101,8 @@ * @param - Options to use when generating a file's upload URL. | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * @param - File mime type. | ||
@@ -138,11 +116,11 @@ * @param - Options to use when generating a resumable upload URL. | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -153,3 +131,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Publicly accessible external file URL. | ||
@@ -163,11 +141,13 @@ * @param - Options to use when importing a single file. | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -181,3 +161,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Information about the files to import. | ||
@@ -192,10 +173,12 @@ * @param - Options to use when uploading multiple files. | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -206,3 +189,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Information about the files to import. | ||
@@ -218,7 +201,3 @@ * @param - Options to include the file descriptor in the response. | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| * @param - Options to use when listing media files. | ||
@@ -231,7 +210,5 @@ */ | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| * @param - Options to specify which folders to search. | ||
@@ -244,8 +221,5 @@ */ | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| * @param - Options to use when generating a video file's streaming URL. | ||
@@ -262,15 +236,12 @@ * @param - File ID. | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| * @param - Options to use when deleting files. | ||
@@ -288,4 +259,2 @@ * @param - IDs of the files to move to the Media Manager's trash bin. | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| * @param - IDs of the files to restore from the Media Manager's trash bin. | ||
@@ -301,9 +270,5 @@ * | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * @param - Options to use when listing deleted files from the trash bin. | ||
@@ -310,0 +275,0 @@ */ |
@@ -155,9 +155,7 @@ "use strict"; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @public | ||
@@ -205,11 +203,10 @@ * @requiredField fileIds | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @public | ||
@@ -270,8 +267,3 @@ * @requiredField fileId | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| * Gets information about a specific file in the Media Manager. | ||
| * @public | ||
@@ -343,8 +335,3 @@ * @requiredField fileId | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| * Gets information about specific files in the Media Manager. | ||
| * @public | ||
@@ -415,7 +402,4 @@ * @requiredField fileIds | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -507,11 +491,8 @@ * @param file - The file to update. | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
@@ -573,11 +554,8 @@ * @public | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * @param mimeType - File mime type. | ||
@@ -639,11 +617,11 @@ * @public | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -654,3 +632,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -741,11 +719,13 @@ * @public | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -759,3 +739,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -828,10 +809,12 @@ * @public | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -842,3 +825,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -916,7 +899,3 @@ * @public | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| * @public | ||
@@ -995,7 +974,5 @@ * @param options - Options to use when listing media files. | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| * @public | ||
@@ -1076,8 +1053,5 @@ * @param options - Options to specify which folders to search. | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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 | ||
@@ -1129,15 +1103,12 @@ * @requiredField fileId | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| * @public | ||
@@ -1190,4 +1161,2 @@ * @requiredField fileIds | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| * @public | ||
@@ -1232,9 +1201,5 @@ * @requiredField fileIds | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * @public | ||
@@ -1241,0 +1206,0 @@ * @param options - Options to use when listing deleted files from the trash bin. |
@@ -5,9 +5,7 @@ import { RequestOptionsFactory } from '@wix/sdk-types'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -18,37 +16,19 @@ export declare function generateFilesDownloadUrl(payload: object): RequestOptionsFactory<any>; | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
| export declare function generateFileDownloadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| */ | ||
| /** Gets information about a specific file in the Media Manager. */ | ||
| export declare function getFileDescriptor(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| */ | ||
| /** Gets information about specific files in the Media Manager. */ | ||
| export declare function getFileDescriptors(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -58,35 +38,29 @@ */ | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
| */ | ||
| export declare function generateFileUploadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| */ | ||
| export declare function generateFileResumableUploadUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -97,15 +71,17 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
| export declare function importFile(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -119,3 +95,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @deprecated It has been replaced with com.wix.media.site_media.v1.FilesService.BulkImportFile(), and will be removed on 2024-03-31. | ||
@@ -125,10 +102,12 @@ */ | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -139,3 +118,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -146,57 +125,37 @@ export declare function bulkImportFile(payload: object): RequestOptionsFactory<any>; | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| */ | ||
| export declare function listFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| */ | ||
| export declare function searchFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| */ | ||
| export declare function generateVideoStreamingUrl(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| */ | ||
| export declare function bulkDeleteFiles(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| */ | ||
| /** Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. */ | ||
| export declare function bulkRestoreFilesFromTrashBin(payload: object): RequestOptionsFactory<any>; | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| */ | ||
| export declare function listDeletedFiles(payload: object): RequestOptionsFactory<any>; |
@@ -94,9 +94,7 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -124,11 +122,10 @@ export function generateFilesDownloadUrl(payload) { | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| */ | ||
@@ -153,10 +150,3 @@ export function generateFileDownloadUrl(payload) { | ||
| } | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| */ | ||
| /** Gets information about a specific file in the Media Manager. */ | ||
| export function getFileDescriptor(payload) { | ||
@@ -221,10 +211,3 @@ function __getFileDescriptor({ host }) { | ||
| } | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| */ | ||
| /** Gets information about specific files in the Media Manager. */ | ||
| export function getFileDescriptors(payload) { | ||
@@ -281,7 +264,4 @@ function __getFileDescriptors({ host }) { | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -372,11 +352,8 @@ */ | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
| */ | ||
@@ -402,11 +379,8 @@ export function generateFileUploadUrl(payload) { | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| */ | ||
@@ -432,11 +406,11 @@ export function generateFileResumableUploadUrl(payload) { | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -447,3 +421,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -499,11 +473,13 @@ export function importFile(payload) { | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -517,3 +493,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @deprecated It has been replaced with com.wix.media.site_media.v1.FilesService.BulkImportFile(), and will be removed on 2024-03-31. | ||
@@ -572,10 +549,12 @@ */ | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -586,3 +565,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| */ | ||
@@ -650,7 +629,3 @@ export function bulkImportFile(payload) { | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| */ | ||
@@ -708,7 +683,5 @@ export function listFiles(payload) { | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| */ | ||
@@ -766,8 +739,5 @@ export function searchFiles(payload) { | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| */ | ||
@@ -793,15 +763,12 @@ export function generateVideoStreamingUrl(payload) { | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| */ | ||
@@ -826,7 +793,3 @@ export function bulkDeleteFiles(payload) { | ||
| } | ||
| /** | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| */ | ||
| /** Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. */ | ||
| export function bulkRestoreFilesFromTrashBin(payload) { | ||
@@ -851,9 +814,5 @@ function __bulkRestoreFilesFromTrashBin({ host }) { | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| */ | ||
@@ -860,0 +819,0 @@ export function listDeletedFiles(payload) { |
@@ -11,9 +11,7 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @param - IDs of the files to download. | ||
@@ -31,11 +29,10 @@ * | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @param - Options to use when generating a file's download URL. | ||
@@ -52,8 +49,3 @@ * @param - File ID. | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| * Gets information about a specific file in the Media Manager. | ||
| * @param - File ID. | ||
@@ -70,8 +62,3 @@ * | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| * Gets information about specific files in the Media Manager. | ||
| * @param - File IDs. | ||
@@ -87,7 +74,4 @@ * | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -102,11 +86,8 @@ * @param - The file to update. | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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 - File mime type. | ||
@@ -120,11 +101,8 @@ * @param - Options to use when generating a file's upload URL. | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * @param - File mime type. | ||
@@ -138,11 +116,11 @@ * @param - Options to use when generating a resumable upload URL. | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -153,3 +131,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Publicly accessible external file URL. | ||
@@ -163,11 +141,13 @@ * @param - Options to use when importing a single file. | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -181,3 +161,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Information about the files to import. | ||
@@ -192,10 +173,12 @@ * @param - Options to use when uploading multiple files. | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -206,3 +189,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * @param - Information about the files to import. | ||
@@ -218,7 +201,3 @@ * @param - Options to include the file descriptor in the response. | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| * @param - Options to use when listing media files. | ||
@@ -231,7 +210,5 @@ */ | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| * @param - Options to specify which folders to search. | ||
@@ -244,8 +221,5 @@ */ | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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. | ||
| * @param - Options to use when generating a video file's streaming URL. | ||
@@ -262,15 +236,12 @@ * @param - File ID. | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| * @param - Options to use when deleting files. | ||
@@ -288,4 +259,2 @@ * @param - IDs of the files to move to the Media Manager's trash bin. | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| * @param - IDs of the files to restore from the Media Manager's trash bin. | ||
@@ -301,9 +270,5 @@ * | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * @param - Options to use when listing deleted files from the trash bin. | ||
@@ -310,0 +275,0 @@ */ |
@@ -129,9 +129,7 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error'; | ||
| * | ||
| * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL. | ||
| * | ||
| * The compressed file can contain up to 1000 files. | ||
| * | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function. | ||
| * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for. | ||
| * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint. | ||
| * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @public | ||
@@ -178,11 +176,10 @@ * @requiredField fileIds | ||
| * | ||
| * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter. | ||
| * | ||
| * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset. | ||
| * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality. | ||
| * | ||
| * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires. | ||
| * Use this endpoint to grant external clients access to a private media file. Use 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, use the `generateFilesDownloadUrl()` function. | ||
| * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for. | ||
| * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint. | ||
| * Since this is a permanent URL, it is less secure. | ||
| * Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for. | ||
| * @public | ||
@@ -242,8 +239,3 @@ * @requiredField fileId | ||
| /** | ||
| * Gets information about the specified file in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor. | ||
| * | ||
| * Use `getFileDescriptors()` to get multiple file descriptors at once. | ||
| * Gets information about a specific file in the Media Manager. | ||
| * @public | ||
@@ -314,8 +306,3 @@ * @requiredField fileId | ||
| /** | ||
| * Gets information about the specified files in the Media Manager. | ||
| * | ||
| * | ||
| * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors. | ||
| * | ||
| * Use `getFileDescriptor()` to get a single file descriptor. | ||
| * Gets information about specific files in the Media Manager. | ||
| * @public | ||
@@ -385,7 +372,4 @@ * @requiredField fileIds | ||
| /** | ||
| * Updates a file. | ||
| * Updates a file. <br /> | ||
| * | ||
| * | ||
| * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor. | ||
| * | ||
| * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder. | ||
@@ -476,11 +460,8 @@ * @param file - The file to update. | ||
| /** | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. | ||
| * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL. | ||
| * | ||
| * 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 article. | ||
| * | ||
| * 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) article. | ||
| * > **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](/files/importing-files). | ||
| * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` 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. | ||
| * > - 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](/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, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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. | ||
@@ -541,11 +522,8 @@ * @public | ||
| /** | ||
| * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager. | ||
| * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/> | ||
| * | ||
| * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol. | ||
| * 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 the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article. | ||
| * | ||
| * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. 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 the Resumable Upload API article. | ||
| * | ||
| * > **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](/files/importing-files). | ||
| * > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * @param mimeType - File mime type. | ||
@@ -606,11 +584,11 @@ * @public | ||
| /** | ||
| * Imports a file to the Media Manager using an external URL. | ||
| * Imports a file to the Media Manager using an external url. | ||
| * | ||
| * The `importFile()` function returns a Promise that resolves to the imported file's descriptor. | ||
| * | ||
| * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager. | ||
| * Returns information about the imported file. | ||
| * Use 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -621,3 +599,3 @@ * To import a file, you need to do one of the following: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -707,11 +685,13 @@ * @public | ||
| /** | ||
| * > **Deprecated.** | ||
| * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * <blockquote class='warning'> | ||
| * | ||
| * __Deprecation Notice:__ | ||
| * | ||
| * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors. | ||
| * This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024. | ||
| * | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * </blockquote> | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
@@ -725,3 +705,4 @@ * | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -793,10 +774,12 @@ * @public | ||
| /** | ||
| * Imports a bulk of files to the Media Manager using external urls. | ||
| * Imports a bulk of files to the Media Manager using external urls. <br/> | ||
| * | ||
| * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata. | ||
| * Returns information about the imported files. | ||
| * | ||
| * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported. | ||
| * 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. | ||
| * | ||
| * > **Note:** 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](/files/importing-files). | ||
| * >**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](/media-manager/files/importing-files#knowing-when-a-file-is-ready). | ||
| * | ||
@@ -807,3 +790,3 @@ * To import files, you need to do one of the following for each file: | ||
| * - 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, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`. | ||
| * > **Note:** If you want to validate the media type, pass 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. | ||
@@ -880,7 +863,3 @@ * @public | ||
| * | ||
| * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager. | ||
| * | ||
| * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function. | ||
| * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager. | ||
| * @public | ||
@@ -958,7 +937,5 @@ * @param options - Options to use when listing media files. | ||
| /** | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters. | ||
| * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/> | ||
| * | ||
| * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information. | ||
| * | ||
| * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder. | ||
| * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder. | ||
| * @public | ||
@@ -1038,8 +1015,5 @@ * @param options - Options to specify which folders to search. | ||
| /** | ||
| * Generates a URL for streaming a specific video file in the Media Manager. | ||
| * Generates a URL for streaming a specific video file in the Media Manager. <br/> | ||
| * | ||
| * | ||
| * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key. | ||
| * | ||
| * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality. | ||
| * To stream different assets of the file, use 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 | ||
@@ -1090,15 +1064,12 @@ * @requiredField fileId | ||
| /** | ||
| * Deletes the specified files from the Media Manager. | ||
| * 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, pass 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. | ||
| * | ||
| * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted. | ||
| * | ||
| * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass 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. | ||
| * | ||
| * >**Notes:** | ||
| * > - 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin. | ||
| * 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 your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin). | ||
| * * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin. | ||
| * @public | ||
@@ -1150,4 +1121,2 @@ * @requiredField fileIds | ||
| * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager. | ||
| * | ||
| * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored. | ||
| * @public | ||
@@ -1191,9 +1160,5 @@ * @requiredField fileIds | ||
| /** | ||
| * Retrieves a list of files in the Media Manager's trash bin. | ||
| * Retrieves a list of files in the Media Manager's trash bin. <br/> | ||
| * | ||
| * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information. | ||
| * | ||
| * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * | ||
| * To retrieve a list of non-deleted files, use the `listFiles()` function. | ||
| * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files. | ||
| * @public | ||
@@ -1200,0 +1165,0 @@ * @param options - Options to use when listing deleted files from the trash bin. |
| { | ||
| "name": "@wix/media_files", | ||
| "version": "1.0.62", | ||
| "version": "1.0.63", | ||
| "publishConfig": { | ||
@@ -49,3 +49,3 @@ "registry": "https://registry.npmjs.org/", | ||
| }, | ||
| "falconPackageHash": "d8b5395a60bce3005f006f4b1b7e3faec0a8f696122db851cf591497" | ||
| "falconPackageHash": "d91571711d7b14e2a9b9b885363a277de4d96b48382f3a4725fff658" | ||
| } |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
No alert changes
Worsened metrics
- Total package byte prevSize
- decreased by-0.59%
1096801
- Lines of code
- decreased by-2.97%
21614
No dependency changes