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

package/api/subscribers-api.ts

@@ -31,12 +31,18 @@ import { EnrollmentDisenroll } from '../models';
 // @ts-ignore
 import { EnrollmentReenroll } from '../models';
 // @ts-ignore
+import { EnrollmentWaitingPeriodByHireDateListVBAResponse } from '../models';
+// @ts-ignore
 import { Int32StaticOptionListVBAResponse } from '../models';
 // @ts-ignore
 import { MultiCodeResponseListVBAResponse } from '../models';
 // @ts-ignore
+import { PremInvoiceGenerateInvListResultListVBAResponse } from '../models';
+// @ts-ignore
 import { StringStaticOptionListVBAResponse } from '../models';
 // @ts-ignore
+import { StringVBAResponse } from '../models';
+// @ts-ignore
 import { Subscribers } from '../models';
 // @ts-ignore
 import { SubscribersListVBAResponse } from '../models';
@@ -193,6 +199,50 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID
+         * @summary Get Unique Subscriber ID
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateSubscriberID: async (vbasoftwareDatabase: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('generateSubscriberID', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/subscribers-generate-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 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};
@@ -400,6 +450,58 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.
+         * @summary List Billing Adjustments for Disenroll
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {string} asOfDate As of Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDisenrollAdjustment: async (vbasoftwareDatabase: string, subscriberID: string, asOfDate: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listDisenrollAdjustment', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'subscriberID' is not null or undefined
+            assertParamExists('listDisenrollAdjustment', 'subscriberID', subscriberID)
+            // verify required parameter 'asOfDate' is not null or undefined
+            assertParamExists('listDisenrollAdjustment', 'asOfDate', asOfDate)
+            const localVarPath = `/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments`
+                .replace(`{${"subscriberID"}}`, encodeURIComponent(String(subscriberID)))
+                .replace(`{${"asOfDate"}}`, encodeURIComponent(String(asOfDate)));
+            // 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};
@@ -444,6 +546,72 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).
+         * @summary List Waiting Period Details
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [groupID] Group ID
+         * @param {string} [divisionID] Division ID
+         * @param {string} [planID] Plan ID
+         * @param {string} [hireDate] Hire Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listEnrollmentWaitingPeriodByHireDate: async (vbasoftwareDatabase: string, groupID?: string, divisionID?: string, planID?: string, hireDate?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listEnrollmentWaitingPeriodByHireDate', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/enrollment-waiting-period-by-hire-date`;
+            // 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 (groupID !== undefined) {
+                localVarQueryParameter['groupID'] = groupID;
+            }
+
+            if (divisionID !== undefined) {
+                localVarQueryParameter['divisionID'] = divisionID;
+            }
+
+            if (planID !== undefined) {
+                localVarQueryParameter['planID'] = planID;
+            }
+
+            if (hireDate !== undefined) {
+                localVarQueryParameter['hireDate'] = (hireDate as any instanceof Date) ?
+                    (hireDate as any).toISOString() :
+                    hireDate;
+            }
+
+            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};
@@ -925,6 +1093,17 @@ export const SubscribersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscribers(vbasoftwareDatabase, subscriberID, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID
+         * @summary Get Unique Subscriber ID
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async generateSubscriberID(vbasoftwareDatabase: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.generateSubscriberID(vbasoftwareDatabase, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Gets Subscribers
          * @summary Get Subscribers
@@ -975,6 +1154,19 @@ export const SubscribersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCobraDurationTypes(vbasoftwareDatabase, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.
+         * @summary List Billing Adjustments for Disenroll
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {string} asOfDate As of Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listDisenrollAdjustment(vbasoftwareDatabase: string, subscriberID: string, asOfDate: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PremInvoiceGenerateInvListResultListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listDisenrollAdjustment(vbasoftwareDatabase, subscriberID, asOfDate, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * List of all Disenrollment Family Options
          * @summary List Disenrollment Family Options
@@ -986,6 +1178,21 @@ export const SubscribersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listDisenrollmentFamilyOptions(vbasoftwareDatabase, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).
+         * @summary List Waiting Period Details
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [groupID] Group ID
+         * @param {string} [divisionID] Division ID
+         * @param {string} [planID] Plan ID
+         * @param {string} [hireDate] Hire Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase: string, groupID?: string, divisionID?: string, planID?: string, hireDate?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnrollmentWaitingPeriodByHireDateListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase, groupID, divisionID, planID, hireDate, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * List of all Reenrollment Family Options
          * @summary List Reenrollment Family Options
@@ -1133,6 +1340,16 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba
         deleteSubscribers(vbasoftwareDatabase: string, subscriberID: string, options?: any): AxiosPromise<void> {
             return localVarFp.deleteSubscribers(vbasoftwareDatabase, subscriberID, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID
+         * @summary Get Unique Subscriber ID
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateSubscriberID(vbasoftwareDatabase: string, options?: any): AxiosPromise<StringVBAResponse> {
+            return localVarFp.generateSubscriberID(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
+        },
         /**
          * Gets Subscribers
          * @summary Get Subscribers
@@ -1179,6 +1396,18 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba
         listCobraDurationTypes(vbasoftwareDatabase: string, options?: any): AxiosPromise<StringStaticOptionListVBAResponse> {
             return localVarFp.listCobraDurationTypes(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
         },
+        /**
+         * List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.
+         * @summary List Billing Adjustments for Disenroll
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {string} asOfDate As of Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listDisenrollAdjustment(vbasoftwareDatabase: string, subscriberID: string, asOfDate: string, options?: any): AxiosPromise<PremInvoiceGenerateInvListResultListVBAResponse> {
+            return localVarFp.listDisenrollAdjustment(vbasoftwareDatabase, subscriberID, asOfDate, options).then((request) => request(axios, basePath));
+        },
         /**
          * List of all Disenrollment Family Options
          * @summary List Disenrollment Family Options
@@ -1189,6 +1418,20 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba
         listDisenrollmentFamilyOptions(vbasoftwareDatabase: string, options?: any): AxiosPromise<Int32StaticOptionListVBAResponse> {
             return localVarFp.listDisenrollmentFamilyOptions(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
         },
+        /**
+         * List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).
+         * @summary List Waiting Period Details
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [groupID] Group ID
+         * @param {string} [divisionID] Division ID
+         * @param {string} [planID] Plan ID
+         * @param {string} [hireDate] Hire Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase: string, groupID?: string, divisionID?: string, planID?: string, hireDate?: string, options?: any): AxiosPromise<EnrollmentWaitingPeriodByHireDateListVBAResponse> {
+            return localVarFp.listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase, groupID, divisionID, planID, hireDate, options).then((request) => request(axios, basePath));
+        },
         /**
          * List of all Reenrollment Family Options
          * @summary List Reenrollment Family Options
@@ -1327,6 +1570,16 @@ export interface SubscribersApiInterface {
      */
     deleteSubscribers(vbasoftwareDatabase: string, subscriberID: string, options?: AxiosRequestConfig): AxiosPromise<void>;
 
+    /**
+     * Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID
+     * @summary Get Unique Subscriber ID
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApiInterface
+     */
+    generateSubscriberID(vbasoftwareDatabase: string, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
     /**
      * Gets Subscribers
      * @summary Get Subscribers
@@ -1373,6 +1626,18 @@ export interface SubscribersApiInterface {
      */
     listCobraDurationTypes(vbasoftwareDatabase: string, options?: AxiosRequestConfig): AxiosPromise<StringStaticOptionListVBAResponse>;
 
+    /**
+     * List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.
+     * @summary List Billing Adjustments for Disenroll
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Subscriber ID
+     * @param {string} asOfDate As of Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApiInterface
+     */
+    listDisenrollAdjustment(vbasoftwareDatabase: string, subscriberID: string, asOfDate: string, options?: AxiosRequestConfig): AxiosPromise<PremInvoiceGenerateInvListResultListVBAResponse>;
+
     /**
      * List of all Disenrollment Family Options
      * @summary List Disenrollment Family Options
@@ -1383,6 +1648,20 @@ export interface SubscribersApiInterface {
      */
     listDisenrollmentFamilyOptions(vbasoftwareDatabase: string, options?: AxiosRequestConfig): AxiosPromise<Int32StaticOptionListVBAResponse>;
 
+    /**
+     * List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).
+     * @summary List Waiting Period Details
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} [groupID] Group ID
+     * @param {string} [divisionID] Division ID
+     * @param {string} [planID] Plan ID
+     * @param {string} [hireDate] Hire Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApiInterface
+     */
+    listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase: string, groupID?: string, divisionID?: string, planID?: string, hireDate?: string, options?: AxiosRequestConfig): AxiosPromise<EnrollmentWaitingPeriodByHireDateListVBAResponse>;
+
     /**
      * List of all Reenrollment Family Options
      * @summary List Reenrollment Family Options
@@ -1527,6 +1806,18 @@ export class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
         return SubscribersApiFp(this.configuration).deleteSubscribers(vbasoftwareDatabase, subscriberID, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID
+     * @summary Get Unique Subscriber ID
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApi
+     */
+    public generateSubscriberID(vbasoftwareDatabase: string, options?: AxiosRequestConfig) {
+        return SubscribersApiFp(this.configuration).generateSubscriberID(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Gets Subscribers
      * @summary Get Subscribers
@@ -1581,6 +1872,20 @@ export class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
         return SubscribersApiFp(this.configuration).listCobraDurationTypes(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.
+     * @summary List Billing Adjustments for Disenroll
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Subscriber ID
+     * @param {string} asOfDate As of Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApi
+     */
+    public listDisenrollAdjustment(vbasoftwareDatabase: string, subscriberID: string, asOfDate: string, options?: AxiosRequestConfig) {
+        return SubscribersApiFp(this.configuration).listDisenrollAdjustment(vbasoftwareDatabase, subscriberID, asOfDate, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List of all Disenrollment Family Options
      * @summary List Disenrollment Family Options
@@ -1593,6 +1898,22 @@ export class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
         return SubscribersApiFp(this.configuration).listDisenrollmentFamilyOptions(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).
+     * @summary List Waiting Period Details
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} [groupID] Group ID
+     * @param {string} [divisionID] Division ID
+     * @param {string} [planID] Plan ID
+     * @param {string} [hireDate] Hire Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApi
+     */
+    public listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase: string, groupID?: string, divisionID?: string, planID?: string, hireDate?: string, options?: AxiosRequestConfig) {
+        return SubscribersApiFp(this.configuration).listEnrollmentWaitingPeriodByHireDate(vbasoftwareDatabase, groupID, divisionID, planID, hireDate, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List of all Reenrollment Family Options
      * @summary List Reenrollment Family Options