@wix/auto_sdk_media_folders 1.0.11 → 1.0.13

package/build/cjs/index.d.ts

@@ -1 +1,133 @@
-export * from './src/media-site-media-v1-folder-folders.context.js';
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { CreateFolderOptions, CreateFolderResponse, Folder, ListFoldersOptions, ListFoldersResponse, SearchFoldersOptions, SearchFoldersResponse, UpdateFolder, UpdateFolderValidationErrors, GenerateFolderDownloadUrlResponse, BulkDeleteFoldersOptions, ListDeletedFoldersOptions, ListDeletedFoldersResponse, FolderCreatedEnvelope, FolderDeletedEnvelope, FolderUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, BaseEventMetadata, BulkDeleteFoldersRequest, BulkDeleteFoldersResponse, BulkRestoreFoldersFromTrashBinRequest, BulkRestoreFoldersFromTrashBinResponse, CreateFolderRequest, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GenerateFolderDownloadUrlRequest, GetFolderRequest, GetFolderResponse, IdentificationData, IdentificationDataIdOneOf, ListDeletedFoldersRequest, ListFoldersRequest, MessageEnvelope, Namespace, PagingMetadataV2, RestoreInfo, RootFolder, SearchFoldersRequest, SortOrder, Sorting, State, UnsupportedRequestValueError, UpdateFolderRequest, UpdateFolderResponse, WebhookIdentityType } from './index.typings.js';
+
+declare function createFolder$1(httpClient: HttpClient): CreateFolderSignature;
+interface CreateFolderSignature {
+    /**
+     * Creates a new folder in the Media Manager. <br/>
+     *
+     * Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.
+     * If no folder is specified, the new folder is created in the `media-root` folder.
+     * @param - Folder name that appears in the Media Manager.
+     * @param - Options for specifying where to create a folder.
+     */
+    (displayName: string, options?: CreateFolderOptions | undefined): Promise<CreateFolderResponse>;
+}
+declare function getFolder$1(httpClient: HttpClient): GetFolderSignature;
+interface GetFolderSignature {
+    /**
+     * Gets information from a specific folder in the Media Manager.
+     * @param - Folder ID.
+     * @returns Information about the folder.
+     */
+    (folderId: string): Promise<Folder>;
+}
+declare function listFolders$1(httpClient: HttpClient): ListFoldersSignature;
+interface ListFoldersSignature {
+    /**
+     * Retrieves a list of folders in the Media Manager. To retrieve a list of folders within a specific folder in the Media Manager, specify the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves a list of folders within the root folder of the Media Manager.
+     * @param - Options to use when listing folders from the Media Manager.
+     */
+    (options?: ListFoldersOptions | undefined): Promise<ListFoldersResponse>;
+}
+declare function searchFolders$1(httpClient: HttpClient): SearchFoldersSignature;
+interface SearchFoldersSignature {
+    /**
+     * Searches the Media Manager and returns a list of folders that match the terms specified in the parameters. <br/>
+     *
+     * If no parameters are specified, the method returns all folders in the `MEDIA_ROOT` folder.
+     * @param - Options specifying which folders to search.
+     */
+    (options?: SearchFoldersOptions | undefined): Promise<SearchFoldersResponse>;
+}
+declare function updateFolder$1(httpClient: HttpClient): UpdateFolderSignature;
+interface UpdateFolderSignature {
+    /**
+     * Updates a folder. <br />
+     *
+     * You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.
+     * @param - Folder ID. Generated when a folder is created in the Media Manager.
+     * @param - Folder to update.
+     * @returns Information about the updated folder.
+     */
+    (_id: string, folder: UpdateFolder): Promise<Folder & {
+        __validationErrorsType?: UpdateFolderValidationErrors | undefined;
+    }>;
+}
+declare function generateFolderDownloadUrl$1(httpClient: HttpClient): GenerateFolderDownloadUrlSignature;
+interface GenerateFolderDownloadUrlSignature {
+    /**
+     * Generates a URL for downloading a compressed file containing a specific folder in the Media Manager. <br/>
+     *
+     * The compressed file can contain sub-folders, and up to 1000 files.
+     * @param - Folder ID.
+     */
+    (folderId: string): Promise<GenerateFolderDownloadUrlResponse>;
+}
+declare function bulkDeleteFolders$1(httpClient: HttpClient): BulkDeleteFoldersSignature;
+interface BulkDeleteFoldersSignature {
+    /**
+     * Temporarily deletes the specified folders from the Media Manager. <br/>
+     *
+     * The deleted folders are moved to the Media Manager's `trash-root` folder (trash bin) unless permanently deleted. To permanently delete folders, specify the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.
+     *
+     * Note the following:
+     * * When a folder is deleted, the files in that folder are deleted.
+     * * The specified folders can be from different parent folders.
+     * * Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
+     * * Attempting to delete folders that are already in the trash bin doesn't result in an error.
+     * * If a site contains files from a deleted media folder, the files still appear on the site as the deleted folder is still in the Media Manager (in the trash bin).
+     * * You can also use the Bulk Restore Folders From Trash Bin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/folders/bulk-restore-folders-from-trash-bin) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/folders/bulk-restore-folders-from-trash-bin)) method to restore folders from the Media Manager's trash bin.
+     * @param - IDs of the folders to move to the Media Manager's trash bin.
+     * @param - Options to use when deleting folders.
+     */
+    (folderIds: string[], options?: BulkDeleteFoldersOptions | undefined): Promise<void>;
+}
+declare function bulkRestoreFoldersFromTrashBin$1(httpClient: HttpClient): BulkRestoreFoldersFromTrashBinSignature;
+interface BulkRestoreFoldersFromTrashBinSignature {
+    /**
+     * Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
+     * @param - IDs of the folders to restore from the Media Manager's trash bin.
+     */
+    (folderIds: string[]): Promise<void>;
+}
+declare function listDeletedFolders$1(httpClient: HttpClient): ListDeletedFoldersSignature;
+interface ListDeletedFoldersSignature {
+    /**
+     * Retrieves a list of folders in the Media Manager's trash bin.
+     * @param - Options to use when listing deleted folders from the trash bin.
+     */
+    (options?: ListDeletedFoldersOptions | undefined): Promise<ListDeletedFoldersResponse>;
+}
+declare const onFolderCreated$1: EventDefinition<FolderCreatedEnvelope, "wix.media.site_media.v1.folder_created">;
+declare const onFolderDeleted$1: EventDefinition<FolderDeletedEnvelope, "wix.media.site_media.v1.folder_deleted">;
+declare const onFolderUpdated$1: EventDefinition<FolderUpdatedEnvelope, "wix.media.site_media.v1.folder_updated">;
+
+declare const createFolder: MaybeContext<BuildRESTFunction<typeof createFolder$1> & typeof createFolder$1>;
+declare const getFolder: MaybeContext<BuildRESTFunction<typeof getFolder$1> & typeof getFolder$1>;
+declare const listFolders: MaybeContext<BuildRESTFunction<typeof listFolders$1> & typeof listFolders$1>;
+declare const searchFolders: MaybeContext<BuildRESTFunction<typeof searchFolders$1> & typeof searchFolders$1>;
+declare const updateFolder: MaybeContext<BuildRESTFunction<typeof updateFolder$1> & typeof updateFolder$1>;
+declare const generateFolderDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFolderDownloadUrl$1> & typeof generateFolderDownloadUrl$1>;
+declare const bulkDeleteFolders: MaybeContext<BuildRESTFunction<typeof bulkDeleteFolders$1> & typeof bulkDeleteFolders$1>;
+declare const bulkRestoreFoldersFromTrashBin: MaybeContext<BuildRESTFunction<typeof bulkRestoreFoldersFromTrashBin$1> & typeof bulkRestoreFoldersFromTrashBin$1>;
+declare const listDeletedFolders: MaybeContext<BuildRESTFunction<typeof listDeletedFolders$1> & typeof listDeletedFolders$1>;
+/**
+ * Triggered when a folder is created.
+ *
+ * This event is also triggered when a folder is restored from the Media Manager's trash bin.
+ */
+declare const onFolderCreated: BuildEventDefinition<typeof onFolderCreated$1>;
+/**
+ * Triggered when a folder is deleted.
+ *
+ * If the `movedToTrash` property in the event object is `true`, the folder was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the folder was permanently deleted.
+ */
+declare const onFolderDeleted: BuildEventDefinition<typeof onFolderDeleted$1>;
+/**
+ * Triggered when a folder is updated, including when a folder is moved to a different parent folder.
+ */
+declare const onFolderUpdated: BuildEventDefinition<typeof onFolderUpdated$1>;
+
+export { BulkDeleteFoldersOptions, CreateFolderOptions, CreateFolderResponse, Folder, FolderCreatedEnvelope, FolderDeletedEnvelope, FolderUpdatedEnvelope, GenerateFolderDownloadUrlResponse, ListDeletedFoldersOptions, ListDeletedFoldersResponse, ListFoldersOptions, ListFoldersResponse, SearchFoldersOptions, SearchFoldersResponse, UpdateFolder, bulkDeleteFolders, bulkRestoreFoldersFromTrashBin, createFolder, generateFolderDownloadUrl, getFolder, listDeletedFolders, listFolders, onFolderCreated, onFolderDeleted, onFolderUpdated, searchFolders, updateFolder };