@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20260105.1 → 1.20260306.1

package/docs/ReportRequestReinsuranceDetailApi.md

@@ -0,0 +1,366 @@
+# ReportRequestReinsuranceDetailApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createReportRequestReinsDetail**](#createreportrequestreinsdetail) | **POST** /report-request-reinsurance-detail | Create ReportRequestReinsDetail|
+|[**deleteReportRequestReinsDetail**](#deletereportrequestreinsdetail) | **DELETE** /report-request-reinsurance/{ReportRequestReins_Key}/detail/{Request_Seq} | Delete ReportRequestReinsDetail|
+|[**getReportRequestReinsDetail**](#getreportrequestreinsdetail) | **GET** /report-request-reinsurance/{ReportRequestReins_Key}/detail/{Request_Seq} | Get ReportRequestReinsDetail|
+|[**listReportRequestReinsDetail**](#listreportrequestreinsdetail) | **GET** /report-request-reinsurance/{ReportRequestReins_Key}/detail | List ReportRequestReinsDetail|
+|[**updateBatchReportRequestReinsDetail**](#updatebatchreportrequestreinsdetail) | **PUT** /report-request-reinsurance-detail/batch | Create or Update Batch ReportRequestReinsDetail|
+|[**updateReportRequestReinsDetail**](#updatereportrequestreinsdetail) | **PUT** /report-request-reinsurance/{ReportRequestReins_Key}/detail/{Request_Seq} | Update ReportRequestReinsDetail|
+
+# **createReportRequestReinsDetail**
+> ReportRequestReinsDetailVBAResponse createReportRequestReinsDetail(reportRequestReinsDetail)
+
+Creates a new ReportRequestReinsDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration,
+    ReportRequestReinsDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsDetail: ReportRequestReinsDetail; //
+
+const { status, data } = await apiInstance.createReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestReinsDetail** | **ReportRequestReinsDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestReinsDetailVBAResponse**
+
+### 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)
+
+# **deleteReportRequestReinsDetail**
+> deleteReportRequestReinsDetail()
+
+Deletes an ReportRequestReinsDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsKey: number; //ReportRequestReins Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+
+const { status, data } = await apiInstance.deleteReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsKey,
+    requestSeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestReinsKey** | [**number**] | ReportRequestReins Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request 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)
+
+# **getReportRequestReinsDetail**
+> ReportRequestReinsDetailVBAResponse getReportRequestReinsDetail()
+
+Gets ReportRequestReinsDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsKey: number; //ReportRequestReins Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+
+const { status, data } = await apiInstance.getReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsKey,
+    requestSeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestReinsKey** | [**number**] | ReportRequestReins Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request Seq | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestReinsDetailVBAResponse**
+
+### 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)
+
+# **listReportRequestReinsDetail**
+> ReportRequestReinsDetailListVBAResponse listReportRequestReinsDetail()
+
+Lists all ReportRequestReinsDetail for the given ReportRequestReins_Key
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsKey: number; //ReportRequestReins Key (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.listReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsKey,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestReinsKey** | [**number**] | ReportRequestReins Key | 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
+
+**ReportRequestReinsDetailListVBAResponse**
+
+### 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)
+
+# **updateBatchReportRequestReinsDetail**
+> MultiCodeResponseListVBAResponse updateBatchReportRequestReinsDetail(reportRequestReinsDetail)
+
+Create or Update multiple ReportRequestReinsDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsDetail: Array<ReportRequestReinsDetail>; //
+
+const { status, data } = await apiInstance.updateBatchReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestReinsDetail** | **Array<ReportRequestReinsDetail>**|  | |
+| **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)
+
+# **updateReportRequestReinsDetail**
+> ReportRequestReinsDetailVBAResponse updateReportRequestReinsDetail(reportRequestReinsDetail)
+
+Updates a specific ReportRequestReinsDetail.
+
+### Example
+
+```typescript
+import {
+    ReportRequestReinsuranceDetailApi,
+    Configuration,
+    ReportRequestReinsDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestReinsuranceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestReinsKey: number; //ReportRequestReins Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+let reportRequestReinsDetail: ReportRequestReinsDetail; //
+
+const { status, data } = await apiInstance.updateReportRequestReinsDetail(
+    vbasoftwareDatabase,
+    reportRequestReinsKey,
+    requestSeq,
+    reportRequestReinsDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestReinsDetail** | **ReportRequestReinsDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestReinsKey** | [**number**] | ReportRequestReins Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request Seq | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestReinsDetailVBAResponse**
+
+### 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/VBAEDIExecuteContent.md

@@ -0,0 +1,22 @@
+# VBAEDIExecuteContent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sort_Key** | **number** |  | [optional] [default to undefined]
+**contents** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VBAEDIExecuteContent } from './api';
+
+const instance: VBAEDIExecuteContent = {
+    sort_Key,
+    contents,
+};
+```
+
+[[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/VBAEDIExecuteContentListVBAResponse.md

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

@@ -24,6 +24,8 @@ Name | Type | Description | Notes
 **vbaInterface_Status** | **string** | Indicates the current status of the interface. | [optional] [default to undefined]
 **vbaInterface_Type** | **string** | Indicates the type of interface being configured. | [optional] [default to undefined]
 **vbaInterface_Vendor** | **string** | Indicates the vendor who is associated with the interface. | [optional] [default to undefined]
+**vbA_Standard_Interface** | **boolean** |  | [optional] [default to undefined]
+**allow_Profile_Config** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -50,6 +52,8 @@ const instance: VBAInterface = {
     vbaInterface_Status,
     vbaInterface_Type,
     vbaInterface_Vendor,
+    vbA_Standard_Interface,
+    allow_Profile_Config,
 };
 ```
 

package/docs/VBAInterfaceProfile.md

@@ -0,0 +1,122 @@
+# VBAInterfaceProfile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vbaInterface_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**profile_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**acknowledgment_Requested** | **string** |  | [optional] [default to undefined]
+**application_Receivers_Code** | **string** |  | [optional] [default to undefined]
+**application_Senders_Code** | **string** |  | [optional] [default to undefined]
+**authorization_Information** | **string** |  | [optional] [default to undefined]
+**authorization_Information_Qualifier** | **string** |  | [optional] [default to undefined]
+**client_SFTP_File_Name** | **string** | What the file will be named when transfer completes | [optional] [default to undefined]
+**client_SFTP_Host** | **string** | Domain name or IP address of the remote SFTP server | [optional] [default to undefined]
+**client_SFTP_Passive** | **boolean** | Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**client_SFTP_Password** | **string** | Password associated with the SFTP_User account. Used for authentication. | [optional] [default to undefined]
+**client_SFTP_Path** | **string** | Remote directory path where files are read from or written to during file transfer | [optional] [default to undefined]
+**client_SFTP_Port** | **number** | Network port used to establish connection to the SFTP server, default is 22 | [optional] [default to undefined]
+**client_SFTP_Protocol** | **number** | Indicates protocol used for file transfer to the SFTP server | [optional] [default to undefined]
+**client_SFTP_User** | **string** | Username credential used to authenticate the connection to the external SFTP server | [optional] [default to undefined]
+**component_Element_Separator** | **string** |  | [optional] [default to undefined]
+**create_Date** | **string** |  | [optional] [default to undefined]
+**create_Time** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**eMail_Body** | **string** | Body text of the email. | [optional] [default to undefined]
+**eMail_From** | **string** | Identifies the sender email. | [optional] [default to undefined]
+**eMail_Notification** | **boolean** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**eMail_Server** | **string** | Indicates the server over which the email will be sent. | [optional] [default to undefined]
+**eMail_Subject** | **string** | Subject line of the email. | [optional] [default to undefined]
+**eMail_To** | **string** | Indentifies the receiver email. | [optional] [default to undefined]
+**event_ID** | **number** |  | [optional] [default to undefined]
+**functional_Identifier_Code** | **string** |  | [optional] [default to undefined]
+**group_Control_Number** | **string** |  | [optional] [default to undefined]
+**interchange_Control_Number** | **string** |  | [optional] [default to undefined]
+**interchange_Control_Version_Number** | **string** |  | [optional] [default to undefined]
+**interchange_Date** | **string** |  | [optional] [default to undefined]
+**interchange_ID_Qualifier_Receiver** | **string** |  | [optional] [default to undefined]
+**interchange_ID_Qualifier_Sender** | **string** |  | [optional] [default to undefined]
+**interchange_Receiver_ID** | **string** |  | [optional] [default to undefined]
+**interchange_Sender_ID** | **string** |  | [optional] [default to undefined]
+**interchange_Time** | **string** |  | [optional] [default to undefined]
+**repetition_Separator** | **string** |  | [optional] [default to undefined]
+**responsible_Agency_Code** | **string** |  | [optional] [default to undefined]
+**run_On_Demand** | **boolean** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**security_Information** | **string** |  | [optional] [default to undefined]
+**security_Information_Qualifier** | **string** |  | [optional] [default to undefined]
+**test_File** | **boolean** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**usage_Indicator** | **string** |  | [optional] [default to undefined]
+**vendor_SFTP_File_Name** | **string** | What the file will be named when transfer completes | [optional] [default to undefined]
+**vendor_SFTP_Host** | **string** | Domain name or IP address of the remote SFTP server | [optional] [default to undefined]
+**vendor_SFTP_Passive** | **boolean** | Specifies whether passive moede is used when establishing connection to the SFTP server Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**vendor_SFTP_Password** | **string** | Password associated with the SFTP_User account. Used for authentication. | [optional] [default to undefined]
+**vendor_SFTP_Path** | **string** | Remote directory path where files are read from or written to during file transfer | [optional] [default to undefined]
+**vendor_SFTP_Port** | **number** | Network port used to establish connection to the SFTP server, default is 22 | [optional] [default to undefined]
+**vendor_SFTP_Protocol** | **number** | Indicates protocol used for file transfer to the SFTP server | [optional] [default to undefined]
+**vendor_SFTP_User** | **string** | Username credential used to authenticate the connection to the external SFTP server | [optional] [default to undefined]
+**version_Release_Industry_Identifier** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VBAInterfaceProfile } from './api';
+
+const instance: VBAInterfaceProfile = {
+    vbaInterface_Key,
+    profile_Key,
+    acknowledgment_Requested,
+    application_Receivers_Code,
+    application_Senders_Code,
+    authorization_Information,
+    authorization_Information_Qualifier,
+    client_SFTP_File_Name,
+    client_SFTP_Host,
+    client_SFTP_Passive,
+    client_SFTP_Password,
+    client_SFTP_Path,
+    client_SFTP_Port,
+    client_SFTP_Protocol,
+    client_SFTP_User,
+    component_Element_Separator,
+    create_Date,
+    create_Time,
+    description,
+    eMail_Body,
+    eMail_From,
+    eMail_Notification,
+    eMail_Server,
+    eMail_Subject,
+    eMail_To,
+    event_ID,
+    functional_Identifier_Code,
+    group_Control_Number,
+    interchange_Control_Number,
+    interchange_Control_Version_Number,
+    interchange_Date,
+    interchange_ID_Qualifier_Receiver,
+    interchange_ID_Qualifier_Sender,
+    interchange_Receiver_ID,
+    interchange_Sender_ID,
+    interchange_Time,
+    repetition_Separator,
+    responsible_Agency_Code,
+    run_On_Demand,
+    security_Information,
+    security_Information_Qualifier,
+    test_File,
+    usage_Indicator,
+    vendor_SFTP_File_Name,
+    vendor_SFTP_Host,
+    vendor_SFTP_Passive,
+    vendor_SFTP_Password,
+    vendor_SFTP_Path,
+    vendor_SFTP_Port,
+    vendor_SFTP_Protocol,
+    vendor_SFTP_User,
+    version_Release_Industry_Identifier,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)