@wix/auto_sdk_media_folders 1.0.12 → 1.0.13

package/build/internal/cjs/{media-site-media-v1-folder-folders.universal-QxJ1WwtA.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Folder {
     /**
      * Folder ID. Generated when a folder is created in the Media Manager.
@@ -64,6 +66,8 @@ declare enum Namespace {
     /** _nsWixLegends */
     WIX_LEGENDS = "WIX_LEGENDS"
 }
+/** @enumType */
+type NamespaceWithLiterals = Namespace | 'NO_NAMESPACE' | 'OTHERS' | 'WIX_VIDEO' | 'WIX_MUSIC' | 'ALBUMS_AND_ART_STORE' | 'WIX_ECOM' | 'PHOTO_SHARE_APP' | 'SHARING_APP' | 'CHAT' | 'LOGO_BUILDER' | 'ALBUMS_OLD' | 'CHAT_MOBILE' | 'WIX_FORMS' | 'WIX_LEGENDS';
 interface CreateFolderRequest {
     /**
      * Folder name that appears in the Media Manager.
@@ -420,6 +424,9 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type UpdateFolderValidationErrors = {
+    ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -468,13 +475,127 @@ interface FolderCreatedEnvelope {
     entity: Folder;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a folder is created.
+ *
+ * This event is also triggered when a folder is restored from the Media Manager's trash bin.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_created
+ * @serviceIdentifier com.wix.media.site_media.v1.FoldersService
+ * @slug created
+ */
+declare function onFolderCreated(handler: (event: FolderCreatedEnvelope) => void | Promise<void>): void;
 interface FolderDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * 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.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_deleted
+ * @serviceIdentifier com.wix.media.site_media.v1.FoldersService
+ * @slug deleted
+ */
+declare function onFolderDeleted(handler: (event: FolderDeletedEnvelope) => void | Promise<void>): void;
 interface FolderUpdatedEnvelope {
     entity: Folder;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a folder is updated, including when a folder is moved to a different parent folder.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Read Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_updated
+ * @serviceIdentifier com.wix.media.site_media.v1.FoldersService
+ * @slug updated
+ */
+declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope) => void | Promise<void>): void;
+type FolderNonNullablePaths = `_id` | `displayName` | `parentFolderId` | `state`;
+/**
+ * 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 displayName - Folder name that appears in the Media Manager.
+ * @public
+ * @requiredField displayName
+ * @param options - Options for specifying where to create a folder.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.CreateFolder
+ */
+declare function createFolder(displayName: string, options?: CreateFolderOptions): Promise<NonNullablePaths<CreateFolderResponse, {
+    [P in FolderNonNullablePaths]: `folder.${P}`;
+}[FolderNonNullablePaths]>>;
 interface CreateFolderOptions {
     /**
      * ID of the folder's parent folder.
@@ -482,6 +603,28 @@ interface CreateFolderOptions {
      */
     parentFolderId?: string | null;
 }
+/**
+ * Gets information from a specific folder in the Media Manager.
+ * @param folderId - Folder ID.
+ * @public
+ * @requiredField folderId
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @applicableIdentity APP
+ * @returns Information about the folder.
+ * @fqn com.wix.media.site_media.v1.FoldersService.GetFolder
+ */
+declare function getFolder(folderId: string): Promise<NonNullablePaths<Folder, FolderNonNullablePaths>>;
+/**
+ * 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.
+ * @public
+ * @param options - Options to use when listing folders from the Media Manager.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.ListFolders
+ */
+declare function listFolders(options?: ListFoldersOptions): Promise<NonNullablePaths<ListFoldersResponse, {
+    [P in FolderNonNullablePaths]: `folders.${number}.${P}`;
+}[FolderNonNullablePaths]>>;
 interface ListFoldersOptions {
     /**
      * ID of the folder's parent folder.
@@ -499,6 +642,19 @@ interface ListFoldersOptions {
     /** Cursor and paging information. */
     paging?: CursorPaging;
 }
+/**
+ * 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.
+ * @public
+ * @param options - Options specifying which folders to search.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.SearchFolders
+ */
+declare function searchFolders(options?: SearchFoldersOptions): Promise<NonNullablePaths<SearchFoldersResponse, {
+    [P in FolderNonNullablePaths]: `folders.${number}.${P}`;
+}[FolderNonNullablePaths]>>;
 interface SearchFoldersOptions {
     /**
      * A root folder in the Media Manager to search in. <br />
@@ -521,6 +677,23 @@ interface SearchFoldersOptions {
      */
     search?: string | null;
 }
+/**
+ * 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 _id - Folder ID. Generated when a folder is created in the Media Manager.
+ * @public
+ * @requiredField _id
+ * @requiredField folder
+ * @param folder - Folder to update.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_UPDATE
+ * @applicableIdentity APP
+ * @returns Information about the updated folder.
+ * @fqn com.wix.media.site_media.v1.FoldersService.UpdateFolder
+ */
+declare function updateFolder(_id: string, folder: UpdateFolder): Promise<NonNullablePaths<Folder, FolderNonNullablePaths> & {
+    __validationErrorsType?: UpdateFolderValidationErrors;
+}>;
 interface UpdateFolder {
     /**
      * Folder ID. Generated when a folder is created in the Media Manager.
@@ -553,6 +726,39 @@ interface UpdateFolder {
      */
     state?: StateWithLiterals;
 }
+/**
+ * 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 folderId - Folder ID.
+ * @public
+ * @requiredField folderId
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_DOWNLOAD
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.GenerateFolderDownloadUrl
+ */
+declare function generateFolderDownloadUrl(folderId: string): Promise<NonNullablePaths<GenerateFolderDownloadUrlResponse, `downloadUrl`>>;
+/**
+ * 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 folderIds - IDs of the folders to move to the Media Manager's trash bin.
+ * @public
+ * @requiredField folderIds
+ * @param options - Options to use when deleting folders.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_MOVE_TO_TRASH
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.BulkDeleteFolders
+ */
+declare function bulkDeleteFolders(folderIds: string[], options?: BulkDeleteFoldersOptions): Promise<void>;
 interface BulkDeleteFoldersOptions {
     /**
      * Whether the specified folders are permanently deleted. <br />
@@ -560,6 +766,27 @@ interface BulkDeleteFoldersOptions {
      */
     permanent?: boolean;
 }
+/**
+ * Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
+ * @param folderIds - IDs of the folders to restore from the Media Manager's trash bin.
+ * @public
+ * @requiredField folderIds
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_RESTORE_FROM_TRASH
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.BulkRestoreFoldersFromTrashBin
+ */
+declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise<void>;
+/**
+ * Retrieves a list of folders in the Media Manager's trash bin.
+ * @public
+ * @param options - Options to use when listing deleted folders from the trash bin.
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST_DELETED
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.ListDeletedFolders
+ */
+declare function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise<NonNullablePaths<ListDeletedFoldersResponse, {
+    [P in FolderNonNullablePaths]: `folders.${number}.${P}`;
+}[FolderNonNullablePaths]>>;
 interface ListDeletedFoldersOptions {
     /**
      * ID of the folder's parent folder.
@@ -577,4 +804,4 @@ interface ListDeletedFoldersOptions {
     paging?: CursorPaging;
 }
 
-export { type ListDeletedFoldersRequest as A, type BulkDeleteFoldersOptions as B, type CreateFolderOptions as C, type DomainEvent as D, type DomainEventBodyOneOf as E, type Folder as F, type GenerateFolderDownloadUrlResponse as G, type EntityCreatedEvent as H, type RestoreInfo as I, type EntityUpdatedEvent as J, type EntityDeletedEvent as K, type ListFoldersOptions as L, type ActionEvent as M, Namespace as N, type MessageEnvelope as O, type PagingMetadataV2 as P, type IdentificationData as Q, RootFolder as R, type SearchFoldersOptions as S, type IdentificationDataIdOneOf as T, type UpdateFolder as U, type BaseEventMetadata as V, WebhookIdentityType as W, type EventMetadata as X, type CreateFolderResponse as a, type ListFoldersResponse as b, type SearchFoldersResponse as c, type ListDeletedFoldersOptions as d, type ListDeletedFoldersResponse as e, type FolderCreatedEnvelope as f, type FolderDeletedEnvelope as g, type FolderUpdatedEnvelope as h, State as i, SortOrder as j, type CreateFolderRequest as k, type GetFolderRequest as l, type GetFolderResponse as m, type ListFoldersRequest as n, type Sorting as o, type CursorPaging as p, type Cursors as q, type SearchFoldersRequest as r, type UpdateFolderRequest as s, type UpdateFolderResponse as t, type UnsupportedRequestValueError as u, type GenerateFolderDownloadUrlRequest as v, type BulkDeleteFoldersRequest as w, type BulkDeleteFoldersResponse as x, type BulkRestoreFoldersFromTrashBinRequest as y, type BulkRestoreFoldersFromTrashBinResponse as z };
+export { type ActionEvent, type BaseEventMetadata, type BulkDeleteFoldersOptions, type BulkDeleteFoldersRequest, type BulkDeleteFoldersResponse, type BulkRestoreFoldersFromTrashBinRequest, type BulkRestoreFoldersFromTrashBinResponse, type CreateFolderOptions, type CreateFolderRequest, type CreateFolderResponse, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Folder, type FolderCreatedEnvelope, type FolderDeletedEnvelope, type FolderUpdatedEnvelope, type GenerateFolderDownloadUrlRequest, type GenerateFolderDownloadUrlResponse, type GetFolderRequest, type GetFolderResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListDeletedFoldersOptions, type ListDeletedFoldersRequest, type ListDeletedFoldersResponse, type ListFoldersOptions, type ListFoldersRequest, type ListFoldersResponse, type MessageEnvelope, Namespace, type NamespaceWithLiterals, type PagingMetadataV2, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFoldersOptions, type SearchFoldersRequest, type SearchFoldersResponse, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UnsupportedRequestValueError, type UpdateFolder, type UpdateFolderRequest, type UpdateFolderResponse, type UpdateFolderValidationErrors, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFolders, bulkRestoreFoldersFromTrashBin, createFolder, generateFolderDownloadUrl, getFolder, listDeletedFolders, listFolders, onFolderCreated, onFolderDeleted, onFolderUpdated, searchFolders, updateFolder };