@openfilz-sdk/typescript-ee 1.9.6 → 1.9.7

package/dist/models/index.d.ts

@@ -3,11 +3,15 @@ export * from './ai-chat-request';
 export * from './ai-chat-response';
 export * from './ai-connection-test-result';
 export * from './ai-models-response';
+export * from './ai-preferences-view';
 export * from './ai-settings-response';
 export * from './ancestor-info';
 export * from './apply-signature-request';
 export * from './audit-log-details';
 export * from './audit-verification-result';
+export * from './auto-file-job-view';
+export * from './auto-file-request';
+export * from './auto-file-ticket';
 export * from './broken-link';
 export * from './bulk-row';
 export * from './bulk-row-result';
@@ -36,6 +40,7 @@ export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './delete-share-request';
 export * from './document-info';
+export * from './document-insight-view';
 export * from './document-position';
 export * from './document-version-info';
 export * from './element-info';
@@ -44,10 +49,13 @@ export * from './enriched-audit-log';
 export * from './enriched-audit-log-details';
 export * from './feature-entitlement';
 export * from './file-type-stats';
+export * from './filing-outcome';
 export * from './filter-input';
 export * from './folder-element-info';
 export * from './folder-response';
 export * from './ingestion-status-dto';
+export * from './insight-backfill-request';
+export * from './insight-backfill-status';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
@@ -83,6 +91,7 @@ export * from './restore-version-audit';
 export * from './restore-version-response';
 export * from './role-binding';
 export * from './rotate-request';
+export * from './save-ai-preferences-request';
 export * from './save-ai-settings-request';
 export * from './scan-job-status-dto';
 export * from './scan-request-dto';

package/dist/models/index.js

@@ -19,11 +19,15 @@ __exportStar(require("./ai-chat-request"), exports);
 __exportStar(require("./ai-chat-response"), exports);
 __exportStar(require("./ai-connection-test-result"), exports);
 __exportStar(require("./ai-models-response"), exports);
+__exportStar(require("./ai-preferences-view"), exports);
 __exportStar(require("./ai-settings-response"), exports);
 __exportStar(require("./ancestor-info"), exports);
 __exportStar(require("./apply-signature-request"), exports);
 __exportStar(require("./audit-log-details"), exports);
 __exportStar(require("./audit-verification-result"), exports);
+__exportStar(require("./auto-file-job-view"), exports);
+__exportStar(require("./auto-file-request"), exports);
+__exportStar(require("./auto-file-ticket"), exports);
 __exportStar(require("./broken-link"), exports);
 __exportStar(require("./bulk-row"), exports);
 __exportStar(require("./bulk-row-result"), exports);
@@ -52,6 +56,7 @@ __exportStar(require("./delete-metadata-request"), exports);
 __exportStar(require("./delete-request"), exports);
 __exportStar(require("./delete-share-request"), exports);
 __exportStar(require("./document-info"), exports);
+__exportStar(require("./document-insight-view"), exports);
 __exportStar(require("./document-position"), exports);
 __exportStar(require("./document-version-info"), exports);
 __exportStar(require("./element-info"), exports);
@@ -60,10 +65,13 @@ __exportStar(require("./enriched-audit-log"), exports);
 __exportStar(require("./enriched-audit-log-details"), exports);
 __exportStar(require("./feature-entitlement"), exports);
 __exportStar(require("./file-type-stats"), exports);
+__exportStar(require("./filing-outcome"), exports);
 __exportStar(require("./filter-input"), exports);
 __exportStar(require("./folder-element-info"), exports);
 __exportStar(require("./folder-response"), exports);
 __exportStar(require("./ingestion-status-dto"), exports);
+__exportStar(require("./insight-backfill-request"), exports);
+__exportStar(require("./insight-backfill-status"), exports);
 __exportStar(require("./instantiate-template-request"), exports);
 __exportStar(require("./item"), exports);
 __exportStar(require("./item-result"), exports);
@@ -99,6 +107,7 @@ __exportStar(require("./restore-version-audit"), exports);
 __exportStar(require("./restore-version-response"), exports);
 __exportStar(require("./role-binding"), exports);
 __exportStar(require("./rotate-request"), exports);
+__exportStar(require("./save-ai-preferences-request"), exports);
 __exportStar(require("./save-ai-settings-request"), exports);
 __exportStar(require("./scan-job-status-dto"), exports);
 __exportStar(require("./scan-request-dto"), exports);

package/dist/models/insight-backfill-request.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 InsightBackfillRequest {
+    'folderId'?: string;
+    'force'?: boolean;
+}

package/dist/models/insight-backfill-request.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/insight-backfill-status.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 InsightBackfillStatus {
+    'jobId'?: string;
+    'folderId'?: string;
+    'force'?: boolean;
+    'status'?: string;
+    'total'?: number;
+    'done'?: number;
+    'failed'?: number;
+    'skipped'?: number;
+    'startedAt'?: string;
+    'finishedAt'?: string;
+}

package/dist/models/insight-backfill-status.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/save-ai-preferences-request.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 SaveAiPreferencesRequest {
+    'autoFile'?: boolean;
+    'autoFileNewFolders'?: boolean;
+}

package/dist/models/save-ai-preferences-request.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/settings.d.ts

@@ -18,6 +18,8 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
+    'aiInsightsActive'?: boolean;
+    'aiAutoFileActive'?: boolean;
     'signatureActive'?: boolean;
     'pdfToolsActive'?: boolean;
     'signatureRequesterRoleRequired'?: boolean;

package/dist/models/tus-finalize-request.d.ts

@@ -16,4 +16,5 @@ export interface TusFinalizeRequest {
         [key: string]: any;
     };
     'allowDuplicateFileNames'?: boolean;
+    'autoFile'?: boolean;
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { AutoFileTicket } from './auto-file-ticket';
 export interface UploadResponse {
     'id'?: string;
     'name'?: string;
@@ -16,4 +17,5 @@ export interface UploadResponse {
     'size'?: number;
     'errorType'?: string;
     'errorMessage'?: string;
+    'autoFile'?: AutoFileTicket;
 }

package/docs/AIChatApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:8081*
 |[**chat**](#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant|
 |[**deleteConversation**](#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation|
 |[**discard**](#discard) | **POST** /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan|
-|[**get3**](#get3) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
+|[**get4**](#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
 |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
 |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
 
@@ -220,8 +220,8 @@ const { status, data } = await apiInstance.discard(
 
 [[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)
 
-# **get3**
-> ReorganizationPlanView get3()
+# **get4**
+> ReorganizationPlanView get4()
 
 The plan\'s items (what moves where), which are applicable, and its status.
 
@@ -238,7 +238,7 @@ const apiInstance = new AIChatApi(configuration);
 
 let planId: string; // (default to undefined)
 
-const { status, data } = await apiInstance.get3(
+const { status, data } = await apiInstance.get4(
     planId
 );
 ```

package/docs/AiPreferencesView.md

@@ -0,0 +1,24 @@
+# AiPreferencesView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**autoFileAvailable** | **boolean** |  | [optional] [default to undefined]
+**autoFile** | **boolean** |  | [optional] [default to undefined]
+**autoFileNewFolders** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiPreferencesView } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiPreferencesView = {
+    autoFileAvailable,
+    autoFile,
+    autoFileNewFolders,
+};
+```
+
+[[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/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)
+