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

package/docs/PlanDependencyBenefitApi.md

@@ -0,0 +1,378 @@
+# PlanDependencyBenefitApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPlanDependencyBenefit**](#createplandependencybenefit) | **POST** /plan-dependencies-benefit | Create PlanDependencyBenefit|
+|[**deletePlanDependencyBenefit**](#deleteplandependencybenefit) | **DELETE** /plan/{Plan_ID}/dependencies/{Dependency_Seq}/benefit/{Benefit_Code} | Delete PlanDependencyBenefit|
+|[**getPlanDependencyBenefit**](#getplandependencybenefit) | **GET** /plan/{Plan_ID}/dependencies/{Dependency_Seq}/benefit/{Benefit_Code} | Get PlanDependencyBenefit|
+|[**listPlanDependencyBenefit**](#listplandependencybenefit) | **GET** /plan/{Plan_ID}/dependencies/{Dependency_Seq}/benefit | List PlanDependencyBenefit|
+|[**updateBatchPlanDependencyBenefit**](#updatebatchplandependencybenefit) | **PUT** /plan-dependencies-benefit-batch | Create or Update Batch PlanDependencyBenefit|
+|[**updatePlanDependencyBenefit**](#updateplandependencybenefit) | **PUT** /plan/{Plan_ID}/dependencies/{Dependency_Seq}/benefit/{Benefit_Code} | Update PlanDependencyBenefit|
+
+# **createPlanDependencyBenefit**
+> PlanDependencyBenefitVBAResponse createPlanDependencyBenefit(planDependencyBenefit)
+
+Creates a new PlanDependencyBenefit
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration,
+    PlanDependencyBenefit
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planDependencyBenefit: PlanDependencyBenefit; //
+
+const { status, data } = await apiInstance.createPlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planDependencyBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependencyBenefit** | **PlanDependencyBenefit**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyBenefitVBAResponse**
+
+### 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)
+
+# **deletePlanDependencyBenefit**
+> deletePlanDependencyBenefit()
+
+Deletes an PlanDependencyBenefit
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(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 benefitCode: string; //Benefit Code (default to undefined)
+
+const { status, data } = await apiInstance.deletePlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq,
+    benefitCode
+);
+```
+
+### 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|
+| **benefitCode** | [**string**] | Benefit Code | 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)
+
+# **getPlanDependencyBenefit**
+> PlanDependencyBenefitVBAResponse getPlanDependencyBenefit()
+
+Gets PlanDependencyBenefit
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(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 benefitCode: string; //Benefit Code (default to undefined)
+
+const { status, data } = await apiInstance.getPlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq,
+    benefitCode
+);
+```
+
+### 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|
+| **benefitCode** | [**string**] | Benefit Code | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyBenefitVBAResponse**
+
+### 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)
+
+# **listPlanDependencyBenefit**
+> PlanDependencyBenefitListVBAResponse listPlanDependencyBenefit()
+
+Lists all PlanDependencyBenefit for the given Plan_ID and Dependency_Seq
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(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 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.listPlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### 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|
+| **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
+
+**PlanDependencyBenefitListVBAResponse**
+
+### 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)
+
+# **updateBatchPlanDependencyBenefit**
+> MultiCodeResponseListVBAResponse updateBatchPlanDependencyBenefit(planDependencyBenefit)
+
+Create or Update multiple PlanDependencyBenefit at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planDependencyBenefit: Array<PlanDependencyBenefit>; //
+
+const { status, data } = await apiInstance.updateBatchPlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planDependencyBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependencyBenefit** | **Array<PlanDependencyBenefit>**|  | |
+| **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)
+
+# **updatePlanDependencyBenefit**
+> PlanDependencyBenefitVBAResponse updatePlanDependencyBenefit(planDependencyBenefit)
+
+Updates a specific PlanDependencyBenefit.
+
+### Example
+
+```typescript
+import {
+    PlanDependencyBenefitApi,
+    Configuration,
+    PlanDependencyBenefit
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanDependencyBenefitApi(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 benefitCode: string; //Benefit Code (default to undefined)
+let planDependencyBenefit: PlanDependencyBenefit; //
+
+const { status, data } = await apiInstance.updatePlanDependencyBenefit(
+    vbasoftwareDatabase,
+    planID,
+    dependencySeq,
+    benefitCode,
+    planDependencyBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planDependencyBenefit** | **PlanDependencyBenefit**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **dependencySeq** | [**number**] | Dependency Seq | defaults to undefined|
+| **benefitCode** | [**string**] | Benefit Code | defaults to undefined|
+
+
+### Return type
+
+**PlanDependencyBenefitVBAResponse**
+
+### 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/PlanDependencyBenefitListVBAResponse.md

@@ -0,0 +1,24 @@
+# PlanDependencyBenefitListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<PlanDependencyBenefit>**](PlanDependencyBenefit.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependencyBenefitListVBAResponse } from './api';
+
+const instance: PlanDependencyBenefitListVBAResponse = {
+    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/PlanDependencyBenefitVBAResponse.md

@@ -0,0 +1,24 @@
+# PlanDependencyBenefitVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**PlanDependencyBenefit**](PlanDependencyBenefit.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependencyBenefitVBAResponse } from './api';
+
+const instance: PlanDependencyBenefitVBAResponse = {
+    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/PlanDependencyListVBAResponse.md

@@ -0,0 +1,24 @@
+# PlanDependencyListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<PlanDependency>**](PlanDependency.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependencyListVBAResponse } from './api';
+
+const instance: PlanDependencyListVBAResponse = {
+    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/PlanDependencyVBAResponse.md

@@ -0,0 +1,24 @@
+# PlanDependencyVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**PlanDependency**](PlanDependency.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlanDependencyVBAResponse } from './api';
+
+const instance: PlanDependencyVBAResponse = {
+    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/Plans.md

@@ -150,6 +150,8 @@ Name | Type | Description | Notes
 **visium_Setting_ID** | **string** | This field is not currently used - future-proofing for additional custom parameters | [optional] [default to undefined]
 **talon_Edit** | **boolean** |  | [optional] [default to undefined]
 **talon_Criteria_Key** | **number** |  | [optional] [default to undefined]
+**clearity_Plan** | **boolean** |  | [optional] [default to undefined]
+**clearity_Criteria_Key** | **number** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -302,6 +304,8 @@ const instance: Plans = {
     visium_Setting_ID,
     talon_Edit,
     talon_Criteria_Key,
+    clearity_Plan,
+    clearity_Criteria_Key,
 };
 ```
 

package/docs/ProviderRate.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **provider_ID** | **string** | Unique idenfitier assigned to the Proivider record. | [default to undefined]
 **rate** | **number** | Rate used in price calculations. | [optional] [default to undefined]
 **rate_Percent** | **boolean** | Tells the system to read the rate as a percentage instead of flat rate. | [default to undefined]
-**rate_Type** | **string** | Determines how the selected rate is applied: Per Service Line – applies the associated rate to each service line that matches the defined criteria. All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim. Per Unit – multiplies the rate by the number of units on the matching service line. Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error. ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines. | [optional] [default to undefined]
+**rate_Type** | **string** | Determines how the selected rate is applied (use the single character value):  - **S** = Per Service Line – applies the associated rate to each service line that matches the defined criteria.  - **L** = All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim.  - **U** = Per Unit – multiplies the rate by the number of units on the matching service line.  - **C** = Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error.  - **A** = ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProviderRateCriteria.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **providerRateCriteria_Key** | **number** | References. The ProviderRateCriteria.ProviderRateCriteria_Key value on the parent table. | [default to undefined]
 **criteria_From** | **string** | Beginning of selected criteria range. | [optional] [default to undefined]
-**criteria_Operator** | **string** | Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc. | [optional] [default to undefined]
+**criteria_Operator** | **string** |  | [optional] [default to undefined]
 **criteria_Thru** | **string** | End of selected criteria range. This criterion is only used for the ‘Between’ operation. | [optional] [default to undefined]
 **providerRateColumn_Key** | **number** | References the ProviderRateColumn.ProviderRateColumn_Key on the parent table. | [default to undefined]
 **providerRate_Key** | **number** | References the ProviderRate.ProviderRate_Key value on the parent table. | [default to undefined]

package/docs/ReinsContractConditionalSpecificDetail.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **procedure_Cluster** | **string** |  | [optional] [default to undefined]
 **subscriber_ID** | **string** |  | [optional] [default to undefined]
 **member_Seq** | **string** |  | [optional] [default to undefined]
+**drug_Code** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -48,6 +49,7 @@ const instance: ReinsContractConditionalSpecificDetail = {
     procedure_Cluster,
     subscriber_ID,
     member_Seq,
+    drug_Code,
 };
 ```
 

package/docs/ReportRequestInvoice.md

@@ -0,0 +1,38 @@
+# ReportRequestInvoice
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportRequestInvoice_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**entry_Date** | **string** |  | [optional] [default to undefined]
+**entry_User** | **string** |  | [optional] [default to undefined]
+**reportDefinition_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**report_Category** | **string** |  | [optional] [default to undefined]
+**report_ID** | **string** |  | [default to undefined]
+**report_Name** | **string** |  | [default to undefined]
+**request_Date** | **string** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**update_Date** | **string** |  | [optional] [default to undefined]
+**update_User** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestInvoice } from './api';
+
+const instance: ReportRequestInvoice = {
+    reportRequestInvoice_Key,
+    entry_Date,
+    entry_User,
+    reportDefinition_Key,
+    report_Category,
+    report_ID,
+    report_Name,
+    request_Date,
+    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)