@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250620.1 → 1.20250627.1

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.13.0
+7.14.0

package/api/security-area-user-groups-api.ts

@@ -243,14 +243,15 @@ export const SecurityAreaUserGroupsApiAxiosParamCreator = function (configuratio
             };
         },
         /**
-         * Lists all SecurityAreaUserGroup securityArea
+         * Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
          * @summary List SecurityAreaUserGroup
          * @param {string} vbasoftwareDatabase Target database
          * @param {string} securityArea Security Area
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSecurityAreaUserGroup: async (vbasoftwareDatabase: string, securityArea: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listSecurityAreaUserGroup: async (vbasoftwareDatabase: string, securityArea: string, userGroupKey?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'vbasoftwareDatabase' is not null or undefined
             assertParamExists('listSecurityAreaUserGroup', 'vbasoftwareDatabase', vbasoftwareDatabase)
             // verify required parameter 'securityArea' is not null or undefined
@@ -275,6 +276,58 @@ export const SecurityAreaUserGroupsApiAxiosParamCreator = function (configuratio
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (userGroupKey !== undefined) {
+                localVarQueryParameter['UserGroup_Key'] = userGroupKey;
+            }
+
+
+    
+            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,
+            };
+        },
+        /**
+         * Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+         * @summary List SecurityAreaUserGroup with optional UserGroup Key filter
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key. If not provided, returns all records.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSecurityAreaUserGroupByUserGroupKey: async (vbasoftwareDatabase: string, userGroupKey?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listSecurityAreaUserGroupByUserGroupKey', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/security-area-user-groups`;
+            // 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 (userGroupKey !== undefined) {
+                localVarQueryParameter['userGroupKey'] = userGroupKey;
+            }
+
 
     
             if (vbasoftwareDatabase != null) {
@@ -469,19 +522,34 @@ export const SecurityAreaUserGroupsApiFp = function(configuration?: Configuratio
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Lists all SecurityAreaUserGroup securityArea
+         * Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
          * @summary List SecurityAreaUserGroup
          * @param {string} vbasoftwareDatabase Target database
          * @param {string} securityArea Security Area
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecurityAreaUserGroupListVBAResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, options);
+        async listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, userGroupKey?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecurityAreaUserGroupListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, userGroupKey, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SecurityAreaUserGroupsApi.listSecurityAreaUserGroup']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+         * @summary List SecurityAreaUserGroup with optional UserGroup Key filter
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key. If not provided, returns all records.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase: string, userGroupKey?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecurityAreaUserGroupListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase, userGroupKey, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SecurityAreaUserGroupsApi.listSecurityAreaUserGroupByUserGroupKey']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Create or Update multiple SecurityAreaUserGroup records at once. If the entity exists, it will be updated; if it does not exist, it will be created. **Please note**: The `Security_Area` and `UserGroup_Key` fields represent the primary identifiers for these records and cannot be modified during an update. Ensure these values remain consistent with the original records when performing updates.
          * @summary Create or Update Batch SecurityAreaUserGroup
@@ -571,15 +639,27 @@ export const SecurityAreaUserGroupsApiFactory = function (configuration?: Config
             return localVarFp.listSecureGroupsForUserID(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
         },
         /**
-         * Lists all SecurityAreaUserGroup securityArea
+         * Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
          * @summary List SecurityAreaUserGroup
          * @param {string} vbasoftwareDatabase Target database
          * @param {string} securityArea Security Area
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse> {
-            return localVarFp.listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, options).then((request) => request(axios, basePath));
+        listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, userGroupKey?: number, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse> {
+            return localVarFp.listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, userGroupKey, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+         * @summary List SecurityAreaUserGroup with optional UserGroup Key filter
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} [userGroupKey] Optional filter for UserGroup_Key. If not provided, returns all records.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase: string, userGroupKey?: number, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse> {
+            return localVarFp.listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase, userGroupKey, options).then((request) => request(axios, basePath));
         },
         /**
          * Create or Update multiple SecurityAreaUserGroup records at once. If the entity exists, it will be updated; if it does not exist, it will be created. **Please note**: The `Security_Area` and `UserGroup_Key` fields represent the primary identifiers for these records and cannot be modified during an update. Ensure these values remain consistent with the original records when performing updates.
@@ -663,15 +743,27 @@ export interface SecurityAreaUserGroupsApiInterface {
     listSecureGroupsForUserID(vbasoftwareDatabase: string, userID: string, options?: RawAxiosRequestConfig): AxiosPromise<StringListVBAResponse>;
 
     /**
-     * Lists all SecurityAreaUserGroup securityArea
+     * Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
      * @summary List SecurityAreaUserGroup
      * @param {string} vbasoftwareDatabase Target database
      * @param {string} securityArea Security Area
+     * @param {number} [userGroupKey] Optional filter for UserGroup_Key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SecurityAreaUserGroupsApiInterface
+     */
+    listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, userGroupKey?: number, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse>;
+
+    /**
+     * Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+     * @summary List SecurityAreaUserGroup with optional UserGroup Key filter
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} [userGroupKey] Optional filter for UserGroup_Key. If not provided, returns all records.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SecurityAreaUserGroupsApiInterface
      */
-    listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse>;
+    listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase: string, userGroupKey?: number, options?: RawAxiosRequestConfig): AxiosPromise<SecurityAreaUserGroupListVBAResponse>;
 
     /**
      * Create or Update multiple SecurityAreaUserGroup records at once. If the entity exists, it will be updated; if it does not exist, it will be created. **Please note**: The `Security_Area` and `UserGroup_Key` fields represent the primary identifiers for these records and cannot be modified during an update. Ensure these values remain consistent with the original records when performing updates.
@@ -763,16 +855,30 @@ export class SecurityAreaUserGroupsApi extends BaseAPI implements SecurityAreaUs
     }
 
     /**
-     * Lists all SecurityAreaUserGroup securityArea
+     * Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
      * @summary List SecurityAreaUserGroup
      * @param {string} vbasoftwareDatabase Target database
      * @param {string} securityArea Security Area
+     * @param {number} [userGroupKey] Optional filter for UserGroup_Key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SecurityAreaUserGroupsApi
+     */
+    public listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, userGroupKey?: number, options?: RawAxiosRequestConfig) {
+        return SecurityAreaUserGroupsApiFp(this.configuration).listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, userGroupKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+     * @summary List SecurityAreaUserGroup with optional UserGroup Key filter
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} [userGroupKey] Optional filter for UserGroup_Key. If not provided, returns all records.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SecurityAreaUserGroupsApi
      */
-    public listSecurityAreaUserGroup(vbasoftwareDatabase: string, securityArea: string, options?: RawAxiosRequestConfig) {
-        return SecurityAreaUserGroupsApiFp(this.configuration).listSecurityAreaUserGroup(vbasoftwareDatabase, securityArea, options).then((request) => request(this.axios, this.basePath));
+    public listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase: string, userGroupKey?: number, options?: RawAxiosRequestConfig) {
+        return SecurityAreaUserGroupsApiFp(this.configuration).listSecurityAreaUserGroupByUserGroupKey(vbasoftwareDatabase, userGroupKey, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/common.ts

@@ -89,17 +89,17 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        } 
+        }
         else {
-            Object.keys(parameter).forEach(currentKey => 
+            Object.keys(parameter).forEach(currentKey =>
                 setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
             );
         }
-    } 
+    }
     else {
         if (urlSearchParams.has(key)) {
             urlSearchParams.append(key, parameter);
-        } 
+        }
         else {
             urlSearchParams.set(key, parameter);
         }

package/docs/ClaimBatchPayee.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **payTo_City** | **string** | City of the address that should be used for payments to the Payee. | [optional] [default to undefined]
 **payTo_State** | **string** | State of the Payee\'s address used for payments. | [optional] [default to undefined]
 **payTo_Zip** | **string** | Zip Code of the Payee\'s address used for payments. | [optional] [default to undefined]
+**payee_NPI** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: ClaimBatchPayee = {
     payTo_City,
     payTo_State,
     payTo_Zip,
+    payee_NPI,
 };
 ```
 

package/docs/ClaimPayee.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **payTo_City** | **string** | City of the address that should be used for payments to the Payee. | [optional] [default to undefined]
 **payTo_State** | **string** | State of the Payee\'s address used for payments. | [optional] [default to undefined]
 **payTo_Zip** | **string** | Zip Code of the Payee\'s address used for payments. | [optional] [default to undefined]
+**payee_NPI** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: ClaimPayee = {
     payTo_City,
     payTo_State,
     payTo_Zip,
+    payee_NPI,
 };
 ```
 

package/docs/SecurityAreaUserGroupsApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
 |[**getSecurityAreaUserGroup**](#getsecurityareausergroup) | **GET** /security-areas/{securityArea}/user-groups/{userGroupKey} | Get SecurityAreaUserGroup|
 |[**listSecureGroupsForUserID**](#listsecuregroupsforuserid) | **GET** /secure-groups | List Secure Groups|
 |[**listSecurityAreaUserGroup**](#listsecurityareausergroup) | **GET** /security-areas/{securityArea}/user-groups | List SecurityAreaUserGroup|
+|[**listSecurityAreaUserGroupByUserGroupKey**](#listsecurityareausergroupbyusergroupkey) | **GET** /security-area-user-groups | List SecurityAreaUserGroup with optional UserGroup Key filter|
 |[**updateBatchSecurityAreaUserGroup**](#updatebatchsecurityareausergroup) | **PUT** /security-areas/{securityArea}/user-groups | Create or Update Batch SecurityAreaUserGroup|
 |[**updateSecurityAreaUserGroup**](#updatesecurityareausergroup) | **PUT** /security-areas/{securityArea}/user-groups/{userGroupKey} | Update SecurityAreaUserGroup|
 
@@ -245,7 +246,7 @@ const { status, data } = await apiInstance.listSecureGroupsForUserID(
 # **listSecurityAreaUserGroup**
 > SecurityAreaUserGroupListVBAResponse listSecurityAreaUserGroup()
 
-Lists all SecurityAreaUserGroup securityArea
+Lists all SecurityAreaUserGroup for a given securityArea with optional filtering by UserGroup_Key
 
 ### Example
 
@@ -260,10 +261,12 @@ const apiInstance = new SecurityAreaUserGroupsApi(configuration);
 
 let vbasoftwareDatabase: string; //Target database (default to undefined)
 let securityArea: string; //Security Area (default to undefined)
+let userGroupKey: number; //Optional filter for UserGroup_Key. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listSecurityAreaUserGroup(
     vbasoftwareDatabase,
-    securityArea
+    securityArea,
+    userGroupKey
 );
 ```
 
@@ -273,6 +276,62 @@ const { status, data } = await apiInstance.listSecurityAreaUserGroup(
 |------------- | ------------- | ------------- | -------------|
 | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
 | **securityArea** | [**string**] | Security Area | defaults to undefined|
+| **userGroupKey** | [**number**] | Optional filter for UserGroup_Key. | (optional) defaults to undefined|
+
+
+### Return type
+
+**SecurityAreaUserGroupListVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listSecurityAreaUserGroupByUserGroupKey**
+> SecurityAreaUserGroupListVBAResponse listSecurityAreaUserGroupByUserGroupKey()
+
+Lists all SecurityAreaUserGroup records across all security areas. If UserGroup_Key is provided, filters by that value.
+
+### Example
+
+```typescript
+import {
+    SecurityAreaUserGroupsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new SecurityAreaUserGroupsApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let userGroupKey: number; //Optional filter for UserGroup_Key. If not provided, returns all records. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listSecurityAreaUserGroupByUserGroupKey(
+    vbasoftwareDatabase,
+    userGroupKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **userGroupKey** | [**number**] | Optional filter for UserGroup_Key. If not provided, returns all records. | (optional) defaults to undefined|
 
 
 ### Return type

package/models/claim-batch-payee.ts

@@ -104,5 +104,11 @@ export interface ClaimBatchPayee {
      * @memberof ClaimBatchPayee
      */
     'payTo_Zip'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClaimBatchPayee
+     */
+    'payee_NPI'?: string | null;
 }
 

package/models/claim-payee.ts

@@ -104,5 +104,11 @@ export interface ClaimPayee {
      * @memberof ClaimPayee
      */
     'payTo_Zip'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClaimPayee
+     */
+    'payee_NPI'?: string | null;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
-  "version": "1.20250620.1",
+  "version": "1.20250627.1",
   "main": "index.js",
   "directories": {
     "doc": "docs"