@openfilz-sdk/typescript-ee 1.3.5

package/dist/esm/api/scan-agent-api.js

@@ -0,0 +1,201 @@
+/* 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());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * ScanAgentApi - axios parameter creator
+ */
+export const ScanAgentApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Downloads the scan agent for the specified platform. Use format=zip (default) for the portable ZIP archive, or format=installer for the native installer (.deb/.exe/.dmg). Supports ETag-based caching to avoid redundant downloads.
+         * @summary Download agent binary
+         * @param {string} platform
+         * @param {string} [format]
+         * @param {string} [ifNoneMatch]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        download: (platform_1, format_1, ifNoneMatch_1, ...args_1) => __awaiter(this, [platform_1, format_1, ifNoneMatch_1, ...args_1], void 0, function* (platform, format, ifNoneMatch, options = {}) {
+            // verify required parameter 'platform' is not null or undefined
+            assertParamExists('download', 'platform', platform);
+            const localVarPath = `/api/v1/agent/download/{platform}`
+                .replace(`{${"platform"}}`, encodeURIComponent(String(platform)));
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            if (format !== undefined) {
+                localVarQueryParameter['format'] = format;
+            }
+            localVarHeaderParameter['Accept'] = '*/*';
+            if (ifNoneMatch != null) {
+                localVarHeaderParameter['If-None-Match'] = String(ifNoneMatch);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Returns the expected agent version, available platforms, and download formats (zip, installer)
+         * @summary Get agent version
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getVersion: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/agent/version`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ScanAgentApi - functional programming interface
+ */
+export const ScanAgentApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ScanAgentApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Downloads the scan agent for the specified platform. Use format=zip (default) for the portable ZIP archive, or format=installer for the native installer (.deb/.exe/.dmg). Supports ETag-based caching to avoid redundant downloads.
+         * @summary Download agent binary
+         * @param {string} platform
+         * @param {string} [format]
+         * @param {string} [ifNoneMatch]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        download(platform, format, ifNoneMatch, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.download(platform, format, ifNoneMatch, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ScanAgentApi.download']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Returns the expected agent version, available platforms, and download formats (zip, installer)
+         * @summary Get agent version
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getVersion(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getVersion(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ScanAgentApi.getVersion']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ScanAgentApi - factory interface
+ */
+export const ScanAgentApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ScanAgentApiFp(configuration);
+    return {
+        /**
+         * Downloads the scan agent for the specified platform. Use format=zip (default) for the portable ZIP archive, or format=installer for the native installer (.deb/.exe/.dmg). Supports ETag-based caching to avoid redundant downloads.
+         * @summary Download agent binary
+         * @param {string} platform
+         * @param {string} [format]
+         * @param {string} [ifNoneMatch]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        download(platform, format, ifNoneMatch, options) {
+            return localVarFp.download(platform, format, ifNoneMatch, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns the expected agent version, available platforms, and download formats (zip, installer)
+         * @summary Get agent version
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getVersion(options) {
+            return localVarFp.getVersion(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ScanAgentApi - object-oriented interface
+ */
+export class ScanAgentApi extends BaseAPI {
+    /**
+     * Downloads the scan agent for the specified platform. Use format=zip (default) for the portable ZIP archive, or format=installer for the native installer (.deb/.exe/.dmg). Supports ETag-based caching to avoid redundant downloads.
+     * @summary Download agent binary
+     * @param {string} platform
+     * @param {string} [format]
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    download(platform, format, ifNoneMatch, options) {
+        return ScanAgentApiFp(this.configuration).download(platform, format, ifNoneMatch, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns the expected agent version, available platforms, and download formats (zip, installer)
+     * @summary Get agent version
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVersion(options) {
+        return ScanAgentApiFp(this.configuration).getVersion(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/scanner-proxy-api.d.ts

@@ -0,0 +1,202 @@
+/**
+ * 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 { IngestionStatusDto } from '../models';
+import type { ScanJobStatusDto } from '../models';
+import type { ScanRequestDto } from '../models';
+import type { ScannerInfoDto } from '../models';
+/**
+ * ScannerProxyApi - axios parameter creator
+ */
+export declare const ScannerProxyApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns ingestion service status including eSCL feature flag
+     * @summary Get ingestion status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIngestionStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * List all discovered eSCL scanners on the network
+     * @summary List scanners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScanners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * ScannerProxyApi - functional programming interface
+ */
+export declare const ScannerProxyApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns ingestion service status including eSCL feature flag
+     * @summary Get ingestion status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIngestionStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IngestionStatusDto>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScanJobStatusDto>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScannerInfoDto>>;
+    /**
+     * List all discovered eSCL scanners on the network
+     * @summary List scanners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScanners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScannerInfoDto>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScanJobStatusDto>>;
+};
+/**
+ * ScannerProxyApi - factory interface
+ */
+export declare const ScannerProxyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>>;
+    /**
+     * 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>;
+};
+/**
+ * ScannerProxyApi - object-oriented interface
+ */
+export declare class ScannerProxyApi extends BaseAPI {
+    /**
+     * Returns ingestion service status including eSCL feature flag
+     * @summary Get ingestion status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIngestionStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IngestionStatusDto, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ScanJobStatusDto, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ScannerInfoDto, any, {}>>;
+    /**
+     * List all discovered eSCL scanners on the network
+     * @summary List scanners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listScanners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScannerInfoDto[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ScanJobStatusDto, any, {}>>;
+}