@openfilz-sdk/typescript 1.3.19 → 1.3.21

package/dist/esm/api/document-controller-api.d.ts

@@ -16,6 +16,7 @@ import type { AncestorInfo } from '../models';
 import type { CreateBlankDocumentRequest } from '../models';
 import type { DeleteMetadataRequest } from '../models';
 import type { DocumentInfo } from '../models';
+import type { DocumentIntegrityRecord } from '../models';
 import type { DocumentPosition } from '../models';
 import type { ElementInfo } from '../models';
 import type { SearchByMetadataRequest } from '../models';
@@ -86,6 +87,14 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
      * @throws {RequiredError}
      */
     getDocumentInfo: (documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentIntegrity: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document
@@ -230,6 +239,14 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInfo>>;
+    /**
+     * 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.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DocumentIntegrityRecord>>>;
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document
@@ -376,6 +393,14 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo>;
+    /**
+     * 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.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DocumentIntegrityRecord>>;
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document
@@ -522,6 +547,14 @@ export declare class DocumentControllerApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInfo, any, {}>>;
+    /**
+     * 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.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentIntegrityRecord[], any, {}>>;
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document

package/dist/esm/api/document-controller-api.js

@@ -282,6 +282,39 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDocumentIntegrity: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('getDocumentIntegrity', 'documentId', documentId);
+            const localVarPath = `/api/v1/documents/{documentId}/integrity`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -741,6 +774,22 @@ export const DocumentControllerApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDocumentIntegrity(documentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDocumentIntegrity(documentId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentControllerApi.getDocumentIntegrity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -964,6 +1013,16 @@ export const DocumentControllerApiFactory = function (configuration, basePath, a
         getDocumentInfo(documentId, withMetadata, options) {
             return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDocumentIntegrity(documentId, options) {
+            return localVarFp.getDocumentIntegrity(documentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -1137,6 +1196,16 @@ export class DocumentControllerApi extends BaseAPI {
     getDocumentInfo(documentId, withMetadata, options) {
         return DocumentControllerApiFp(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * 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.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentIntegrity(documentId, options) {
+        return DocumentControllerApiFp(this.configuration).getDocumentIntegrity(documentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document

package/dist/esm/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

package/dist/esm/api/document-insights-api.js

@@ -96,6 +96,35 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration) {
                 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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, 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
@@ -130,7 +159,7 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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
@@ -207,6 +236,21 @@ export const DocumentInsightsApiFp = function (configuration) {
                 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}
+         */
+        facets(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.facets(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentInsightsApi.facets']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.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
@@ -224,7 +268,7 @@ export const DocumentInsightsApiFp = function (configuration) {
             });
         },
         /**
-         * 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
@@ -268,6 +312,15 @@ export const DocumentInsightsApiFactory = function (configuration, basePath, axi
         backfillStatus(jobId, options) {
             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) {
+            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
@@ -279,7 +332,7 @@ export const DocumentInsightsApiFactory = function (configuration, basePath, axi
             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
@@ -315,6 +368,15 @@ export class DocumentInsightsApi extends BaseAPI {
     backfillStatus(jobId, options) {
         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}
+     */
+    facets(options) {
+        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
@@ -326,7 +388,7 @@ export class DocumentInsightsApi extends BaseAPI {
         return DocumentInsightsApiFp(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.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

package/dist/esm/api/settings-api.d.ts

@@ -34,13 +34,14 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
      */
     getSettings1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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) => Promise<RequestArgs>;
+    save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * SettingsApi - functional programming interface
@@ -61,13 +62,14 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
      */
     getSettings1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
     /**
-     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
 };
 /**
  * SettingsApi - factory interface
@@ -88,13 +90,14 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
      */
     getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
     /**
-     * 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>;
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
 };
 /**
  * SettingsApi - object-oriented interface
@@ -115,11 +118,12 @@ export declare class SettingsApi extends BaseAPI {
      */
     getSettings1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
     /**
-     * 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): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
 }

package/dist/esm/api/settings-api.js

@@ -90,13 +90,14 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, ...args_1], void 0, function* (saveAiPreferencesRequest, options = {}) {
+        save: (saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1], void 0, function* (saveAiPreferencesRequest, acceptLanguage, options = {}) {
             // verify required parameter 'saveAiPreferencesRequest' is not null or undefined
             assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest);
             const localVarPath = `/api/v1/settings/ai/preferences`;
@@ -114,6 +115,9 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
             yield setBearerAuthToObject(localVarHeaderParameter, configuration);
             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 = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -162,16 +166,17 @@ export const SettingsApiFp = function (configuration) {
             });
         },
         /**
-         * 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, options) {
+        save(saveAiPreferencesRequest, acceptLanguage, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, acceptLanguage, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SettingsApi.save']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -204,14 +209,15 @@ export const SettingsApiFactory = function (configuration, basePath, axios) {
             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, options) {
-            return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
+        save(saveAiPreferencesRequest, acceptLanguage, options) {
+            return localVarFp.save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -238,13 +244,14 @@ export class SettingsApi extends BaseAPI {
         return SettingsApiFp(this.configuration).getSettings1(options).then((request) => request(this.axios, this.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, options) {
-        return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
+    save(saveAiPreferencesRequest, acceptLanguage, options) {
+        return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/dist/esm/api/smart-filing-api.d.ts

@@ -12,6 +12,7 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { AutoFileInboxRequest } from '../models';
 import type { AutoFileJobView } from '../models';
 import type { AutoFileJobsRequest } from '../models';
 import type { AutoFileRequest } from '../models';
@@ -28,6 +29,14 @@ export declare const SmartFilingApiAxiosParamCreator: (configuration?: Configura
      * @throws {RequiredError}
      */
     file: (autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
     /**
      *
      * @summary Progress and outcome of a filing job
@@ -81,6 +90,14 @@ export declare const SmartFilingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
     /**
      *
      * @summary Progress and outcome of a filing job
@@ -134,6 +151,14 @@ export declare const SmartFilingApiFactory: (configuration?: Configuration, base
      * @throws {RequiredError}
      */
     file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
+    /**
+     * 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>;
     /**
      *
      * @summary Progress and outcome of a filing job
@@ -187,6 +212,14 @@ export declare class SmartFilingApi extends BaseAPI {
      * @throws {RequiredError}
      */
     file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
     /**
      *
      * @summary Progress and outcome of a filing job