@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250131.1 → 1.20250207.1

package/.openapi-generator/FILES

@@ -42,6 +42,7 @@ api/auth-review-type-api.ts
 api/auth-review-urgency-type-api.ts
 api/auth-type-places-api.ts
 api/auth-types-api.ts
+api/authentication-api.ts
 api/benefit-categories-api.ts
 api/benefit-diagnostic-codes-api.ts
 api/benefit-places-api.ts

package/api/authentication-api.ts

@@ -0,0 +1,244 @@
+/* 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';
+/**
+ * AuthenticationApi - axios parameter creator
+ * @export
+ */
+export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Ends the session of the user who has been logged in the longest, forcing them to log in again.
+         * @summary Forcefully terminate the longest active user session
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        kickLongestSessionUser: async (vbasoftwareDatabase: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('kickLongestSessionUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/kick`;
+            // 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)
+
+
+    
+            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,
+            };
+        },
+        /**
+         * Terminates the current user\'s session and logs them out of the system.
+         * @summary Log out user
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        logoutUser: async (vbasoftwareDatabase: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('logoutUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/logout`;
+            // 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)
+
+
+    
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * AuthenticationApi - functional programming interface
+ * @export
+ */
+export const AuthenticationApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Ends the session of the user who has been logged in the longest, forcing them to log in again.
+         * @summary Forcefully terminate the longest active user session
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.kickLongestSessionUser(vbasoftwareDatabase, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.kickLongestSessionUser']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Terminates the current user\'s session and logs them out of the system.
+         * @summary Log out user
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async logoutUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.logoutUser(vbasoftwareDatabase, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.logoutUser']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AuthenticationApi - factory interface
+ * @export
+ */
+export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AuthenticationApiFp(configuration)
+    return {
+        /**
+         * Ends the session of the user who has been logged in the longest, forcing them to log in again.
+         * @summary Forcefully terminate the longest active user session
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.kickLongestSessionUser(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Terminates the current user\'s session and logs them out of the system.
+         * @summary Log out user
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        logoutUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.logoutUser(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AuthenticationApi - interface
+ * @export
+ * @interface AuthenticationApi
+ */
+export interface AuthenticationApiInterface {
+    /**
+     * Ends the session of the user who has been logged in the longest, forcing them to log in again.
+     * @summary Forcefully terminate the longest active user session
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
+    /**
+     * Terminates the current user\'s session and logs them out of the system.
+     * @summary Log out user
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    logoutUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+
+}
+
+/**
+ * AuthenticationApi - object-oriented interface
+ * @export
+ * @class AuthenticationApi
+ * @extends {BaseAPI}
+ */
+export class AuthenticationApi extends BaseAPI implements AuthenticationApiInterface {
+    /**
+     * Ends the session of the user who has been logged in the longest, forcing them to log in again.
+     * @summary Forcefully terminate the longest active user session
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApi
+     */
+    public kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
+        return AuthenticationApiFp(this.configuration).kickLongestSessionUser(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Terminates the current user\'s session and logs them out of the system.
+     * @summary Log out user
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApi
+     */
+    public logoutUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
+        return AuthenticationApiFp(this.configuration).logoutUser(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api/group-contract-plans-api.ts

@@ -37,6 +37,59 @@ import type { PlansListVBAResponse } from '../models';
  */
 export const GroupContractPlansApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
+         * @summary Cascade Plan Update to GroupContractPlan
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} planId Plan ID
+         * @param {GroupContractPlan} groupContractPlan 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cascadeUpdateGroupContractPlan: async (vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('cascadeUpdateGroupContractPlan', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'planId' is not null or undefined
+            assertParamExists('cascadeUpdateGroupContractPlan', 'planId', planId)
+            // verify required parameter 'groupContractPlan' is not null or undefined
+            assertParamExists('cascadeUpdateGroupContractPlan', 'groupContractPlan', groupContractPlan)
+            const localVarPath = `/group-contract-plan-cascade-update/{planId}`
+                .replace(`{${"planId"}}`, encodeURIComponent(String(planId)));
+            // 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(groupContractPlan, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Creates a new GroupContractPlan
          * @summary Create GroupContractPlan
@@ -473,6 +526,21 @@ export const GroupContractPlansApiAxiosParamCreator = function (configuration?:
 export const GroupContractPlansApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = GroupContractPlansApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
+         * @summary Cascade Plan Update to GroupContractPlan
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} planId Plan ID
+         * @param {GroupContractPlan} groupContractPlan 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupContractPlanVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['GroupContractPlansApi.cascadeUpdateGroupContractPlan']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Creates a new GroupContractPlan
          * @summary Create GroupContractPlan
@@ -603,6 +671,18 @@ export const GroupContractPlansApiFp = function(configuration?: Configuration) {
 export const GroupContractPlansApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = GroupContractPlansApiFp(configuration)
     return {
+        /**
+         * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
+         * @summary Cascade Plan Update to GroupContractPlan
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} planId Plan ID
+         * @param {GroupContractPlan} groupContractPlan 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): AxiosPromise<GroupContractPlanVBAResponse> {
+            return localVarFp.cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options).then((request) => request(axios, basePath));
+        },
         /**
          * Creates a new GroupContractPlan
          * @summary Create GroupContractPlan
@@ -711,6 +791,18 @@ export const GroupContractPlansApiFactory = function (configuration?: Configurat
  * @interface GroupContractPlansApi
  */
 export interface GroupContractPlansApiInterface {
+    /**
+     * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
+     * @summary Cascade Plan Update to GroupContractPlan
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} planId Plan ID
+     * @param {GroupContractPlan} groupContractPlan 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GroupContractPlansApiInterface
+     */
+    cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): AxiosPromise<GroupContractPlanVBAResponse>;
+
     /**
      * Creates a new GroupContractPlan
      * @summary Create GroupContractPlan
@@ -819,6 +911,20 @@ export interface GroupContractPlansApiInterface {
  * @extends {BaseAPI}
  */
 export class GroupContractPlansApi extends BaseAPI implements GroupContractPlansApiInterface {
+    /**
+     * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
+     * @summary Cascade Plan Update to GroupContractPlan
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} planId Plan ID
+     * @param {GroupContractPlan} groupContractPlan 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GroupContractPlansApi
+     */
+    public cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig) {
+        return GroupContractPlansApiFp(this.configuration).cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Creates a new GroupContractPlan
      * @summary Create GroupContractPlan

package/api.ts

@@ -54,6 +54,7 @@ export * from './api/auth-review-type-api';
 export * from './api/auth-review-urgency-type-api';
 export * from './api/auth-type-places-api';
 export * from './api/auth-types-api';
+export * from './api/authentication-api';
 export * from './api/benefit-categories-api';
 export * from './api/benefit-diagnostic-codes-api';
 export * from './api/benefit-places-api';

package/models/database-connection.ts

@@ -15,19 +15,19 @@
 
 
 /**
- * 
+ * Represents a connection to a database for the client.
  * @export
  * @interface DatabaseConnection
  */
 export interface DatabaseConnection {
     /**
-     * 
+     * Name of the database.
      * @type {string}
      * @memberof DatabaseConnection
      */
     'databaseName'?: string | null;
     /**
-     * 
+     * Connection string used to access the database.
      * @type {string}
      * @memberof DatabaseConnection
      */

package/models/vbaclient.ts

@@ -24,31 +24,37 @@ import type { DatabaseConnection } from './database-connection';
  */
 export interface VBAClient {
     /**
-     * 
+     * Unique identifier for the client.
      * @type {string}
      * @memberof VBAClient
      */
     'id'?: string | null;
     /**
-     * 
+     * Name of the client.
      * @type {string}
      * @memberof VBAClient
      */
     'name'?: string | null;
     /**
-     * 
+     * Unique client identifier used for authentication or tracking.
      * @type {string}
      * @memberof VBAClient
      */
     'clientId'?: string | null;
     /**
-     * 
+     * Internal client code used within the system.
      * @type {string}
      * @memberof VBAClient
      */
     'clientCode'?: string | null;
     /**
-     * 
+     * Maximum number of users allowed for this client.
+     * @type {number}
+     * @memberof VBAClient
+     */
+    'maxUsers'?: number;
+    /**
+     * List of database connections associated with the client.
      * @type {Array<DatabaseConnection>}
      * @memberof VBAClient
      */

package/package.json

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