@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

package/docs/DocumentInsightsApi.md

@@ -0,0 +1,219 @@
+# 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|
+|[**setCategory**](#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind 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)
+
+# **setCategory**
+> DocumentInsightView setCategory(insightCategoryUpdate)
+
+Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration,
+    InsightCategoryUpdate
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+let documentId: string; // (default to undefined)
+let insightCategoryUpdate: InsightCategoryUpdate; //
+
+const { status, data } = await apiInstance.setCategory(
+    documentId,
+    insightCategoryUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **insightCategoryUpdate** | **InsightCategoryUpdate**|  | |
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DocumentInsightView**
+
+### 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)
+

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/InsightCategoryUpdate.md

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

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

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

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
 **aiActive** | **boolean** |  | [optional] [default to undefined]
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
+**aiInsightsActive** | **boolean** |  | [optional] [default to undefined]
+**aiInsightsCategories** | **Array<string>** |  | [optional] [default to undefined]
+**aiAutoFileActive** | **boolean** |  | [optional] [default to undefined]
 **signatureActive** | **boolean** |  | [optional] [default to undefined]
 **pdfToolsActive** | **boolean** |  | [optional] [default to undefined]
 **signatureRequesterRoleRequired** | **boolean** |  | [optional] [default to undefined]
@@ -41,6 +44,9 @@ const instance: Settings = {
     thumbnailsActive,
     aiActive,
     aiUserSettingsEnabled,
+    aiInsightsActive,
+    aiInsightsCategories,
+    aiAutoFileActive,
     signatureActive,
     pdfToolsActive,
     signatureRequesterRoleRequired,

package/docs/SettingsApi.md

@@ -4,10 +4,55 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**get2**](#get2) | **GET** /api/v1/settings/ai/preferences | The caller\'s smart-filing preferences|
 |[**getLicenseInfo**](#getlicenseinfo) | **GET** /api/v1/settings/license | Coarse license info|
 |[**getSettings**](#getsettings) | **GET** /api/v1/settings | Get user\'s settings|
+|[**save**](#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences|
 |[**saveSettings**](#savesettings) | **PUT** /api/v1/settings | Save user preferences|
 
+# **get2**
+> AiPreferencesView get2()
+
+
+### Example
+
+```typescript
+import {
+    SettingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SettingsApi(configuration);
+
+const { status, data } = await apiInstance.get2();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiPreferencesView**
+
+### 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)
+
 # **getLicenseInfo**
 > LicenseInfo getLicenseInfo()
 
@@ -89,6 +134,58 @@ This endpoint does not have any parameters.
  - **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)
+
+# **save**
+> AiPreferencesView save(saveAiPreferencesRequest)
+
+A null field leaves the current value unchanged.
+
+### Example
+
+```typescript
+import {
+    SettingsApi,
+    Configuration,
+    SaveAiPreferencesRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SettingsApi(configuration);
+
+let saveAiPreferencesRequest: SaveAiPreferencesRequest; //
+
+const { status, data } = await apiInstance.save(
+    saveAiPreferencesRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveAiPreferencesRequest** | **SaveAiPreferencesRequest**|  | |
+
+
+### Return type
+
+**AiPreferencesView**
+
+### 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 |
 |-------------|-------------|------------------|