@openfilz-sdk/typescript-ee 1.9.11 → 1.10.1

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-ee';
+
+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-ee';
+
+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-ee';
+
+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/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|
-|[**get3**](#get3) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)|
+|[**get8**](#get8) | **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)
 
-# **get3**
-> SignatureEnvelopeDTO get3()
+# **get8**
+> SignatureEnvelopeDTO get8()
 
 
 ### Example
@@ -226,7 +226,7 @@ const apiInstance = new ESignApi(configuration);
 
 let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.get3(
+const { status, data } = await apiInstance.get8(
     id
 );
 ```

package/docs/ESignEnterpriseApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**archive**](#archive) | **GET** /api/v1/signatures/{id}/archive | PDF/A-2b archive + veraPDF compliance for a completed envelope|
+|[**archive1**](#archive1) | **GET** /api/v1/signatures/{id}/archive | PDF/A-2b archive + veraPDF compliance for a completed envelope|
 |[**bulk**](#bulk) | **POST** /api/v1/signatures/bulk | Create (and send) one envelope per row from a template|
 |[**embedUrl**](#embedurl) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/embed-url | Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)|
 
-# **archive**
-> SignatureArchiveDTO archive()
+# **archive1**
+> SignatureArchiveDTO archive1()
 
 
 ### Example
@@ -25,7 +25,7 @@ const apiInstance = new ESignEnterpriseApi(configuration);
 
 let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.archive(
+const { status, data } = await apiInstance.archive1(
     id
 );
 ```

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-ee';
+
+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/Filing.md

@@ -0,0 +1,32 @@
+# Filing
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**undone** | **number** |  | [optional] [default to undefined]
+**byStage** | **{ [key: string]: number; }** |  | [optional] [default to undefined]
+**skippedReasons** | [**Array<KeyCount>**](KeyCount.md) |  | [optional] [default to undefined]
+**last30Days** | [**Array<DayCount>**](DayCount.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Filing } from '@openfilz-sdk/typescript-ee';
+
+const instance: Filing = {
+    filed,
+    skipped,
+    failed,
+    undone,
+    byStage,
+    skippedReasons,
+    last30Days,
+};
+```
+
+[[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/FilingRuleEventView.md

@@ -0,0 +1,30 @@
+# FilingRuleEventView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**ruleId** | **string** |  | [optional] [default to undefined]
+**documentId** | **string** |  | [optional] [default to undefined]
+**outcome** | **string** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilingRuleEventView } from '@openfilz-sdk/typescript-ee';
+
+const instance: FilingRuleEventView = {
+    id,
+    ruleId,
+    documentId,
+    outcome,
+    reason,
+    createdAt,
+};
+```
+
+[[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/FilingRuleRequest.md

@@ -0,0 +1,44 @@
+# FilingRuleRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**priority** | **number** | Lower runs first (default 100) | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**dryRun** | **boolean** | Record what the rule would do without moving anything | [optional] [default to undefined]
+**matchCategories** | **Array<string>** | Insight categories the document may have (null/empty = any) | [optional] [default to undefined]
+**matchEntityKey** | **string** |  | [optional] [default to undefined]
+**matchEntityPattern** | **string** | Regex (find semantics, case-insensitive) on the entity\'s value | [optional] [default to undefined]
+**matchUploaderTeamIds** | **Array<string>** | The uploader must belong to one of these teams (null/empty = any) | [optional] [default to undefined]
+**matchSource** | **string** | ANY | UPLOAD | SCAN | MIGRATION | [optional] [default to 'ANY']
+**matchContentTypePattern** | **string** | Regex (find semantics, case-insensitive) on the MIME type | [optional] [default to undefined]
+**destinationPath** | **string** |  | [default to undefined]
+**createFolders** | **boolean** |  | [optional] [default to undefined]
+**stopOnMatch** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilingRuleRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: FilingRuleRequest = {
+    name,
+    priority,
+    enabled,
+    dryRun,
+    matchCategories,
+    matchEntityKey,
+    matchEntityPattern,
+    matchUploaderTeamIds,
+    matchSource,
+    matchContentTypePattern,
+    destinationPath,
+    createFolders,
+    stopOnMatch,
+};
+```
+
+[[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/FilingRuleTestRequest.md

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

@@ -0,0 +1,36 @@
+# FilingRuleTestResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ruleId** | **string** |  | [optional] [default to undefined]
+**documentId** | **string** |  | [optional] [default to undefined]
+**documentName** | **string** |  | [optional] [default to undefined]
+**outcome** | **string** |  | [optional] [default to undefined]
+**destinationPath** | **string** |  | [optional] [default to undefined]
+**createFolders** | **boolean** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+**category** | **string** |  | [optional] [default to undefined]
+**source** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilingRuleTestResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: FilingRuleTestResult = {
+    ruleId,
+    documentId,
+    documentName,
+    outcome,
+    destinationPath,
+    createFolders,
+    reason,
+    category,
+    source,
+};
+```
+
+[[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/FilingRuleView.md

@@ -0,0 +1,52 @@
+# FilingRuleView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**priority** | **number** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**dryRun** | **boolean** |  | [optional] [default to undefined]
+**matchCategories** | **Array<string>** |  | [optional] [default to undefined]
+**matchEntityKey** | **string** |  | [optional] [default to undefined]
+**matchEntityPattern** | **string** |  | [optional] [default to undefined]
+**matchUploaderTeamIds** | **Array<string>** |  | [optional] [default to undefined]
+**matchSource** | **string** |  | [optional] [default to undefined]
+**matchContentTypePattern** | **string** |  | [optional] [default to undefined]
+**destinationPath** | **string** |  | [optional] [default to undefined]
+**createFolders** | **boolean** |  | [optional] [default to undefined]
+**stopOnMatch** | **boolean** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilingRuleView } from '@openfilz-sdk/typescript-ee';
+
+const instance: FilingRuleView = {
+    id,
+    name,
+    priority,
+    enabled,
+    dryRun,
+    matchCategories,
+    matchEntityKey,
+    matchEntityPattern,
+    matchUploaderTeamIds,
+    matchSource,
+    matchContentTypePattern,
+    destinationPath,
+    createFolders,
+    stopOnMatch,
+    createdBy,
+    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/ForeignItem.md

@@ -0,0 +1,25 @@
+# ForeignItem
+
+A document that will NOT be archived, and whose owner is named so the user understands why it stays
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ForeignItem } from '@openfilz-sdk/typescript-ee';
+
+const instance: ForeignItem = {
+    documentId,
+    name,
+    ownerEmail,
+};
+```
+
+[[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-ee';
+
+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/Insights.md

@@ -0,0 +1,34 @@
+# Insights
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [optional] [default to undefined]
+**tier1Only** | **number** |  | [optional] [default to undefined]
+**tier2** | **number** |  | [optional] [default to undefined]
+**pending** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**enrichedToday** | **number** |  | [optional] [default to undefined]
+**dailyLimit** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Insights } from '@openfilz-sdk/typescript-ee';
+
+const instance: Insights = {
+    total,
+    tier1Only,
+    tier2,
+    pending,
+    failed,
+    skipped,
+    enrichedToday,
+    dailyLimit,
+};
+```
+
+[[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/KeyCount.md

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

package/docs/ScanRequestDto.md

@@ -11,6 +11,9 @@ Name | Type | Description | Notes
 **targetFolderPath** | **string** |  | [optional] [default to undefined]
 **targetFolderId** | **string** |  | [optional] [default to undefined]
 **pageSize** | **string** |  | [optional] [default to undefined]
+**inputSource** | **string** |  | [optional] [default to undefined]
+**autoFile** | **boolean** |  | [optional] [default to undefined]
+**category** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -24,6 +27,9 @@ const instance: ScanRequestDto = {
     targetFolderPath,
     targetFolderId,
     pageSize,
+    inputSource,
+    autoFile,
+    category,
 };
 ```
 

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

@@ -144,7 +144,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
 
@@ -159,9 +159,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
 );
 ```
 
@@ -170,6 +172,7 @@ const { status, data } = await apiInstance.save(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **saveAiPreferencesRequest** | **SaveAiPreferencesRequest**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
 
 
 ### Return type