@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230923.2 → 1.20230927.1

package/.openapi-generator/FILES

@@ -811,6 +811,8 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/active-subscriber-list-vbaresponse.ts
+models/active-subscriber.ts
 models/add-enrollment-request.ts
 models/admission-type-place-list-vbaresponse.ts
 models/admission-type-place-vbaresponse.ts

package/api/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 { ActiveSubscriberListVBAResponse } from '../models';
+// @ts-ignore
 import { AddEnrollmentRequest } from '../models';
 // @ts-ignore
 import { ChangeSubscriberIDRequest } from '../models';
@@ -239,6 +241,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,
+            };
+        },
+        /**
+         * Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.
+         * @summary List Active Subscribers for a Groupd & Division
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} groupId Group ID
+         * @param {string} [divisionId] Division ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listActiveSubscribers: async (vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listActiveSubscribers', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'groupId' is not null or undefined
+            assertParamExists('listActiveSubscribers', 'groupId', groupId)
+            const localVarPath = `/active-subscribers`;
+            // 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 (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            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};
@@ -859,6 +927,21 @@ export const SubscribersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscribers(vbasoftwareDatabase, subscriberID, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.
+         * @summary List Active Subscribers for a Groupd & Division
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} groupId Group ID
+         * @param {string} [divisionId] Division ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActiveSubscriberListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listActiveSubscribers(vbasoftwareDatabase, groupId, divisionId, page, pageSize, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * List of all Cobra Disenroll Reason Types
          * @summary List Cobra Disenroll Reason Types
@@ -1049,6 +1132,20 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba
         getSubscribers(vbasoftwareDatabase: string, subscriberID: string, options?: any): AxiosPromise<SubscribersVBAResponse> {
             return localVarFp.getSubscribers(vbasoftwareDatabase, subscriberID, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.
+         * @summary List Active Subscribers for a Groupd & Division
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} groupId Group ID
+         * @param {string} [divisionId] Division ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, options?: any): AxiosPromise<ActiveSubscriberListVBAResponse> {
+            return localVarFp.listActiveSubscribers(vbasoftwareDatabase, groupId, divisionId, page, pageSize, options).then((request) => request(axios, basePath));
+        },
         /**
          * List of all Cobra Disenroll Reason Types
          * @summary List Cobra Disenroll Reason Types
@@ -1227,6 +1324,20 @@ export interface SubscribersApiInterface {
      */
     getSubscribers(vbasoftwareDatabase: string, subscriberID: string, options?: AxiosRequestConfig): AxiosPromise<SubscribersVBAResponse>;
 
+    /**
+     * Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.
+     * @summary List Active Subscribers for a Groupd & Division
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} groupId Group ID
+     * @param {string} [divisionId] Division ID
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApiInterface
+     */
+    listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): AxiosPromise<ActiveSubscriberListVBAResponse>;
+
     /**
      * List of all Cobra Disenroll Reason Types
      * @summary List Cobra Disenroll Reason Types
@@ -1413,6 +1524,22 @@ export class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
         return SubscribersApiFp(this.configuration).getSubscribers(vbasoftwareDatabase, subscriberID, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.
+     * @summary List Active Subscribers for a Groupd & Division
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} groupId Group ID
+     * @param {string} [divisionId] Division ID
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SubscribersApi
+     */
+    public listActiveSubscribers(vbasoftwareDatabase: string, groupId: string, divisionId?: string, page?: number, pageSize?: number, options?: AxiosRequestConfig) {
+        return SubscribersApiFp(this.configuration).listActiveSubscribers(vbasoftwareDatabase, groupId, divisionId, page, pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List of all Cobra Disenroll Reason Types
      * @summary List Cobra Disenroll Reason Types

package/models/active-subscriber-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 { ActiveSubscriber } from './active-subscriber';
+import { Debug } from './debug';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface ActiveSubscriberListVBAResponse
+ */
+export interface ActiveSubscriberListVBAResponse {
+    /**
+     * 
+     * @type {Array<ActiveSubscriber>}
+     * @memberof ActiveSubscriberListVBAResponse
+     */
+    'data'?: Array<ActiveSubscriber> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof ActiveSubscriberListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof ActiveSubscriberListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/active-subscriber.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 ActiveSubscriber
+ */
+export interface ActiveSubscriber {
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'subscriberId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'memberSeq'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'birthDate'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'firstName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'lastName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'planDescription'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'tierDescription'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'startDate'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveSubscriber
+     */
+    'endDate'?: string | null;
+}
+

package/models/index.ts

@@ -7,6 +7,8 @@ export * from './apcschedule-vbaresponse';
 export * from './apcweight';
 export * from './apcweight-list-vbaresponse';
 export * from './apcweight-vbaresponse';
+export * from './active-subscriber';
+export * from './active-subscriber-list-vbaresponse';
 export * from './add-enrollment-request';
 export * from './admission-type-place';
 export * from './admission-type-place-list-vbaresponse';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
-  "version": "1.20230923.2",
+  "version": "1.20230927.1",
   "description": "APIs for VBASoftware APIs",
   "main": "index.js",
   "scripts": {