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

package/docs/PlanPlaceAuthApi.md

@@ -0,0 +1,372 @@
+# PlanPlaceAuthApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPlanPlaceAuth**](#createplanplaceauth) | **POST** /plans/{Plan_ID}/place-auths/{Place_Code} | Create PlanPlaceAuth|
+|[**deletePlanPlaceAuth**](#deleteplanplaceauth) | **DELETE** /plans/{Plan_ID}/place-auths/{Place_Code} | Delete PlanPlaceAuth|
+|[**getPlanPlaceAuth**](#getplanplaceauth) | **GET** /plans/{Plan_ID}/place-auths/{Place_Code} | Get PlanPlaceAuth|
+|[**listPlanPlaceAuth**](#listplanplaceauth) | **GET** /plans/{Plan_ID}/place-auths | List PlanPlaceAuth|
+|[**updateBatchPlanPlaceAuth**](#updatebatchplanplaceauth) | **PUT** /plan-place-auths-batch | Create or Update Batch PlanPlaceAuth|
+|[**updatePlanPlaceAuth**](#updateplanplaceauth) | **PUT** /plans/{Plan_ID}/place-auths/{Place_Code} | Update PlanPlaceAuth|
+
+# **createPlanPlaceAuth**
+> PlanPlaceAuthVBAResponse createPlanPlaceAuth(planPlaceAuth)
+
+Creates a new PlanPlaceAuth
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration,
+    PlanPlaceAuth
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(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 planPlaceAuth: PlanPlaceAuth; //
+
+const { status, data } = await apiInstance.createPlanPlaceAuth(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    planPlaceAuth
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuth** | **PlanPlaceAuth**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | defaults to undefined|
+
+
+### Return type
+
+**PlanPlaceAuthVBAResponse**
+
+### 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)
+
+# **deletePlanPlaceAuth**
+> deletePlanPlaceAuth()
+
+Deletes an PlanPlaceAuth
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(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)
+
+const { status, data } = await apiInstance.deletePlanPlaceAuth(
+    vbasoftwareDatabase,
+    planID,
+    placeCode
+);
+```
+
+### 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|
+
+
+### 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)
+
+# **getPlanPlaceAuth**
+> PlanPlaceAuthVBAResponse getPlanPlaceAuth()
+
+Gets PlanPlaceAuth
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(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)
+
+const { status, data } = await apiInstance.getPlanPlaceAuth(
+    vbasoftwareDatabase,
+    planID,
+    placeCode
+);
+```
+
+### 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|
+
+
+### Return type
+
+**PlanPlaceAuthVBAResponse**
+
+### 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)
+
+# **listPlanPlaceAuth**
+> PlanPlaceAuthListVBAResponse listPlanPlaceAuth()
+
+Lists all PlanPlaceAuth for the given Plan_ID
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(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.listPlanPlaceAuth(
+    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
+
+**PlanPlaceAuthListVBAResponse**
+
+### 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)
+
+# **updateBatchPlanPlaceAuth**
+> MultiCodeResponseListVBAResponse updateBatchPlanPlaceAuth(planPlaceAuth)
+
+Create or Update multiple PlanPlaceAuth at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let planPlaceAuth: Array<PlanPlaceAuth>; //
+
+const { status, data } = await apiInstance.updateBatchPlanPlaceAuth(
+    vbasoftwareDatabase,
+    planPlaceAuth
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuth** | **Array<PlanPlaceAuth>**|  | |
+| **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)
+
+# **updatePlanPlaceAuth**
+> PlanPlaceAuthVBAResponse updatePlanPlaceAuth(planPlaceAuth)
+
+Updates a specific PlanPlaceAuth.
+
+### Example
+
+```typescript
+import {
+    PlanPlaceAuthApi,
+    Configuration,
+    PlanPlaceAuth
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PlanPlaceAuthApi(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 planPlaceAuth: PlanPlaceAuth; //
+
+const { status, data } = await apiInstance.updatePlanPlaceAuth(
+    vbasoftwareDatabase,
+    planID,
+    placeCode,
+    planPlaceAuth
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planPlaceAuth** | **PlanPlaceAuth**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **planID** | [**string**] | Plan ID | defaults to undefined|
+| **placeCode** | [**string**] | Place Code | defaults to undefined|
+
+
+### Return type
+
+**PlanPlaceAuthVBAResponse**
+
+### 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/PlanPlaceAuthBenefit.md

@@ -0,0 +1,32 @@
+# PlanPlaceAuthBenefit
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan_ID** | **string** |  | [default to undefined]
+**place_Code** | **string** |  | [default to undefined]
+**benefit_Code** | **string** |  | [default to undefined]
+**entry_Date** | **string** | Date when the record was 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 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]
+
+## Example
+
+```typescript
+import { PlanPlaceAuthBenefit } from './api';
+
+const instance: PlanPlaceAuthBenefit = {
+    plan_ID,
+    place_Code,
+    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)