@openfilz-sdk/typescript-ee 1.9.5 → 1.9.7

package/docs/AutoFileJobView.md

@@ -0,0 +1,40 @@
+# AutoFileJobView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**filed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**pending** | **number** |  | [optional] [default to undefined]
+**items** | [**Array<FilingOutcome>**](FilingOutcome.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoFileJobView } from '@openfilz-sdk/typescript-ee';
+
+const instance: AutoFileJobView = {
+    jobId,
+    createdBy,
+    status,
+    total,
+    filed,
+    skipped,
+    failed,
+    pending,
+    items,
+    createdAt,
+    finishedAt,
+};
+```
+
+[[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/AutoFileRequest.md

@@ -0,0 +1,22 @@
+# AutoFileRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** |  | [optional] [default to undefined]
+**allowNewFolders** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoFileRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: AutoFileRequest = {
+    documentIds,
+    allowNewFolders,
+};
+```
+
+[[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/AutoFileTicket.md

@@ -0,0 +1,22 @@
+# AutoFileTicket
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoFileTicket } from '@openfilz-sdk/typescript-ee';
+
+const instance: AutoFileTicket = {
+    jobId,
+    status,
+};
+```
+
+[[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

@@ -736,11 +736,13 @@ 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 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)
 
 const { status, data } = await apiInstance.uploadDocument(
     file,
     allowDuplicateFileNames,
+    autoFile,
     parametersByFilename
 );
 ```
@@ -751,6 +753,7 @@ const { status, data } = await apiInstance.uploadDocument(
 |------------- | ------------- | ------------- | -------------|
 | **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|
+| **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|
 
 
@@ -793,12 +796,14 @@ 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 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)
 
 const { status, data } = await apiInstance.uploadDocument1(
     file,
     allowDuplicateFileNames,
+    autoFile,
     parentFolderId,
     metadata
 );
@@ -810,6 +815,7 @@ const { status, data } = await apiInstance.uploadDocument1(
 |------------- | ------------- | ------------- | -------------|
 | **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|
+| **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|
 

package/docs/DocumentInsightView.md

@@ -0,0 +1,54 @@
+# DocumentInsightView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**fileTitle** | **string** |  | [optional] [default to undefined]
+**fileAuthor** | **string** |  | [optional] [default to undefined]
+**fileCreatedAt** | **string** |  | [optional] [default to undefined]
+**fileModifiedAt** | **string** |  | [optional] [default to undefined]
+**pageCount** | **number** |  | [optional] [default to undefined]
+**language** | **string** |  | [optional] [default to undefined]
+**category** | **string** |  | [optional] [default to undefined]
+**summary** | **string** |  | [optional] [default to undefined]
+**keywords** | **Array<string>** |  | [optional] [default to undefined]
+**entities** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**tier** | **number** |  | [optional] [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**promptVersion** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentInsightView } from '@openfilz-sdk/typescript-ee';
+
+const instance: DocumentInsightView = {
+    documentId,
+    fileTitle,
+    fileAuthor,
+    fileCreatedAt,
+    fileModifiedAt,
+    pageCount,
+    language,
+    category,
+    summary,
+    keywords,
+    entities,
+    tier,
+    model,
+    promptVersion,
+    status,
+    error,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/DocumentInsightsApi.md

@@ -0,0 +1,163 @@
+# DocumentInsightsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**backfill**](#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents|
+|[**backfillStatus**](#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job|
+|[**getInsights**](#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document|
+
+# **backfill**
+> InsightBackfillStatus backfill()
+
+Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration,
+    InsightBackfillRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+let insightBackfillRequest: InsightBackfillRequest; // (optional)
+
+const { status, data } = await apiInstance.backfill(
+    insightBackfillRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **insightBackfillRequest** | **InsightBackfillRequest**|  | |
+
+
+### Return type
+
+**InsightBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### 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)
+
+# **backfillStatus**
+> InsightBackfillStatus backfillStatus()
+
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.backfillStatus(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**InsightBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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)
+
+# **getInsights**
+> DocumentInsightView getInsights()
+
+Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getInsights(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DocumentInsightView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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/ESignApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:8081*
 |[**cloudSubscription**](#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)|
 |[**create**](#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)|
 |[**events**](#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes|
-|[**get2**](#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)|
+|[**get3**](#get3) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)|
 |[**listSent**](#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature|
 |[**listToSign**](#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature|
 |[**resend**](#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked)|
@@ -209,8 +209,8 @@ const { status, data } = await apiInstance.events(
 
 [[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)
 
-# **get2**
-> SignatureEnvelopeDTO get2()
+# **get3**
+> SignatureEnvelopeDTO get3()
 
 
 ### Example
@@ -226,7 +226,7 @@ const apiInstance = new ESignApi(configuration);
 
 let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.get2(
+const { status, data } = await apiInstance.get3(
     id
 );
 ```

package/docs/FilingOutcome.md

@@ -0,0 +1,42 @@
+# FilingOutcome
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**fromFolderId** | **string** |  | [optional] [default to undefined]
+**fromPath** | **string** |  | [optional] [default to undefined]
+**toFolderId** | **string** |  | [optional] [default to undefined]
+**toPath** | **string** |  | [optional] [default to undefined]
+**stage** | **string** |  | [optional] [default to undefined]
+**confidence** | **number** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+**planId** | **string** |  | [optional] [default to undefined]
+**decidedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilingOutcome } from '@openfilz-sdk/typescript-ee';
+
+const instance: FilingOutcome = {
+    documentId,
+    name,
+    status,
+    fromFolderId,
+    fromPath,
+    toFolderId,
+    toPath,
+    stage,
+    confidence,
+    reason,
+    planId,
+    decidedAt,
+};
+```
+
+[[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/InsightBackfillRequest.md

@@ -0,0 +1,22 @@
+# InsightBackfillRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folderId** | **string** |  | [optional] [default to undefined]
+**force** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InsightBackfillRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: InsightBackfillRequest = {
+    folderId,
+    force,
+};
+```
+
+[[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/InsightBackfillStatus.md

@@ -0,0 +1,38 @@
+# InsightBackfillStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**folderId** | **string** |  | [optional] [default to undefined]
+**force** | **boolean** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**done** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InsightBackfillStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: InsightBackfillStatus = {
+    jobId,
+    folderId,
+    force,
+    status,
+    total,
+    done,
+    failed,
+    skipped,
+    startedAt,
+    finishedAt,
+};
+```
+
+[[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/Item.md

@@ -0,0 +1,34 @@
+# Item
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**currentPath** | **string** |  | [optional] [default to undefined]
+**targetPath** | **string** |  | [optional] [default to undefined]
+**targetExists** | **boolean** |  | [optional] [default to undefined]
+**applicable** | **boolean** |  | [optional] [default to undefined]
+**issue** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Item } from '@openfilz-sdk/typescript-ee';
+
+const instance: Item = {
+    documentId,
+    name,
+    type,
+    currentPath,
+    targetPath,
+    targetExists,
+    applicable,
+    issue,
+};
+```
+
+[[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/ItemResult.md

@@ -0,0 +1,24 @@
+# ItemResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**outcome** | **string** |  | [optional] [default to undefined]
+**detail** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ItemResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: ItemResult = {
+    documentId,
+    outcome,
+    detail,
+};
+```
+
+[[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/ReorganizationApplyRequest.md

@@ -0,0 +1,20 @@
+# ReorganizationApplyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemIds** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReorganizationApplyRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReorganizationApplyRequest = {
+    itemIds,
+};
+```
+
+[[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/ReorganizationApplyResult.md

@@ -0,0 +1,34 @@
+# ReorganizationApplyResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**planId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**moved** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**createdFolders** | **Array<string>** |  | [optional] [default to undefined]
+**modifiedFolderIds** | **Array<string>** |  | [optional] [default to undefined]
+**plan** | [**ReorganizationPlanView**](ReorganizationPlanView.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReorganizationApplyResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReorganizationApplyResult = {
+    planId,
+    status,
+    moved,
+    failed,
+    skipped,
+    createdFolders,
+    modifiedFolderIds,
+    plan,
+};
+```
+
+[[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/ReorganizationPlanView.md

@@ -0,0 +1,44 @@
+# ReorganizationPlanView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**rootFolderId** | **string** |  | [optional] [default to undefined]
+**rootFolderPath** | **string** |  | [optional] [default to undefined]
+**rationale** | **string** |  | [optional] [default to undefined]
+**items** | [**Array<Item>**](Item.md) |  | [optional] [default to undefined]
+**foldersToCreate** | **Array<string>** |  | [optional] [default to undefined]
+**applicable** | **number** |  | [optional] [default to undefined]
+**blocked** | **number** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**appliedAt** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<ItemResult>**](ItemResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReorganizationPlanView } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReorganizationPlanView = {
+    id,
+    status,
+    rootFolderId,
+    rootFolderPath,
+    rationale,
+    items,
+    foldersToCreate,
+    applicable,
+    blocked,
+    createdBy,
+    createdAt,
+    appliedAt,
+    results,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)