@openfilz-sdk/typescript-ee 1.3.5

package/api/search-administration-api.ts

@@ -0,0 +1,314 @@
+/* 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';
+/**
+ * SearchAdministrationApi - axios parameter creator
+ */
+export const SearchAdministrationApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Creates or recreates the OpenSearch index with proper mappings and analyzer settings.
+         * @summary Create search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createIndex: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/search`;
+            // 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,
+            };
+        },
+        /**
+         * Deletes the OpenSearch index. Requires full-text search to be enabled.
+         * @summary Delete search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteIndex: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/search`;
+            // 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)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns the current status of the reindexation process.
+         * @summary Get reindexation status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/search/status`;
+            // 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,
+            };
+        },
+        /**
+         * Triggers a full reindexation of all documents. Runs asynchronously in the background.
+         * @summary Reindex all documents
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reindexAll: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/search/reindex`;
+            // 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,
+            };
+        },
+    }
+};
+
+/**
+ * SearchAdministrationApi - functional programming interface
+ */
+export const SearchAdministrationApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SearchAdministrationApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Creates or recreates the OpenSearch index with proper mappings and analyzer settings.
+         * @summary Create search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createIndex(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createIndex(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.createIndex']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Deletes the OpenSearch index. Requires full-text search to be enabled.
+         * @summary Delete search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteIndex(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIndex(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.deleteIndex']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Returns the current status of the reindexation process.
+         * @summary Get reindexation status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getStatus(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.getStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Triggers a full reindexation of all documents. Runs asynchronously in the background.
+         * @summary Reindex all documents
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async reindexAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.reindexAll(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.reindexAll']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * SearchAdministrationApi - factory interface
+ */
+export const SearchAdministrationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SearchAdministrationApiFp(configuration)
+    return {
+        /**
+         * Creates or recreates the OpenSearch index with proper mappings and analyzer settings.
+         * @summary Create search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createIndex(options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.createIndex(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Deletes the OpenSearch index. Requires full-text search to be enabled.
+         * @summary Delete search index
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteIndex(options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.deleteIndex(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns the current status of the reindexation process.
+         * @summary Get reindexation status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStatus(options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.getStatus(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Triggers a full reindexation of all documents. Runs asynchronously in the background.
+         * @summary Reindex all documents
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reindexAll(options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.reindexAll(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * SearchAdministrationApi - object-oriented interface
+ */
+export class SearchAdministrationApi extends BaseAPI {
+    /**
+     * Creates or recreates the OpenSearch index with proper mappings and analyzer settings.
+     * @summary Create search index
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public createIndex(options?: RawAxiosRequestConfig) {
+        return SearchAdministrationApiFp(this.configuration).createIndex(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Deletes the OpenSearch index. Requires full-text search to be enabled.
+     * @summary Delete search index
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public deleteIndex(options?: RawAxiosRequestConfig) {
+        return SearchAdministrationApiFp(this.configuration).deleteIndex(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns the current status of the reindexation process.
+     * @summary Get reindexation status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getStatus(options?: RawAxiosRequestConfig) {
+        return SearchAdministrationApiFp(this.configuration).getStatus(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Triggers a full reindexation of all documents. Runs asynchronously in the background.
+     * @summary Reindex all documents
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public reindexAll(options?: RawAxiosRequestConfig) {
+        return SearchAdministrationApiFp(this.configuration).reindexAll(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api/settings-api.ts

@@ -0,0 +1,196 @@
+/* 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 { Settings } from '../models';
+// @ts-ignore
+import type { UserPreferencesRequest } from '../models';
+/**
+ * SettingsApi - axios parameter creator
+ */
+export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieve user\'s settings : global settings and user\'s preferences
+         * @summary Get user\'s settings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettings: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/settings`;
+            // 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,
+            };
+        },
+        /**
+         * Save user\'s language and theme preferences
+         * @summary Save user preferences
+         * @param {UserPreferencesRequest} userPreferencesRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveSettings: async (userPreferencesRequest: UserPreferencesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'userPreferencesRequest' is not null or undefined
+            assertParamExists('saveSettings', 'userPreferencesRequest', userPreferencesRequest)
+            const localVarPath = `/api/v1/settings`;
+            // 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(userPreferencesRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SettingsApi - functional programming interface
+ */
+export const SettingsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieve user\'s settings : global settings and user\'s preferences
+         * @summary Get user\'s settings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSettings(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SettingsApi.getSettings']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Save user\'s language and theme preferences
+         * @summary Save user preferences
+         * @param {UserPreferencesRequest} userPreferencesRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async saveSettings(userPreferencesRequest: UserPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.saveSettings(userPreferencesRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SettingsApi.saveSettings']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * SettingsApi - factory interface
+ */
+export const SettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SettingsApiFp(configuration)
+    return {
+        /**
+         * Retrieve user\'s settings : global settings and user\'s preferences
+         * @summary Get user\'s settings
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettings(options?: RawAxiosRequestConfig): AxiosPromise<Settings> {
+            return localVarFp.getSettings(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Save user\'s language and theme preferences
+         * @summary Save user preferences
+         * @param {UserPreferencesRequest} userPreferencesRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        saveSettings(userPreferencesRequest: UserPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Settings> {
+            return localVarFp.saveSettings(userPreferencesRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * SettingsApi - object-oriented interface
+ */
+export class SettingsApi extends BaseAPI {
+    /**
+     * Retrieve user\'s settings : global settings and user\'s preferences
+     * @summary Get user\'s settings
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getSettings(options?: RawAxiosRequestConfig) {
+        return SettingsApiFp(this.configuration).getSettings(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Save user\'s language and theme preferences
+     * @summary Save user preferences
+     * @param {UserPreferencesRequest} userPreferencesRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public saveSettings(userPreferencesRequest: UserPreferencesRequest, options?: RawAxiosRequestConfig) {
+        return SettingsApiFp(this.configuration).saveSettings(userPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+