@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/dist/esm/api/ai-analytics-admin-controller-api.js

@@ -0,0 +1,132 @@
+/* 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());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * AiAnalyticsAdminControllerApi - axios parameter creator
+ */
+export const AiAnalyticsAdminControllerApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Category and language mix, enrichment pipeline state and today\'s model spend, smart-filing volume / stages / skip reasons / last 30 days, undo and manual-move corrections with the implied accuracy, and the documents untouched for N months. Optionally restricted to a folder subtree.
+         * @summary Tenant-wide AI insights and smart-filing analytics (admin only)
+         * @param {string} [folderId] Restrict every figure to this folder\'s subtree
+         * @param {number} [untouchedMonths] Inactivity threshold of the \'untouched\' block, in months (default 12)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analytics: (folderId_1, untouchedMonths_1, ...args_1) => __awaiter(this, [folderId_1, untouchedMonths_1, ...args_1], void 0, function* (folderId, untouchedMonths, options = {}) {
+            const localVarPath = `/api/v1/admin/ai/analytics`;
+            // 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);
+            if (folderId !== undefined) {
+                localVarQueryParameter['folderId'] = folderId;
+            }
+            if (untouchedMonths !== undefined) {
+                localVarQueryParameter['untouchedMonths'] = untouchedMonths;
+            }
+            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,
+            };
+        }),
+    };
+};
+/**
+ * AiAnalyticsAdminControllerApi - functional programming interface
+ */
+export const AiAnalyticsAdminControllerApiFp = function (configuration) {
+    const localVarAxiosParamCreator = AiAnalyticsAdminControllerApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Category and language mix, enrichment pipeline state and today\'s model spend, smart-filing volume / stages / skip reasons / last 30 days, undo and manual-move corrections with the implied accuracy, and the documents untouched for N months. Optionally restricted to a folder subtree.
+         * @summary Tenant-wide AI insights and smart-filing analytics (admin only)
+         * @param {string} [folderId] Restrict every figure to this folder\'s subtree
+         * @param {number} [untouchedMonths] Inactivity threshold of the \'untouched\' block, in months (default 12)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analytics(folderId, untouchedMonths, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.analytics(folderId, untouchedMonths, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AiAnalyticsAdminControllerApi.analytics']) === 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);
+            });
+        },
+    };
+};
+/**
+ * AiAnalyticsAdminControllerApi - factory interface
+ */
+export const AiAnalyticsAdminControllerApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = AiAnalyticsAdminControllerApiFp(configuration);
+    return {
+        /**
+         * Category and language mix, enrichment pipeline state and today\'s model spend, smart-filing volume / stages / skip reasons / last 30 days, undo and manual-move corrections with the implied accuracy, and the documents untouched for N months. Optionally restricted to a folder subtree.
+         * @summary Tenant-wide AI insights and smart-filing analytics (admin only)
+         * @param {string} [folderId] Restrict every figure to this folder\'s subtree
+         * @param {number} [untouchedMonths] Inactivity threshold of the \'untouched\' block, in months (default 12)
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analytics(folderId, untouchedMonths, options) {
+            return localVarFp.analytics(folderId, untouchedMonths, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * AiAnalyticsAdminControllerApi - object-oriented interface
+ */
+export class AiAnalyticsAdminControllerApi extends BaseAPI {
+    /**
+     * Category and language mix, enrichment pipeline state and today\'s model spend, smart-filing volume / stages / skip reasons / last 30 days, undo and manual-move corrections with the implied accuracy, and the documents untouched for N months. Optionally restricted to a folder subtree.
+     * @summary Tenant-wide AI insights and smart-filing analytics (admin only)
+     * @param {string} [folderId] Restrict every figure to this folder\'s subtree
+     * @param {number} [untouchedMonths] Inactivity threshold of the \'untouched\' block, in months (default 12)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    analytics(folderId, untouchedMonths, options) {
+        return AiAnalyticsAdminControllerApiFp(this.configuration).analytics(folderId, untouchedMonths, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/ai-archiving-admin-controller-api.d.ts

@@ -0,0 +1,262 @@
+/**
+ * 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 { ArchivingProposalRequest } from '../models';
+import type { ArchivingProposalResult } from '../models';
+import type { ArchivingScheduleRequest } from '../models';
+import type { ArchivingScheduleView } from '../models';
+/**
+ * AiArchivingAdminControllerApi - axios parameter creator
+ */
+export declare const AiArchivingAdminControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4: (archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose: (archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4: (id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AiArchivingAdminControllerApi - functional programming interface
+ */
+export declare const AiArchivingAdminControllerApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingProposalResult>>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingProposalResult>>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ArchivingScheduleView>>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivingScheduleView>>;
+};
+/**
+ * AiArchivingAdminControllerApi - factory interface
+ */
+export declare const AiArchivingAdminControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingProposalResult>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingProposalResult>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): AxiosPromise<Array<ArchivingScheduleView>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<ArchivingScheduleView>;
+};
+/**
+ * AiArchivingAdminControllerApi - object-oriented interface
+ */
+export declare class AiArchivingAdminControllerApi extends BaseAPI {
+    /**
+     *
+     * @summary Create an archiving schedule
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create4(archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+    /**
+     *
+     * @summary Delete an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    delete3(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Get an archiving schedule
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get7(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+    /**
+     * Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+     * @summary Propose an archiving plan now (admin only)
+     * @param {ArchivingProposalRequest} archivingProposalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    propose(archivingProposalRequest: ArchivingProposalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingProposalResult, any, {}, any>>;
+    /**
+     * Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+     * @summary Run an archiving schedule now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    run1(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingProposalResult, any, {}, any>>;
+    /**
+     *
+     * @summary List archiving schedules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    schedules(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView[], any, {}, any>>;
+    /**
+     *
+     * @summary Update an archiving schedule
+     * @param {string} id
+     * @param {ArchivingScheduleRequest} archivingScheduleRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update4(id: string, archivingScheduleRequest: ArchivingScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ArchivingScheduleView, any, {}, any>>;
+}