@wix/auto_sdk_media_folders 1.0.0

package/build/internal/cjs/src/media-site-media-v1-folder-folders.universal.d.ts

@@ -0,0 +1,745 @@
+export interface Folder {
+    /** Folder ID. Generated when a folder is created in the Media Manager. */
+    _id?: string;
+    /** Folder name as it appears in the Media Manager. */
+    displayName?: string;
+    /** ID of the folder's parent folder. <br /> Default: `media-root` folder. */
+    parentFolderId?: string;
+    /**
+     * Date the folder was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the folder was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * State of the folder.
+     * @readonly
+     */
+    state?: State;
+}
+export declare enum State {
+    OK = "OK",
+    DELETED = "DELETED"
+}
+export declare enum Namespace {
+    NO_NAMESPACE = "NO_NAMESPACE",
+    OTHERS = "OTHERS",
+    /** ANY = 2; */
+    WIX_VIDEO = "WIX_VIDEO",
+    /** _nsWixMusic */
+    WIX_MUSIC = "WIX_MUSIC",
+    /** _nsArtStore */
+    ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
+    /** _nsDigitalProduct */
+    WIX_ECOM = "WIX_ECOM",
+    /** _nsPhotoShareApp */
+    PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
+    /** _nsSharingApp, */
+    SHARING_APP = "SHARING_APP",
+    /** engage */
+    CHAT = "CHAT",
+    /** logobuilder */
+    LOGO_BUILDER = "LOGO_BUILDER",
+    /** WixExposure */
+    ALBUMS_OLD = "ALBUMS_OLD",
+    /** chat-mobile-uploads */
+    CHAT_MOBILE = "CHAT_MOBILE",
+    /** _nsWixForms */
+    WIX_FORMS = "WIX_FORMS",
+    /** _nsWixLegends */
+    WIX_LEGENDS = "WIX_LEGENDS"
+}
+export interface CreateFolderRequest {
+    /** Folder name that appears in the Media Manager. */
+    displayName: string;
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+}
+export interface CreateFolderResponse {
+    /** Information about the newly created folder. */
+    folder?: Folder;
+}
+export interface GetFolderRequest {
+    /** Folder ID. */
+    folderId: string;
+}
+export interface GetFolderResponse {
+    /** Information about the folder. */
+    folder?: Folder;
+}
+export interface ListFoldersRequest {
+    /**
+     * ID of the folder's parent folder.
+     * <br /> Default: `media-root` folder.
+     */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListFoldersResponse {
+    /** Information about the folders in the requested folder. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+}
+export interface SearchFoldersRequest {
+    /**
+     * A root folder in the Media Manager to search in. <br />
+     * Default: `MEDIA_ROOT`.
+     */
+    rootFolder?: RootFolder;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+    /**
+     * Term to search for, such as the value of a folder's `displayName`. <br />
+     * For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
+     */
+    search?: string | null;
+}
+export declare enum RootFolder {
+    /** Root of all site media */
+    MEDIA_ROOT = "MEDIA_ROOT",
+    /** Root of the trash system folder */
+    TRASH_ROOT = "TRASH_ROOT",
+    /** Root of all visitor uploads */
+    VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
+}
+export interface SearchFoldersResponse {
+    /** Information about the folders in the requested folder. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+export interface UpdateFolderRequest {
+    /** Folder to update. */
+    folder: Folder;
+}
+export interface UpdateFolderResponse {
+    /** Information about the updated folder. */
+    folder?: Folder;
+}
+export interface UnsupportedRequestValueError {
+    /** Optional A list of allowed values */
+    allowedValues?: string[];
+    /** The unsupported value send in the request */
+    requestValue?: string;
+}
+export interface GenerateFolderDownloadUrlRequest {
+    /** Folder ID. */
+    folderId: string;
+}
+export interface GenerateFolderDownloadUrlResponse {
+    /** URL for downloading a specific folder in the Media Manager. */
+    downloadUrl?: string;
+}
+export interface BulkDeleteFoldersRequest {
+    /** IDs of the folders to move to the Media Manager's trash bin. */
+    folderIds: string[];
+    /**
+     * Whether the specified folders are permanently deleted. <br />
+     * Default: `false`
+     */
+    permanent?: boolean;
+}
+export interface BulkDeleteFoldersResponse {
+}
+export interface BulkRestoreFoldersFromTrashBinRequest {
+    /** IDs of the folders to restore from the Media Manager's trash bin. */
+    folderIds: string[];
+}
+export interface BulkRestoreFoldersFromTrashBinResponse {
+}
+export interface ListDeletedFoldersRequest {
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+}
+export interface ListDeletedFoldersResponse {
+    /** List of folders in the Media Manager's trash bin. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface FolderNonNullableFields {
+    _id: string;
+    displayName: string;
+    parentFolderId: string;
+    state: State;
+    namespace: Namespace;
+}
+export interface CreateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface GetFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface ListFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export interface SearchFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export interface UpdateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface GenerateFolderDownloadUrlResponseNonNullableFields {
+    downloadUrl: string;
+}
+export interface ListDeletedFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export 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 Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_created
+ */
+export declare function onFolderCreated(handler: (event: FolderCreatedEnvelope) => void | Promise<void>): void;
+export 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 Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_deleted
+ */
+export declare function onFolderDeleted(handler: (event: FolderDeletedEnvelope) => void | Promise<void>): void;
+export 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 Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
+ * @webhook
+ * @eventType wix.media.site_media.v1.folder_updated
+ */
+export declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.CreateFolder
+ */
+export declare function createFolder(displayName: string, options?: CreateFolderOptions): Promise<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
+export interface CreateFolderOptions {
+    /** ID of the folder's parent folder. */
+    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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Information about the folder.
+ * @fqn com.wix.media.site_media.v1.FoldersService.GetFolder
+ */
+export declare function getFolder(folderId: string): Promise<Folder & FolderNonNullableFields>;
+/**
+ * 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.ListFolders
+ */
+export declare function listFolders(options?: ListFoldersOptions): Promise<ListFoldersResponse & ListFoldersResponseNonNullableFields>;
+export interface ListFoldersOptions {
+    /**
+     * ID of the folder's parent folder.
+     * <br /> Default: `media-root` folder.
+     */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.SearchFolders
+ */
+export declare function searchFolders(options?: SearchFoldersOptions): Promise<SearchFoldersResponse & SearchFoldersResponseNonNullableFields>;
+export interface SearchFoldersOptions {
+    /**
+     * A root folder in the Media Manager to search in. <br />
+     * Default: `MEDIA_ROOT`.
+     */
+    rootFolder?: RootFolder;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+    /**
+     * Term to search for, such as the value of a folder's `displayName`. <br />
+     * For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
+     */
+    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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Information about the updated folder.
+ * @fqn com.wix.media.site_media.v1.FoldersService.UpdateFolder
+ */
+export declare function updateFolder(_id: string, folder: UpdateFolder): Promise<Folder & FolderNonNullableFields>;
+export interface UpdateFolder {
+    /** Folder ID. Generated when a folder is created in the Media Manager. */
+    _id?: string;
+    /** Folder name as it appears in the Media Manager. */
+    displayName?: string;
+    /** ID of the folder's parent folder. <br /> Default: `media-root` folder. */
+    parentFolderId?: string;
+    /**
+     * Date the folder was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the folder was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * State of the folder.
+     * @readonly
+     */
+    state?: State;
+}
+/**
+ * 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.GenerateFolderDownloadUrl
+ */
+export declare function generateFolderDownloadUrl(folderId: string): Promise<GenerateFolderDownloadUrlResponse & GenerateFolderDownloadUrlResponseNonNullableFields>;
+/**
+ * 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.BulkDeleteFolders
+ */
+export declare function bulkDeleteFolders(folderIds: string[], options?: BulkDeleteFoldersOptions): Promise<void>;
+export interface BulkDeleteFoldersOptions {
+    /**
+     * Whether the specified folders are permanently deleted. <br />
+     * Default: `false`
+     */
+    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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Media Manager
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.BulkRestoreFoldersFromTrashBin
+ */
+export 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
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wix.media.site_media.v1.FoldersService.ListDeletedFolders
+ */
+export declare function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise<ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields>;
+export interface ListDeletedFoldersOptions {
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+}