@openfilz-sdk/typescript-ee 1.10.4 → 1.10.5

package/dist/models/unzip-response.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { UnzipSkippedEntry } from './unzip-skipped-entry';
+export interface UnzipResponse {
+    /**
+     * Folder the archive was extracted into (null = root).
+     */
+    'targetFolderId'?: string;
+    /**
+     * Id of the folder created from newFolderName, if any.
+     */
+    'createdFolderId'?: string;
+    /**
+     * Number of folders created.
+     */
+    'foldersCreated'?: number;
+    /**
+     * Number of files extracted.
+     */
+    'filesExtracted'?: number;
+    /**
+     * Entries that were not extracted, with the reason.
+     */
+    'skipped'?: Array<UnzipSkippedEntry>;
+}

package/dist/models/unzip-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/unzip-skipped-entry.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 UnzipSkippedEntry {
+    /**
+     * Path of the entry inside the archive.
+     */
+    'path'?: string;
+    /**
+     * Why it was skipped.
+     */
+    'reason'?: UnzipSkippedEntryReasonEnum;
+    /**
+     * Details, when available.
+     */
+    'message'?: string;
+}
+export declare const UnzipSkippedEntryReasonEnum: {
+    readonly DuplicateName: "DUPLICATE_NAME";
+    readonly UnsafePath: "UNSAFE_PATH";
+    readonly Unsupported: "UNSUPPORTED";
+    readonly FileTooLarge: "FILE_TOO_LARGE";
+    readonly ParentNotCreated: "PARENT_NOT_CREATED";
+    readonly Error: "ERROR";
+};
+export type UnzipSkippedEntryReasonEnum = typeof UnzipSkippedEntryReasonEnum[keyof typeof UnzipSkippedEntryReasonEnum];

package/dist/models/unzip-skipped-entry.js

@@ -0,0 +1,24 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnzipSkippedEntryReasonEnum = void 0;
+exports.UnzipSkippedEntryReasonEnum = {
+    DuplicateName: 'DUPLICATE_NAME',
+    UnsafePath: 'UNSAFE_PATH',
+    Unsupported: 'UNSUPPORTED',
+    FileTooLarge: 'FILE_TOO_LARGE',
+    ParentNotCreated: 'PARENT_NOT_CREATED',
+    Error: 'ERROR',
+};

package/docs/CopyRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **documentIds** | **Array<string>** | List of document IDs (files or folders) to copy. | [optional] [default to undefined]
 **targetFolderId** | **string** | ID of the target folder. | [optional] [default to undefined]
-**allowDuplicateFileNames** | **boolean** | 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) | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** | 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. | [optional] [default to undefined]
 
 ## Example
 

package/docs/DesktopSyncAdministrationApi.md

@@ -0,0 +1,96 @@
+# DesktopSyncAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**start1**](#start1) | **POST** /api/v1/admin/sync/backfill | Run the backfill again over every file|
+|[**status**](#status) | **GET** /api/v1/admin/sync/backfill | Progress of the size and hash backfill|
+
+# **start1**
+> SyncBackfillStatus start1()
+
+202 with the status once started in the background; 409 while a run is in progress.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.start1();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SyncBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **status**
+> SyncBackfillStatus status()
+
+
+### Example
+
+```typescript
+import {
+    DesktopSyncAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.status();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SyncBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/DesktopSyncApi.md

@@ -0,0 +1,376 @@
+# DesktopSyncApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**changes**](#changes) | **GET** /api/v1/sync/changes | Documents that changed since a cursor, as the caller sees them now|
+|[**content**](#content) | **GET** /api/v1/sync/content/{documentId} | Download a file; its ETag is the SHA-256 of the content|
+|[**discover**](#discover) | **GET** /.well-known/openfilz-desktop | Connection details for the desktop application (public)|
+|[**forWebApplication**](#forwebapplication) | **GET** /api/v1/settings/desktop-sync | Where to get the desktop application, and the address to give it|
+|[**items**](#items) | **GET** /api/v1/sync/items | Current state of the given documents, as the caller sees them|
+|[**replaceContent**](#replacecontent) | **PUT** /api/v1/sync/content/{documentId} | Replace a file\'s content, only if it is still the content the edit was based on|
+|[**snapshot**](#snapshot) | **GET** /api/v1/sync/snapshot | One page of a folder\'s children; without folderId, the caller\'s root|
+
+# **changes**
+> SyncChangesResponse changes()
+
+Without a cursor: no items, only the cursor of the present moment. An item is either the document\'s current state or {gone: true}. Call again while hasMore is true.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+let cursor: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.changes(
+    cursor,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SyncChangesResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **content**
+> File content()
+
+If-None-Match with the hash the client already holds answers 304 without a body.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+let documentId: string; // (default to undefined)
+let ifNoneMatch: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.content(
+    documentId,
+    ifNoneMatch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+| **ifNoneMatch** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **discover**
+> DesktopSyncClientInfo discover()
+
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+const { status, data } = await apiInstance.discover();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**DesktopSyncClientInfo**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **forWebApplication**
+> DesktopSyncClientInfo forWebApplication()
+
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+const { status, data } = await apiInstance.forWebApplication();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**DesktopSyncClientInfo**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **items**
+> Array<SyncItem> items()
+
+What /changes would answer for these ids: a client asks after its own upload, or to settle a conflict. Ids the caller cannot see come back as {gone: true}. At most 200 ids.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+let ids: Array<string>; // (default to undefined)
+
+const { status, data } = await apiInstance.items(
+    ids
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ids** | **Array&lt;string&gt;** |  | defaults to undefined|
+
+
+### Return type
+
+**Array<SyncItem>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **replaceContent**
+> SyncItem replaceContent()
+
+If-Match carries the SHA-256 the client last saw. 412 = the content changed on the server in the meantime: keep both. 428 = no If-Match. Answers the document\'s new state.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+let documentId: string; // (default to undefined)
+let file: File; // (default to undefined)
+let ifMatch: string; // (optional) (default to undefined)
+let contentLength: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.replaceContent(
+    documentId,
+    file,
+    ifMatch,
+    contentLength
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+| **file** | [**File**] |  | defaults to undefined|
+| **ifMatch** | [**string**] |  | (optional) defaults to undefined|
+| **contentLength** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SyncItem**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **snapshot**
+> SyncSnapshotResponse snapshot()
+
+The root holds the caller\'s own top-level items and the entry point of everything shared with them. Keep the cursor of the first page and start /changes from it.
+
+### Example
+
+```typescript
+import {
+    DesktopSyncApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DesktopSyncApi(configuration);
+
+let folderId: string; // (optional) (default to undefined)
+let after: string; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.snapshot(
+    folderId,
+    after,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | [**string**] |  | (optional) defaults to undefined|
+| **after** | [**string**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SyncSnapshotResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/DesktopSyncClientInfo.md

@@ -0,0 +1,32 @@
+# DesktopSyncClientInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**server** | **string** |  | [optional] [default to undefined]
+**issuer** | **string** |  | [optional] [default to undefined]
+**clientId** | **string** |  | [optional] [default to undefined]
+**updateUrl** | **string** |  | [optional] [default to undefined]
+**downloadUrl** | **string** |  | [optional] [default to undefined]
+**webUrl** | **string** |  | [optional] [default to undefined]
+**apiVersion** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DesktopSyncClientInfo } from '@openfilz-sdk/typescript-ee';
+
+const instance: DesktopSyncClientInfo = {
+    server,
+    issuer,
+    clientId,
+    updateUrl,
+    downloadUrl,
+    webUrl,
+    apiVersion,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DocumentControllerApi.md

@@ -787,7 +787,7 @@ const configuration = new Configuration();
 const apiInstance = new DocumentControllerApi(configuration);
 
 let file: Array<File>; // (default to undefined)
-let allowDuplicateFileNames: boolean; //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) (optional) (default to false)
+let allowDuplicateFileNames: boolean; //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. (optional) (default to false)
 let autoFile: boolean; //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 = the user\'s own switch. Needs openfilz.ai.auto-file.active. (optional) (default to undefined)
 let parametersByFilename: string; //Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section>  <h3>Each object in the array must contain:</h3>    <table>     <thead>       <tr>         <th>Field</th>         <th>Type</th>         <th>Description</th>       </tr>     </thead>     <tbody>       <tr>         <td><code>filename</code></td>         <td><code>String</code></td>         <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td>       </tr>       <tr>         <td><code>fileAttributes</code></td>         <td><code>JSON Object</code></td>         <td>Container for metadata and other file-specific attributes.</td>       </tr>     </tbody>   </table>    <h4>Inside <code>fileAttributes</code>:</h4>   <table>     <thead>       <tr>         <th>Field</th>         <th>Type</th>         <th>Description</th>       </tr>     </thead>     <tbody>       <tr>         <td><code>parentFolderId</code></td>         <td><code>UUID</code></td>         <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td>       </tr>       <tr>         <td><code>metadata</code></td>         <td><code>Map&lt;String, JSON Object&gt;</code></td>         <td>Arbitrary metadata to associate with the file (key/value pairs).</td>       </tr>     </tbody>   </table>    <h4>Example of <code>parametersByFilename</code> JSON array :</h4>   <pre><code>[   {     \\\"filename\\\": \\\"file1.txt\\\",     \\\"fileAttributes\\\": {       \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\",       \\\"metadata\\\": {         \\\"country\\\": \\\"UK\\\",         \\\"owner\\\": {           \\\"name\\\": \\\"Joe\\\",           \\\"owner_id\\\": 1234568         }       }     }   },   {     \\\"filename\\\": \\\"file2.md\\\",     \\\"fileAttributes\\\": {       \\\"metadata\\\": {         \\\"key1\\\": \\\"value1\\\",         \\\"key2\\\": \\\"value2\\\",         \\\"key3\\\": \\\"value3\\\"       }     }   } ]</code></pre> </section> (optional) (default to undefined)
 
@@ -804,7 +804,7 @@ const { status, data } = await apiInstance.uploadDocument(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **file** | **Array&lt;File&gt;** |  | defaults to undefined|
-| **allowDuplicateFileNames** | [**boolean**] | 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) | (optional) defaults to false|
+| **allowDuplicateFileNames** | [**boolean**] | 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. | (optional) defaults to false|
 | **autoFile** | [**boolean**] | 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. | (optional) defaults to undefined|
 | **parametersByFilename** | [**string**] | 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; | (optional) defaults to undefined|
 
@@ -847,7 +847,7 @@ const configuration = new Configuration();
 const apiInstance = new DocumentControllerApi(configuration);
 
 let file: File; // (default to undefined)
-let allowDuplicateFileNames: boolean; //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) (optional) (default to false)
+let allowDuplicateFileNames: boolean; //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. (optional) (default to false)
 let autoFile: boolean; //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 = the user\'s own switch. Needs openfilz.ai.auto-file.active. (optional) (default to undefined)
 let parentFolderId: string; //Target parent folder ID to store the file; if not sent or null, the file is stored at the root level (optional) (default to undefined)
 let metadata: string; // (optional) (default to undefined)
@@ -866,7 +866,7 @@ const { status, data } = await apiInstance.uploadDocument1(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **file** | [**File**] |  | defaults to undefined|
-| **allowDuplicateFileNames** | [**boolean**] | 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) | (optional) defaults to false|
+| **allowDuplicateFileNames** | [**boolean**] | 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. | (optional) defaults to false|
 | **autoFile** | [**boolean**] | 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. | (optional) defaults to undefined|
 | **parentFolderId** | [**string**] | Target parent folder ID to store the file; if not sent or null, the file is stored at the root level | (optional) defaults to undefined|
 | **metadata** | [**string**] |  | (optional) defaults to undefined|