@openfilz-sdk/typescript 1.3.19 → 1.3.20

package/dist/models/auto-file-inbox-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/facet.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 Facet {
+    'key'?: string;
+    'count'?: number;
+}

package/dist/models/facet.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/index.d.ts

@@ -11,6 +11,7 @@ export * from './audit-log';
 export * from './audit-log-details';
 export * from './audit-log-details-one-of';
 export * from './audit-verification-result';
+export * from './auto-file-inbox-request';
 export * from './auto-file-job-view';
 export * from './auto-file-jobs-request';
 export * from './auto-file-request';
@@ -39,6 +40,7 @@ export * from './document-version-info';
 export * from './element-info';
 export * from './embedding-backfill-request';
 export * from './embedding-backfill-status';
+export * from './facet';
 export * from './file-type-stats';
 export * from './filing-outcome';
 export * from './filter-input';
@@ -47,6 +49,7 @@ export * from './folder-response';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
 export * from './insight-category-update';
+export * from './insight-facets';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';

package/dist/models/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./audit-log"), exports);
 __exportStar(require("./audit-log-details"), exports);
 __exportStar(require("./audit-log-details-one-of"), exports);
 __exportStar(require("./audit-verification-result"), exports);
+__exportStar(require("./auto-file-inbox-request"), exports);
 __exportStar(require("./auto-file-job-view"), exports);
 __exportStar(require("./auto-file-jobs-request"), exports);
 __exportStar(require("./auto-file-request"), exports);
@@ -55,6 +56,7 @@ __exportStar(require("./document-version-info"), exports);
 __exportStar(require("./element-info"), exports);
 __exportStar(require("./embedding-backfill-request"), exports);
 __exportStar(require("./embedding-backfill-status"), exports);
+__exportStar(require("./facet"), exports);
 __exportStar(require("./file-type-stats"), exports);
 __exportStar(require("./filing-outcome"), exports);
 __exportStar(require("./filter-input"), exports);
@@ -63,6 +65,7 @@ __exportStar(require("./folder-response"), exports);
 __exportStar(require("./insight-backfill-request"), exports);
 __exportStar(require("./insight-backfill-status"), exports);
 __exportStar(require("./insight-category-update"), exports);
+__exportStar(require("./insight-facets"), exports);
 __exportStar(require("./instantiate-template-request"), exports);
 __exportStar(require("./item"), exports);
 __exportStar(require("./item-result"), exports);

package/dist/models/insight-facets.d.ts

@@ -0,0 +1,16 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Facet } from './facet';
+export interface InsightFacets {
+    'categories'?: Array<Facet>;
+    'languages'?: Array<Facet>;
+}

package/dist/models/insight-facets.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

@@ -12,4 +12,5 @@
 export interface SaveAiPreferencesRequest {
     'autoFile'?: boolean;
     'autoFileNewFolders'?: boolean;
+    'inbox'?: boolean;
 }

package/dist/models/settings.d.ts

@@ -18,6 +18,7 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiChatActive'?: boolean;
+    'aiChatUnavailableReason'?: string;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
     'aiInsightsCategories'?: Array<string>;

package/docs/AiPreferencesView.md

@@ -8,6 +8,9 @@ Name | Type | Description | Notes
 **autoFileAvailable** | **boolean** |  | [optional] [default to undefined]
 **autoFile** | **boolean** |  | [optional] [default to undefined]
 **autoFileNewFolders** | **boolean** |  | [optional] [default to undefined]
+**inboxAvailable** | **boolean** |  | [optional] [default to undefined]
+**inbox** | **boolean** |  | [optional] [default to undefined]
+**inboxFolderId** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +21,9 @@ const instance: AiPreferencesView = {
     autoFileAvailable,
     autoFile,
     autoFileNewFolders,
+    inboxAvailable,
+    inbox,
+    inboxFolderId,
 };
 ```
 

package/docs/AutoFileInboxRequest.md

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

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8081*
 |------------- | ------------- | -------------|
 |[**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|
+|[**facets**](#facets) | **GET** /api/v1/ai/insights/facets | The category and language facets of the library|
 |[**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|
 
@@ -104,6 +105,50 @@ const { status, data } = await apiInstance.backfillStatus(
  - **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)
+
+# **facets**
+> InsightFacets facets()
+
+How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+const { status, data } = await apiInstance.facets();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**InsightFacets**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -165,7 +210,7 @@ const { status, data } = await apiInstance.getInsights(
 # **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.
+Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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
 

package/docs/Facet.md

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

@@ -0,0 +1,22 @@
+# InsightFacets
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**Array<Facet>**](Facet.md) |  | [optional] [default to undefined]
+**languages** | [**Array<Facet>**](Facet.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InsightFacets } from '@openfilz-sdk/typescript';
+
+const instance: InsightFacets = {
+    categories,
+    languages,
+};
+```
+
+[[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

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **autoFile** | **boolean** |  | [optional] [default to undefined]
 **autoFileNewFolders** | **boolean** |  | [optional] [default to undefined]
+**inbox** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { SaveAiPreferencesRequest } from '@openfilz-sdk/typescript';
 const instance: SaveAiPreferencesRequest = {
     autoFile,
     autoFileNewFolders,
+    inbox,
 };
 ```
 

package/docs/Settings.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
 **aiActive** | **boolean** |  | [optional] [default to undefined]
 **aiChatActive** | **boolean** |  | [optional] [default to undefined]
+**aiChatUnavailableReason** | **string** |  | [optional] [default to undefined]
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsActive** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsCategories** | **Array<string>** |  | [optional] [default to undefined]
@@ -47,6 +48,7 @@ const instance: Settings = {
     thumbnailsActive,
     aiActive,
     aiChatActive,
+    aiChatUnavailableReason,
     aiUserSettingsEnabled,
     aiInsightsActive,
     aiInsightsCategories,

package/docs/SettingsApi.md

@@ -98,7 +98,7 @@ This endpoint does not have any parameters.
 # **save**
 > AiPreferencesView save(saveAiPreferencesRequest)
 
-A null field leaves the current value unchanged.
+A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
 
 ### Example
 
@@ -113,9 +113,11 @@ const configuration = new Configuration();
 const apiInstance = new SettingsApi(configuration);
 
 let saveAiPreferencesRequest: SaveAiPreferencesRequest; //
+let acceptLanguage: string; // (optional) (default to undefined)
 
 const { status, data } = await apiInstance.save(
-    saveAiPreferencesRequest
+    saveAiPreferencesRequest,
+    acceptLanguage
 );
 ```
 
@@ -124,6 +126,7 @@ const { status, data } = await apiInstance.save(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **saveAiPreferencesRequest** | **SaveAiPreferencesRequest**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/SmartFilingApi.md

@@ -5,6 +5,7 @@ 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|
+|[**fileInbox**](#fileinbox) | **POST** /api/v1/ai/auto-file/inbox | File everything lying loose in the caller\'s Inbox|
 |[**job**](#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job|
 |[**jobs**](#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs|
 |[**lastFiling**](#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)|
@@ -42,6 +43,58 @@ const { status, data } = await apiInstance.file(
 | **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)
+
+# **fileInbox**
+> AutoFileJobView fileInbox()
+
+Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration,
+    AutoFileInboxRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let autoFileInboxRequest: AutoFileInboxRequest; // (optional)
+
+const { status, data } = await apiInstance.fileInbox(
+    autoFileInboxRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **autoFileInboxRequest** | **AutoFileInboxRequest**|  | |
+
+
 ### Return type
 
 **AutoFileJobView**

package/graphql/document-search.graphqls

@@ -10,6 +10,10 @@ type DocumentSearchInfo {
     updatedAt: DateTime
     createdBy: String
     updatedBy: String
+    "The AI document insight's category of the file (OpenSearch search path only; null on the database path)"
+    category: String
+    "The document insight's language, BCP-47 primary tag (OpenSearch search path only; null on the database path)"
+    language: String
     contentSnippet: String # return a snippet instead of the full content
     "URL to fetch the thumbnail image, null if not available"
     thumbnailUrl: String

package/graphql/document.graphqls

@@ -79,6 +79,10 @@ input ListFolderRequest {
     recursive : Boolean
     "Keep only the folders the caller may write into (Enterprise: owned, or shared in editor mode). Ignored by the Community Edition, which has no per-document permissions."
     writableOnly : Boolean
+    "Keep only the files whose AI document insight carries one of these categories (the deployment's category keys, e.g. invoice, contract). Needs document insights; a file without an insight row never matches."
+    categories : [String]
+    "Keep only the files whose document insight names one of these languages (BCP-47 primary tags, e.g. fr, en)."
+    languages : [String]
 }
 
 input FavoriteRequest {

package/models/ai-preferences-view.ts

@@ -18,5 +18,8 @@ export interface AiPreferencesView {
     'autoFileAvailable'?: boolean;
     'autoFile'?: boolean;
     'autoFileNewFolders'?: boolean;
+    'inboxAvailable'?: boolean;
+    'inbox'?: boolean;
+    'inboxFolderId'?: string;
 }
 

package/models/auto-file-inbox-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 AutoFileInboxRequest {
+    'allowNewFolders'?: boolean;
+}
+

package/models/facet.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 Facet {
+    'key'?: string;
+    'count'?: number;
+}
+

package/models/index.ts

@@ -11,6 +11,7 @@ export * from './audit-log';
 export * from './audit-log-details';
 export * from './audit-log-details-one-of';
 export * from './audit-verification-result';
+export * from './auto-file-inbox-request';
 export * from './auto-file-job-view';
 export * from './auto-file-jobs-request';
 export * from './auto-file-request';
@@ -39,6 +40,7 @@ export * from './document-version-info';
 export * from './element-info';
 export * from './embedding-backfill-request';
 export * from './embedding-backfill-status';
+export * from './facet';
 export * from './file-type-stats';
 export * from './filing-outcome';
 export * from './filter-input';
@@ -47,6 +49,7 @@ export * from './folder-response';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
 export * from './insight-category-update';
+export * from './insight-facets';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';

package/models/insight-facets.ts

@@ -0,0 +1,24 @@
+/* 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 { Facet } from './facet';
+
+export interface InsightFacets {
+    'categories'?: Array<Facet>;
+    'languages'?: Array<Facet>;
+}
+

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

@@ -17,5 +17,6 @@
 export interface SaveAiPreferencesRequest {
     'autoFile'?: boolean;
     'autoFileNewFolders'?: boolean;
+    'inbox'?: boolean;
 }
 

package/models/settings.ts

@@ -23,6 +23,7 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiChatActive'?: boolean;
+    'aiChatUnavailableReason'?: string;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
     'aiInsightsCategories'?: Array<string>;

package/package.json

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