@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20251017.1 → 1.20260102.1

package/docs/ImageListVBAResponse.md

@@ -0,0 +1,24 @@
+# ImageListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<Image>**](Image.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ImageListVBAResponse } from './api';
+
+const instance: ImageListVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ImageVBAResponse.md

@@ -0,0 +1,24 @@
+# ImageVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Image**](Image.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ImageVBAResponse } from './api';
+
+const instance: ImageVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MembersApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
 |[**createMembers**](#createmembers) | **POST** /subscribers/{subscriberID}/members | Create Members|
 |[**deleteMembers**](#deletemembers) | **DELETE** /subscribers/{subscriberID}/members/{memberSeq} | Delete Members|
 |[**enrollmentBenefitInquiry**](#enrollmentbenefitinquiry) | **POST** /enrollment-benefit-inquiry | Benefit Inquiry|
-|[**getEOB**](#geteob) | **GET** /claim-batches/{batchNumber}/claims/{batchClaim}/eob | Retrieves the member EOB (Explanation of Benefits) PDF for the specified batch claim.|
+|[**getMemberEOB**](#getmembereob) | **GET** /claims/{claimNumber}/eob | Retrieves the member EOB (Explanation of Benefits) PDF for the specified batch claim.|
 |[**getMembers**](#getmembers) | **GET** /subscribers/{subscriberID}/members/{memberSeq} | Get Members|
 |[**getMembersDisabilityTaxSummary**](#getmembersdisabilitytaxsummary) | **GET** /subscribers/{subscriberID}/member-disability-tax-summary/{taxYear} | Get MembersDisabilityTaxSummary|
 |[**listAutoAssignPriaryCarePhysicianMembers**](#listautoassignpriarycarephysicianmembers) | **GET** /auto-assign-primary-care-physician-members | List Members with Auto-Assign Primary Care Physician|
@@ -250,8 +250,8 @@ const { status, data } = await apiInstance.enrollmentBenefitInquiry(
 
 [[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)
 
-# **getEOB**
-> VBAMemberEOBResponseVBAResponse getEOB()
+# **getMemberEOB**
+> VBAMemberEOBResponseVBAResponse getMemberEOB()
 
 Resolution order: 1. If the client/company is configured for Zelis RedCard EOBs, attempt external retrieval. 2. If external retrieval is unavailable, misconfigured, or not eligible, fall back to internal VBA report generation. The response always includes correlation identifiers (Subscriber_ID, Member_Seq, Batch_Number, Batch_Claim).
 
@@ -267,13 +267,11 @@ const configuration = new Configuration();
 const apiInstance = new MembersApi(configuration);
 
 let vbasoftwareDatabase: string; //Target client database/schema (multi?tenant routing header). (default to undefined)
-let batchNumber: number; //Claim batch number grouping the claim. (default to undefined)
-let batchClaim: number; //Claim sequence number within the batch. (default to undefined)
+let claimNumber: number; //VBA Claim Number (default to undefined)
 
-const { status, data } = await apiInstance.getEOB(
+const { status, data } = await apiInstance.getMemberEOB(
     vbasoftwareDatabase,
-    batchNumber,
-    batchClaim
+    claimNumber
 );
 ```
 
@@ -282,8 +280,7 @@ const { status, data } = await apiInstance.getEOB(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **vbasoftwareDatabase** | [**string**] | Target client database/schema (multi?tenant routing header). | defaults to undefined|
-| **batchNumber** | [**number**] | Claim batch number grouping the claim. | defaults to undefined|
-| **batchClaim** | [**number**] | Claim sequence number within the batch. | defaults to undefined|
+| **claimNumber** | [**number**] | VBA Claim Number | defaults to undefined|
 
 
 ### Return type

package/docs/NoteAttachmentsApi.md

@@ -198,13 +198,15 @@ let noteKey: number; //Note Key (default to undefined)
 let page: number; //Page (optional) (default to 1)
 let pageSize: number; //Page Size (optional) (default to 100)
 let sortBy: string; //Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. (optional) (default to undefined)
+let includeAttachment: boolean; //Setting to true will include the attachment data to the response. Use with caution, as this may make the endpoint be too large to be returned. (optional) (default to false)
 
 const { status, data } = await apiInstance.listNoteAttachment(
     vbasoftwareDatabase,
     noteKey,
     page,
     pageSize,
-    sortBy
+    sortBy,
+    includeAttachment
 );
 ```
 
@@ -217,6 +219,7 @@ const { status, data } = await apiInstance.listNoteAttachment(
 | **page** | [**number**] | Page | (optional) defaults to 1|
 | **pageSize** | [**number**] | Page Size | (optional) defaults to 100|
 | **sortBy** | [**string**] | Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. | (optional) defaults to undefined|
+| **includeAttachment** | [**boolean**] | Setting to true will include the attachment data to the response. Use with caution, as this may make the endpoint be too large to be returned. | (optional) defaults to false|
 
 
 ### Return type

package/docs/PlanDependency.md

@@ -0,0 +1,46 @@
+# PlanDependency
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan_ID** | **string** |  | [default to undefined]
+**dependency_Seq** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**assign_Benefit_Code** | **string** |  | [optional] [default to undefined]
+**assign_Ex_Code** | **string** |  | [optional] [default to undefined]
+**entry_Date** | **string** | Date record was first added to the system | [optional] [default to undefined]
+**entry_User** | **string** | User that first added the record to the system | [optional] [default to undefined]
+**fallout_Ex_Code** | **string** |  | [optional] [default to undefined]
+**lookup_Range** | **number** |  | [optional] [default to undefined]
+**lookup_Range_Type** | **string** |  | [optional] [default to undefined]
+**primary_Benefit_Code** | **string** |  | [optional] [default to undefined]
+**secondary_Benefit_Code** | **string** |  | [optional] [default to undefined]
+**update_Date** | **string** | Date the record was last updated in the system | [optional] [default to undefined]
+**update_User** | **string** | User that last updated the record in the system | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependency } from './api';
+
+const instance: PlanDependency = {
+    plan_ID,
+    dependency_Seq,
+    description,
+    assign_Benefit_Code,
+    assign_Ex_Code,
+    entry_Date,
+    entry_User,
+    fallout_Ex_Code,
+    lookup_Range,
+    lookup_Range_Type,
+    primary_Benefit_Code,
+    secondary_Benefit_Code,
+    update_Date,
+    update_User,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PlanDependencyApi.md

@@ -0,0 +1,366 @@
+# PlanDependencyApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPlanDependency**](#createplandependency) | **POST** /plan-dependencies | Create PlanDependency|
+|[**deletePlanDependency**](#deleteplandependency) | **DELETE** /plan/{Plan_ID}/dependencies/{Dependency_Seq} | Delete PlanDependency|
+|[**getPlanDependency**](#getplandependency) | **GET** /plan/{Plan_ID}/dependencies/{Dependency_Seq} | Get PlanDependency|
+|[**listPlanDependency**](#listplandependency) | **GET** /plan/{Plan_ID}/dependencies | List PlanDependency|
+|[**updateBatchPlanDependency**](#updatebatchplandependency) | **PUT** /plan-dependencies-batch | Create or Update Batch PlanDependency|
+|[**updatePlanDependency**](#updateplandependency) | **PUT** /plan/{Plan_ID}/dependencies/{Dependency_Seq} | Update PlanDependency|
+
+# **createPlanDependency**
+> PlanDependencyVBAResponse createPlanDependency(planDependency)
+
+Creates a new PlanDependency
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration,
+    PlanDependency
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planDependency: PlanDependency; //
+
+const { status, data } = await apiInstance.createPlanDependency(
+    vbasoftwareDatabase,
+    planDependency
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependency** | **PlanDependency**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **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)
+
+# **deletePlanDependency**
+> deletePlanDependency()
+
+Deletes an PlanDependency
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let dependencySeq: number; //Dependency Seq (default to undefined)
+
+const { status, data } = await apiInstance.deletePlanDependency(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **dependencySeq** | [**number**] | Dependency Seq | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | 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)
+
+# **getPlanDependency**
+> PlanDependencyVBAResponse getPlanDependency()
+
+Gets PlanDependency
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let dependencySeq: number; //Dependency Seq (default to undefined)
+
+const { status, data } = await apiInstance.getPlanDependency(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **dependencySeq** | [**number**] | Dependency Seq | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyVBAResponse**
+
+### 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)
+
+# **listPlanDependency**
+> PlanDependencyListVBAResponse listPlanDependency()
+
+Lists all PlanDependency for the given Plan_ID
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let sortBy: string; //Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. (optional) (default to undefined)
+let page: number; //Page (optional) (default to 1)
+let pageSize: number; //Page Size (optional) (default to 100)
+
+const { status, data } = await apiInstance.listPlanDependency(
+    vbasoftwareDatabase,
+    planID,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **sortBy** | [**string**] | Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. | (optional) defaults to undefined|
+| **page** | [**number**] | Page | (optional) defaults to 1|
+| **pageSize** | [**number**] | Page Size | (optional) defaults to 100|
+
+
+### Return type
+
+**PlanDependencyListVBAResponse**
+
+### 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)
+
+# **updateBatchPlanDependency**
+> MultiCodeResponseListVBAResponse updateBatchPlanDependency(planDependency)
+
+Create or Update multiple PlanDependency at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planDependency: Array<PlanDependency>; //
+
+const { status, data } = await apiInstance.updateBatchPlanDependency(
+    vbasoftwareDatabase,
+    planDependency
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependency** | **Array<PlanDependency>**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**MultiCodeResponseListVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**207** | 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)
+
+# **updatePlanDependency**
+> PlanDependencyVBAResponse updatePlanDependency(planDependency)
+
+Updates a specific PlanDependency.
+
+### Example
+
+```typescript
+import {
+    PlanDependencyApi,
+    Configuration,
+    PlanDependency
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let dependencySeq: number; //Dependency Seq (default to undefined)
+let planDependency: PlanDependency; //
+
+const { status, data } = await apiInstance.updatePlanDependency(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq,
+    planDependency
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependency** | **PlanDependency**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **dependencySeq** | [**number**] | Dependency Seq | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **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)
+

package/docs/PlanDependencyBenefit.md

@@ -0,0 +1,32 @@
+# PlanDependencyBenefit
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan_ID** | **string** |  | [default to undefined]
+**dependency_Seq** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**benefit_Code** | **string** |  | [default to undefined]
+**entry_Date** | **string** | Date record was first added to the system | [optional] [default to undefined]
+**entry_User** | **string** | User that first added the record to the system | [optional] [default to undefined]
+**update_Date** | **string** | Date the record was last updated in the system | [optional] [default to undefined]
+**update_User** | **string** | User that last updated the record in the system | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependencyBenefit } from './api';
+
+const instance: PlanDependencyBenefit = {
+    plan_ID,
+    dependency_Seq,
+    benefit_Code,
+    entry_Date,
+    entry_User,
+    update_Date,
+    update_User,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)