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

package/api/premium-invoice-subscribers-api.ts

@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
+import { GetPremInvoiceSubscriberListResultListVBAResponse } from '../models';
+// @ts-ignore
 import { MultiCodeResponseListVBAResponse } from '../models';
 // @ts-ignore
 import { PremInvoiceSubscriber } from '../models';
@@ -29,6 +31,10 @@ import { PremInvoiceSubscriberListVBAResponse } from '../models';
 // @ts-ignore
 import { PremInvoiceSubscriberVBAResponse } from '../models';
 // @ts-ignore
+import { VBAPremInvoiceSubscriberDetailAdjustmentListVBAResponse } from '../models';
+// @ts-ignore
+import { VBAPremInvoiceSubscriberDetailListVBAResponse } from '../models';
+// @ts-ignore
 import { VBAPremInvoiceSubscriberHistoryListVBAResponse } from '../models';
 /**
  * PremiumInvoiceSubscribersApi - axios parameter creator
@@ -264,6 +270,150 @@ export const PremiumInvoiceSubscribersApiAxiosParamCreator = function (configura
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Calculations by Subscriber
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberCalculations: async (vbasoftwareDatabase: string, invoiceKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberCalculations', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'invoiceKey' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberCalculations', 'invoiceKey', invoiceKey)
+            const localVarPath = `/premium-invoices/{invoiceKey}/subscriber-calculations`
+                .replace(`{${"invoiceKey"}}`, encodeURIComponent(String(invoiceKey)));
+            // 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,
+            };
+        },
+        /**
+         * Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.
+         * @summary List of Premium Invoice Adjustment Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberDetailAdjustments: async (vbasoftwareDatabase: string, invoiceKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberDetailAdjustments', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'invoiceKey' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberDetailAdjustments', 'invoiceKey', invoiceKey)
+            const localVarPath = `/premium-invoices/{invoiceKey}/subscriber-detail-adjustments`
+                .replace(`{${"invoiceKey"}}`, encodeURIComponent(String(invoiceKey)));
+            // 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,
+            };
+        },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberDetails: async (vbasoftwareDatabase: string, invoiceKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberDetails', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'invoiceKey' is not null or undefined
+            assertParamExists('listPremInvoiceSubscriberDetails', 'invoiceKey', invoiceKey)
+            const localVarPath = `/premium-invoices/{invoiceKey}/subscriber-details`
+                .replace(`{${"invoiceKey"}}`, encodeURIComponent(String(invoiceKey)));
+            // 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};
@@ -528,6 +678,42 @@ export const PremiumInvoiceSubscribersApiFp = function(configuration?: Configura
             const localVarAxiosArgs = await localVarAxiosParamCreator.listPremInvoiceSubscriber(vbasoftwareDatabase, invoiceKey, page, pageSize, sortBy, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Calculations by Subscriber
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPremInvoiceSubscriberCalculations(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPremInvoiceSubscriberListResultListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPremInvoiceSubscriberCalculations(vbasoftwareDatabase, invoiceKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.
+         * @summary List of Premium Invoice Adjustment Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAPremInvoiceSubscriberDetailAdjustmentListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase, invoiceKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPremInvoiceSubscriberDetails(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAPremInvoiceSubscriberDetailListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPremInvoiceSubscriberDetails(vbasoftwareDatabase, invoiceKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID
          * @summary List PremInvoiceSubscriberHistory
@@ -637,6 +823,39 @@ export const PremiumInvoiceSubscribersApiFactory = function (configuration?: Con
         listPremInvoiceSubscriber(vbasoftwareDatabase: string, invoiceKey: number, page?: number, pageSize?: number, sortBy?: string, options?: any): AxiosPromise<PremInvoiceSubscriberListVBAResponse> {
             return localVarFp.listPremInvoiceSubscriber(vbasoftwareDatabase, invoiceKey, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Calculations by Subscriber
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberCalculations(vbasoftwareDatabase: string, invoiceKey: number, options?: any): AxiosPromise<GetPremInvoiceSubscriberListResultListVBAResponse> {
+            return localVarFp.listPremInvoiceSubscriberCalculations(vbasoftwareDatabase, invoiceKey, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.
+         * @summary List of Premium Invoice Adjustment Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase: string, invoiceKey: number, options?: any): AxiosPromise<VBAPremInvoiceSubscriberDetailAdjustmentListVBAResponse> {
+            return localVarFp.listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase, invoiceKey, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+         * @summary List of Premium Invoice Details for Subscribers
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} invoiceKey Invoice Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPremInvoiceSubscriberDetails(vbasoftwareDatabase: string, invoiceKey: number, options?: any): AxiosPromise<VBAPremInvoiceSubscriberDetailListVBAResponse> {
+            return localVarFp.listPremInvoiceSubscriberDetails(vbasoftwareDatabase, invoiceKey, options).then((request) => request(axios, basePath));
+        },
         /**
          * Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID
          * @summary List PremInvoiceSubscriberHistory
@@ -742,6 +961,39 @@ export interface PremiumInvoiceSubscribersApiInterface {
      */
     listPremInvoiceSubscriber(vbasoftwareDatabase: string, invoiceKey: number, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig): AxiosPromise<PremInvoiceSubscriberListVBAResponse>;
 
+    /**
+     * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+     * @summary List of Premium Invoice Calculations by Subscriber
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApiInterface
+     */
+    listPremInvoiceSubscriberCalculations(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): AxiosPromise<GetPremInvoiceSubscriberListResultListVBAResponse>;
+
+    /**
+     * Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.
+     * @summary List of Premium Invoice Adjustment Details for Subscribers
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApiInterface
+     */
+    listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): AxiosPromise<VBAPremInvoiceSubscriberDetailAdjustmentListVBAResponse>;
+
+    /**
+     * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+     * @summary List of Premium Invoice Details for Subscribers
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApiInterface
+     */
+    listPremInvoiceSubscriberDetails(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig): AxiosPromise<VBAPremInvoiceSubscriberDetailListVBAResponse>;
+
     /**
      * Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID
      * @summary List PremInvoiceSubscriberHistory
@@ -855,6 +1107,45 @@ export class PremiumInvoiceSubscribersApi extends BaseAPI implements PremiumInvo
         return PremiumInvoiceSubscribersApiFp(this.configuration).listPremInvoiceSubscriber(vbasoftwareDatabase, invoiceKey, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+     * @summary List of Premium Invoice Calculations by Subscriber
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApi
+     */
+    public listPremInvoiceSubscriberCalculations(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig) {
+        return PremiumInvoiceSubscribersApiFp(this.configuration).listPremInvoiceSubscriberCalculations(vbasoftwareDatabase, invoiceKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.
+     * @summary List of Premium Invoice Adjustment Details for Subscribers
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApi
+     */
+    public listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig) {
+        return PremiumInvoiceSubscribersApiFp(this.configuration).listPremInvoiceSubscriberDetailAdjustments(vbasoftwareDatabase, invoiceKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.
+     * @summary List of Premium Invoice Details for Subscribers
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} invoiceKey Invoice Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumInvoiceSubscribersApi
+     */
+    public listPremInvoiceSubscriberDetails(vbasoftwareDatabase: string, invoiceKey: number, options?: AxiosRequestConfig) {
+        return PremiumInvoiceSubscribersApiFp(this.configuration).listPremInvoiceSubscriberDetails(vbasoftwareDatabase, invoiceKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID
      * @summary List PremInvoiceSubscriberHistory