@openfilz-sdk/typescript-ee 1.3.5

package/api/audit-controller-api.ts

@@ -0,0 +1,283 @@
+/* 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 { AuditLog } from '../models';
+// @ts-ignore
+import type { AuditVerificationResult } from '../models';
+// @ts-ignore
+import type { SearchByAuditLogRequest } from '../models';
+/**
+ * AuditControllerApi - axios parameter creator
+ */
+export const AuditControllerApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves the audit trail for a given resource.
+         * @summary Get audit trail for a resource
+         * @param {string} id ID of the resource to get the audit trail for
+         * @param {GetAuditTrailSortEnum} [sort] Sort order for the audit trail. Can be \'ASC\' or \'DESC\'. Default is \'DESC\'
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAuditTrail: async (id: string, sort?: GetAuditTrailSortEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getAuditTrail', 'id', id)
+            const localVarPath = `/api/v1/audit/{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)
+
+            if (sort !== undefined) {
+                localVarQueryParameter['sort'] = sort;
+            }
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves the audit trail according to the search parameters
+         * @summary Search for audit trails
+         * @param {SearchByAuditLogRequest} searchByAuditLogRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchAuditTrail: async (searchByAuditLogRequest: SearchByAuditLogRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'searchByAuditLogRequest' is not null or undefined
+            assertParamExists('searchAuditTrail', 'searchByAuditLogRequest', searchByAuditLogRequest)
+            const localVarPath = `/api/v1/audit/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['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(searchByAuditLogRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Verifies the cryptographic hash chain of the audit log to detect any tampering.
+         * @summary Verify audit chain integrity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        verifyChain: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/audit/verify`;
+            // 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,
+            };
+        },
+    }
+};
+
+/**
+ * AuditControllerApi - functional programming interface
+ */
+export const AuditControllerApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AuditControllerApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves the audit trail for a given resource.
+         * @summary Get audit trail for a resource
+         * @param {string} id ID of the resource to get the audit trail for
+         * @param {GetAuditTrailSortEnum} [sort] Sort order for the audit trail. Can be \&#39;ASC\&#39; or \&#39;DESC\&#39;. Default is \&#39;DESC\&#39;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getAuditTrail(id: string, sort?: GetAuditTrailSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AuditLog>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAuditTrail(id, sort, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AuditControllerApi.getAuditTrail']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Retrieves the audit trail according to the search parameters
+         * @summary Search for audit trails
+         * @param {SearchByAuditLogRequest} searchByAuditLogRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async searchAuditTrail(searchByAuditLogRequest: SearchByAuditLogRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AuditLog>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.searchAuditTrail(searchByAuditLogRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AuditControllerApi.searchAuditTrail']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Verifies the cryptographic hash chain of the audit log to detect any tampering.
+         * @summary Verify audit chain integrity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async verifyChain(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditVerificationResult>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.verifyChain(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AuditControllerApi.verifyChain']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AuditControllerApi - factory interface
+ */
+export const AuditControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AuditControllerApiFp(configuration)
+    return {
+        /**
+         * Retrieves the audit trail for a given resource.
+         * @summary Get audit trail for a resource
+         * @param {string} id ID of the resource to get the audit trail for
+         * @param {GetAuditTrailSortEnum} [sort] Sort order for the audit trail. Can be \&#39;ASC\&#39; or \&#39;DESC\&#39;. Default is \&#39;DESC\&#39;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAuditTrail(id: string, sort?: GetAuditTrailSortEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<AuditLog>> {
+            return localVarFp.getAuditTrail(id, sort, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves the audit trail according to the search parameters
+         * @summary Search for audit trails
+         * @param {SearchByAuditLogRequest} searchByAuditLogRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchAuditTrail(searchByAuditLogRequest: SearchByAuditLogRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<AuditLog>> {
+            return localVarFp.searchAuditTrail(searchByAuditLogRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Verifies the cryptographic hash chain of the audit log to detect any tampering.
+         * @summary Verify audit chain integrity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        verifyChain(options?: RawAxiosRequestConfig): AxiosPromise<AuditVerificationResult> {
+            return localVarFp.verifyChain(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AuditControllerApi - object-oriented interface
+ */
+export class AuditControllerApi extends BaseAPI {
+    /**
+     * Retrieves the audit trail for a given resource.
+     * @summary Get audit trail for a resource
+     * @param {string} id ID of the resource to get the audit trail for
+     * @param {GetAuditTrailSortEnum} [sort] Sort order for the audit trail. Can be \&#39;ASC\&#39; or \&#39;DESC\&#39;. Default is \&#39;DESC\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getAuditTrail(id: string, sort?: GetAuditTrailSortEnum, options?: RawAxiosRequestConfig) {
+        return AuditControllerApiFp(this.configuration).getAuditTrail(id, sort, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves the audit trail according to the search parameters
+     * @summary Search for audit trails
+     * @param {SearchByAuditLogRequest} searchByAuditLogRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public searchAuditTrail(searchByAuditLogRequest: SearchByAuditLogRequest, options?: RawAxiosRequestConfig) {
+        return AuditControllerApiFp(this.configuration).searchAuditTrail(searchByAuditLogRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Verifies the cryptographic hash chain of the audit log to detect any tampering.
+     * @summary Verify audit chain integrity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public verifyChain(options?: RawAxiosRequestConfig) {
+        return AuditControllerApiFp(this.configuration).verifyChain(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+export const GetAuditTrailSortEnum = {
+    Asc: 'ASC',
+    Desc: 'DESC'
+} as const;
+export type GetAuditTrailSortEnum = typeof GetAuditTrailSortEnum[keyof typeof GetAuditTrailSortEnum];