@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250819.1 → 1.20251010.1

package/docs/PlanPlaceAuthBenefitApi.md

@@ -0,0 +1,387 @@
+# PlanPlaceAuthBenefitApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPlanPlaceAuthBenefit**](#createplanplaceauthbenefit) | **POST** /plans/{Plan_ID}/places/{Place_Code}/auth-benefits/{Benefit_Code} | Create PlanPlaceAuthBenefit|
+|[**deletePlanPlaceAuthBenefit**](#deleteplanplaceauthbenefit) | **DELETE** /plans/{Plan_ID}/places/{Place_Code}/auth-benefits/{Benefit_Code} | Delete PlanPlaceAuthBenefit|
+|[**getPlanPlaceAuthBenefit**](#getplanplaceauthbenefit) | **GET** /plans/{Plan_ID}/places/{Place_Code}/auth-benefits/{Benefit_Code} | Get PlanPlaceAuthBenefit|
+|[**listPlanPlaceAuthBenefit**](#listplanplaceauthbenefit) | **GET** /plans/{Plan_ID}/places/{Place_Code}/auth-benefits | List PlanPlaceAuthBenefit|
+|[**updateBatchPlanPlaceAuthBenefit**](#updatebatchplanplaceauthbenefit) | **PUT** /plan-place-auth-benefits-batch | Create or Update Batch PlanPlaceAuthBenefit|
+|[**updatePlanPlaceAuthBenefit**](#updateplanplaceauthbenefit) | **PUT** /plans/{Plan_ID}/places/{Place_Code}/auth-benefits/{Benefit_Code} | Update PlanPlaceAuthBenefit|
+
+# **createPlanPlaceAuthBenefit**
+> PlanPlaceAuthBenefitVBAResponse createPlanPlaceAuthBenefit(planPlaceAuthBenefit)
+
+Creates a new PlanPlaceAuthBenefit
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration,
+    PlanPlaceAuthBenefit
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let placeCode: string; //Place Code (default to undefined)
+let benefitCode: string; //Benefit Code (default to undefined)
+let planPlaceAuthBenefit: PlanPlaceAuthBenefit; //
+
+const { status, data } = await apiInstance.createPlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    benefitCode,
+    planPlaceAuthBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuthBenefit** | **PlanPlaceAuthBenefit**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | defaults to undefined|
+| **benefitCode** | [**string**] | Benefit Code | defaults to undefined|
+
+
+### Return type
+
+**PlanPlaceAuthBenefitVBAResponse**
+
+### 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)
+
+# **deletePlanPlaceAuthBenefit**
+> deletePlanPlaceAuthBenefit()
+
+Deletes an PlanPlaceAuthBenefit
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let placeCode: string; //Place Code (default to undefined)
+let benefitCode: string; //Benefit Code (default to undefined)
+
+const { status, data } = await apiInstance.deletePlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    benefitCode
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | 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)
+
+# **getPlanPlaceAuthBenefit**
+> PlanPlaceAuthBenefitVBAResponse getPlanPlaceAuthBenefit()
+
+Gets PlanPlaceAuthBenefit
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let placeCode: string; //Place Code (default to undefined)
+let benefitCode: string; //Benefit Code (default to undefined)
+
+const { status, data } = await apiInstance.getPlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    benefitCode
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | defaults to undefined|
+| **benefitCode** | [**string**] | Benefit Code | defaults to undefined|
+
+
+### Return type
+
+**PlanPlaceAuthBenefitVBAResponse**
+
+### 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)
+
+# **listPlanPlaceAuthBenefit**
+> PlanPlaceAuthBenefitListVBAResponse listPlanPlaceAuthBenefit()
+
+Lists all PlanPlaceAuthBenefit for the given Plan_ID and Place_Code
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let placeCode: string; //Place Code (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.listPlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | 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
+
+**PlanPlaceAuthBenefitListVBAResponse**
+
+### 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)
+
+# **updateBatchPlanPlaceAuthBenefit**
+> MultiCodeResponseListVBAResponse updateBatchPlanPlaceAuthBenefit(planPlaceAuthBenefit)
+
+Create or Update multiple PlanPlaceAuthBenefit at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planPlaceAuthBenefit: Array<PlanPlaceAuthBenefit>; //
+
+const { status, data } = await apiInstance.updateBatchPlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planPlaceAuthBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuthBenefit** | **Array<PlanPlaceAuthBenefit>**|  | |
+| **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)
+
+# **updatePlanPlaceAuthBenefit**
+> PlanPlaceAuthBenefitVBAResponse updatePlanPlaceAuthBenefit(planPlaceAuthBenefit)
+
+Updates a specific PlanPlaceAuthBenefit.
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthBenefitApi,
+    Configuration,
+    PlanPlaceAuthBenefit
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthBenefitApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planID: string; //Plan ID (default to undefined)
+let placeCode: string; //Place Code (default to undefined)
+let benefitCode: string; //Benefit Code (default to undefined)
+let planPlaceAuthBenefit: PlanPlaceAuthBenefit; //
+
+const { status, data } = await apiInstance.updatePlanPlaceAuthBenefit(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    benefitCode,
+    planPlaceAuthBenefit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuthBenefit** | **PlanPlaceAuthBenefit**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | defaults to undefined|
+| **benefitCode** | [**string**] | Benefit Code | defaults to undefined|
+
+
+### Return type
+
+**PlanPlaceAuthBenefitVBAResponse**
+
+### 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/PlanPlaceAuthBenefitListVBAResponse.md

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

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

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

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

@@ -145,6 +145,11 @@ Name | Type | Description | Notes
 **update_Date** | **string** | Date when 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]
 **use_COB_Savings** | **boolean** | Indicates whether the COB should be used. Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**visium_Criteria_Key** | **number** | This field is not currently used - future-proofing support for additional options | [optional] [default to undefined]
+**visium_Edit** | **boolean** | Flag for enabling Visium integration. Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**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]
 
 ## Example
 
@@ -292,6 +297,11 @@ const instance: Plans = {
     update_Date,
     update_User,
     use_COB_Savings,
+    visium_Criteria_Key,
+    visium_Edit,
+    visium_Setting_ID,
+    talon_Edit,
+    talon_Criteria_Key,
 };
 ```
 

package/docs/PremiumInvoicesApi.md

@@ -1577,10 +1577,14 @@ const apiInstance = new PremiumInvoicesApi(configuration);
 
 let vbasoftwareDatabase: string; //Target database (default to undefined)
 let invoiceKey: number; //Invoice Key (default to undefined)
+let deleteAdditionalInvoices: boolean; //Delete Additional Invoices (default to undefined)
+let keepManualAdjustments: boolean; //Keep Manual Adjustments (default to undefined)
 
 const { status, data } = await apiInstance.regenerateInvoice(
     vbasoftwareDatabase,
-    invoiceKey
+    invoiceKey,
+    deleteAdditionalInvoices,
+    keepManualAdjustments
 );
 ```
 
@@ -1590,6 +1594,8 @@ const { status, data } = await apiInstance.regenerateInvoice(
 |------------- | ------------- | ------------- | -------------|
 | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
 | **invoiceKey** | [**number**] | Invoice Key | defaults to undefined|
+| **deleteAdditionalInvoices** | [**boolean**] | Delete Additional Invoices | defaults to undefined|
+| **keepManualAdjustments** | [**boolean**] | Keep Manual Adjustments | defaults to undefined|
 
 
 ### Return type

package/docs/ReinsContract.md

@@ -46,6 +46,7 @@ Name | Type | Description | Notes
 **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]
 **use_Reins_Level** | **boolean** | Indicates if this contract uses \"Reinsurance Levels\" for Reinsurance Calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**advanced_Funding_Minimum** | **number** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -94,6 +95,7 @@ const instance: ReinsContract = {
     update_Date,
     update_User,
     use_Reins_Level,
+    advanced_Funding_Minimum,
 };
 ```
 

package/docs/ReinsContractTrans.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **transaction_Type** | **string** | The type of transaction being created. This is a spec transaction or agg transaction. | [optional] [default to undefined]
 **update_Date** | **string** | User that last updated the record in the system | [optional] [default to undefined]
 **update_User** | **string** | Date the record was last updated in the system | [optional] [default to undefined]
+**attachment_Point** | **number** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -42,6 +43,7 @@ const instance: ReinsContractTrans = {
     transaction_Type,
     update_Date,
     update_User,
+    attachment_Point,
 };
 ```
 

package/docs/ReinsContractTransClaim.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **domestic_Claim** | **boolean** |  | [optional] [default to undefined]
 **criteria_Key** | **number** |  | [optional] [default to undefined]
 **domestic_Reduction_Pct** | **number** |  | [optional] [default to undefined]
+**attachment_Point_Applied** | **number** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -42,6 +43,7 @@ const instance: ReinsContractTransClaim = {
     domestic_Claim,
     criteria_Key,
     domestic_Reduction_Pct,
+    attachment_Point_Applied,
 };
 ```