@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/dist/api/aigovernance-api.js

@@ -0,0 +1,195 @@
+"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.AIGovernanceApi = exports.AIGovernanceApiFactory = exports.AIGovernanceApiFp = exports.AIGovernanceApiAxiosParamCreator = 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");
+/**
+ * AIGovernanceApi - axios parameter creator
+ */
+const AIGovernanceApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary The AI governance settings in force
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get5: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/admin/ai/governance`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Full replace. blockedCategories must be kinds of the taxonomy (400 otherwise); insightRetentionDays null keeps insights forever. Takes effect within 30 seconds on every node.
+         * @summary Replace the AI governance settings
+         * @param {AiGovernanceSettings} aiGovernanceSettings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        put1: (aiGovernanceSettings_1, ...args_1) => __awaiter(this, [aiGovernanceSettings_1, ...args_1], void 0, function* (aiGovernanceSettings, options = {}) {
+            // verify required parameter 'aiGovernanceSettings' is not null or undefined
+            (0, common_1.assertParamExists)('put1', 'aiGovernanceSettings', aiGovernanceSettings);
+            const localVarPath = `/api/v1/admin/ai/governance`;
+            // 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: 'PUT' }, 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'] = '*/*';
+            (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)(aiGovernanceSettings, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.AIGovernanceApiAxiosParamCreator = AIGovernanceApiAxiosParamCreator;
+/**
+ * AIGovernanceApi - functional programming interface
+ */
+const AIGovernanceApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.AIGovernanceApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary The AI governance settings in force
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get5(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.get5(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['AIGovernanceApi.get5']) === 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);
+            });
+        },
+        /**
+         * Full replace. blockedCategories must be kinds of the taxonomy (400 otherwise); insightRetentionDays null keeps insights forever. Takes effect within 30 seconds on every node.
+         * @summary Replace the AI governance settings
+         * @param {AiGovernanceSettings} aiGovernanceSettings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        put1(aiGovernanceSettings, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.put1(aiGovernanceSettings, 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['AIGovernanceApi.put1']) === 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.AIGovernanceApiFp = AIGovernanceApiFp;
+/**
+ * AIGovernanceApi - factory interface
+ */
+const AIGovernanceApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.AIGovernanceApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary The AI governance settings in force
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get5(options) {
+            return localVarFp.get5(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Full replace. blockedCategories must be kinds of the taxonomy (400 otherwise); insightRetentionDays null keeps insights forever. Takes effect within 30 seconds on every node.
+         * @summary Replace the AI governance settings
+         * @param {AiGovernanceSettings} aiGovernanceSettings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        put1(aiGovernanceSettings, options) {
+            return localVarFp.put1(aiGovernanceSettings, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.AIGovernanceApiFactory = AIGovernanceApiFactory;
+/**
+ * AIGovernanceApi - object-oriented interface
+ */
+class AIGovernanceApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary The AI governance settings in force
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get5(options) {
+        return (0, exports.AIGovernanceApiFp)(this.configuration).get5(options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Full replace. blockedCategories must be kinds of the taxonomy (400 otherwise); insightRetentionDays null keeps insights forever. Takes effect within 30 seconds on every node.
+     * @summary Replace the AI governance settings
+     * @param {AiGovernanceSettings} aiGovernanceSettings
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    put1(aiGovernanceSettings, options) {
+        return (0, exports.AIGovernanceApiFp)(this.configuration).put1(aiGovernanceSettings, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.AIGovernanceApi = AIGovernanceApi;

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

@@ -0,0 +1,162 @@
+/**
+ * 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 { AiTaxonomyCategory } from '../models';
+import type { AiTaxonomyRenameRequest } from '../models';
+import type { AiTaxonomyRenameResult } from '../models';
+import type { AiTaxonomyView } from '../models';
+/**
+ * AITaxonomyApi - axios parameter creator
+ */
+export declare const AITaxonomyApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * source PROPERTIES: the table is empty and openfilz.ai.insights.categories rules (the rows shown are that list); source DATABASE: the managed rows rule. \'other\' is never a row — it is always appended.
+     * @summary The taxonomy and where it comes from
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get4: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Keys are normalised (lower case, hyphens), duplicates and \'other\' refused/dropped, positions follow the list order. An empty list is refused (400): use POST /reset to return to the properties.
+     * @summary Replace the whole taxonomy
+     * @param {Array<AiTaxonomyCategory>} aiTaxonomyCategory
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    put: (aiTaxonomyCategory: Array<AiTaxonomyCategory>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * relabel: rewrite every stored insight carrying the old key (and the search index mirror). backfill: start a forced insights backfill and return its job id — under the enterprise ownership rule it covers the documents the calling admin owns.
+     * @summary Rename a kind
+     * @param {string} key
+     * @param {AiTaxonomyRenameRequest} aiTaxonomyRenameRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rename: (key: string, aiTaxonomyRenameRequest: AiTaxonomyRenameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete every managed kind: the properties list rules again
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reset: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AITaxonomyApi - functional programming interface
+ */
+export declare const AITaxonomyApiFp: (configuration?: Configuration) => {
+    /**
+     * source PROPERTIES: the table is empty and openfilz.ai.insights.categories rules (the rows shown are that list); source DATABASE: the managed rows rule. \'other\' is never a row — it is always appended.
+     * @summary The taxonomy and where it comes from
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get4(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiTaxonomyView>>;
+    /**
+     * Keys are normalised (lower case, hyphens), duplicates and \'other\' refused/dropped, positions follow the list order. An empty list is refused (400): use POST /reset to return to the properties.
+     * @summary Replace the whole taxonomy
+     * @param {Array<AiTaxonomyCategory>} aiTaxonomyCategory
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    put(aiTaxonomyCategory: Array<AiTaxonomyCategory>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiTaxonomyView>>;
+    /**
+     * relabel: rewrite every stored insight carrying the old key (and the search index mirror). backfill: start a forced insights backfill and return its job id — under the enterprise ownership rule it covers the documents the calling admin owns.
+     * @summary Rename a kind
+     * @param {string} key
+     * @param {AiTaxonomyRenameRequest} aiTaxonomyRenameRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rename(key: string, aiTaxonomyRenameRequest: AiTaxonomyRenameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiTaxonomyRenameResult>>;
+    /**
+     *
+     * @summary Delete every managed kind: the properties list rules again
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reset(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiTaxonomyView>>;
+};
+/**
+ * AITaxonomyApi - factory interface
+ */
+export declare const AITaxonomyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * source PROPERTIES: the table is empty and openfilz.ai.insights.categories rules (the rows shown are that list); source DATABASE: the managed rows rule. \'other\' is never a row — it is always appended.
+     * @summary The taxonomy and where it comes from
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get4(options?: RawAxiosRequestConfig): AxiosPromise<AiTaxonomyView>;
+    /**
+     * Keys are normalised (lower case, hyphens), duplicates and \'other\' refused/dropped, positions follow the list order. An empty list is refused (400): use POST /reset to return to the properties.
+     * @summary Replace the whole taxonomy
+     * @param {Array<AiTaxonomyCategory>} aiTaxonomyCategory
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    put(aiTaxonomyCategory: Array<AiTaxonomyCategory>, options?: RawAxiosRequestConfig): AxiosPromise<AiTaxonomyView>;
+    /**
+     * relabel: rewrite every stored insight carrying the old key (and the search index mirror). backfill: start a forced insights backfill and return its job id — under the enterprise ownership rule it covers the documents the calling admin owns.
+     * @summary Rename a kind
+     * @param {string} key
+     * @param {AiTaxonomyRenameRequest} aiTaxonomyRenameRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rename(key: string, aiTaxonomyRenameRequest: AiTaxonomyRenameRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiTaxonomyRenameResult>;
+    /**
+     *
+     * @summary Delete every managed kind: the properties list rules again
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reset(options?: RawAxiosRequestConfig): AxiosPromise<AiTaxonomyView>;
+};
+/**
+ * AITaxonomyApi - object-oriented interface
+ */
+export declare class AITaxonomyApi extends BaseAPI {
+    /**
+     * source PROPERTIES: the table is empty and openfilz.ai.insights.categories rules (the rows shown are that list); source DATABASE: the managed rows rule. \'other\' is never a row — it is always appended.
+     * @summary The taxonomy and where it comes from
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get4(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiTaxonomyView, any, {}, any>>;
+    /**
+     * Keys are normalised (lower case, hyphens), duplicates and \'other\' refused/dropped, positions follow the list order. An empty list is refused (400): use POST /reset to return to the properties.
+     * @summary Replace the whole taxonomy
+     * @param {Array<AiTaxonomyCategory>} aiTaxonomyCategory
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    put(aiTaxonomyCategory: Array<AiTaxonomyCategory>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiTaxonomyView, any, {}, any>>;
+    /**
+     * relabel: rewrite every stored insight carrying the old key (and the search index mirror). backfill: start a forced insights backfill and return its job id — under the enterprise ownership rule it covers the documents the calling admin owns.
+     * @summary Rename a kind
+     * @param {string} key
+     * @param {AiTaxonomyRenameRequest} aiTaxonomyRenameRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rename(key: string, aiTaxonomyRenameRequest: AiTaxonomyRenameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiTaxonomyRenameResult, any, {}, any>>;
+    /**
+     *
+     * @summary Delete every managed kind: the properties list rules again
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reset(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiTaxonomyView, any, {}, any>>;
+}