@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/api/aiteam-inboxes-api.ts

@@ -0,0 +1,491 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { TeamInboxRequest } from '../models';
+// @ts-ignore
+import type { TeamInboxView } from '../models';
+/**
+ * AITeamInboxesApi - axios parameter creator
+ */
+export const AITeamInboxesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * teamId must be a team, inboxFolderId an existing folder not already an inbox, targetRootFolderId (optional, null = the library root) a folder outside the inbox, technicalUserEmail an OpenFilz user.
+         * @summary Create a team inbox
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        create2: async (teamInboxRequest: TeamInboxRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'teamInboxRequest' is not null or undefined
+            assertParamExists('create2', 'teamInboxRequest', teamInboxRequest)
+            const localVarPath = `/api/v1/admin/ai/team-inboxes`;
+            // 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'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(teamInboxRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Delete a team inbox (the folder and its documents stay)
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        delete1: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('delete1', 'id', id)
+            const localVarPath = `/api/v1/admin/ai/team-inboxes/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary One team inbox, with its warnings
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get3: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('get3', 'id', id)
+            const localVarPath = `/api/v1/admin/ai/team-inboxes/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary List the team inboxes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        list2: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/ai/team-inboxes`;
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Schedules one smart-filing job for every file lying loose in the inbox, as the technical user, whatever the inbox\'s interval, and returns the inbox with its lastRunAt / lastJobId. 400 when the inbox is disabled or smart filing is off.
+         * @summary File the inbox now
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        run: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('run', 'id', id)
+            const localVarPath = `/api/v1/admin/ai/team-inboxes/{id}/run`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Replace a team inbox
+         * @param {string} id 
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        update2: async (id: string, teamInboxRequest: TeamInboxRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('update2', 'id', id)
+            // verify required parameter 'teamInboxRequest' is not null or undefined
+            assertParamExists('update2', 'teamInboxRequest', teamInboxRequest)
+            const localVarPath = `/api/v1/admin/ai/team-inboxes/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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: 'PUT', ...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'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(teamInboxRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AITeamInboxesApi - functional programming interface
+ */
+export const AITeamInboxesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AITeamInboxesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * teamId must be a team, inboxFolderId an existing folder not already an inbox, targetRootFolderId (optional, null = the library root) a folder outside the inbox, technicalUserEmail an OpenFilz user.
+         * @summary Create a team inbox
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async create2(teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamInboxView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.create2(teamInboxRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.create2']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Delete a team inbox (the folder and its documents stay)
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async delete1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.delete1(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.delete1']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary One team inbox, with its warnings
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async get3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamInboxView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.get3(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.get3']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary List the team inboxes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async list2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamInboxView>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.list2(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.list2']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Schedules one smart-filing job for every file lying loose in the inbox, as the technical user, whatever the inbox\'s interval, and returns the inbox with its lastRunAt / lastJobId. 400 when the inbox is disabled or smart filing is off.
+         * @summary File the inbox now
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async run(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamInboxView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.run(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.run']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Replace a team inbox
+         * @param {string} id 
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async update2(id: string, teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamInboxView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.update2(id, teamInboxRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AITeamInboxesApi.update2']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AITeamInboxesApi - factory interface
+ */
+export const AITeamInboxesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AITeamInboxesApiFp(configuration)
+    return {
+        /**
+         * teamId must be a team, inboxFolderId an existing folder not already an inbox, targetRootFolderId (optional, null = the library root) a folder outside the inbox, technicalUserEmail an OpenFilz user.
+         * @summary Create a team inbox
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        create2(teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamInboxView> {
+            return localVarFp.create2(teamInboxRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Delete a team inbox (the folder and its documents stay)
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        delete1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.delete1(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary One team inbox, with its warnings
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<TeamInboxView> {
+            return localVarFp.get3(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary List the team inboxes
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        list2(options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamInboxView>> {
+            return localVarFp.list2(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Schedules one smart-filing job for every file lying loose in the inbox, as the technical user, whatever the inbox\'s interval, and returns the inbox with its lastRunAt / lastJobId. 400 when the inbox is disabled or smart filing is off.
+         * @summary File the inbox now
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        run(id: string, options?: RawAxiosRequestConfig): AxiosPromise<TeamInboxView> {
+            return localVarFp.run(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Replace a team inbox
+         * @param {string} id 
+         * @param {TeamInboxRequest} teamInboxRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        update2(id: string, teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamInboxView> {
+            return localVarFp.update2(id, teamInboxRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AITeamInboxesApi - object-oriented interface
+ */
+export class AITeamInboxesApi extends BaseAPI {
+    /**
+     * teamId must be a team, inboxFolderId an existing folder not already an inbox, targetRootFolderId (optional, null = the library root) a folder outside the inbox, technicalUserEmail an OpenFilz user.
+     * @summary Create a team inbox
+     * @param {TeamInboxRequest} teamInboxRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public create2(teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).create2(teamInboxRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Delete a team inbox (the folder and its documents stay)
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public delete1(id: string, options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).delete1(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary One team inbox, with its warnings
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public get3(id: string, options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).get3(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary List the team inboxes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public list2(options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).list2(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Schedules one smart-filing job for every file lying loose in the inbox, as the technical user, whatever the inbox\'s interval, and returns the inbox with its lastRunAt / lastJobId. 400 when the inbox is disabled or smart filing is off.
+     * @summary File the inbox now
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public run(id: string, options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).run(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Replace a team inbox
+     * @param {string} id 
+     * @param {TeamInboxRequest} teamInboxRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public update2(id: string, teamInboxRequest: TeamInboxRequest, options?: RawAxiosRequestConfig) {
+        return AITeamInboxesApiFp(this.configuration).update2(id, teamInboxRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+