@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

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

@@ -12,13 +12,22 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { AiPreferencesView } from '../models';
 import type { LicenseInfo } from '../models';
+import type { SaveAiPreferencesRequest } from '../models';
 import type { Settings } from '../models';
 import type { UserPreferencesRequest } from '../models';
 /**
  * SettingsApi - axios parameter creator
  */
 export declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary The caller\'s smart-filing preferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get2: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
      * @summary Coarse license info
@@ -33,6 +42,14 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getSettings: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * A null field leaves the current value unchanged.
+     * @summary Save the caller\'s smart-filing preferences
+     * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Save user\'s language and theme preferences
      * @summary Save user preferences
@@ -46,6 +63,13 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
  * SettingsApi - functional programming interface
  */
 export declare const SettingsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary The caller\'s smart-filing preferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
     /**
      * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
      * @summary Coarse license info
@@ -60,6 +84,14 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
+    /**
+     * A null field leaves the current value unchanged.
+     * @summary Save the caller\'s smart-filing preferences
+     * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
     /**
      * Save user\'s language and theme preferences
      * @summary Save user preferences
@@ -73,6 +105,13 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
  * SettingsApi - factory interface
  */
 export declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary The caller\'s smart-filing preferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get2(options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
     /**
      * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
      * @summary Coarse license info
@@ -87,6 +126,14 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getSettings(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
+    /**
+     * A null field leaves the current value unchanged.
+     * @summary Save the caller\'s smart-filing preferences
+     * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
     /**
      * Save user\'s language and theme preferences
      * @summary Save user preferences
@@ -100,6 +147,13 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
  * SettingsApi - object-oriented interface
  */
 export declare class SettingsApi extends BaseAPI {
+    /**
+     *
+     * @summary The caller\'s smart-filing preferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get2(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}, any>>;
     /**
      * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
      * @summary Coarse license info
@@ -114,6 +168,14 @@ export declare class SettingsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getSettings(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}, any>>;
+    /**
+     * A null field leaves the current value unchanged.
+     * @summary Save the caller\'s smart-filing preferences
+     * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}, any>>;
     /**
      * Save user\'s language and theme preferences
      * @summary Save user preferences

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

@@ -31,6 +31,35 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
  */
 export const SettingsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary The caller\'s smart-filing preferences
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get2: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/settings/ai/preferences`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
          * @summary Coarse license info
@@ -89,6 +118,40 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * A null field leaves the current value unchanged.
+         * @summary Save the caller\'s smart-filing preferences
+         * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        save: (saveAiPreferencesRequest_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, ...args_1], void 0, function* (saveAiPreferencesRequest, options = {}) {
+            // verify required parameter 'saveAiPreferencesRequest' is not null or undefined
+            assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest);
+            const localVarPath = `/api/v1/settings/ai/preferences`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(saveAiPreferencesRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Save user\'s language and theme preferences
          * @summary Save user preferences
@@ -131,6 +194,21 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
 export const SettingsApiFp = function (configuration) {
     const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration);
     return {
+        /**
+         *
+         * @summary The caller\'s smart-filing preferences
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get2(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.get2(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SettingsApi.get2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
          * @summary Coarse license info
@@ -161,6 +239,22 @@ export const SettingsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * A null field leaves the current value unchanged.
+         * @summary Save the caller\'s smart-filing preferences
+         * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        save(saveAiPreferencesRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SettingsApi.save']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Save user\'s language and theme preferences
          * @summary Save user preferences
@@ -185,6 +279,15 @@ export const SettingsApiFp = function (configuration) {
 export const SettingsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = SettingsApiFp(configuration);
     return {
+        /**
+         *
+         * @summary The caller\'s smart-filing preferences
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get2(options) {
+            return localVarFp.get2(options).then((request) => request(axios, basePath));
+        },
         /**
          * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
          * @summary Coarse license info
@@ -203,6 +306,16 @@ export const SettingsApiFactory = function (configuration, basePath, axios) {
         getSettings(options) {
             return localVarFp.getSettings(options).then((request) => request(axios, basePath));
         },
+        /**
+         * A null field leaves the current value unchanged.
+         * @summary Save the caller\'s smart-filing preferences
+         * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        save(saveAiPreferencesRequest, options) {
+            return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Save user\'s language and theme preferences
          * @summary Save user preferences
@@ -219,6 +332,15 @@ export const SettingsApiFactory = function (configuration, basePath, axios) {
  * SettingsApi - object-oriented interface
  */
 export class SettingsApi extends BaseAPI {
+    /**
+     *
+     * @summary The caller\'s smart-filing preferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get2(options) {
+        return SettingsApiFp(this.configuration).get2(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
      * @summary Coarse license info
@@ -237,6 +359,16 @@ export class SettingsApi extends BaseAPI {
     getSettings(options) {
         return SettingsApiFp(this.configuration).getSettings(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * A null field leaves the current value unchanged.
+     * @summary Save the caller\'s smart-filing preferences
+     * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    save(saveAiPreferencesRequest, options) {
+        return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Save user\'s language and theme preferences
      * @summary Save user preferences

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

@@ -0,0 +1,197 @@
+/**
+ * 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 { AutoFileJobView } from '../models';
+import type { AutoFileRequest } from '../models';
+import type { FilingOutcome } from '../models';
+/**
+ * SmartFilingApi - axios parameter creator
+ */
+export declare const SmartFilingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
+     * @summary File existing documents on demand
+     * @param {AutoFileRequest} autoFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    file: (autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Progress and outcome of a filing job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    job: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lastFiling: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Move every document the job filed back where it came from
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undo: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Move one filed document back (the chip\'s \"Move back\")
+     * @param {string} planId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undoFiling: (planId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SmartFilingApi - functional programming interface
+ */
+export declare const SmartFilingApiFp: (configuration?: Configuration) => {
+    /**
+     * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
+     * @summary File existing documents on demand
+     * @param {AutoFileRequest} autoFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
+    /**
+     *
+     * @summary Progress and outcome of a filing job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    job(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
+    /**
+     *
+     * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lastFiling(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilingOutcome>>;
+    /**
+     *
+     * @summary Move every document the job filed back where it came from
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undo(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
+    /**
+     *
+     * @summary Move one filed document back (the chip\'s \"Move back\")
+     * @param {string} planId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undoFiling(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilingOutcome>>;
+};
+/**
+ * SmartFilingApi - factory interface
+ */
+export declare const SmartFilingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
+     * @summary File existing documents on demand
+     * @param {AutoFileRequest} autoFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
+    /**
+     *
+     * @summary Progress and outcome of a filing job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    job(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
+    /**
+     *
+     * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lastFiling(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FilingOutcome>;
+    /**
+     *
+     * @summary Move every document the job filed back where it came from
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undo(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
+    /**
+     *
+     * @summary Move one filed document back (the chip\'s \"Move back\")
+     * @param {string} planId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undoFiling(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<FilingOutcome>;
+};
+/**
+ * SmartFilingApi - object-oriented interface
+ */
+export declare class SmartFilingApi extends BaseAPI {
+    /**
+     * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
+     * @summary File existing documents on demand
+     * @param {AutoFileRequest} autoFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}, any>>;
+    /**
+     *
+     * @summary Progress and outcome of a filing job
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    job(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}, any>>;
+    /**
+     *
+     * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lastFiling(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FilingOutcome, any, {}, any>>;
+    /**
+     *
+     * @summary Move every document the job filed back where it came from
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undo(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}, any>>;
+    /**
+     *
+     * @summary Move one filed document back (the chip\'s \"Move back\")
+     * @param {string} planId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    undoFiling(planId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FilingOutcome, any, {}, any>>;
+}