@wix/media 1.0.0

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

@@ -0,0 +1,179 @@
+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. */
+    createdDate?: Date;
+    /** Date the folder was updated. */
+    updatedDate?: Date;
+    /** State of the folder. */
+    state?: State;
+}
+export declare enum State {
+    OK = "OK",
+    DELETED = "DELETED"
+}
+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 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get 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 {
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to 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: <br />
+     * * `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 {
+    /** ID of the folder to update. */
+    folderId: string;
+    /** Folder name that appears in the Media Manager. */
+    displayName?: string | null;
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+}
+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: <br />
+     * * `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;
+}

package/build/cjs/src/media-site-media-v1-folder.types.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RootFolder = exports.SortOrder = exports.State = void 0;
+var State;
+(function (State) {
+    State["OK"] = "OK";
+    State["DELETED"] = "DELETED";
+})(State = exports.State || (exports.State = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+var RootFolder;
+(function (RootFolder) {
+    /** Root of all site media */
+    RootFolder["MEDIA_ROOT"] = "MEDIA_ROOT";
+    /** Root of the trash system folder */
+    RootFolder["TRASH_ROOT"] = "TRASH_ROOT";
+    /** Root of all visitor uploads */
+    RootFolder["VISITOR_UPLOADS_ROOT"] = "VISITOR_UPLOADS_ROOT";
+})(RootFolder = exports.RootFolder || (exports.RootFolder = {}));
+//# sourceMappingURL=media-site-media-v1-folder.types.js.map

package/build/cjs/src/media-site-media-v1-folder.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-site-media-v1-folder.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder.types.ts"],"names":[],"mappings":";;;AAeA,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,kBAAS,CAAA;IACT,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAgDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAsDD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB"}

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

@@ -0,0 +1,337 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+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. */
+    _createdDate?: Date;
+    /** Date the folder was updated. */
+    _updatedDate?: Date;
+    /** State of the folder. */
+    state?: State;
+}
+export declare enum State {
+    OK = "OK",
+    DELETED = "DELETED"
+}
+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 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get 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 {
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to 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: <br />
+     * * `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 {
+    /** ID of the folder to update. */
+    folderId: string;
+    /** Folder name that appears in the Media Manager. */
+    displayName?: string | null;
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+}
+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: <br />
+     * * `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;
+}
+/**
+ * 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
+ * @documentationMaturity preview
+ * @requiredField displayName
+ */
+export declare function createFolder(displayName: string, options?: CreateFolderOptions): Promise<CreateFolderResponse>;
+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
+ * @documentationMaturity preview
+ * @requiredField folderId
+ */
+export declare function getFolder(folderId: string): Promise<GetFolderResponse>;
+/**
+ * Retrieves a list of folders in the Media Manager. 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 endpoint retrieves a list of folders within the root folder of the Media Manager.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listFolders(options?: ListFoldersOptions): Promise<ListFoldersResponse>;
+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 endpoint returns all folders in the `MEDIA_ROOT` folder.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function searchFolders(options?: SearchFoldersOptions): Promise<SearchFoldersResponse>;
+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: <br />
+     * * `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 folderId - ID of the folder to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField folderId
+ */
+export declare function updateFolder(folderId: string, options?: UpdateFolderOptions): Promise<UpdateFolderResponse>;
+export interface UpdateFolderOptions {
+    /** Folder name that appears in the Media Manager. */
+    displayName?: string | null;
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+}
+/**
+ * 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. <br/>
+ * @param folderId - Folder ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField folderId
+ */
+export declare function generateFolderDownloadUrl(folderId: string): Promise<GenerateFolderDownloadUrlResponse>;
+/**
+ * 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, 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.
+ *
+ * Note the following:
+ * * When a folder is deleted, the files in that folder are deleted.
+ * * The specified foldes 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 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 [Bulk Restore Folders From Trash Bin](bulk-restore-folders-from-trash-bin) endpoint 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
+ * @documentationMaturity preview
+ * @requiredField folderIds
+ */
+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
+ * @documentationMaturity preview
+ * @requiredField folderIds
+ */
+export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise<void>;
+/**
+ * Returns a list of the folder infos of all the deleted folders as directed by the filter.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise<ListDeletedFoldersResponse>;
+export interface ListDeletedFoldersOptions {
+    /** ID of the folder's parent 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;
+}