/** * 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 { CopyResponse } from '../models'; import type { DeleteRequest } from '../models'; import type { ElementInfo } from '../models'; import type { MoveRequest } from '../models'; import type { RenameRequest } from '../models'; import type { UnzipRequest } from '../models'; import type { UnzipResponse } from '../models'; /** * FileControllerApi - axios parameter creator */ export declare const FileControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Copies a set of files into an existing target folder. * @summary Copy files * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFiles: (copyRequest: CopyRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a set of files from storage and database. * @summary Delete files * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFiles: (deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig) => Promise; /** * Moves a set of files into an existing target folder. * @summary Move files * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFiles: (moveRequest: MoveRequest, options?: RawAxiosRequestConfig) => Promise; /** * Renames an existing file. * @summary Rename a file * @param {string} fileId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFile: (fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig) => Promise; /** * Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID). * @summary Extract a ZIP file * @param {string} fileId Id of the ZIP document * @param {UnzipRequest} [unzipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unzipFile: (fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * FileControllerApi - functional programming interface */ export declare const FileControllerApiFp: (configuration?: Configuration) => { /** * Copies a set of files into an existing target folder. * @summary Copy files * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFiles(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Deletes a set of files from storage and database. * @summary Delete files * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFiles(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Moves a set of files into an existing target folder. * @summary Move files * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFiles(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Renames an existing file. * @summary Rename a file * @param {string} fileId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID). * @summary Extract a ZIP file * @param {string} fileId Id of the ZIP document * @param {UnzipRequest} [unzipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FileControllerApi - factory interface */ export declare const FileControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Copies a set of files into an existing target folder. * @summary Copy files * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFiles(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Deletes a set of files from storage and database. * @summary Delete files * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFiles(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Moves a set of files into an existing target folder. * @summary Move files * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFiles(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Renames an existing file. * @summary Rename a file * @param {string} fileId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID). * @summary Extract a ZIP file * @param {string} fileId Id of the ZIP document * @param {UnzipRequest} [unzipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FileControllerApi - object-oriented interface */ export declare class FileControllerApi extends BaseAPI { /** * Copies a set of files into an existing target folder. * @summary Copy files * @param {CopyRequest} copyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFiles(copyRequest: CopyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a set of files from storage and database. * @summary Delete files * @param {DeleteRequest} deleteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFiles(deleteRequest: DeleteRequest, options?: RawAxiosRequestConfig): Promise>; /** * Moves a set of files into an existing target folder. * @summary Move files * @param {MoveRequest} moveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveFiles(moveRequest: MoveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Renames an existing file. * @summary Rename a file * @param {string} fileId * @param {RenameRequest} renameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise>; /** * Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID). * @summary Extract a ZIP file * @param {string} fileId Id of the ZIP document * @param {UnzipRequest} [unzipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): Promise>; }