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

package/docs/VBAInterfaceProfileApi.md

@@ -0,0 +1,552 @@
+# VBAInterfaceProfileApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createFromExistingProfile**](#createfromexistingprofile) | **POST** /vba-interface/{VBAInterface_Key}/profile/{Profile_Key}/create-from-existing | Create from Existing Profile|
+|[**createVBAInterfaceProfile**](#createvbainterfaceprofile) | **POST** /vba-interface-profile | Create VBAInterfaceProfile|
+|[**createVBAProcessFromInterfaceProfile**](#createvbaprocessfrominterfaceprofile) | **POST** /create-vbaprocess-from-interfaceprofile | Create a VBAProcess record based on VBAInterfaceProfile|
+|[**deleteVBAInterfaceProfile**](#deletevbainterfaceprofile) | **DELETE** /vba-interface/{VBAInterface_Key}/profile/{Profile_Key} | Delete VBAInterfaceProfile|
+|[**getVBAInterfaceProfile**](#getvbainterfaceprofile) | **GET** /vba-interface/{VBAInterface_Key}/profile/{Profile_Key} | Get VBAInterfaceProfile|
+|[**listVBAInterfaceProfile**](#listvbainterfaceprofile) | **GET** /vba-interface/{VBAInterface_Key}/profile | List VBAInterfaceProfile|
+|[**rerunEDIByInterfaceProfile**](#rerunedibyinterfaceprofile) | **POST** /rerun-edi-by-interfaceprofile | Rerun an already executed Interface|
+|[**updateBatchVBAInterfaceProfile**](#updatebatchvbainterfaceprofile) | **PUT** /vba-interface-profile-batch | Create or Update Batch VBAInterfaceProfile|
+|[**updateVBAInterfaceProfile**](#updatevbainterfaceprofile) | **PUT** /vba-interface/{VBAInterface_Key}/profile/{Profile_Key} | Update VBAInterfaceProfile|
+
+# **createFromExistingProfile**
+> createFromExistingProfile()
+
+Create a New Interface Profile from an existing Profile copying all child data.
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBA Interface Key (default to undefined)
+let profileKey: number; //Profile Key (default to undefined)
+let newDescription: string; //New Profile Description (default to undefined)
+
+const { status, data } = await apiInstance.createFromExistingProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey,
+    newDescription
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBA Interface Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile Key | defaults to undefined|
+| **newDescription** | [**string**] | New Profile Description | 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 |
+|-------------|-------------|------------------|
+|**202** | Accepted for processing |  -  |
+|**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)
+
+# **createVBAInterfaceProfile**
+> VBAInterfaceProfileVBAResponse createVBAInterfaceProfile(vBAInterfaceProfile)
+
+Creates a new VBAInterfaceProfile
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration,
+    VBAInterfaceProfile
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceProfile: VBAInterfaceProfile; //
+
+const { status, data } = await apiInstance.createVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceProfile
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vBAInterfaceProfile** | **VBAInterfaceProfile**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**VBAInterfaceProfileVBAResponse**
+
+### 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)
+
+# **createVBAProcessFromInterfaceProfile**
+> VBAProcessVBAResponse createVBAProcessFromInterfaceProfile()
+
+Utlizing the VBAInterfaceProfile, create a VBAProcess record that can then be used to Execute Profile enabled Standard EDI Interfaces.
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface_Key (default to undefined)
+let profileKey: number; //Profile_Key (default to undefined)
+let returnInterfaceResults: string; //Return_Interface_Results (default to undefined)
+
+const { status, data } = await apiInstance.createVBAProcessFromInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey,
+    returnInterfaceResults
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface_Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile_Key | defaults to undefined|
+| **returnInterfaceResults** | [**string**] | Return_Interface_Results | defaults to undefined|
+
+
+### Return type
+
+**VBAProcessVBAResponse**
+
+### 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)
+
+# **deleteVBAInterfaceProfile**
+> deleteVBAInterfaceProfile()
+
+Deletes an VBAInterfaceProfile
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface Key (default to undefined)
+let profileKey: number; //Profile Key (default to undefined)
+
+const { status, data } = await apiInstance.deleteVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile Key | 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)
+
+# **getVBAInterfaceProfile**
+> VBAInterfaceProfileVBAResponse getVBAInterfaceProfile()
+
+Gets VBAInterfaceProfile
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface Key (default to undefined)
+let profileKey: number; //Profile Key (default to undefined)
+
+const { status, data } = await apiInstance.getVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile Key | defaults to undefined|
+
+
+### Return type
+
+**VBAInterfaceProfileVBAResponse**
+
+### 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)
+
+# **listVBAInterfaceProfile**
+> VBAInterfaceProfileListVBAResponse listVBAInterfaceProfile()
+
+Lists all VBAInterfaceProfile for the given VBAInterface_Key
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface 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.listVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface 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
+
+**VBAInterfaceProfileListVBAResponse**
+
+### 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)
+
+# **rerunEDIByInterfaceProfile**
+> VBAEDIExecuteContentListVBAResponse rerunEDIByInterfaceProfile()
+
+Based on the selected Interface Profile, execute a previously executed Interface based on Execution ID.
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface_Key (default to undefined)
+let profileKey: number; //Profile_Key (default to undefined)
+let executeId: string; //Execute_ID (default to undefined)
+
+const { status, data } = await apiInstance.rerunEDIByInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey,
+    executeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface_Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile_Key | defaults to undefined|
+| **executeId** | [**string**] | Execute_ID | defaults to undefined|
+
+
+### Return type
+
+**VBAEDIExecuteContentListVBAResponse**
+
+### 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)
+
+# **updateBatchVBAInterfaceProfile**
+> MultiCodeResponseListVBAResponse updateBatchVBAInterfaceProfile(vBAInterfaceProfile)
+
+Create or Update multiple VBAInterfaceProfile at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceProfile: Array<VBAInterfaceProfile>; //
+
+const { status, data } = await apiInstance.updateBatchVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceProfile
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vBAInterfaceProfile** | **Array<VBAInterfaceProfile>**|  | |
+| **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)
+
+# **updateVBAInterfaceProfile**
+> VBAInterfaceProfileVBAResponse updateVBAInterfaceProfile(vBAInterfaceProfile)
+
+Updates a specific VBAInterfaceProfile.
+
+### Example
+
+```typescript
+import {
+    VBAInterfaceProfileApi,
+    Configuration,
+    VBAInterfaceProfile
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new VBAInterfaceProfileApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let vBAInterfaceKey: number; //VBAInterface Key (default to undefined)
+let profileKey: number; //Profile Key (default to undefined)
+let vBAInterfaceProfile: VBAInterfaceProfile; //
+
+const { status, data } = await apiInstance.updateVBAInterfaceProfile(
+    vbasoftwareDatabase,
+    vBAInterfaceKey,
+    profileKey,
+    vBAInterfaceProfile
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vBAInterfaceProfile** | **VBAInterfaceProfile**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **vBAInterfaceKey** | [**number**] | VBAInterface Key | defaults to undefined|
+| **profileKey** | [**number**] | Profile Key | defaults to undefined|
+
+
+### Return type
+
+**VBAInterfaceProfileVBAResponse**
+
+### 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/VBAInterfaceProfileEDICodeMap.md

@@ -0,0 +1,46 @@
+# VBAInterfaceProfileEDICodeMap
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vbaInterfaceProfileEDICodeMap_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**destination_Value** | **string** |  | [default to undefined]
+**direction** | **string** |  | [default to undefined]
+**effective_Date** | **string** |  | [optional] [default to undefined]
+**map_Type** | **string** |  | [default to undefined]
+**map_Variable1** | **string** |  | [optional] [default to undefined]
+**map_Variable2** | **string** |  | [optional] [default to undefined]
+**map_Variable3** | **string** |  | [optional] [default to undefined]
+**map_Variable4** | **string** |  | [optional] [default to undefined]
+**map_Variable5** | **string** |  | [optional] [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]
+**source_Value** | **string** |  | [default to undefined]
+**term_Date** | **string** |  | [optional] [default to undefined]
+**vbaInterface_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+
+## Example
+
+```typescript
+import { VBAInterfaceProfileEDICodeMap } from './api';
+
+const instance: VBAInterfaceProfileEDICodeMap = {
+    vbaInterfaceProfileEDICodeMap_Key,
+    destination_Value,
+    direction,
+    effective_Date,
+    map_Type,
+    map_Variable1,
+    map_Variable2,
+    map_Variable3,
+    map_Variable4,
+    map_Variable5,
+    profile_Key,
+    source_Value,
+    term_Date,
+    vbaInterface_Key,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)