@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

package/docs/SmartFilingApi.md

@@ -0,0 +1,264 @@
+# SmartFilingApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**file**](#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand|
+|[**job**](#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job|
+|[**lastFiling**](#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)|
+|[**undo**](#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from|
+|[**undoFiling**](#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\")|
+
+# **file**
+> AutoFileJobView file(autoFileRequest)
+
+Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration,
+    AutoFileRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let autoFileRequest: AutoFileRequest; //
+
+const { status, data } = await apiInstance.file(
+    autoFileRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **autoFileRequest** | **AutoFileRequest**|  | |
+
+
+### Return type
+
+**AutoFileJobView**
+
+### 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)
+
+# **job**
+> AutoFileJobView job()
+
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.job(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AutoFileJobView**
+
+### 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)
+
+# **lastFiling**
+> FilingOutcome lastFiling()
+
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.lastFiling(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FilingOutcome**
+
+### 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)
+
+# **undo**
+> AutoFileJobView undo()
+
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.undo(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AutoFileJobView**
+
+### 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)
+
+# **undoFiling**
+> FilingOutcome undoFiling()
+
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let planId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.undoFiling(
+    planId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FilingOutcome**
+
+### 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/TusFinalizeRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **parentFolderId** | **string** |  | [optional] [default to undefined]
 **metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
 **allowDuplicateFileNames** | **boolean** |  | [optional] [default to undefined]
+**autoFile** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: TusFinalizeRequest = {
     parentFolderId,
     metadata,
     allowDuplicateFileNames,
+    autoFile,
 };
 ```
 

package/docs/UploadResponse.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **size** | **number** |  | [optional] [default to undefined]
 **errorType** | **string** |  | [optional] [default to undefined]
 **errorMessage** | **string** |  | [optional] [default to undefined]
+**autoFile** | [**AutoFileTicket**](AutoFileTicket.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -24,6 +25,7 @@ const instance: UploadResponse = {
     size,
     errorType,
     errorMessage,
+    autoFile,
 };
 ```
 

package/models/ai-preferences-view.ts

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

package/models/auto-file-job-view.ts

@@ -0,0 +1,33 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { FilingOutcome } from './filing-outcome';
+
+export interface AutoFileJobView {
+    'jobId'?: string;
+    'createdBy'?: string;
+    'status'?: string;
+    'total'?: number;
+    'filed'?: number;
+    'skipped'?: number;
+    'failed'?: number;
+    'pending'?: number;
+    'items'?: Array<FilingOutcome>;
+    'createdAt'?: string;
+    'finishedAt'?: string;
+}
+

package/models/auto-file-request.ts

@@ -0,0 +1,21 @@
+/* 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 interface AutoFileRequest {
+    'documentIds'?: Array<string>;
+    'allowNewFolders'?: boolean;
+}
+

package/models/auto-file-ticket.ts

@@ -0,0 +1,21 @@
+/* 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 interface AutoFileTicket {
+    'jobId'?: string;
+    'status'?: string;
+}
+

package/models/document-insight-view.ts

@@ -0,0 +1,37 @@
+/* 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 interface DocumentInsightView {
+    'documentId'?: string;
+    'fileTitle'?: string;
+    'fileAuthor'?: string;
+    'fileCreatedAt'?: string;
+    'fileModifiedAt'?: string;
+    'pageCount'?: number;
+    'language'?: string;
+    'category'?: string;
+    'summary'?: string;
+    'keywords'?: Array<string>;
+    'entities'?: { [key: string]: any; };
+    'tier'?: number;
+    'model'?: string;
+    'promptVersion'?: number;
+    'status'?: string;
+    'error'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+}
+

package/models/filing-outcome.ts

@@ -0,0 +1,31 @@
+/* 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 interface FilingOutcome {
+    'documentId'?: string;
+    'name'?: string;
+    'status'?: string;
+    'fromFolderId'?: string;
+    'fromPath'?: string;
+    'toFolderId'?: string;
+    'toPath'?: string;
+    'stage'?: string;
+    'confidence'?: number;
+    'reason'?: string;
+    'planId'?: string;
+    'decidedAt'?: string;
+}
+

package/models/index.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,14 @@ 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 './insight-category-update';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
@@ -76,6 +85,7 @@ export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
 export * from './reorganization-apply-result';
+export * from './reorganization-by-kind-request';
 export * from './reorganization-plan-view';
 export * from './replace-audit';
 export * from './response';
@@ -83,6 +93,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/models/insight-backfill-request.ts

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

package/models/insight-backfill-status.ts

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

package/models/insight-category-update.ts

@@ -0,0 +1,20 @@
+/* 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 interface InsightCategoryUpdate {
+    'category'?: string;
+}
+

package/models/reorganization-by-kind-request.ts

@@ -0,0 +1,20 @@
+/* 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 interface ReorganizationByKindRequest {
+    'rootFolderId'?: string;
+}
+

package/models/save-ai-preferences-request.ts

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

package/models/settings.ts

@@ -23,6 +23,9 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
+    'aiInsightsActive'?: boolean;
+    'aiInsightsCategories'?: Array<string>;
+    'aiAutoFileActive'?: boolean;
     'signatureActive'?: boolean;
     'pdfToolsActive'?: boolean;
     'signatureRequesterRoleRequired'?: boolean;

package/models/tus-finalize-request.ts

@@ -19,5 +19,6 @@ export interface TusFinalizeRequest {
     'parentFolderId'?: string;
     'metadata'?: { [key: string]: any; };
     'allowDuplicateFileNames'?: boolean;
+    'autoFile'?: boolean;
 }
 

package/models/upload-response.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AutoFileTicket } from './auto-file-ticket';
 
 export interface UploadResponse {
     'id'?: string;
@@ -21,5 +24,6 @@ export interface UploadResponse {
     'size'?: number;
     'errorType'?: string;
     'errorMessage'?: string;
+    'autoFile'?: AutoFileTicket;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript-ee",
-  "version": "1.9.6",
+  "version": "1.9.8",
   "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
   "author": "OpenAPI-Generator Contributors",
   "repository": {