@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/dist/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, {}, 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, {}, any>>;
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document

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

@@ -285,6 +285,39 @@ 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
+            (0, common_1.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, common_1.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 (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -745,6 +778,22 @@ const DocumentControllerApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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 = base_1.operationServerMap['DocumentControllerApi.getDocumentIntegrity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -969,6 +1018,16 @@ const DocumentControllerApiFactory = function (configuration, basePath, axios) {
         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
@@ -1143,6 +1202,16 @@ class DocumentControllerApi extends base_1.BaseAPI {
     getDocumentInfo(documentId, withMetadata, options) {
         return (0, exports.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 (0, exports.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/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, {}, 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, {}, 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, {}, 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/api/document-insights-api.js

@@ -99,6 +99,35 @@ 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, common_1.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 (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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
@@ -133,7 +162,7 @@ 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
@@ -211,6 +240,21 @@ const DocumentInsightsApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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 = base_1.operationServerMap['DocumentInsightsApi.facets']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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
@@ -228,7 +272,7 @@ 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
@@ -273,6 +317,15 @@ const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
         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
@@ -284,7 +337,7 @@ const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
             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
@@ -321,6 +374,15 @@ class DocumentInsightsApi extends base_1.BaseAPI {
     backfillStatus(jobId, options) {
         return (0, exports.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 (0, exports.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
@@ -332,7 +394,7 @@ class DocumentInsightsApi extends base_1.BaseAPI {
         return (0, exports.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/api/esign-api.d.ts

@@ -58,7 +58,7 @@ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    get3: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    get8: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List envelopes I sent for signature
@@ -142,7 +142,7 @@ export declare const ESignApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    get3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
+    get8(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
     /**
      *
      * @summary List envelopes I sent for signature
@@ -226,7 +226,7 @@ export declare const ESignApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    get3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
+    get8(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
     /**
      *
      * @summary List envelopes I sent for signature
@@ -310,7 +310,7 @@ export declare class ESignApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    get3(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    get8(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
     /**
      *
      * @summary List envelopes I sent for signature

package/dist/api/esign-api.js

@@ -170,9 +170,9 @@ const ESignApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        get3: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+        get8: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
             // verify required parameter 'id' is not null or undefined
-            (0, common_1.assertParamExists)('get3', 'id', id);
+            (0, common_1.assertParamExists)('get8', 'id', id);
             const localVarPath = `/api/v1/signatures/{id}`
                 .replace('{id}', encodeURIComponent(String(id)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -440,12 +440,12 @@ const ESignApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        get3(id, options) {
+        get8(id, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.get3(id, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.get8(id, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignApi.get3']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignApi.get8']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
@@ -584,8 +584,8 @@ const ESignApiFactory = function (configuration, basePath, axios) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        get3(id, options) {
-            return localVarFp.get3(id, options).then((request) => request(axios, basePath));
+        get8(id, options) {
+            return localVarFp.get8(id, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -690,8 +690,8 @@ class ESignApi extends base_1.BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    get3(id, options) {
-        return (0, exports.ESignApiFp)(this.configuration).get3(id, options).then((request) => request(this.axios, this.basePath));
+    get8(id, options) {
+        return (0, exports.ESignApiFp)(this.configuration).get8(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *

package/dist/api/esign-enterprise-api.d.ts

@@ -27,7 +27,7 @@ export declare const ESignEnterpriseApiAxiosParamCreator: (configuration?: Confi
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    archive: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    archive1: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Create (and send) one envelope per row from a template
@@ -57,7 +57,7 @@ export declare const ESignEnterpriseApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>>;
+    archive1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>>;
     /**
      *
      * @summary Create (and send) one envelope per row from a template
@@ -87,7 +87,7 @@ export declare const ESignEnterpriseApiFactory: (configuration?: Configuration,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO>;
+    archive1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO>;
     /**
      *
      * @summary Create (and send) one envelope per row from a template
@@ -117,7 +117,7 @@ export declare class ESignEnterpriseApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    archive(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureArchiveDTO, any, {}, any>>;
+    archive1(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureArchiveDTO, any, {}, any>>;
     /**
      *
      * @summary Create (and send) one envelope per row from a template

package/dist/api/esign-enterprise-api.js

@@ -41,9 +41,9 @@ const ESignEnterpriseApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        archive: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+        archive1: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
             // verify required parameter 'id' is not null or undefined
-            (0, common_1.assertParamExists)('archive', 'id', id);
+            (0, common_1.assertParamExists)('archive1', 'id', id);
             const localVarPath = `/api/v1/signatures/{id}/archive`
                 .replace('{id}', encodeURIComponent(String(id)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -154,12 +154,12 @@ const ESignEnterpriseApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        archive(id, options) {
+        archive1(id, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.archive(id, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.archive1(id, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignEnterpriseApi.archive']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignEnterpriseApi.archive1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
@@ -212,8 +212,8 @@ const ESignEnterpriseApiFactory = function (configuration, basePath, axios) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        archive(id, options) {
-            return localVarFp.archive(id, options).then((request) => request(axios, basePath));
+        archive1(id, options) {
+            return localVarFp.archive1(id, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -250,8 +250,8 @@ class ESignEnterpriseApi extends base_1.BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    archive(id, options) {
-        return (0, exports.ESignEnterpriseApiFp)(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
+    archive1(id, options) {
+        return (0, exports.ESignEnterpriseApiFp)(this.configuration).archive1(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *