@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240120.1 → 1.20240302.1

package/api/process-automation-api.ts

@@ -0,0 +1,365 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { EmailReportDTO } from '../models';
+// @ts-ignore
+import { FaxReportDTO } from '../models';
+// @ts-ignore
+import { SMSDTO } from '../models';
+// @ts-ignore
+import { StringVBAResponse } from '../models';
+/**
+ * ProcessAutomationApi - axios parameter creator
+ * @export
+ */
+export const ProcessAutomationApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Sends an email with attached report
+         * @summary Send Report Email
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {EmailReportDTO} emailReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendReportEmail: async (vbasoftwareDatabase: string, emailReportDTO: EmailReportDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('sendReportEmail', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'emailReportDTO' is not null or undefined
+            assertParamExists('sendReportEmail', 'emailReportDTO', emailReportDTO)
+            const localVarPath = `/process-automation/report/email`;
+            // 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 apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(emailReportDTO, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Sends a report via fax
+         * @summary Send Report Fax
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {FaxReportDTO} faxReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendReportFax: async (vbasoftwareDatabase: string, faxReportDTO: FaxReportDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('sendReportFax', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'faxReportDTO' is not null or undefined
+            assertParamExists('sendReportFax', 'faxReportDTO', faxReportDTO)
+            const localVarPath = `/process-automation/report/fax`;
+            // 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 apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(faxReportDTO, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Sends or schedules an SMS
+         * @summary Send or schedule SMS
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {SMSDTO} sMSDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendSMS: async (vbasoftwareDatabase: string, sMSDTO: SMSDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('sendSMS', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'sMSDTO' is not null or undefined
+            assertParamExists('sendSMS', 'sMSDTO', sMSDTO)
+            const localVarPath = `/process-automation/sms`;
+            // 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 apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(sMSDTO, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ProcessAutomationApi - functional programming interface
+ * @export
+ */
+export const ProcessAutomationApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ProcessAutomationApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Sends an email with attached report
+         * @summary Send Report Email
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {EmailReportDTO} emailReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async sendReportEmail(vbasoftwareDatabase: string, emailReportDTO: EmailReportDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.sendReportEmail(vbasoftwareDatabase, emailReportDTO, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Sends a report via fax
+         * @summary Send Report Fax
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {FaxReportDTO} faxReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async sendReportFax(vbasoftwareDatabase: string, faxReportDTO: FaxReportDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.sendReportFax(vbasoftwareDatabase, faxReportDTO, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Sends or schedules an SMS
+         * @summary Send or schedule SMS
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {SMSDTO} sMSDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async sendSMS(vbasoftwareDatabase: string, sMSDTO: SMSDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.sendSMS(vbasoftwareDatabase, sMSDTO, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * ProcessAutomationApi - factory interface
+ * @export
+ */
+export const ProcessAutomationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ProcessAutomationApiFp(configuration)
+    return {
+        /**
+         * Sends an email with attached report
+         * @summary Send Report Email
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {EmailReportDTO} emailReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendReportEmail(vbasoftwareDatabase: string, emailReportDTO: EmailReportDTO, options?: any): AxiosPromise<StringVBAResponse> {
+            return localVarFp.sendReportEmail(vbasoftwareDatabase, emailReportDTO, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Sends a report via fax
+         * @summary Send Report Fax
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {FaxReportDTO} faxReportDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendReportFax(vbasoftwareDatabase: string, faxReportDTO: FaxReportDTO, options?: any): AxiosPromise<StringVBAResponse> {
+            return localVarFp.sendReportFax(vbasoftwareDatabase, faxReportDTO, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Sends or schedules an SMS
+         * @summary Send or schedule SMS
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {SMSDTO} sMSDTO 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendSMS(vbasoftwareDatabase: string, sMSDTO: SMSDTO, options?: any): AxiosPromise<StringVBAResponse> {
+            return localVarFp.sendSMS(vbasoftwareDatabase, sMSDTO, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ProcessAutomationApi - interface
+ * @export
+ * @interface ProcessAutomationApi
+ */
+export interface ProcessAutomationApiInterface {
+    /**
+     * Sends an email with attached report
+     * @summary Send Report Email
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {EmailReportDTO} emailReportDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApiInterface
+     */
+    sendReportEmail(vbasoftwareDatabase: string, emailReportDTO: EmailReportDTO, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
+    /**
+     * Sends a report via fax
+     * @summary Send Report Fax
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {FaxReportDTO} faxReportDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApiInterface
+     */
+    sendReportFax(vbasoftwareDatabase: string, faxReportDTO: FaxReportDTO, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
+    /**
+     * Sends or schedules an SMS
+     * @summary Send or schedule SMS
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {SMSDTO} sMSDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApiInterface
+     */
+    sendSMS(vbasoftwareDatabase: string, sMSDTO: SMSDTO, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
+}
+
+/**
+ * ProcessAutomationApi - object-oriented interface
+ * @export
+ * @class ProcessAutomationApi
+ * @extends {BaseAPI}
+ */
+export class ProcessAutomationApi extends BaseAPI implements ProcessAutomationApiInterface {
+    /**
+     * Sends an email with attached report
+     * @summary Send Report Email
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {EmailReportDTO} emailReportDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApi
+     */
+    public sendReportEmail(vbasoftwareDatabase: string, emailReportDTO: EmailReportDTO, options?: AxiosRequestConfig) {
+        return ProcessAutomationApiFp(this.configuration).sendReportEmail(vbasoftwareDatabase, emailReportDTO, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Sends a report via fax
+     * @summary Send Report Fax
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {FaxReportDTO} faxReportDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApi
+     */
+    public sendReportFax(vbasoftwareDatabase: string, faxReportDTO: FaxReportDTO, options?: AxiosRequestConfig) {
+        return ProcessAutomationApiFp(this.configuration).sendReportFax(vbasoftwareDatabase, faxReportDTO, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Sends or schedules an SMS
+     * @summary Send or schedule SMS
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {SMSDTO} sMSDTO 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessAutomationApi
+     */
+    public sendSMS(vbasoftwareDatabase: string, sMSDTO: SMSDTO, options?: AxiosRequestConfig) {
+        return ProcessAutomationApiFp(this.configuration).sendSMS(vbasoftwareDatabase, sMSDTO, options).then((request) => request(this.axios, this.basePath));
+    }
+}