@openfilz-sdk/typescript 1.3.9 → 1.3.12

package/.openapi-generator/FILES

@@ -82,6 +82,7 @@ docs/FolderElementInfo.md
 docs/FolderResponse.md
 docs/InsightBackfillRequest.md
 docs/InsightBackfillStatus.md
+docs/InsightCategoryUpdate.md
 docs/InstantiateTemplateRequest.md
 docs/Item.md
 docs/ItemResult.md
@@ -106,6 +107,7 @@ docs/RenameAudit.md
 docs/RenameRequest.md
 docs/ReorganizationApplyRequest.md
 docs/ReorganizationApplyResult.md
+docs/ReorganizationByKindRequest.md
 docs/ReorganizationPlanView.md
 docs/ReplaceAudit.md
 docs/RestoreVersionAudit.md
@@ -192,6 +194,7 @@ models/folder-response.ts
 models/index.ts
 models/insight-backfill-request.ts
 models/insight-backfill-status.ts
+models/insight-category-update.ts
 models/instantiate-template-request.ts
 models/item-result.ts
 models/item.ts
@@ -214,6 +217,7 @@ models/rename-audit.ts
 models/rename-request.ts
 models/reorganization-apply-request.ts
 models/reorganization-apply-result.ts
+models/reorganization-by-kind-request.ts
 models/reorganization-plan-view.ts
 models/replace-audit.ts
 models/restore-version-audit.ts

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

@@ -1 +1 @@
-43c5d04dd3991a7d4b0c4722474c62b97f9244205cf7bc869b7596cb0bca5568
+28066b1152de31a60e95008433816f15fe3f11a3648c67623652143df0cd25d0

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript@1.3.9
+## @openfilz-sdk/typescript@1.3.12
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript@1.3.9 --save
+npm install @openfilz-sdk/typescript@1.3.12 --save
 ```
 
 _unPublished (not recommended):_
@@ -58,6 +58,7 @@ Class | Method | HTTP request | Description
 *AIChatApi* | [**get3**](docs/AIChatApi.md#get3) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant
 *AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
 *AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
+*AIChatApi* | [**proposeByKind**](docs/AIChatApi.md#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved
 *AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
 *AISettingsApi* | [**getSettings**](docs/AISettingsApi.md#getsettings) | **GET** /api/v1/settings/ai | Get my AI settings
 *AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
@@ -85,6 +86,7 @@ Class | Method | HTTP request | Description
 *DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
 *DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
 *DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
+*DocumentInsightsApi* | [**setCategory**](docs/DocumentInsightsApi.md#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document
 *DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions | 
 *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
 *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
@@ -198,6 +200,7 @@ Class | Method | HTTP request | Description
  - [FolderResponse](docs/FolderResponse.md)
  - [InsightBackfillRequest](docs/InsightBackfillRequest.md)
  - [InsightBackfillStatus](docs/InsightBackfillStatus.md)
+ - [InsightCategoryUpdate](docs/InsightCategoryUpdate.md)
  - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
  - [Item](docs/Item.md)
  - [ItemResult](docs/ItemResult.md)
@@ -220,6 +223,7 @@ Class | Method | HTTP request | Description
  - [RenameRequest](docs/RenameRequest.md)
  - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
  - [ReorganizationApplyResult](docs/ReorganizationApplyResult.md)
+ - [ReorganizationByKindRequest](docs/ReorganizationByKindRequest.md)
  - [ReorganizationPlanView](docs/ReorganizationPlanView.md)
  - [ReplaceAudit](docs/ReplaceAudit.md)
  - [RestoreVersionAudit](docs/RestoreVersionAudit.md)

package/api/aichat-api.ts

@@ -32,6 +32,8 @@ import type { ReorganizationApplyRequest } from '../models';
 // @ts-ignore
 import type { ReorganizationApplyResult } from '../models';
 // @ts-ignore
+import type { ReorganizationByKindRequest } from '../models';
+// @ts-ignore
 import type { ReorganizationPlanView } from '../models';
 /**
  * AIChatApi - axios parameter creator
@@ -298,6 +300,43 @@ export const AIChatApiAxiosParamCreator = function (configuration?: Configuratio
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind: async (reorganizationByKindRequest?: ReorganizationByKindRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/reorganization/by-kind`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(reorganizationByKindRequest, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -403,6 +442,19 @@ export const AIChatApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AIChatApi.listConversations']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.proposeByKind(reorganizationByKindRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.proposeByKind']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -482,6 +534,16 @@ export const AIChatApiFactory = function (configuration?: Configuration, basePat
         listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>> {
             return localVarFp.listConversations(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView> {
+            return localVarFp.proposeByKind(reorganizationByKindRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -565,5 +627,16 @@ export class AIChatApi extends BaseAPI {
     public listConversations(options?: RawAxiosRequestConfig) {
         return AIChatApiFp(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).proposeByKind(reorganizationByKindRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/api/document-insights-api.ts

@@ -27,6 +27,8 @@ import type { DocumentInsightView } from '../models';
 import type { InsightBackfillRequest } from '../models';
 // @ts-ignore
 import type { InsightBackfillStatus } from '../models';
+// @ts-ignore
+import type { InsightCategoryUpdate } from '../models';
 /**
  * DocumentInsightsApi - axios parameter creator
  */
@@ -140,6 +142,49 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration?: Co
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: 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: async (documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('setCategory', 'documentId', documentId)
+            // verify required parameter 'insightCategoryUpdate' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(insightCategoryUpdate, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -193,6 +238,20 @@ export const DocumentInsightsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.getInsights']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
+         * @summary Correct the kind of a document
+         * @param {string} documentId 
+         * @param {InsightCategoryUpdate} insightCategoryUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setCategory(documentId, insightCategoryUpdate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.setCategory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -232,6 +291,17 @@ export const DocumentInsightsApiFactory = function (configuration?: Configuratio
         getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView> {
             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: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView> {
+            return localVarFp.setCategory(documentId, insightCategoryUpdate, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -271,5 +341,17 @@ export class DocumentInsightsApi extends BaseAPI {
     public getInsights(documentId: string, options?: RawAxiosRequestConfig) {
         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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId 
+     * @param {InsightCategoryUpdate} insightCategoryUpdate 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig) {
+        return DocumentInsightsApiFp(this.configuration).setCategory(documentId, insightCategoryUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/dist/api/aichat-api.d.ts

@@ -17,6 +17,7 @@ import type { AiChatRequest } from '../models';
 import type { AiChatResponse } from '../models';
 import type { ReorganizationApplyRequest } from '../models';
 import type { ReorganizationApplyResult } from '../models';
+import type { ReorganizationByKindRequest } from '../models';
 import type { ReorganizationPlanView } from '../models';
 /**
  * AIChatApi - axios parameter creator
@@ -78,6 +79,14 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     listConversations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind: (reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AIChatApi - functional programming interface
@@ -139,6 +148,14 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatConversation>>>;
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
 };
 /**
  * AIChatApi - factory interface
@@ -200,6 +217,14 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>>;
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
 };
 /**
  * AIChatApi - object-oriented interface
@@ -261,4 +286,12 @@ export declare class AIChatApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiChatConversation[], any, {}>>;
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}>>;
 }

package/dist/api/aichat-api.js

@@ -264,6 +264,38 @@ const AIChatApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind: (reorganizationByKindRequest_1, ...args_1) => __awaiter(this, [reorganizationByKindRequest_1, ...args_1], void 0, function* (reorganizationByKindRequest, options = {}) {
+            const localVarPath = `/api/v1/ai/reorganization/by-kind`;
+            // 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)(reorganizationByKindRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 exports.AIChatApiAxiosParamCreator = AIChatApiAxiosParamCreator;
@@ -385,6 +417,22 @@ const AIChatApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind(reorganizationByKindRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.proposeByKind(reorganizationByKindRequest, 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['AIChatApi.proposeByKind']) === 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.AIChatApiFp = AIChatApiFp;
@@ -464,6 +512,16 @@ const AIChatApiFactory = function (configuration, basePath, axios) {
         listConversations(options) {
             return localVarFp.listConversations(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind(reorganizationByKindRequest, options) {
+            return localVarFp.proposeByKind(reorganizationByKindRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.AIChatApiFactory = AIChatApiFactory;
@@ -541,5 +599,15 @@ class AIChatApi extends base_1.BaseAPI {
     listConversations(options) {
         return (0, exports.AIChatApiFp)(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest, options) {
+        return (0, exports.AIChatApiFp)(this.configuration).proposeByKind(reorganizationByKindRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.AIChatApi = AIChatApi;

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

@@ -15,6 +15,7 @@ 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
  */
@@ -43,6 +44,15 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
      * @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
@@ -72,6 +82,15 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
      * @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
@@ -101,6 +120,15 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
      * @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
@@ -130,4 +158,13 @@ export declare class DocumentInsightsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     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.
+     * @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, {}>>;
 }

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

@@ -132,6 +132,44 @@ const DocumentInsightsApiAxiosParamCreator = function (configuration) {
                 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;
@@ -189,6 +227,23 @@ const DocumentInsightsApiFp = function (configuration) {
                 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;
@@ -228,6 +283,17 @@ const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
         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;
@@ -265,5 +331,16 @@ class DocumentInsightsApi extends base_1.BaseAPI {
     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;