@openfilz-sdk/typescript-ee 1.3.5

package/dist/api/document-controller-api.d.ts

@@ -0,0 +1,594 @@
+/**
+ * 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 { AncestorInfo } from '../models';
+import type { CreateBlankDocumentRequest } from '../models';
+import type { DeleteMetadataRequest } from '../models';
+import type { DocumentInfo } from '../models';
+import type { DocumentPosition } from '../models';
+import type { ElementInfo } from '../models';
+import type { SearchByMetadataRequest } from '../models';
+import type { SearchMetadataRequest } from '../models';
+import type { UpdateMetadataRequest } from '../models';
+import type { UploadResponse } from '../models';
+/**
+ * DocumentControllerApi - axios parameter creator
+ */
+export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
+     * @summary Create a blank document from template
+     * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlankDocument: (createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes specified metadata keys from a document.
+     * @summary Delete specific metadata keys
+     * @param {string} documentId
+     * @param {DeleteMetadataRequest} deleteMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocumentMetadata: (documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Downloads a single file document.
+     * @summary Download a document
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
+     * @summary Download document for OnlyOffice
+     * @param {string} documentId
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadForOnlyOffice: (documentId: string, token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Downloads multiple documents as a single ZIP file.
+     * @summary Download multiple documents as ZIP
+     * @param {Array<string>} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadMultipleDocumentsAsZip: (requestBody: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
+     * @summary Get document ancestors
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentAncestors: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves information for a document.
+     * @summary Get information of a document
+     * @param {string} documentId
+     * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentInfo: (documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves metadata for a document. Can filter by keys.
+     * @summary Search metadata of a document
+     * @param {string} documentId
+     * @param {SearchMetadataRequest} [searchMetadataRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentMetadata: (documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the position of a document within its parent folder, useful for pagination.
+     * @summary Get document position in folder
+     * @param {string} documentId
+     * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
+     * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentPosition: (documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces the content of an existing file document.
+     * @summary Replace document content
+     * @param {string} documentId
+     * @param {File} file
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentContent: (documentId: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces all metadata of a document (file or folder).
+     * @summary Replace document metadata
+     * @param {string} documentId
+     * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentMetadata: (documentId: string, requestBody: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Finds document IDs matching all provided metadata criteria.
+     * @summary Search document IDs by metadata
+     * @param {SearchByMetadataRequest} searchByMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchDocumentIdsByMetadata: (searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates or adds specific metadata fields for a document.
+     * @summary Update document metadata
+     * @param {string} documentId
+     * @param {UpdateMetadataRequest} updateMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocumentMetadata: (documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
+     * @summary Upload multiple documents
+     * @param {Array<File>} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt;  &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt;    &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt;   &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt;   &lt;pre&gt;&lt;code&gt;[   {     \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;,       \\\&quot;metadata\\\&quot;: {         \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;,         \\\&quot;owner\\\&quot;: {           \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;,           \\\&quot;owner_id\\\&quot;: 1234568         }       }     }   },   {     \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;metadata\\\&quot;: {         \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;,         \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;,         \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot;       }     }   } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument: (file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Uploads a single file, optionally with metadata and a parent folder ID.
+     * @summary Upload a single document
+     * @param {File} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
+     * @param {string} [metadata]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument1: (file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentControllerApi - functional programming interface
+ */
+export declare const DocumentControllerApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
+     * @summary Create a blank document from template
+     * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>>;
+    /**
+     * Deletes specified metadata keys from a document.
+     * @summary Delete specific metadata keys
+     * @param {string} documentId
+     * @param {DeleteMetadataRequest} deleteMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Downloads a single file document.
+     * @summary Download a document
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
+     * @summary Download document for OnlyOffice
+     * @param {string} documentId
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Downloads multiple documents as a single ZIP file.
+     * @summary Download multiple documents as ZIP
+     * @param {Array<string>} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
+     * @summary Get document ancestors
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AncestorInfo>>>;
+    /**
+     * Retrieves information for a document.
+     * @summary Get information of a document
+     * @param {string} documentId
+     * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInfo>>;
+    /**
+     * Retrieves metadata for a document. Can filter by keys.
+     * @summary Search metadata of a document
+     * @param {string} documentId
+     * @param {SearchMetadataRequest} [searchMetadataRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Retrieves the position of a document within its parent folder, useful for pagination.
+     * @summary Get document position in folder
+     * @param {string} documentId
+     * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
+     * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentPosition>>;
+    /**
+     * Replaces the content of an existing file document.
+     * @summary Replace document content
+     * @param {string} documentId
+     * @param {File} file
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>>;
+    /**
+     * Replaces all metadata of a document (file or folder).
+     * @summary Replace document metadata
+     * @param {string} documentId
+     * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentMetadata(documentId: string, requestBody: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>>;
+    /**
+     * Finds document IDs matching all provided metadata criteria.
+     * @summary Search document IDs by metadata
+     * @param {SearchByMetadataRequest} searchByMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     * Updates or adds specific metadata fields for a document.
+     * @summary Update document metadata
+     * @param {string} documentId
+     * @param {UpdateMetadataRequest} updateMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>>;
+    /**
+     * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
+     * @summary Upload multiple documents
+     * @param {Array<File>} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt;  &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt;    &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt;   &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt;   &lt;pre&gt;&lt;code&gt;[   {     \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;,       \\\&quot;metadata\\\&quot;: {         \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;,         \\\&quot;owner\\\&quot;: {           \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;,           \\\&quot;owner_id\\\&quot;: 1234568         }       }     }   },   {     \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;metadata\\\&quot;: {         \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;,         \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;,         \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot;       }     }   } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>>;
+    /**
+     * Uploads a single file, optionally with metadata and a parent folder ID.
+     * @summary Upload a single document
+     * @param {File} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
+     * @param {string} [metadata]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>>;
+};
+/**
+ * DocumentControllerApi - factory interface
+ */
+export declare const DocumentControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
+     * @summary Create a blank document from template
+     * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse>;
+    /**
+     * Deletes specified metadata keys from a document.
+     * @summary Delete specific metadata keys
+     * @param {string} documentId
+     * @param {DeleteMetadataRequest} deleteMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Downloads a single file document.
+     * @summary Download a document
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
+     * @summary Download document for OnlyOffice
+     * @param {string} documentId
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Downloads multiple documents as a single ZIP file.
+     * @summary Download multiple documents as ZIP
+     * @param {Array<string>} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
+     * @summary Get document ancestors
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AncestorInfo>>;
+    /**
+     * Retrieves information for a document.
+     * @summary Get information of a document
+     * @param {string} documentId
+     * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo>;
+    /**
+     * Retrieves metadata for a document. Can filter by keys.
+     * @summary Search metadata of a document
+     * @param {string} documentId
+     * @param {SearchMetadataRequest} [searchMetadataRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Retrieves the position of a document within its parent folder, useful for pagination.
+     * @summary Get document position in folder
+     * @param {string} documentId
+     * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
+     * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentPosition>;
+    /**
+     * Replaces the content of an existing file document.
+     * @summary Replace document content
+     * @param {string} documentId
+     * @param {File} file
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo>;
+    /**
+     * Replaces all metadata of a document (file or folder).
+     * @summary Replace document metadata
+     * @param {string} documentId
+     * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentMetadata(documentId: string, requestBody: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo>;
+    /**
+     * Finds document IDs matching all provided metadata criteria.
+     * @summary Search document IDs by metadata
+     * @param {SearchByMetadataRequest} searchByMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     * Updates or adds specific metadata fields for a document.
+     * @summary Update document metadata
+     * @param {string} documentId
+     * @param {UpdateMetadataRequest} updateMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo>;
+    /**
+     * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
+     * @summary Upload multiple documents
+     * @param {Array<File>} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt;  &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt;    &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt;   &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt;   &lt;pre&gt;&lt;code&gt;[   {     \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;,       \\\&quot;metadata\\\&quot;: {         \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;,         \\\&quot;owner\\\&quot;: {           \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;,           \\\&quot;owner_id\\\&quot;: 1234568         }       }     }   },   {     \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;metadata\\\&quot;: {         \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;,         \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;,         \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot;       }     }   } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>>;
+    /**
+     * Uploads a single file, optionally with metadata and a parent folder ID.
+     * @summary Upload a single document
+     * @param {File} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
+     * @param {string} [metadata]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse>;
+};
+/**
+ * DocumentControllerApi - object-oriented interface
+ */
+export declare class DocumentControllerApi extends BaseAPI {
+    /**
+     * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
+     * @summary Create a blank document from template
+     * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse, any, {}>>;
+    /**
+     * Deletes specified metadata keys from a document.
+     * @summary Delete specific metadata keys
+     * @param {string} documentId
+     * @param {DeleteMetadataRequest} deleteMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Downloads a single file document.
+     * @summary Download a document
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
+     * @summary Download document for OnlyOffice
+     * @param {string} documentId
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Downloads multiple documents as a single ZIP file.
+     * @summary Download multiple documents as ZIP
+     * @param {Array<string>} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
+     * @summary Get document ancestors
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AncestorInfo[], any, {}>>;
+    /**
+     * Retrieves information for a document.
+     * @summary Get information of a document
+     * @param {string} documentId
+     * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInfo, any, {}>>;
+    /**
+     * Retrieves metadata for a document. Can filter by keys.
+     * @summary Search metadata of a document
+     * @param {string} documentId
+     * @param {SearchMetadataRequest} [searchMetadataRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Retrieves the position of a document within its parent folder, useful for pagination.
+     * @summary Get document position in folder
+     * @param {string} documentId
+     * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
+     * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentPosition, any, {}>>;
+    /**
+     * Replaces the content of an existing file document.
+     * @summary Replace document content
+     * @param {string} documentId
+     * @param {File} file
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ElementInfo, any, {}>>;
+    /**
+     * Replaces all metadata of a document (file or folder).
+     * @summary Replace document metadata
+     * @param {string} documentId
+     * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceDocumentMetadata(documentId: string, requestBody: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ElementInfo, any, {}>>;
+    /**
+     * Finds document IDs matching all provided metadata criteria.
+     * @summary Search document IDs by metadata
+     * @param {SearchByMetadataRequest} searchByMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
+    /**
+     * Updates or adds specific metadata fields for a document.
+     * @summary Update document metadata
+     * @param {string} documentId
+     * @param {UpdateMetadataRequest} updateMetadataRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ElementInfo, any, {}>>;
+    /**
+     * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
+     * @summary Upload multiple documents
+     * @param {Array<File>} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt;  &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt;    &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt;   &lt;table&gt;     &lt;thead&gt;       &lt;tr&gt;         &lt;th&gt;Field&lt;/th&gt;         &lt;th&gt;Type&lt;/th&gt;         &lt;th&gt;Description&lt;/th&gt;       &lt;/tr&gt;     &lt;/thead&gt;     &lt;tbody&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt;       &lt;/tr&gt;       &lt;tr&gt;         &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt;         &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt;       &lt;/tr&gt;     &lt;/tbody&gt;   &lt;/table&gt;    &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt;   &lt;pre&gt;&lt;code&gt;[   {     \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;,       \\\&quot;metadata\\\&quot;: {         \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;,         \\\&quot;owner\\\&quot;: {           \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;,           \\\&quot;owner_id\\\&quot;: 1234568         }       }     }   },   {     \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;,     \\\&quot;fileAttributes\\\&quot;: {       \\\&quot;metadata\\\&quot;: {         \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;,         \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;,         \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot;       }     }   } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse[], any, {}>>;
+    /**
+     * Uploads a single file, optionally with metadata and a parent folder ID.
+     * @summary Upload a single document
+     * @param {File} file
+     * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
+     * @param {string} [metadata]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse, any, {}>>;
+}