/** * 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 { DocumentVersionInfo } from '../models'; import type { RestoreVersionResponse } from '../models'; /** * DocumentVersionControllerApi - axios parameter creator */ export declare const DocumentVersionControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Downloads the content of a specific stored version of a file document. * @summary Download a specific document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadVersion: (documentId: string, versionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409). * @summary List document versions * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVersions: (documentId: string, options?: RawAxiosRequestConfig) => Promise; /** * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400). * @summary Restore a previous document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreVersion: (documentId: string, versionId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * DocumentVersionControllerApi - functional programming interface */ export declare const DocumentVersionControllerApiFp: (configuration?: Configuration) => { /** * Downloads the content of a specific stored version of a file document. * @summary Download a specific document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409). * @summary List document versions * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVersions(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400). * @summary Restore a previous document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DocumentVersionControllerApi - factory interface */ export declare const DocumentVersionControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Downloads the content of a specific stored version of a file document. * @summary Download a specific document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409). * @summary List document versions * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVersions(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400). * @summary Restore a previous document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DocumentVersionControllerApi - object-oriented interface */ export declare class DocumentVersionControllerApi extends BaseAPI { /** * Downloads the content of a specific stored version of a file document. * @summary Download a specific document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise>; /** * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409). * @summary List document versions * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVersions(documentId: string, options?: RawAxiosRequestConfig): Promise>; /** * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400). * @summary Restore a previous document version * @param {string} documentId * @param {string} versionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise>; }