@openfilz-sdk/typescript-ee 1.10.4 → 1.10.6

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

@@ -155,7 +155,7 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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.
@@ -166,7 +166,7 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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]
@@ -309,7 +309,7 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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.
@@ -320,7 +320,7 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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]
@@ -463,7 +463,7 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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.
@@ -474,7 +474,7 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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]
@@ -617,7 +617,7 @@ export declare class DocumentControllerApi extends BaseAPI {
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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.
@@ -628,7 +628,7 @@ export declare class DocumentControllerApi extends BaseAPI {
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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]

package/dist/esm/api/document-controller-api.js

@@ -548,7 +548,7 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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.
@@ -600,7 +600,7 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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]
@@ -896,7 +896,7 @@ export const DocumentControllerApiFp = function (configuration) {
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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.
@@ -915,7 +915,7 @@ export const DocumentControllerApiFp = function (configuration) {
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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]
@@ -1093,7 +1093,7 @@ export const DocumentControllerApiFactory = function (configuration, basePath, a
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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.
@@ -1106,7 +1106,7 @@ export const DocumentControllerApiFactory = function (configuration, basePath, a
          * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
          * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
          * @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]
@@ -1276,7 +1276,7 @@ export class DocumentControllerApi extends BaseAPI {
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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.
@@ -1289,7 +1289,7 @@ export class DocumentControllerApi extends BaseAPI {
      * 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 {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      * @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active.
      * @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]

package/dist/esm/api/file-controller-api.d.ts

@@ -18,6 +18,8 @@ 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
  */
@@ -55,6 +57,15 @@ export declare const FileControllerApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     renameFile: (fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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<RequestArgs>;
 };
 /**
  * FileControllerApi - functional programming interface
@@ -93,6 +104,15 @@ export declare const FileControllerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>>;
+    /**
+     * 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<UnzipResponse>>;
 };
 /**
  * FileControllerApi - factory interface
@@ -131,6 +151,15 @@ export declare const FileControllerApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo>;
+    /**
+     * 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<UnzipResponse>;
 };
 /**
  * FileControllerApi - object-oriented interface
@@ -169,4 +198,13 @@ export declare class FileControllerApi extends BaseAPI {
      * @throws {RequiredError}
      */
     renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ElementInfo, any, {}, any>>;
+    /**
+     * 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<import("axios").AxiosResponse<UnzipResponse, any, {}, any>>;
 }

package/dist/esm/api/file-controller-api.js

@@ -169,6 +169,42 @@ export const FileControllerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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_1, unzipRequest_1, ...args_1) => __awaiter(this, [fileId_1, unzipRequest_1, ...args_1], void 0, function* (fileId, unzipRequest, options = {}) {
+            // verify required parameter 'fileId' is not null or undefined
+            assertParamExists('unzipFile', 'fileId', fileId);
+            const localVarPath = `/api/v1/files/{fileId}/unzip`
+                .replace('{fileId}', encodeURIComponent(String(fileId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(unzipRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 /**
@@ -242,6 +278,23 @@ export const FileControllerApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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, unzipRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.unzipFile(fileId, unzipRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FileControllerApi.unzipFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
     };
 };
 /**
@@ -291,6 +344,17 @@ export const FileControllerApiFactory = function (configuration, basePath, axios
         renameFile(fileId, renameRequest, options) {
             return localVarFp.renameFile(fileId, renameRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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, unzipRequest, options) {
+            return localVarFp.unzipFile(fileId, unzipRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -338,4 +402,15 @@ export class FileControllerApi extends BaseAPI {
     renameFile(fileId, renameRequest, options) {
         return FileControllerApiFp(this.configuration).renameFile(fileId, renameRequest, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * 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, unzipRequest, options) {
+        return FileControllerApiFp(this.configuration).unzipFile(fileId, unzipRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }

package/dist/esm/api.d.ts

@@ -27,6 +27,8 @@ export * from './api/comments-api';
 export * from './api/dashboard-api';
 export * from './api/delegated-browse-grants-admin-api';
 export * from './api/delegated-browse-grants-end-user-api';
+export * from './api/desktop-sync-api';
+export * from './api/desktop-sync-administration-api';
 export * from './api/document-controller-api';
 export * from './api/document-insights-api';
 export * from './api/document-suggestion-controller-api';

package/dist/esm/api.js

@@ -29,6 +29,8 @@ export * from './api/comments-api';
 export * from './api/dashboard-api';
 export * from './api/delegated-browse-grants-admin-api';
 export * from './api/delegated-browse-grants-end-user-api';
+export * from './api/desktop-sync-api';
+export * from './api/desktop-sync-administration-api';
 export * from './api/document-controller-api';
 export * from './api/document-insights-api';
 export * from './api/document-suggestion-controller-api';

package/dist/esm/models/copy-request.d.ts

@@ -19,7 +19,7 @@ export interface CopyRequest {
      */
     'targetFolderId'?: string;
     /**
-     * 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)
+     * When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      */
     'allowDuplicateFileNames'?: boolean;
 }

package/dist/esm/models/desktop-sync-client-info.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+export interface DesktopSyncClientInfo {
+    'server'?: string;
+    'issuer'?: string;
+    'clientId'?: string;
+    'updateUrl'?: string;
+    'downloadUrl'?: string;
+    'webUrl'?: string;
+    'apiVersion'?: number;
+}

package/dist/esm/models/desktop-sync-client-info.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+export {};

package/dist/esm/models/enriched-audit-log.d.ts

@@ -43,6 +43,7 @@ export declare const EnrichedAuditLogActionEnum: {
     readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
     readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
     readonly DownloadDocument: "DOWNLOAD_DOCUMENT";
+    readonly OpenDocument: "OPEN_DOCUMENT";
     readonly DeleteDocumentMetadata: "DELETE_DOCUMENT_METADATA";
     readonly RestoreFile: "RESTORE_FILE";
     readonly RestoreFolder: "RESTORE_FOLDER";

package/dist/esm/models/enriched-audit-log.js

@@ -29,6 +29,7 @@ export const EnrichedAuditLogActionEnum = {
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',
+    OpenDocument: 'OPEN_DOCUMENT',
     DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
     RestoreFile: 'RESTORE_FILE',
     RestoreFolder: 'RESTORE_FOLDER',

package/dist/esm/models/index.d.ts

@@ -58,6 +58,7 @@ export * from './delete-metadata-audit';
 export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './delete-share-request';
+export * from './desktop-sync-client-info';
 export * from './document-info';
 export * from './document-insight-view';
 export * from './document-integrity-record';
@@ -162,6 +163,10 @@ export * from './split-request';
 export * from './start-workflow-request';
 export * from './storage-breakdown';
 export * from './suggest';
+export * from './sync-backfill-status';
+export * from './sync-changes-response';
+export * from './sync-item';
+export * from './sync-snapshot-response';
 export * from './team-inbox-request';
 export * from './team-inbox-view';
 export * from './team-member-info';
@@ -170,6 +175,9 @@ export * from './tus-config-response';
 export * from './tus-finalize-request';
 export * from './tus-upload-info';
 export * from './untouched';
+export * from './unzip-request';
+export * from './unzip-response';
+export * from './unzip-skipped-entry';
 export * from './update-comment-request';
 export * from './update-metadata-audit';
 export * from './update-metadata-request';

package/dist/esm/models/index.js

@@ -58,6 +58,7 @@ export * from './delete-metadata-audit';
 export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './delete-share-request';
+export * from './desktop-sync-client-info';
 export * from './document-info';
 export * from './document-insight-view';
 export * from './document-integrity-record';
@@ -162,6 +163,10 @@ export * from './split-request';
 export * from './start-workflow-request';
 export * from './storage-breakdown';
 export * from './suggest';
+export * from './sync-backfill-status';
+export * from './sync-changes-response';
+export * from './sync-item';
+export * from './sync-snapshot-response';
 export * from './team-inbox-request';
 export * from './team-inbox-view';
 export * from './team-member-info';
@@ -170,6 +175,9 @@ export * from './tus-config-response';
 export * from './tus-finalize-request';
 export * from './tus-upload-info';
 export * from './untouched';
+export * from './unzip-request';
+export * from './unzip-response';
+export * from './unzip-skipped-entry';
 export * from './update-comment-request';
 export * from './update-metadata-audit';
 export * from './update-metadata-request';

package/dist/esm/models/move-request.d.ts

@@ -19,7 +19,7 @@ export interface MoveRequest {
      */
     'targetFolderId'?: string;
     /**
-     * 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)
+     * When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
      */
     'allowDuplicateFileNames'?: boolean;
 }

package/dist/esm/models/search-by-audit-log-request.d.ts

@@ -59,6 +59,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
     readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
     readonly DownloadDocument: "DOWNLOAD_DOCUMENT";
+    readonly OpenDocument: "OPEN_DOCUMENT";
     readonly DeleteDocumentMetadata: "DELETE_DOCUMENT_METADATA";
     readonly RestoreFile: "RESTORE_FILE";
     readonly RestoreFolder: "RESTORE_FOLDER";

package/dist/esm/models/search-by-audit-log-request.js

@@ -33,6 +33,7 @@ export const SearchByAuditLogRequestActionEnum = {
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',
+    OpenDocument: 'OPEN_DOCUMENT',
     DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
     RestoreFile: 'RESTORE_FILE',
     RestoreFolder: 'RESTORE_FOLDER',

package/dist/esm/models/settings.d.ts

@@ -41,4 +41,7 @@ export interface Settings {
     'mcpMode'?: string;
     'mcpAuthorizationServerUrl'?: string;
     'mcpClientId'?: string;
+    'extensions'?: {
+        [key: string]: any;
+    };
 }

package/dist/esm/models/sync-backfill-status.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export interface SyncBackfillStatus {
+    'status'?: string;
+    'startedAt'?: string;
+    'finishedAt'?: string;
+    'files'?: number;
+    'sizesCorrected'?: number;
+    'hashesAdded'?: number;
+    'failures'?: number;
+    'lastError'?: string;
+}