@wix/media 1.0.62 → 1.0.64

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

@@ -1,603 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-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;
-    /**
-     * Date the folder was updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * State of the folder.
-     *
-     * Supported values: `"OK"`, `"DELETED"`.
-     * @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"
-}
-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:
-     * - `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.
-     *
-     * Supported values: `"ASC"`, `"DESC"`
-     */
-    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 {
-    /** The folder to update. */
-    folder: Folder;
-}
-export interface UpdateFolderResponse {
-    /** Information about the updated folder. */
-    folder?: Folder;
-}
-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<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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. */
-    eventTime?: Date;
-    /**
-     * 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 DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface CreateFolderResponseNonNullableFields {
-    folder?: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    };
-}
-export interface GetFolderResponseNonNullableFields {
-    folder?: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    };
-}
-export interface ListFoldersResponseNonNullableFields {
-    folders: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    }[];
-}
-export interface SearchFoldersResponseNonNullableFields {
-    folders: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    }[];
-}
-export interface UpdateFolderResponseNonNullableFields {
-    folder?: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    };
-}
-export interface GenerateFolderDownloadUrlResponseNonNullableFields {
-    downloadUrl: string;
-}
-export interface ListDeletedFoldersResponseNonNullableFields {
-    folders: {
-        _id: string;
-        displayName: string;
-        parentFolderId: string;
-        state: State;
-    }[];
-}
-export declare const onFolderCreated: EventDefinition<DomainCreatedEvent<Folder>, "wix.media.site_media.v1.folder_created">;
-export declare const onFolderUpdated: EventDefinition<DomainUpdatedEvent<Folder>, "wix.media.site_media.v1.folder_updated">;
-export declare const onFolderDeleted: EventDefinition<DomainDeletedEvent<Folder>, "wix.media.site_media.v1.folder_deleted">;
-/**
- * Creates a new folder in the Media Manager.
- *
- * The `createFolder()` function returns a Promise that resolves to the created folder.
- *
- * 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.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
- * @applicableIdentity APP
- */
-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 the specified folder in the Media Manager.
- *
- * The `getFolder()` function returns a Promise that resolves to information about the specified folder.
- * @param folderId - Folder ID.
- * @public
- * @requiredField folderId
- * @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
- * @applicableIdentity APP
- * @returns Information about the folder.
- */
-export declare function getFolder(folderId: string): Promise<Folder & NonNullable<GetFolderResponseNonNullableFields>['folder']>;
-/**
- * Retrieves a list of folders in the Media Manager.
- *
- * The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
- *
- * To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the list of folders within the root folder of the Media Manager.
- *
- * To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.
- * @public
- * @param options - Options to use when listing folders from the Media Manager.
- * @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
- * @applicableIdentity APP
- */
-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:
-     * - `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.
- *
- * The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
- *
- * If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.
- * @public
- * @param options - Options specifying which folders to search.
- * @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
- * @applicableIdentity APP
- */
-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 `"DSEC"` order.
-     */
-    sort?: Sorting;
-    /** Cursor and paging information. */
-    paging?: CursorPaging;
-    /**
-     * Term to search for, such as the value of a folder's `displayName`.
-     *
-     * For example, if a folder's `displayName` is 'my-videos-folder', the search term is `'my-videos-folder'`.
-     */
-    search?: string | null;
-}
-/**
- * Updates a folder.
- *
- * The `updateFolder()` function returns a Promise that resolves to information about the updated folder.
- *
- * 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 options - @internal
- * @param folder - Folder to update.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
- * @applicableIdentity APP
- * @returns Information about the updated folder.
- */
-export declare function updateFolder(_id: string, folder: UpdateFolder): Promise<Folder & NonNullable<UpdateFolderResponseNonNullableFields>['folder']>;
-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;
-    /**
-     * Date the folder was updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * State of the folder.
-     *
-     * Supported values: `"OK"`, `"DELETED"`.
-     * @readonly
-     */
-    state?: State;
-}
-/**
- * Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
- *
- * The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.
- *
- * The compressed file can contain sub-folders, and up to 1000 files.
- * @param folderId - Folder ID.
- * @public
- * @requiredField folderId
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
- * @applicableIdentity APP
- */
-export declare function generateFolderDownloadUrl(folderId: string): Promise<GenerateFolderDownloadUrlResponse & GenerateFolderDownloadUrlResponseNonNullableFields>;
-/**
- * Temporarily deletes the specified folders from the Media Manager.
- *
- * The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.
- *
- * The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass 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.
- *
- * >**Notes:**
- * > - 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 your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
- * > - You can use the `bulkRestoreFoldersFromTrashBin()` function 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.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
- * @applicableIdentity APP
- */
-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.
- *
- *
- * The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.
- * @param folderIds - IDs of the folders to restore from the Media Manager's trash bin.
- * @public
- * @requiredField folderIds
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
- * @applicableIdentity APP
- */
-export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise<void>;
-/**
- * Retrieves a list of deleted folders from the trash bin.
- *
- * The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.
- *
- * To retrieve a list of non-deleted folders, use the `listFolders()` function.
- * @public
- * @param options - Options to use when listing deleted folders from the 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
- * @applicableIdentity APP
- */
-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;
-}