@openfilz-sdk/typescript-ee 1.3.5

package/api/scanner-proxy-api.ts

@@ -0,0 +1,428 @@
+/* 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 { IngestionStatusDto } from '../models';
+// @ts-ignore
+import type { ScanJobStatusDto } from '../models';
+// @ts-ignore
+import type { ScanRequestDto } from '../models';
+// @ts-ignore
+import type { ScannerInfoDto } from '../models';
+/**
+ * ScannerProxyApi - axios parameter creator
+ */
+export const ScannerProxyApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns ingestion service status including eSCL feature flag
+         * @summary Get ingestion status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getIngestionStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/scan/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,
+            };
+        },
+        /**
+         * Get the status of a specific scan job
+         * @summary Get scan job status
+         * @param {string} id 
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getScanJobStatus: async (id: string, jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getScanJobStatus', 'id', id)
+            // verify required parameter 'jobId' is not null or undefined
+            assertParamExists('getScanJobStatus', 'jobId', jobId)
+            const localVarPath = `/api/v1/scan/scanners/{id}/scan/{jobId}/status`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"jobId"}}`, encodeURIComponent(String(jobId)));
+            // 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,
+            };
+        },
+        /**
+         * Get detailed capabilities for a specific scanner
+         * @summary Get scanner capabilities
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getScannerCapabilities: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getScannerCapabilities', 'id', id)
+            const localVarPath = `/api/v1/scan/scanners/{id}/capabilities`
+                .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,
+            };
+        },
+        /**
+         * List all discovered eSCL scanners on the network
+         * @summary List scanners
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listScanners: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/scan/scanners`;
+            // 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,
+            };
+        },
+        /**
+         * Trigger a scan on a specific scanner
+         * @summary Trigger scan
+         * @param {string} id 
+         * @param {string} [authorization] 
+         * @param {ScanRequestDto} [scanRequestDto] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerScan: async (id: string, authorization?: string, scanRequestDto?: ScanRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('triggerScan', 'id', id)
+            const localVarPath = `/api/v1/scan/scanners/{id}/scan`
+                .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['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            if (authorization != null) {
+                localVarHeaderParameter['Authorization'] = String(authorization);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(scanRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ScannerProxyApi - functional programming interface
+ */
+export const ScannerProxyApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ScannerProxyApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Returns ingestion service status including eSCL feature flag
+         * @summary Get ingestion status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getIngestionStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IngestionStatusDto>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getIngestionStatus(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ScannerProxyApi.getIngestionStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get the status of a specific scan job
+         * @summary Get scan job status
+         * @param {string} id 
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getScanJobStatus(id: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScanJobStatusDto>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getScanJobStatus(id, jobId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ScannerProxyApi.getScanJobStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get detailed capabilities for a specific scanner
+         * @summary Get scanner capabilities
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getScannerCapabilities(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScannerInfoDto>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getScannerCapabilities(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ScannerProxyApi.getScannerCapabilities']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List all discovered eSCL scanners on the network
+         * @summary List scanners
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listScanners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScannerInfoDto>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listScanners(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ScannerProxyApi.listScanners']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Trigger a scan on a specific scanner
+         * @summary Trigger scan
+         * @param {string} id 
+         * @param {string} [authorization] 
+         * @param {ScanRequestDto} [scanRequestDto] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerScan(id: string, authorization?: string, scanRequestDto?: ScanRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScanJobStatusDto>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerScan(id, authorization, scanRequestDto, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ScannerProxyApi.triggerScan']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ScannerProxyApi - factory interface
+ */
+export const ScannerProxyApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ScannerProxyApiFp(configuration)
+    return {
+        /**
+         * Returns ingestion service status including eSCL feature flag
+         * @summary Get ingestion status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getIngestionStatus(options?: RawAxiosRequestConfig): AxiosPromise<IngestionStatusDto> {
+            return localVarFp.getIngestionStatus(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get the status of a specific scan job
+         * @summary Get scan job status
+         * @param {string} id 
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getScanJobStatus(id: string, jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<ScanJobStatusDto> {
+            return localVarFp.getScanJobStatus(id, jobId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get detailed capabilities for a specific scanner
+         * @summary Get scanner capabilities
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getScannerCapabilities(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ScannerInfoDto> {
+            return localVarFp.getScannerCapabilities(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List all discovered eSCL scanners on the network
+         * @summary List scanners
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listScanners(options?: RawAxiosRequestConfig): AxiosPromise<Array<ScannerInfoDto>> {
+            return localVarFp.listScanners(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Trigger a scan on a specific scanner
+         * @summary Trigger scan
+         * @param {string} id 
+         * @param {string} [authorization] 
+         * @param {ScanRequestDto} [scanRequestDto] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerScan(id: string, authorization?: string, scanRequestDto?: ScanRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<ScanJobStatusDto> {
+            return localVarFp.triggerScan(id, authorization, scanRequestDto, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ScannerProxyApi - object-oriented interface
+ */
+export class ScannerProxyApi extends BaseAPI {
+    /**
+     * Returns ingestion service status including eSCL feature flag
+     * @summary Get ingestion status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getIngestionStatus(options?: RawAxiosRequestConfig) {
+        return ScannerProxyApiFp(this.configuration).getIngestionStatus(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get the status of a specific scan job
+     * @summary Get scan job status
+     * @param {string} id 
+     * @param {string} jobId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getScanJobStatus(id: string, jobId: string, options?: RawAxiosRequestConfig) {
+        return ScannerProxyApiFp(this.configuration).getScanJobStatus(id, jobId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get detailed capabilities for a specific scanner
+     * @summary Get scanner capabilities
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getScannerCapabilities(id: string, options?: RawAxiosRequestConfig) {
+        return ScannerProxyApiFp(this.configuration).getScannerCapabilities(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List all discovered eSCL scanners on the network
+     * @summary List scanners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listScanners(options?: RawAxiosRequestConfig) {
+        return ScannerProxyApiFp(this.configuration).listScanners(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Trigger a scan on a specific scanner
+     * @summary Trigger scan
+     * @param {string} id 
+     * @param {string} [authorization] 
+     * @param {ScanRequestDto} [scanRequestDto] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public triggerScan(id: string, authorization?: string, scanRequestDto?: ScanRequestDto, options?: RawAxiosRequestConfig) {
+        return ScannerProxyApiFp(this.configuration).triggerScan(id, authorization, scanRequestDto, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+