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

package/api/vbareports-api.ts

@@ -0,0 +1,155 @@
+/* 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 { VBAReportListVBAResponse } from '../models';
+/**
+ * VBAReportsApi - axios parameter creator
+ * @export
+ */
+export const VBAReportsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Lists all VBA Report
+         * @summary List VBA Report
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listVBAReports: async (vbasoftwareDatabase: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listVBAReports', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/reports`;
+            // 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 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);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * VBAReportsApi - functional programming interface
+ * @export
+ */
+export const VBAReportsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = VBAReportsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Lists all VBA Report
+         * @summary List VBA Report
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listVBAReports(vbasoftwareDatabase: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAReportListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listVBAReports(vbasoftwareDatabase, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * VBAReportsApi - factory interface
+ * @export
+ */
+export const VBAReportsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = VBAReportsApiFp(configuration)
+    return {
+        /**
+         * Lists all VBA Report
+         * @summary List VBA Report
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listVBAReports(vbasoftwareDatabase: string, options?: any): AxiosPromise<VBAReportListVBAResponse> {
+            return localVarFp.listVBAReports(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * VBAReportsApi - interface
+ * @export
+ * @interface VBAReportsApi
+ */
+export interface VBAReportsApiInterface {
+    /**
+     * Lists all VBA Report
+     * @summary List VBA Report
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportsApiInterface
+     */
+    listVBAReports(vbasoftwareDatabase: string, options?: AxiosRequestConfig): AxiosPromise<VBAReportListVBAResponse>;
+
+}
+
+/**
+ * VBAReportsApi - object-oriented interface
+ * @export
+ * @class VBAReportsApi
+ * @extends {BaseAPI}
+ */
+export class VBAReportsApi extends BaseAPI implements VBAReportsApiInterface {
+    /**
+     * Lists all VBA Report
+     * @summary List VBA Report
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportsApi
+     */
+    public listVBAReports(vbasoftwareDatabase: string, options?: AxiosRequestConfig) {
+        return VBAReportsApiFp(this.configuration).listVBAReports(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api.ts

@@ -30,6 +30,7 @@ export * from './api/adv-group-contracts-api';
 export * from './api/adv-group-divisions-api';
 export * from './api/adv-groups-api';
 export * from './api/adv-reinsurance-api';
+export * from './api/adv-workflow-api';
 export * from './api/age-settings-api';
 export * from './api/agriculture-tax-returns-api';
 export * from './api/amount-details-api';
@@ -221,6 +222,7 @@ export * from './api/claim-types-api';
 export * from './api/claim-value-codes-api';
 export * from './api/claims-api';
 export * from './api/classes-api';
+export * from './api/client-config-api';
 export * from './api/college-types-api';
 export * from './api/colleges-api';
 export * from './api/commission-activity-api';
@@ -443,6 +445,7 @@ export * from './api/group-subscriber-reimbursements-api';
 export * from './api/group-tax-day-limit-types-api';
 export * from './api/group-term-rules-api';
 export * from './api/group-ucpercent-claim-types-api';
+export * from './api/group-ucpercent-criterias-api';
 export * from './api/group-ucpercent-settings-api';
 export * from './api/group-vbaplan-types-api';
 export * from './api/group-volumes-api';
@@ -627,6 +630,7 @@ export * from './api/procedure-code-qualifiers-api';
 export * from './api/procedure-code-sets-api';
 export * from './api/procedure-codes-api';
 export * from './api/procedure-groups-api';
+export * from './api/process-automation-api';
 export * from './api/process-logging-api';
 export * from './api/process-parameters-api';
 export * from './api/processes-api';
@@ -767,6 +771,7 @@ export * from './api/subscriber-prior-accumulators-api';
 export * from './api/subscriber-waive-premiums-api';
 export * from './api/subscribers-api';
 export * from './api/suffix-api';
+export * from './api/support-api';
 export * from './api/suspense-claims-api';
 export * from './api/suspense-criterias-api';
 export * from './api/suspense-types-api';
@@ -806,6 +811,7 @@ export * from './api/vbainterface-types-api';
 export * from './api/vbainterface-vendors-api';
 export * from './api/vbainterfaces-api';
 export * from './api/vbaplan-types-api';
+export * from './api/vbareports-api';
 export * from './api/vbassist-api';
 export * from './api/volume-types-api';
 export * from './api/waiting-period-types-api';

package/models/auth.ts

@@ -189,7 +189,7 @@ export interface Auth {
      */
     'cityCode_ID'?: string | null;
     /**
-     * Field no longer used. This is repalced by the Status field.
+     * Field no longer used. This is repalced by the Status field.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {boolean}
      * @memberof Auth
      */
@@ -230,6 +230,18 @@ export interface Auth {
      * @memberof Auth
      */
     'discharge_Date'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof Auth
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof Auth
+     */
+    'entry_User'?: string | null;
     /**
      * Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting \'Lookup\' from the context menu.
      * @type {string}
@@ -267,7 +279,7 @@ export interface Auth {
      */
     'narrative'?: string | null;
     /**
-     * Indicates that the associated authorization is a new authorization or an extension of the original authorization.
+     * Indicates that the associated authorization is a new authorization or an extension of the original authorization.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {boolean}
      * @memberof Auth
      */
@@ -321,7 +333,7 @@ export interface Auth {
      */
     'previous_Auth'?: string | null;
     /**
-     * Check this box to indicate that previous treatment had been administered.
+     * Check this box to indicate that previous treatment had been administered.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {boolean}
      * @memberof Auth
      */
@@ -429,7 +441,7 @@ export interface Auth {
      */
     'subscriber_ID'?: string | null;
     /**
-     * Indicates if the Treatment Plan was downloaded from the application.
+     * Indicates if the Treatment Plan was downloaded from the application.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {boolean}
      * @memberof Auth
      */
@@ -525,7 +537,19 @@ export interface Auth {
      */
     'units_Requested'?: number | null;
     /**
-     * Check this box to indicate that the authorization request is urgent.
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof Auth
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof Auth
+     */
+    'update_User'?: string | null;
+    /**
+     * Check this box to indicate that the authorization request is urgent.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {boolean}
      * @memberof Auth
      */

package/models/callback-dto.ts

@@ -0,0 +1,43 @@
+/* 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 { JsonValue } from './json-value';
+
+/**
+ * 
+ * @export
+ * @interface CallbackDTO
+ */
+export interface CallbackDTO {
+    /**
+     * The HTTP Verb (eg: GET, PUT, POST, DELETE)
+     * @type {string}
+     * @memberof CallbackDTO
+     */
+    'verb'?: string | null;
+    /**
+     * The fully-qualified URL to call using the Verb
+     * @type {string}
+     * @memberof CallbackDTO
+     */
+    'url'?: string | null;
+    /**
+     * The serialized payload to send to the URL using the Verb and Headers
+     * @type {{ [key: string]: JsonValue; }}
+     * @memberof CallbackDTO
+     */
+    'payload'?: { [key: string]: JsonValue; } | null;
+}
+

package/models/company-data.ts

@@ -213,17 +213,29 @@ export interface CompanyData {
      */
     'auto_Term_Plan_On_Gateway_Request': boolean;
     /**
-     * The domain name for the VBAReports server, e.g., https://vbareports.vbasoftware.com/reporting/site/
+     * 
      * @type {string}
      * @memberof CompanyData
      */
     'bR_Domain_Name'?: string | null;
     /**
-     * The name of the client\'s VBAReports site, e.g., VBA.    Example of BR_Domain_Name + BR_Site_Name: https://vbareports.vbasoftware.com/reporting/site/VBA
+     * 
      * @type {string}
      * @memberof CompanyData
      */
     'bR_Site_Name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Site_Secret'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Site_User'?: string | null;
     /**
      * Whether or not BaseLoad is turned on
      * @type {boolean}

package/models/database-connection.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DatabaseConnection
+ */
+export interface DatabaseConnection {
+    /**
+     * 
+     * @type {string}
+     * @memberof DatabaseConnection
+     */
+    'databaseName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DatabaseConnection
+     */
+    'connectionString'?: string | null;
+}
+

package/models/email-report-dto.ts

@@ -0,0 +1,103 @@
+/* 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 { CallbackDTO } from './callback-dto';
+
+/**
+ * 
+ * @export
+ * @interface EmailReportDTO
+ */
+export interface EmailReportDTO {
+    /**
+     * Activity ID that spawned this
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'parentActivityId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'when'?: string | null;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof EmailReportDTO
+     */
+    'onSuccess'?: CallbackDTO;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof EmailReportDTO
+     */
+    'onFailure'?: CallbackDTO;
+    /**
+     * ID of the Report
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'reportId'?: string | null;
+    /**
+     * Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'exportType'?: string | null;
+    /**
+     * Client specific Site ID within the report server.   This is typically their Client ID, but may be different based on client needs.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'siteId'?: string | null;
+    /**
+     * Filename of the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'filename'?: string | null;
+    /**
+     * An object of report parameters  Required if a report requires them.
+     * @type {{ [key: string]: string; }}
+     * @memberof EmailReportDTO
+     */
+    'reportParameters'?: { [key: string]: string; } | null;
+    /**
+     * The sender of the email containing the report. This should be a valid email address.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'from'?: string | null;
+    /**
+     * All recipients of the email containing the report. Each entry should be a valid email address.
+     * @type {Array<string>}
+     * @memberof EmailReportDTO
+     */
+    'recipients'?: Array<string> | null;
+    /**
+     * Subject of the email for the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'subject'?: string | null;
+    /**
+     * Body content of the email for the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'body'?: string | null;
+}
+

package/models/fax-report-dto.ts

@@ -0,0 +1,85 @@
+/* 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 { CallbackDTO } from './callback-dto';
+
+/**
+ * 
+ * @export
+ * @interface FaxReportDTO
+ */
+export interface FaxReportDTO {
+    /**
+     * Activity ID that spawned this
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'parentActivityId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'when'?: string | null;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof FaxReportDTO
+     */
+    'onSuccess'?: CallbackDTO;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof FaxReportDTO
+     */
+    'onFailure'?: CallbackDTO;
+    /**
+     * ID of the Report
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'reportId'?: string | null;
+    /**
+     * Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'exportType'?: string | null;
+    /**
+     * Client specific Site ID within the report server.   This is typically their Client ID, but may be different based on client needs.
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'siteId'?: string | null;
+    /**
+     * Filename of the report.
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'filename'?: string | null;
+    /**
+     * A json object of report parameters  Required if a report requires them.
+     * @type {{ [key: string]: string; }}
+     * @memberof FaxReportDTO
+     */
+    'reportParameters'?: { [key: string]: string; } | null;
+    /**
+     * Fax destination
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'faxNumber'?: string | null;
+}
+

package/models/group-ucpercent-criteria-list-vbaresponse.ts

@@ -0,0 +1,45 @@
+/* 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 { Debug } from './debug';
+import { GroupUCPercentCriteria } from './group-ucpercent-criteria';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface GroupUCPercentCriteriaListVBAResponse
+ */
+export interface GroupUCPercentCriteriaListVBAResponse {
+    /**
+     * 
+     * @type {Array<GroupUCPercentCriteria>}
+     * @memberof GroupUCPercentCriteriaListVBAResponse
+     */
+    'data'?: Array<GroupUCPercentCriteria> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof GroupUCPercentCriteriaListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof GroupUCPercentCriteriaListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/group-ucpercent-criteria-vbaresponse.ts

@@ -0,0 +1,45 @@
+/* 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 { Debug } from './debug';
+import { GroupUCPercentCriteria } from './group-ucpercent-criteria';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface GroupUCPercentCriteriaVBAResponse
+ */
+export interface GroupUCPercentCriteriaVBAResponse {
+    /**
+     * 
+     * @type {GroupUCPercentCriteria}
+     * @memberof GroupUCPercentCriteriaVBAResponse
+     */
+    'data'?: GroupUCPercentCriteria;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof GroupUCPercentCriteriaVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof GroupUCPercentCriteriaVBAResponse
+     */
+    'debug'?: Debug;
+}
+