@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250314.1 → 1.20250321.1

package/.openapi-generator/FILES

@@ -3324,6 +3324,7 @@ models/tooth-quadrant-vbaresponse.ts
 models/tooth-quadrant.ts
 models/tooth-vbaresponse.ts
 models/tooth.ts
+models/trackable-report.ts
 models/transpose-request-meta-data-result-list-vbaresponse.ts
 models/transpose-request-meta-data-result.ts
 models/treatment-type-list-vbaresponse.ts

package/api/subscriber-enrollments-api.ts

@@ -276,6 +276,75 @@ export const SubscriberEnrollmentsApiAxiosParamCreator = function (configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Modify an existing Subenrollment changing the table keys which forces downstream table updates.
+         * @summary Modify SubEnrollment
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Original Subscriber ID
+         * @param {string} groupID Original Group ID
+         * @param {string} divisionID Original Division ID
+         * @param {string} groupCoverageStart Original Group Coverage Start
+         * @param {string} startDate Original Start Date
+         * @param {SubEnrollment} subEnrollment 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        modifySubEnrollment: async (vbasoftwareDatabase: string, subscriberID: string, groupID: string, divisionID: string, groupCoverageStart: string, startDate: string, subEnrollment: SubEnrollment, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'subscriberID' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'subscriberID', subscriberID)
+            // verify required parameter 'groupID' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'groupID', groupID)
+            // verify required parameter 'divisionID' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'divisionID', divisionID)
+            // verify required parameter 'groupCoverageStart' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'groupCoverageStart', groupCoverageStart)
+            // verify required parameter 'startDate' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'startDate', startDate)
+            // verify required parameter 'subEnrollment' is not null or undefined
+            assertParamExists('modifySubEnrollment', 'subEnrollment', subEnrollment)
+            const localVarPath = `/subscribers/{subscriberID}/enrollments-modify/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}`
+                .replace(`{${"subscriberID"}}`, encodeURIComponent(String(subscriberID)))
+                .replace(`{${"groupID"}}`, encodeURIComponent(String(groupID)))
+                .replace(`{${"divisionID"}}`, encodeURIComponent(String(divisionID)))
+                .replace(`{${"groupCoverageStart"}}`, encodeURIComponent(String(groupCoverageStart)))
+                .replace(`{${"startDate"}}`, encodeURIComponent(String(startDate)));
+            // 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: 'PUT', ...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)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            if (vbasoftwareDatabase != null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(subEnrollment, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.
          * @summary Set SubEnrollment Paid Through
@@ -531,6 +600,25 @@ export const SubscriberEnrollmentsApiFp = function(configuration?: Configuration
             const localVarOperationServerBasePath = operationServerMap['SubscriberEnrollmentsApi.listSubEnrollment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Modify an existing Subenrollment changing the table keys which forces downstream table updates.
+         * @summary Modify SubEnrollment
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Original Subscriber ID
+         * @param {string} groupID Original Group ID
+         * @param {string} divisionID Original Division ID
+         * @param {string} groupCoverageStart Original Group Coverage Start
+         * @param {string} startDate Original Start Date
+         * @param {SubEnrollment} subEnrollment 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async modifySubEnrollment(vbasoftwareDatabase: string, subscriberID: string, groupID: string, divisionID: string, groupCoverageStart: string, startDate: string, subEnrollment: SubEnrollment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubEnrollmentVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.modifySubEnrollment(vbasoftwareDatabase, subscriberID, groupID, divisionID, groupCoverageStart, startDate, subEnrollment, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SubscriberEnrollmentsApi.modifySubEnrollment']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.
          * @summary Set SubEnrollment Paid Through
@@ -647,6 +735,22 @@ export const SubscriberEnrollmentsApiFactory = function (configuration?: Configu
         listSubEnrollment(vbasoftwareDatabase: string, subscriberID: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<SubEnrollmentListVBAResponse> {
             return localVarFp.listSubEnrollment(vbasoftwareDatabase, subscriberID, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Modify an existing Subenrollment changing the table keys which forces downstream table updates.
+         * @summary Modify SubEnrollment
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Original Subscriber ID
+         * @param {string} groupID Original Group ID
+         * @param {string} divisionID Original Division ID
+         * @param {string} groupCoverageStart Original Group Coverage Start
+         * @param {string} startDate Original Start Date
+         * @param {SubEnrollment} subEnrollment 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        modifySubEnrollment(vbasoftwareDatabase: string, subscriberID: string, groupID: string, divisionID: string, groupCoverageStart: string, startDate: string, subEnrollment: SubEnrollment, options?: RawAxiosRequestConfig): AxiosPromise<SubEnrollmentVBAResponse> {
+            return localVarFp.modifySubEnrollment(vbasoftwareDatabase, subscriberID, groupID, divisionID, groupCoverageStart, startDate, subEnrollment, options).then((request) => request(axios, basePath));
+        },
         /**
          * Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.
          * @summary Set SubEnrollment Paid Through
@@ -753,6 +857,22 @@ export interface SubscriberEnrollmentsApiInterface {
      */
     listSubEnrollment(vbasoftwareDatabase: string, subscriberID: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<SubEnrollmentListVBAResponse>;
 
+    /**
+     * Modify an existing Subenrollment changing the table keys which forces downstream table updates.
+     * @summary Modify SubEnrollment
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Original Subscriber ID
+     * @param {string} groupID Original Group ID
+     * @param {string} divisionID Original Division ID
+     * @param {string} groupCoverageStart Original Group Coverage Start
+     * @param {string} startDate Original Start Date
+     * @param {SubEnrollment} subEnrollment 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscriberEnrollmentsApiInterface
+     */
+    modifySubEnrollment(vbasoftwareDatabase: string, subscriberID: string, groupID: string, divisionID: string, groupCoverageStart: string, startDate: string, subEnrollment: SubEnrollment, options?: RawAxiosRequestConfig): AxiosPromise<SubEnrollmentVBAResponse>;
+
     /**
      * Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.
      * @summary Set SubEnrollment Paid Through
@@ -867,6 +987,24 @@ export class SubscriberEnrollmentsApi extends BaseAPI implements SubscriberEnrol
         return SubscriberEnrollmentsApiFp(this.configuration).listSubEnrollment(vbasoftwareDatabase, subscriberID, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Modify an existing Subenrollment changing the table keys which forces downstream table updates.
+     * @summary Modify SubEnrollment
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Original Subscriber ID
+     * @param {string} groupID Original Group ID
+     * @param {string} divisionID Original Division ID
+     * @param {string} groupCoverageStart Original Group Coverage Start
+     * @param {string} startDate Original Start Date
+     * @param {SubEnrollment} subEnrollment 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscriberEnrollmentsApi
+     */
+    public modifySubEnrollment(vbasoftwareDatabase: string, subscriberID: string, groupID: string, divisionID: string, groupCoverageStart: string, startDate: string, subEnrollment: SubEnrollment, options?: RawAxiosRequestConfig) {
+        return SubscriberEnrollmentsApiFp(this.configuration).modifySubEnrollment(vbasoftwareDatabase, subscriberID, groupID, divisionID, groupCoverageStart, startDate, subEnrollment, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.
      * @summary Set SubEnrollment Paid Through

package/api/vbareports-api.ts

@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
+import type { TrackableReport } from '../models';
+// @ts-ignore
 import type { VBAReportListVBAResponse } from '../models';
 // @ts-ignore
 import type { VBAReportVBAResponse } from '../models';
@@ -116,6 +118,55 @@ export const VBAReportsApiAxiosParamCreator = function (configuration?: Configur
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Tracks a Report.
+         * @summary Track a Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {TrackableReport} trackableReport 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        trackReport: async (vbasoftwareDatabase: string, trackableReport: TrackableReport, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('trackReport', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'trackableReport' is not null or undefined
+            assertParamExists('trackReport', 'trackableReport', trackableReport)
+            const localVarPath = `/reports/track`;
+            // 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)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            if (vbasoftwareDatabase != null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(trackableReport, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -158,6 +209,20 @@ export const VBAReportsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['VBAReportsApi.listVBAReports']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Tracks a Report.
+         * @summary Track a Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {TrackableReport} trackableReport 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async trackReport(vbasoftwareDatabase: string, trackableReport: TrackableReport, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.trackReport(vbasoftwareDatabase, trackableReport, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VBAReportsApi.trackReport']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -189,6 +254,17 @@ export const VBAReportsApiFactory = function (configuration?: Configuration, bas
         listVBAReports(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportListVBAResponse> {
             return localVarFp.listVBAReports(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Tracks a Report.
+         * @summary Track a Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {TrackableReport} trackableReport 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        trackReport(vbasoftwareDatabase: string, trackableReport: TrackableReport, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.trackReport(vbasoftwareDatabase, trackableReport, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -219,6 +295,17 @@ export interface VBAReportsApiInterface {
      */
     listVBAReports(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportListVBAResponse>;
 
+    /**
+     * Tracks a Report.
+     * @summary Track a Report
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {TrackableReport} trackableReport 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportsApiInterface
+     */
+    trackReport(vbasoftwareDatabase: string, trackableReport: TrackableReport, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
 }
 
 /**
@@ -252,5 +339,18 @@ export class VBAReportsApi extends BaseAPI implements VBAReportsApiInterface {
     public listVBAReports(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
         return VBAReportsApiFp(this.configuration).listVBAReports(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Tracks a Report.
+     * @summary Track a Report
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {TrackableReport} trackableReport 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportsApi
+     */
+    public trackReport(vbasoftwareDatabase: string, trackableReport: TrackableReport, options?: RawAxiosRequestConfig) {
+        return VBAReportsApiFp(this.configuration).trackReport(vbasoftwareDatabase, trackableReport, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/models/index.ts

@@ -2438,6 +2438,7 @@ export * from './tooth-quadrant';
 export * from './tooth-quadrant-list-vbaresponse';
 export * from './tooth-quadrant-vbaresponse';
 export * from './tooth-vbaresponse';
+export * from './trackable-report';
 export * from './transpose-request-meta-data-result';
 export * from './transpose-request-meta-data-result-list-vbaresponse';
 export * from './treatment-type';

package/models/trackable-report.ts

@@ -0,0 +1,78 @@
+/* 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 TrackableReport
+ */
+export interface TrackableReport {
+    /**
+     * Unique identifier for the report definition.
+     * @type {number}
+     * @memberof TrackableReport
+     */
+    'reportDefinition_Key'?: number;
+    /**
+     * ID of the report, often used as a unique string identifier.
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'report_ID'?: string | null;
+    /**
+     * Name of the report.
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'report_Name'?: string | null;
+    /**
+     * Category under which the report falls.
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'report_Category'?: string | null;
+    /**
+     * Description of the report and its purpose.
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'report_Description'?: string | null;
+    /**
+     * URL for embedding the report in other applications.
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'embed_Url'?: string | null;
+    /**
+     * Subscriber ID if the report uses it
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'subscriberID'?: string | null;
+    /**
+     * MemberSeq if the report uses it
+     * @type {string}
+     * @memberof TrackableReport
+     */
+    'memberSeq'?: string | null;
+    /**
+     * Report Parameters used in the report
+     * @type {{ [key: string]: string | null; }}
+     * @memberof TrackableReport
+     */
+    'reportParameters'?: { [key: string]: string | null; } | null;
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
-  "version": "1.20250314.1",
+  "version": "1.20250321.1",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"