@openfilz-sdk/typescript 1.3.19 → 1.3.21

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

@@ -4,10 +4,55 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**auditIntegrityStatus**](#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification|
 |[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource|
 |[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails|
 |[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|
 
+# **auditIntegrityStatus**
+> AuditIntegrityStatusResponse auditIntegrityStatus()
+
+Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
+
+### Example
+
+```typescript
+import {
+    AuditControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AuditControllerApi(configuration);
+
+const { status, data } = await apiInstance.auditIntegrityStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuditIntegrityStatusResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
 # **getAuditTrail**
 > Array<AuditLog> getAuditTrail()
 

package/docs/AuditIntegrityStatusResponse.md

@@ -0,0 +1,29 @@
+# AuditIntegrityStatusResponse
+
+Last known result of the scheduled audit chain verification on this instance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chainBroken** | **boolean** | true when the last scheduled pass reported a broken chain | [optional] [default to undefined]
+**verified** | **boolean** | false until the first scheduled verification has completed on this instance, or when the last one could not run. Not verified is not the same as valid. | [optional] [default to undefined]
+**lastResult** | [**AuditVerificationResult**](AuditVerificationResult.md) | Verdict of the last completed scheduled verification, if any | [optional] [default to undefined]
+**lastFailureMessage** | **string** | Why the last scheduled verification could not run, if it failed | [optional] [default to undefined]
+**lastFailureAt** | **string** | When the last scheduled verification failed to run, if it did | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditIntegrityStatusResponse } from '@openfilz-sdk/typescript';
+
+const instance: AuditIntegrityStatusResponse = {
+    chainBroken,
+    verified,
+    lastResult,
+    lastFailureMessage,
+    lastFailureAt,
+};
+```
+
+[[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/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/DocumentControllerApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:8081*
 |[**downloadMultipleDocumentsAsZip**](#downloadmultipledocumentsaszip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP|
 |[**getDocumentAncestors**](#getdocumentancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors|
 |[**getDocumentInfo**](#getdocumentinfo) | **GET** /api/v1/documents/{documentId}/info | Get information of a document|
+|[**getDocumentIntegrity**](#getdocumentintegrity) | **GET** /api/v1/documents/{documentId}/integrity | Get a document\'s integrity ledger|
 |[**getDocumentMetadata**](#getdocumentmetadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document|
 |[**getDocumentPosition**](#getdocumentposition) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder|
 |[**replaceDocumentContent**](#replacedocumentcontent) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content|
@@ -384,6 +385,57 @@ const { status, data } = await apiInstance.getDocumentInfo(
  - **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)
+
+# **getDocumentIntegrity**
+> Array<DocumentIntegrityRecord> getDocumentIntegrity()
+
+Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+
+### Example
+
+```typescript
+import {
+    DocumentControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDocumentIntegrity(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<DocumentIntegrityRecord>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

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

@@ -0,0 +1,33 @@
+# DocumentIntegrityRecord
+
+One entry of a document\'s append-only integrity ledger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**storagePath** | **string** |  | [optional] [default to undefined]
+**versionId** | **string** |  | [optional] [default to undefined]
+**algorithm** | **string** |  | [optional] [default to undefined]
+**hash** | **string** |  | [optional] [default to undefined]
+**recordedAt** | **string** |  | [optional] [default to undefined]
+**recordedBy** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentIntegrityRecord } from '@openfilz-sdk/typescript';
+
+const instance: DocumentIntegrityRecord = {
+    documentId,
+    storagePath,
+    versionId,
+    algorithm,
+    hash,
+    recordedAt,
+    recordedBy,
+};
+```
+
+[[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/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/audit-integrity-status-response.ts

@@ -0,0 +1,45 @@
+/* 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 { AuditVerificationResult } from './audit-verification-result';
+
+/**
+ * Last known result of the scheduled audit chain verification on this instance
+ */
+export interface AuditIntegrityStatusResponse {
+    /**
+     * true when the last scheduled pass reported a broken chain
+     */
+    'chainBroken'?: boolean;
+    /**
+     * false until the first scheduled verification has completed on this instance, or when the last one could not run. Not verified is not the same as valid.
+     */
+    'verified'?: boolean;
+    /**
+     * Verdict of the last completed scheduled verification, if any
+     */
+    'lastResult'?: AuditVerificationResult;
+    /**
+     * Why the last scheduled verification could not run, if it failed
+     */
+    'lastFailureMessage'?: string;
+    /**
+     * When the last scheduled verification failed to run, if it did
+     */
+    'lastFailureAt'?: 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/document-integrity-record.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.
+ */
+
+
+
+/**
+ * One entry of a document\'s append-only integrity ledger
+ */
+export interface DocumentIntegrityRecord {
+    'documentId'?: string;
+    'storagePath'?: string;
+    'versionId'?: string;
+    'algorithm'?: string;
+    'hash'?: string;
+    'recordedAt'?: string;
+    'recordedBy'?: string;
+}
+

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;
+}
+