@openfilz-sdk/typescript 1.3.18 → 1.3.20

package/.openapi-generator/FILES

@@ -44,6 +44,7 @@ docs/AuditLog.md
 docs/AuditLogDetails.md
 docs/AuditLogDetailsOneOf.md
 docs/AuditVerificationResult.md
+docs/AutoFileInboxRequest.md
 docs/AutoFileJobView.md
 docs/AutoFileJobsRequest.md
 docs/AutoFileRequest.md
@@ -80,6 +81,7 @@ docs/ESignTemplatesApi.md
 docs/ElementInfo.md
 docs/EmbeddingBackfillRequest.md
 docs/EmbeddingBackfillStatus.md
+docs/Facet.md
 docs/FavoritesApi.md
 docs/FileControllerApi.md
 docs/FileTypeStats.md
@@ -91,6 +93,7 @@ docs/FolderResponse.md
 docs/InsightBackfillRequest.md
 docs/InsightBackfillStatus.md
 docs/InsightCategoryUpdate.md
+docs/InsightFacets.md
 docs/InstantiateTemplateRequest.md
 docs/Item.md
 docs/ItemResult.md
@@ -193,6 +196,7 @@ models/audit-log-details-one-of.ts
 models/audit-log-details.ts
 models/audit-log.ts
 models/audit-verification-result.ts
+models/auto-file-inbox-request.ts
 models/auto-file-job-view.ts
 models/auto-file-jobs-request.ts
 models/auto-file-request.ts
@@ -221,6 +225,7 @@ models/document-version-info.ts
 models/element-info.ts
 models/embedding-backfill-request.ts
 models/embedding-backfill-status.ts
+models/facet.ts
 models/file-type-stats.ts
 models/filing-outcome.ts
 models/filter-input.ts
@@ -230,6 +235,7 @@ models/index.ts
 models/insight-backfill-request.ts
 models/insight-backfill-status.ts
 models/insight-category-update.ts
+models/insight-facets.ts
 models/instantiate-template-request.ts
 models/item-result.ts
 models/item.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-8672580c6c5002cb918a847b9f10e8dd17d4fb82174d95aee6d855cadfbb0aa8
+92e1063d026df6b8f0edd342f5b536e19993cd2e27bd18a21d56bbf17b60bd0a

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript@1.3.18
+## @openfilz-sdk/typescript@1.3.20
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript@1.3.18 --save
+npm install @openfilz-sdk/typescript@1.3.20 --save
 ```
 
 _unPublished (not recommended):_
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *DocumentControllerApi* | [**uploadDocument1**](docs/DocumentControllerApi.md#uploaddocument1) | **POST** /api/v1/documents/upload | Upload a single document
 *DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
 *DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
+*DocumentInsightsApi* | [**facets**](docs/DocumentInsightsApi.md#facets) | **GET** /api/v1/ai/insights/facets | The category and language facets of the library
 *DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
 *DocumentInsightsApi* | [**setCategory**](docs/DocumentInsightsApi.md#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document
 *DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions | 
@@ -142,6 +143,7 @@ Class | Method | HTTP request | Description
 *SettingsApi* | [**getSettings1**](docs/SettingsApi.md#getsettings1) | **GET** /api/v1/settings | Get user\'s settings
 *SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences
 *SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand
+*SmartFilingApi* | [**fileInbox**](docs/SmartFilingApi.md#fileinbox) | **POST** /api/v1/ai/auto-file/inbox | File everything lying loose in the caller\'s Inbox
 *SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job
 *SmartFilingApi* | [**jobs**](docs/SmartFilingApi.md#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs
 *SmartFilingApi* | [**lastFiling**](docs/SmartFilingApi.md#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)
@@ -188,6 +190,7 @@ Class | Method | HTTP request | Description
  - [AuditLogDetails](docs/AuditLogDetails.md)
  - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
  - [AuditVerificationResult](docs/AuditVerificationResult.md)
+ - [AutoFileInboxRequest](docs/AutoFileInboxRequest.md)
  - [AutoFileJobView](docs/AutoFileJobView.md)
  - [AutoFileJobsRequest](docs/AutoFileJobsRequest.md)
  - [AutoFileRequest](docs/AutoFileRequest.md)
@@ -216,6 +219,7 @@ Class | Method | HTTP request | Description
  - [ElementInfo](docs/ElementInfo.md)
  - [EmbeddingBackfillRequest](docs/EmbeddingBackfillRequest.md)
  - [EmbeddingBackfillStatus](docs/EmbeddingBackfillStatus.md)
+ - [Facet](docs/Facet.md)
  - [FileTypeStats](docs/FileTypeStats.md)
  - [FilingOutcome](docs/FilingOutcome.md)
  - [FilterInput](docs/FilterInput.md)
@@ -224,6 +228,7 @@ Class | Method | HTTP request | Description
  - [InsightBackfillRequest](docs/InsightBackfillRequest.md)
  - [InsightBackfillStatus](docs/InsightBackfillStatus.md)
  - [InsightCategoryUpdate](docs/InsightCategoryUpdate.md)
+ - [InsightFacets](docs/InsightFacets.md)
  - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
  - [Item](docs/Item.md)
  - [ItemResult](docs/ItemResult.md)

package/api/document-insights-api.ts

@@ -29,6 +29,8 @@ import type { InsightBackfillRequest } from '../models';
 import type { InsightBackfillStatus } from '../models';
 // @ts-ignore
 import type { InsightCategoryUpdate } from '../models';
+// @ts-ignore
+import type { InsightFacets } from '../models';
 /**
  * DocumentInsightsApi - axios parameter creator
  */
@@ -109,6 +111,40 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration?: Co
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary The category and language facets of the library
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        facets: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/insights/facets`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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.
          * @summary Get the insights of a document
@@ -148,7 +184,7 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration?: Co
             };
         },
         /**
-         * 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.
          * @summary Correct the kind of a document
          * @param {string} documentId 
          * @param {InsightCategoryUpdate} insightCategoryUpdate 
@@ -225,6 +261,18 @@ export const DocumentInsightsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.backfillStatus']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary The category and language facets of the library
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async facets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightFacets>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.facets(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.facets']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 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.
          * @summary Get the insights of a document
@@ -239,7 +287,7 @@ export const DocumentInsightsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 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.
          * @summary Correct the kind of a document
          * @param {string} documentId 
          * @param {InsightCategoryUpdate} insightCategoryUpdate 
@@ -281,6 +329,15 @@ export const DocumentInsightsApiFactory = function (configuration?: Configuratio
         backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus> {
             return localVarFp.backfillStatus(jobId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary The category and language facets of the library
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        facets(options?: RawAxiosRequestConfig): AxiosPromise<InsightFacets> {
+            return localVarFp.facets(options).then((request) => request(axios, basePath));
+        },
         /**
          * 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.
          * @summary Get the insights of a document
@@ -292,7 +349,7 @@ export const DocumentInsightsApiFactory = function (configuration?: Configuratio
             return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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.
          * @summary Correct the kind of a document
          * @param {string} documentId 
          * @param {InsightCategoryUpdate} insightCategoryUpdate 
@@ -331,6 +388,16 @@ export class DocumentInsightsApi extends BaseAPI {
         return DocumentInsightsApiFp(this.configuration).backfillStatus(jobId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary The category and language facets of the library
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public facets(options?: RawAxiosRequestConfig) {
+        return DocumentInsightsApiFp(this.configuration).facets(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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.
      * @summary Get the insights of a document
@@ -343,7 +410,7 @@ export class DocumentInsightsApi extends BaseAPI {
     }
 
     /**
-     * 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.
      * @summary Correct the kind of a document
      * @param {string} documentId 
      * @param {InsightCategoryUpdate} insightCategoryUpdate 

package/api/settings-api.ts

@@ -101,13 +101,14 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * 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.
          * @summary Save the caller\'s smart-filing preferences
          * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest 
+         * @param {string} [acceptLanguage] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        save: async (saveAiPreferencesRequest: SaveAiPreferencesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        save: async (saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'saveAiPreferencesRequest' is not null or undefined
             assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest)
             const localVarPath = `/api/v1/settings/ai/preferences`;
@@ -129,6 +130,9 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
             localVarHeaderParameter['Content-Type'] = 'application/json';
             localVarHeaderParameter['Accept'] = 'application/json';
 
+            if (acceptLanguage != null) {
+                localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -173,14 +177,15 @@ export const SettingsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 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.
          * @summary Save the caller\'s smart-filing preferences
          * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest 
+         * @param {string} [acceptLanguage] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
+        async save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.save(saveAiPreferencesRequest, acceptLanguage, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SettingsApi.save']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -213,14 +218,15 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
         },
         /**
-         * 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.
          * @summary Save the caller\'s smart-filing preferences
          * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest 
+         * @param {string} [acceptLanguage] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
-            return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
+        save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
+            return localVarFp.save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -250,14 +256,15 @@ export class SettingsApi extends BaseAPI {
     }
 
     /**
-     * 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.
      * @summary Save the caller\'s smart-filing preferences
      * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest 
+     * @param {string} [acceptLanguage] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) {
-        return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
+    public save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) {
+        return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/api/smart-filing-api.ts

@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
+import type { AutoFileInboxRequest } from '../models';
+// @ts-ignore
 import type { AutoFileJobView } from '../models';
 // @ts-ignore
 import type { AutoFileJobsRequest } from '../models';
@@ -73,6 +75,43 @@ export const SmartFilingApiAxiosParamCreator = function (configuration?: Configu
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary File everything lying loose in the caller\'s Inbox
+         * @param {AutoFileInboxRequest} [autoFileInboxRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        fileInbox: async (autoFileInboxRequest?: AutoFileInboxRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/auto-file/inbox`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(autoFileInboxRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Progress and outcome of a filing job
@@ -286,6 +325,19 @@ export const SmartFilingApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.file']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary File everything lying loose in the caller\'s Inbox
+         * @param {AutoFileInboxRequest} [autoFileInboxRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fileInbox(autoFileInboxRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.fileInbox']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Progress and outcome of a filing job
@@ -370,6 +422,16 @@ export const SmartFilingApiFactory = function (configuration?: Configuration, ba
         file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
             return localVarFp.file(autoFileRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary File everything lying loose in the caller\'s Inbox
+         * @param {AutoFileInboxRequest} [autoFileInboxRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
+            return localVarFp.fileInbox(autoFileInboxRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Progress and outcome of a filing job
@@ -438,6 +500,17 @@ export class SmartFilingApi extends BaseAPI {
         return SmartFilingApiFp(this.configuration).file(autoFileRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary File everything lying loose in the caller\'s Inbox
+     * @param {AutoFileInboxRequest} [autoFileInboxRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig) {
+        return SmartFilingApiFp(this.configuration).fileInbox(autoFileInboxRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Progress and outcome of a filing job

package/dist/api/document-insights-api.d.ts

@@ -16,6 +16,7 @@ import type { DocumentInsightView } from '../models';
 import type { InsightBackfillRequest } from '../models';
 import type { InsightBackfillStatus } from '../models';
 import type { InsightCategoryUpdate } from '../models';
+import type { InsightFacets } from '../models';
 /**
  * DocumentInsightsApi - axios parameter creator
  */
@@ -36,6 +37,13 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     backfillStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary The category and language facets of the library
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    facets: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary Get the insights of a document
@@ -45,7 +53,7 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
      */
     getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
      * @summary Correct the kind of a document
      * @param {string} documentId
      * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -74,6 +82,13 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
+    /**
+     * 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.
+     * @summary The category and language facets of the library
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    facets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightFacets>>;
     /**
      * 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.
      * @summary Get the insights of a document
@@ -83,7 +98,7 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
      */
     getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
     /**
-     * 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.
      * @summary Correct the kind of a document
      * @param {string} documentId
      * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -112,6 +127,13 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
+    /**
+     * 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.
+     * @summary The category and language facets of the library
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    facets(options?: RawAxiosRequestConfig): AxiosPromise<InsightFacets>;
     /**
      * 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.
      * @summary Get the insights of a document
@@ -121,7 +143,7 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
      */
     getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
     /**
-     * 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.
      * @summary Correct the kind of a document
      * @param {string} documentId
      * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -150,6 +172,13 @@ export declare class DocumentInsightsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}>>;
+    /**
+     * 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.
+     * @summary The category and language facets of the library
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    facets(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightFacets, any, {}>>;
     /**
      * 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.
      * @summary Get the insights of a document
@@ -159,7 +188,7 @@ export declare class DocumentInsightsApi extends BaseAPI {
      */
     getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}>>;
     /**
-     * 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.
      * @summary Correct the kind of a document
      * @param {string} documentId
      * @param {InsightCategoryUpdate} insightCategoryUpdate