@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250404.1 → 1.20250425.1

package/api/subscribers-api.ts

@@ -26,6 +26,8 @@ import type { ActiveSubscriberListVBAResponse } from '../models';
 // @ts-ignore
 import type { AddEnrollmentRequest } from '../models';
 // @ts-ignore
+import type { AllEnrollmentsSubscriberResultListVBAResponse } from '../models';
+// @ts-ignore
 import type { ChangeSubscriberIDRequest } from '../models';
 // @ts-ignore
 import type { EnrollmentDisenroll } from '../models';
@@ -354,6 +356,53 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            if (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,
+            };
+        },
+        /**
+         * Return a compiled list of enrollments for all members of a given family including Group, Division, Plan, and Tier information.  Takes into account Subenrollment and Memenrollment options.
+         * @summary List Enrollment Detail
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAllEnrollmentsSubscriber: async (vbasoftwareDatabase: string, subscriberID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listAllEnrollmentsSubscriber', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'subscriberID' is not null or undefined
+            assertParamExists('listAllEnrollmentsSubscriber', 'subscriberID', subscriberID)
+            const localVarPath = `/subscribers/{subscriberID}/list-all-enrollments`
+                .replace(`{${"subscriberID"}}`, encodeURIComponent(String(subscriberID)));
+            // 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 != null) {
                 localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
             }
@@ -1126,6 +1175,20 @@ export const SubscribersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SubscribersApi.listActiveSubscribers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Return a compiled list of enrollments for all members of a given family including Group, Division, Plan, and Tier information.  Takes into account Subenrollment and Memenrollment options.
+         * @summary List Enrollment Detail
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listAllEnrollmentsSubscriber(vbasoftwareDatabase: string, subscriberID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllEnrollmentsSubscriberResultListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listAllEnrollmentsSubscriber(vbasoftwareDatabase, subscriberID, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SubscribersApi.listAllEnrollmentsSubscriber']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * List of all Cobra Disenroll Reason Types
          * @summary List Cobra Disenroll Reason Types
@@ -1396,6 +1459,17 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba
         listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<ActiveSubscriberListVBAResponse> {
             return localVarFp.listActiveSubscribers(vbasoftwareDatabase, groupId, divisionId, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a compiled list of enrollments for all members of a given family including Group, Division, Plan, and Tier information.  Takes into account Subenrollment and Memenrollment options.
+         * @summary List Enrollment Detail
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} subscriberID Subscriber ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAllEnrollmentsSubscriber(vbasoftwareDatabase: string, subscriberID: string, options?: RawAxiosRequestConfig): AxiosPromise<AllEnrollmentsSubscriberResultListVBAResponse> {
+            return localVarFp.listAllEnrollmentsSubscriber(vbasoftwareDatabase, subscriberID, options).then((request) => request(axios, basePath));
+        },
         /**
          * List of all Cobra Disenroll Reason Types
          * @summary List Cobra Disenroll Reason Types
@@ -1626,6 +1700,17 @@ export interface SubscribersApiInterface {
      */
     listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<ActiveSubscriberListVBAResponse>;
 
+    /**
+     * Return a compiled list of enrollments for all members of a given family including Group, Division, Plan, and Tier information.  Takes into account Subenrollment and Memenrollment options.
+     * @summary List Enrollment Detail
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApiInterface
+     */
+    listAllEnrollmentsSubscriber(vbasoftwareDatabase: string, subscriberID: string, options?: RawAxiosRequestConfig): AxiosPromise<AllEnrollmentsSubscriberResultListVBAResponse>;
+
     /**
      * List of all Cobra Disenroll Reason Types
      * @summary List Cobra Disenroll Reason Types
@@ -1868,6 +1953,19 @@ export class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
         return SubscribersApiFp(this.configuration).listActiveSubscribers(vbasoftwareDatabase, groupId, divisionId, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Return a compiled list of enrollments for all members of a given family including Group, Division, Plan, and Tier information.  Takes into account Subenrollment and Memenrollment options.
+     * @summary List Enrollment Detail
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} subscriberID Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApi
+     */
+    public listAllEnrollmentsSubscriber(vbasoftwareDatabase: string, subscriberID: string, options?: RawAxiosRequestConfig) {
+        return SubscribersApiFp(this.configuration).listAllEnrollmentsSubscriber(vbasoftwareDatabase, subscriberID, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List of all Cobra Disenroll Reason Types
      * @summary List Cobra Disenroll Reason Types

package/api/vbareporting-api.ts

@@ -0,0 +1,265 @@
+/* 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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// 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, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { VBAReportingReportListVBAResponse } from '../models';
+// @ts-ignore
+import type { VBAReportingReportVBAResponse } from '../models';
+/**
+ * VBAReportingApi - axios parameter creator
+ * @export
+ */
+export const VBAReportingApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves a specific VBAReporting report by its ID.
+         * @summary Retrieve VBAReporting Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} vbaReportingId Unique VBAReporting report ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get: async (vbasoftwareDatabase: string, vbaReportingId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('get', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbaReportingId' is not null or undefined
+            assertParamExists('get', 'vbaReportingId', vbaReportingId)
+            const localVarPath = `/vbareporting/reports/{vbaReportingId}`
+                .replace(`{${"vbaReportingId"}}`, encodeURIComponent(String(vbaReportingId)));
+            // 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 != 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 a list of all available VBAReporting reports.
+         * @summary List VBAReporting Reports
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} [category] category
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        list: async (vbasoftwareDatabase: string, category?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('list', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/vbareporting/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 (category !== undefined) {
+                localVarQueryParameter['category'] = category;
+            }
+
+
+    
+            if (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,
+            };
+        },
+    }
+};
+
+/**
+ * VBAReportingApi - functional programming interface
+ * @export
+ */
+export const VBAReportingApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = VBAReportingApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves a specific VBAReporting report by its ID.
+         * @summary Retrieve VBAReporting Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} vbaReportingId Unique VBAReporting report ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async get(vbasoftwareDatabase: string, vbaReportingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAReportingReportVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.get(vbasoftwareDatabase, vbaReportingId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VBAReportingApi.get']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Retrieves a list of all available VBAReporting reports.
+         * @summary List VBAReporting Reports
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} [category] category
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async list(vbasoftwareDatabase: string, category?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAReportingReportListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.list(vbasoftwareDatabase, category, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VBAReportingApi.list']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * VBAReportingApi - factory interface
+ * @export
+ */
+export const VBAReportingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = VBAReportingApiFp(configuration)
+    return {
+        /**
+         * Retrieves a specific VBAReporting report by its ID.
+         * @summary Retrieve VBAReporting Report
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} vbaReportingId Unique VBAReporting report ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        get(vbasoftwareDatabase: string, vbaReportingId: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportingReportVBAResponse> {
+            return localVarFp.get(vbasoftwareDatabase, vbaReportingId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves a list of all available VBAReporting reports.
+         * @summary List VBAReporting Reports
+         * @param {string} vbasoftwareDatabase The target database name to query.
+         * @param {string} [category] category
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        list(vbasoftwareDatabase: string, category?: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportingReportListVBAResponse> {
+            return localVarFp.list(vbasoftwareDatabase, category, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * VBAReportingApi - interface
+ * @export
+ * @interface VBAReportingApi
+ */
+export interface VBAReportingApiInterface {
+    /**
+     * Retrieves a specific VBAReporting report by its ID.
+     * @summary Retrieve VBAReporting Report
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {string} vbaReportingId Unique VBAReporting report ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportingApiInterface
+     */
+    get(vbasoftwareDatabase: string, vbaReportingId: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportingReportVBAResponse>;
+
+    /**
+     * Retrieves a list of all available VBAReporting reports.
+     * @summary List VBAReporting Reports
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {string} [category] category
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportingApiInterface
+     */
+    list(vbasoftwareDatabase: string, category?: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAReportingReportListVBAResponse>;
+
+}
+
+/**
+ * VBAReportingApi - object-oriented interface
+ * @export
+ * @class VBAReportingApi
+ * @extends {BaseAPI}
+ */
+export class VBAReportingApi extends BaseAPI implements VBAReportingApiInterface {
+    /**
+     * Retrieves a specific VBAReporting report by its ID.
+     * @summary Retrieve VBAReporting Report
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {string} vbaReportingId Unique VBAReporting report ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportingApi
+     */
+    public get(vbasoftwareDatabase: string, vbaReportingId: string, options?: RawAxiosRequestConfig) {
+        return VBAReportingApiFp(this.configuration).get(vbasoftwareDatabase, vbaReportingId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves a list of all available VBAReporting reports.
+     * @summary List VBAReporting Reports
+     * @param {string} vbasoftwareDatabase The target database name to query.
+     * @param {string} [category] category
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAReportingApi
+     */
+    public list(vbasoftwareDatabase: string, category?: string, options?: RawAxiosRequestConfig) {
+        return VBAReportingApiFp(this.configuration).list(vbasoftwareDatabase, category, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+