@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

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

@@ -0,0 +1,170 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { DocumentInsightView } from '../models';
+import type { InsightBackfillRequest } from '../models';
+import type { InsightBackfillStatus } from '../models';
+import type { InsightCategoryUpdate } from '../models';
+/**
+ * DocumentInsightsApi - axios parameter creator
+ */
+export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+     * @summary Enrich existing documents
+     * @param {InsightBackfillRequest} [insightBackfillRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfill: (insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Progress of a backfill job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfillStatus: (jobId: string, 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
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId
+     * @param {InsightCategoryUpdate} insightCategoryUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCategory: (documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentInsightsApi - functional programming interface
+ */
+export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
+    /**
+     * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+     * @summary Enrich existing documents
+     * @param {InsightBackfillRequest} [insightBackfillRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
+    /**
+     *
+     * @summary Progress of a backfill job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
+    /**
+     * 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
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId
+     * @param {InsightCategoryUpdate} insightCategoryUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
+};
+/**
+ * DocumentInsightsApi - factory interface
+ */
+export declare const DocumentInsightsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+     * @summary Enrich existing documents
+     * @param {InsightBackfillRequest} [insightBackfillRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
+    /**
+     *
+     * @summary Progress of a backfill job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
+    /**
+     * 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
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId
+     * @param {InsightCategoryUpdate} insightCategoryUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
+};
+/**
+ * DocumentInsightsApi - object-oriented interface
+ */
+export declare class DocumentInsightsApi extends BaseAPI {
+    /**
+     * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+     * @summary Enrich existing documents
+     * @param {InsightBackfillRequest} [insightBackfillRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}, any>>;
+    /**
+     *
+     * @summary Progress of a backfill job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, 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
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId
+     * @param {InsightCategoryUpdate} insightCategoryUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}, any>>;
+}

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

@@ -0,0 +1,346 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentInsightsApi = exports.DocumentInsightsApiFactory = exports.DocumentInsightsApiFp = exports.DocumentInsightsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * DocumentInsightsApi - axios parameter creator
+ */
+const DocumentInsightsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+         * @summary Enrich existing documents
+         * @param {InsightBackfillRequest} [insightBackfillRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfill: (insightBackfillRequest_1, ...args_1) => __awaiter(this, [insightBackfillRequest_1, ...args_1], void 0, function* (insightBackfillRequest, options = {}) {
+            const localVarPath = `/api/v1/ai/insights/backfill`;
+            // 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: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            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);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(insightBackfillRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Progress of a backfill job
+         * @param {string} jobId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfillStatus: (jobId_1, ...args_1) => __awaiter(this, [jobId_1, ...args_1], void 0, function* (jobId, options = {}) {
+            // verify required parameter 'jobId' is not null or undefined
+            (0, common_1.assertParamExists)('backfillStatus', 'jobId', jobId);
+            const localVarPath = `/api/v1/ai/insights/backfill/{jobId}`
+                .replace('{jobId}', encodeURIComponent(String(jobId)));
+            // 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
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInsights: (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)('getInsights', 'documentId', documentId);
+            const localVarPath = `/api/v1/documents/{documentId}/insights`
+                .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'] = '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,
+            };
+        }),
+        /**
+         * 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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId
+         * @param {InsightCategoryUpdate} insightCategoryUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCategory: (documentId_1, insightCategoryUpdate_1, ...args_1) => __awaiter(this, [documentId_1, insightCategoryUpdate_1, ...args_1], void 0, function* (documentId, insightCategoryUpdate, options = {}) {
+            // verify required parameter 'documentId' is not null or undefined
+            (0, common_1.assertParamExists)('setCategory', 'documentId', documentId);
+            // verify required parameter 'insightCategoryUpdate' is not null or undefined
+            (0, common_1.assertParamExists)('setCategory', 'insightCategoryUpdate', insightCategoryUpdate);
+            const localVarPath = `/api/v1/documents/{documentId}/insights`
+                .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: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            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);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(insightCategoryUpdate, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.DocumentInsightsApiAxiosParamCreator = DocumentInsightsApiAxiosParamCreator;
+/**
+ * DocumentInsightsApi - functional programming interface
+ */
+const DocumentInsightsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.DocumentInsightsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+         * @summary Enrich existing documents
+         * @param {InsightBackfillRequest} [insightBackfillRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfill(insightBackfillRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.backfill(insightBackfillRequest, 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.backfill']) === 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);
+            });
+        },
+        /**
+         *
+         * @summary Progress of a backfill job
+         * @param {string} jobId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfillStatus(jobId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.backfillStatus(jobId, 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.backfillStatus']) === 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
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInsights(documentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getInsights(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['DocumentInsightsApi.getInsights']) === 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);
+            });
+        },
+        /**
+         * 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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId
+         * @param {InsightCategoryUpdate} insightCategoryUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCategory(documentId, insightCategoryUpdate, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setCategory(documentId, insightCategoryUpdate, 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.setCategory']) === 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);
+            });
+        },
+    };
+};
+exports.DocumentInsightsApiFp = DocumentInsightsApiFp;
+/**
+ * DocumentInsightsApi - factory interface
+ */
+const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.DocumentInsightsApiFp)(configuration);
+    return {
+        /**
+         * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+         * @summary Enrich existing documents
+         * @param {InsightBackfillRequest} [insightBackfillRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfill(insightBackfillRequest, options) {
+            return localVarFp.backfill(insightBackfillRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Progress of a backfill job
+         * @param {string} jobId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfillStatus(jobId, options) {
+            return localVarFp.backfillStatus(jobId, 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
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInsights(documentId, options) {
+            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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId
+         * @param {InsightCategoryUpdate} insightCategoryUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCategory(documentId, insightCategoryUpdate, options) {
+            return localVarFp.setCategory(documentId, insightCategoryUpdate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.DocumentInsightsApiFactory = DocumentInsightsApiFactory;
+/**
+ * DocumentInsightsApi - object-oriented interface
+ */
+class DocumentInsightsApi extends base_1.BaseAPI {
+    /**
+     * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
+     * @summary Enrich existing documents
+     * @param {InsightBackfillRequest} [insightBackfillRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfill(insightBackfillRequest, options) {
+        return (0, exports.DocumentInsightsApiFp)(this.configuration).backfill(insightBackfillRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Progress of a backfill job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backfillStatus(jobId, options) {
+        return (0, exports.DocumentInsightsApiFp)(this.configuration).backfillStatus(jobId, 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
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsights(documentId, options) {
+        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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId
+     * @param {InsightCategoryUpdate} insightCategoryUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCategory(documentId, insightCategoryUpdate, options) {
+        return (0, exports.DocumentInsightsApiFp)(this.configuration).setCategory(documentId, insightCategoryUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.DocumentInsightsApi = DocumentInsightsApi;

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}
      */
-    get2: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    get3: (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}
      */
-    get2(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
+    get3(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}
      */
-    get2(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
+    get3(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}
      */
-    get2(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    get3(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}
          */
-        get2: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+        get3: (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)('get2', 'id', id);
+            (0, common_1.assertParamExists)('get3', '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}
          */
-        get2(id, options) {
+        get3(id, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.get2(id, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.get3(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.get2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                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;
                 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}
          */
-        get2(id, options) {
-            return localVarFp.get2(id, options).then((request) => request(axios, basePath));
+        get3(id, options) {
+            return localVarFp.get3(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}
      */
-    get2(id, options) {
-        return (0, exports.ESignApiFp)(this.configuration).get2(id, options).then((request) => request(this.axios, this.basePath));
+    get3(id, options) {
+        return (0, exports.ESignApiFp)(this.configuration).get3(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *