@wix/media 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * as files from './src/media-site-media-v1-file-descriptor.public';
+export * as folders from './src/media-site-media-v1-folder.public';

package/build/cjs/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.folders = exports.files = void 0;
+exports.files = __importStar(require("./src/media-site-media-v1-file-descriptor.public"));
+exports.folders = __importStar(require("./src/media-site-media-v1-folder.public"));
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,0FAA0E;AAC1E,mFAAmE"}

package/build/cjs/src/media-site-media-v1-file-descriptor.http.d.ts

@@ -0,0 +1,107 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { BulkDeleteFilesRequest, BulkDeleteFilesResponse, BulkImportFilesRequest, BulkImportFilesResponse, BulkRestoreFilesFromTrashBinRequest, BulkRestoreFilesFromTrashBinResponse, GenerateFileDownloadUrlRequest, GenerateFileDownloadUrlResponse, GenerateFileResumableUploadUrlRequest, GenerateFileResumableUploadUrlResponse, GenerateFilesDownloadUrlRequest, GenerateFilesDownloadUrlResponse, GenerateFileUploadUrlRequest, GenerateFileUploadUrlResponse, GenerateVideoStreamingUrlRequest, GenerateVideoStreamingUrlResponse, GetFileDescriptorRequest, GetFileDescriptorResponse, ImportFileRequest, ImportFileResponse, ListDeletedFilesRequest, ListDeletedFilesResponse, ListFilesRequest, ListFilesResponse, SearchFilesRequest, SearchFilesResponse, UpdateFileRequest, UpdateFileResponse } from './media-site-media-v1-file-descriptor.types';
+/**
+ * Generates a URL for downloading a compressed file containing specific files in the Media Manager. <br/>
+ *
+ * The compressed file can contain up to 1000 files.
+ */
+export declare function generateFilesDownloadUrl(payload: GenerateFilesDownloadUrlRequest): RequestOptionsFactory<GenerateFilesDownloadUrlResponse>;
+/**
+ * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
+ *
+ * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset.
+ * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
+ *
+ * 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.
+ */
+export declare function generateFileDownloadUrl(payload: GenerateFileDownloadUrlRequest): RequestOptionsFactory<GenerateFileDownloadUrlResponse>;
+/** Gets information about a specific file in the Media Manager. */
+export declare function getFileDescriptor(payload: GetFileDescriptorRequest): RequestOptionsFactory<GetFileDescriptorResponse>;
+/**
+ * Updates a file. <br />
+ *
+ * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder.
+ */
+export declare function updateFile(payload: UpdateFileRequest): RequestOptionsFactory<UpdateFileResponse>;
+/**
+ * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
+ *
+ * To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see [Using the Upload Url](#upload-api) article.
+ * >**Note:** 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/all-apis/site-media---media-manager-backend/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: GenerateFileUploadUrlRequest): RequestOptionsFactory<GenerateFileUploadUrlResponse>;
+/**
+ * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
+ *
+ * With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.
+ * To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see [Using the Resumable Upload Url](#upload-api) article.
+ */
+export declare function generateFileResumableUploadUrl(payload: GenerateFileResumableUploadUrlRequest): RequestOptionsFactory<GenerateFileResumableUploadUrlResponse>;
+/**
+ * Imports a file to the Media Manager using an external url.
+ *
+ * Returns information about the imported file.
+ * Use the `parentFolderId` parameter 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.
+ *
+ * To import a file, you need to provide one of the following:
+ * 1. Pass the file's [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` parameter of the request.  For example, 'image/png'.
+ * 2. Pass the file's name and extenstion. For example, 'my-image.png'.
+ * 3. If you don't know the file's extension or MIME type, pass its media type in the `mediaType` parameter of the request. For example, 'IMAGE'. Note that this option only works if the server hosting the media allows a 'HEAD' request.
+ *
+ * >**Note:** The `media` property isn't returned in the `files` response object.
+ */
+export declare function importFile(payload: ImportFileRequest): RequestOptionsFactory<ImportFileResponse>;
+/**
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
+ *
+ * Returns information about the imported files. Use the `parentFolderId` parameter to specify in which folder you want each file to be imported to.
+ * If no folder is specified, the file is imported to the `media-root` folder.
+ *
+ * To import files, you need to provide one of the following:
+ * 1. Pass each file's [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` parameter of the request.  For example, 'image/png'.
+ * 2. Pass each file's name and extenstion. For example, 'my-image.png'.
+ * 3. If you don't know a file's extension or MIME type, pass its media type in the `mediaType` parameter of the request. For example, 'IMAGE'. Note that this option only works if the server hosting the media allows a 'HEAD' request.
+ *
+ * >**Note:** The `media` property isn't returned in the `files` response object.
+ */
+export declare function bulkImportFiles(payload: BulkImportFilesRequest): RequestOptionsFactory<BulkImportFilesResponse>;
+/**
+ * Retrieves a list of files in the Media Manager.
+ *
+ * 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: ListFilesRequest): RequestOptionsFactory<ListFilesResponse>;
+/**
+ * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
+ *
+ * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
+ */
+export declare function searchFiles(payload: SearchFilesRequest): RequestOptionsFactory<SearchFilesResponse>;
+/**
+ * Generates a URL for streaming a specific video file in the Media Manager. <br/>
+ *
+ * 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: GenerateVideoStreamingUrlRequest): RequestOptionsFactory<GenerateVideoStreamingUrlResponse>;
+/**
+ * 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.
+ *
+ * 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](bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin.
+ */
+export declare function bulkDeleteFiles(payload: BulkDeleteFilesRequest): RequestOptionsFactory<BulkDeleteFilesResponse>;
+/** 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: BulkRestoreFilesFromTrashBinRequest): RequestOptionsFactory<BulkRestoreFilesFromTrashBinResponse>;
+/**
+ * Retrieves a list of files in the Media Manager's trash bin. <br/>
+ *
+ * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
+ */
+export declare function listDeletedFiles(payload: ListDeletedFilesRequest): RequestOptionsFactory<ListDeletedFilesResponse>;