/** * openfilz-api * API for Document Management System * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CopyRequest } from '../models'; import type { CreateFolderRequest } from '../models'; import type { DeleteRequest } from '../models'; import type { ElementInfo } from '../models'; import type { FolderElementInfo } from '../models'; import type { FolderResponse } from '../models'; import type { MoveRequest } from '../models'; import type { RenameRequest } from '../models'; /** * FolderControllerApi - axios parameter creator */ export declare const FolderControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Copies a set of folders (and their contents) into an existing target folder. * @summary Copy folders * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFolders: (copyRequest: CopyRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the number of elements (files and folders) contained in a given folder - return 0 if empty or not exists(no recursive count, just count the flat list of objects at the root level of a folder) * @summary Count files and subfolders contained in a given folder - return 0 if empty or not exists * @param {string} [folderId] ID of the folder or to count elements at the root level * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ countFolderElements: (folderId?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new folder, optionally under a parent folder. * @summary Create a new folder * @param {CreateFolderRequest} createFolderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder: (createFolderRequest: CreateFolderRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a set of folders and their contents from storage and database. * @summary Delete folders * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolders: (deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves document information of all files and subfolders contained in a given folder (no recursive list, just the flat list of objects at the root level of a folder) * @summary List files and subfolders contained in a given folder * @param {string} [folderId] if null, empty or not provided, then lists the content of the root folder * @param {boolean} [onlyFiles] if true, only files are listed * @param {boolean} [onlyFolders] if true, only folders are listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolder: (folderId?: string, onlyFiles?: boolean, onlyFolders?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Moves a set of folders (and their contents) into an existing target folder. * @summary Move folders * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFolders: (moveRequest: MoveRequest, options?: RawAxiosRequestConfig) => Promise; /** * Renames an existing folder. * @summary Rename a folder * @param {string} folderId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFolder: (folderId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * FolderControllerApi - functional programming interface */ export declare const FolderControllerApiFp: (configuration?: Configuration) => { /** * Copies a set of folders (and their contents) into an existing target folder. * @summary Copy folders * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFolders(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the number of elements (files and folders) contained in a given folder - return 0 if empty or not exists(no recursive count, just count the flat list of objects at the root level of a folder) * @summary Count files and subfolders contained in a given folder - return 0 if empty or not exists * @param {string} [folderId] ID of the folder or to count elements at the root level * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ countFolderElements(folderId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new folder, optionally under a parent folder. * @summary Create a new folder * @param {CreateFolderRequest} createFolderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(createFolderRequest: CreateFolderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a set of folders and their contents from storage and database. * @summary Delete folders * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolders(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves document information of all files and subfolders contained in a given folder (no recursive list, just the flat list of objects at the root level of a folder) * @summary List files and subfolders contained in a given folder * @param {string} [folderId] if null, empty or not provided, then lists the content of the root folder * @param {boolean} [onlyFiles] if true, only files are listed * @param {boolean} [onlyFolders] if true, only folders are listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolder(folderId?: string, onlyFiles?: boolean, onlyFolders?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Moves a set of folders (and their contents) into an existing target folder. * @summary Move folders * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFolders(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Renames an existing folder. * @summary Rename a folder * @param {string} folderId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFolder(folderId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FolderControllerApi - factory interface */ export declare const FolderControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Copies a set of folders (and their contents) into an existing target folder. * @summary Copy folders * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFolders(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the number of elements (files and folders) contained in a given folder - return 0 if empty or not exists(no recursive count, just count the flat list of objects at the root level of a folder) * @summary Count files and subfolders contained in a given folder - return 0 if empty or not exists * @param {string} [folderId] ID of the folder or to count elements at the root level * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ countFolderElements(folderId?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new folder, optionally under a parent folder. * @summary Create a new folder * @param {CreateFolderRequest} createFolderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(createFolderRequest: CreateFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a set of folders and their contents from storage and database. * @summary Delete folders * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolders(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves document information of all files and subfolders contained in a given folder (no recursive list, just the flat list of objects at the root level of a folder) * @summary List files and subfolders contained in a given folder * @param {string} [folderId] if null, empty or not provided, then lists the content of the root folder * @param {boolean} [onlyFiles] if true, only files are listed * @param {boolean} [onlyFolders] if true, only folders are listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolder(folderId?: string, onlyFiles?: boolean, onlyFolders?: boolean, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Moves a set of folders (and their contents) into an existing target folder. * @summary Move folders * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFolders(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Renames an existing folder. * @summary Rename a folder * @param {string} folderId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFolder(folderId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FolderControllerApi - object-oriented interface */ export declare class FolderControllerApi extends BaseAPI { /** * Copies a set of folders (and their contents) into an existing target folder. * @summary Copy folders * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFolders(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the number of elements (files and folders) contained in a given folder - return 0 if empty or not exists(no recursive count, just count the flat list of objects at the root level of a folder) * @summary Count files and subfolders contained in a given folder - return 0 if empty or not exists * @param {string} [folderId] ID of the folder or to count elements at the root level * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ countFolderElements(folderId?: string, options?: RawAxiosRequestConfig): Promise>; /** * Creates a new folder, optionally under a parent folder. * @summary Create a new folder * @param {CreateFolderRequest} createFolderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(createFolderRequest: CreateFolderRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a set of folders and their contents from storage and database. * @summary Delete folders * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolders(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves document information of all files and subfolders contained in a given folder (no recursive list, just the flat list of objects at the root level of a folder) * @summary List files and subfolders contained in a given folder * @param {string} [folderId] if null, empty or not provided, then lists the content of the root folder * @param {boolean} [onlyFiles] if true, only files are listed * @param {boolean} [onlyFolders] if true, only folders are listed * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolder(folderId?: string, onlyFiles?: boolean, onlyFolders?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Moves a set of folders (and their contents) into an existing target folder. * @summary Move folders * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFolders(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Renames an existing folder. * @summary Rename a folder * @param {string} folderId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFolder(folderId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise>; }