@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250627.1 → 1.20250711.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/api/adv-benefits-api.ts +102 -0
  3. package/api/plan-benefits-api.ts +100 -0
  4. package/docs/AdvBenefitsApi.md +57 -0
  5. package/docs/BillingRateModifyConfig.md +2 -2
  6. package/docs/CriteriaDetail.md +10 -10
  7. package/docs/EmailReportDTO.md +1 -1
  8. package/docs/EnrollmentDisenroll.md +1 -1
  9. package/docs/EnrollmentDisenrollGroup.md +1 -1
  10. package/docs/FaxReportDTO.md +1 -1
  11. package/docs/IPWhitelist.md +1 -1
  12. package/docs/Members.md +1 -1
  13. package/docs/MessageThread.md +2 -2
  14. package/docs/Messages.md +7 -7
  15. package/docs/PlanBenefitCopy.md +54 -0
  16. package/docs/PlanBenefitsApi.md +57 -0
  17. package/docs/PremInvoiceApplyPayment.md +4 -4
  18. package/docs/ReinsContract.md +1 -1
  19. package/docs/UserAuthenticationResponse.md +1 -1
  20. package/docs/UserChangeTempPasswordResponse.md +1 -1
  21. package/docs/VBAProblemDetails.md +4 -4
  22. package/docs/VBAProcessPaymentFile.md +1 -1
  23. package/docs/VBAUserStatus.md +1 -1
  24. package/models/billing-rate-modify-config.ts +2 -2
  25. package/models/criteria-detail.ts +10 -10
  26. package/models/email-report-dto.ts +1 -1
  27. package/models/enrollment-disenroll-group.ts +1 -1
  28. package/models/enrollment-disenroll.ts +1 -1
  29. package/models/fax-report-dto.ts +1 -1
  30. package/models/index.ts +1 -0
  31. package/models/ipwhitelist.ts +1 -1
  32. package/models/members.ts +1 -1
  33. package/models/message-thread.ts +2 -2
  34. package/models/messages.ts +7 -7
  35. package/models/plan-benefit-copy.ts +132 -0
  36. package/models/prem-invoice-apply-payment.ts +4 -4
  37. package/models/reins-contract.ts +1 -1
  38. package/models/user-authentication-response.ts +1 -1
  39. package/models/user-change-temp-password-response.ts +1 -1
  40. package/models/vbaproblem-details.ts +4 -4
  41. package/models/vbaprocess-payment-file.ts +1 -1
  42. package/models/vbauser-status.ts +1 -1
  43. package/package.json +1 -1
@@ -3224,6 +3224,7 @@ docs/PlanBenefitCluster.md
3224
3224
  docs/PlanBenefitClusterListVBAResponse.md
3225
3225
  docs/PlanBenefitClusterVBAResponse.md
3226
3226
  docs/PlanBenefitClustersApi.md
3227
+ docs/PlanBenefitCopy.md
3227
3228
  docs/PlanBenefitDiagnosisExCodesApi.md
3228
3229
  docs/PlanBenefitDiagnosticCodesApi.md
3229
3230
  docs/PlanBenefitLevel.md
@@ -6210,6 +6211,7 @@ models/plan-benefit-cascade.ts
6210
6211
  models/plan-benefit-cluster-list-vbaresponse.ts
6211
6212
  models/plan-benefit-cluster-vbaresponse.ts
6212
6213
  models/plan-benefit-cluster.ts
6214
+ models/plan-benefit-copy.ts
6213
6215
  models/plan-benefit-level-list-vbaresponse.ts
6214
6216
  models/plan-benefit-level-vbaresponse.ts
6215
6217
  models/plan-benefit-level.ts
@@ -22,6 +22,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
+ import type { PlanBenefitCopy } from '../models';
26
+ // @ts-ignore
27
+ import type { PlanBenefitsVBAResponse } from '../models';
28
+ // @ts-ignore
25
29
  import type { PlanCopy } from '../models';
26
30
  // @ts-ignore
27
31
  import type { PlansVBAResponse } from '../models';
@@ -75,6 +79,55 @@ export const AdvBenefitsApiAxiosParamCreator = function (configuration?: Configu
75
79
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76
80
  localVarRequestOptions.data = serializeDataIfNeeded(planCopy, localVarRequestOptions, configuration)
77
81
 
82
+ return {
83
+ url: toPathString(localVarUrlObj),
84
+ options: localVarRequestOptions,
85
+ };
86
+ },
87
+ /**
88
+ * Copies an existing Plan Benefit to another existing Plan.
89
+ * @summary Copy Plan Benefit
90
+ * @param {string} vbasoftwareDatabase Target database
91
+ * @param {PlanBenefitCopy} planBenefitCopy
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ copyPlanBenefit: async (vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
96
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
97
+ assertParamExists('copyPlanBenefit', 'vbasoftwareDatabase', vbasoftwareDatabase)
98
+ // verify required parameter 'planBenefitCopy' is not null or undefined
99
+ assertParamExists('copyPlanBenefit', 'planBenefitCopy', planBenefitCopy)
100
+ const localVarPath = `/plans-benefits-copy`;
101
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
102
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
103
+ let baseOptions;
104
+ if (configuration) {
105
+ baseOptions = configuration.baseOptions;
106
+ }
107
+
108
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
109
+ const localVarHeaderParameter = {} as any;
110
+ const localVarQueryParameter = {} as any;
111
+
112
+ // authentication apiKeyAuth required
113
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
114
+
115
+ // authentication bearerAuth required
116
+ // http bearer authentication required
117
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
118
+
119
+
120
+
121
+ localVarHeaderParameter['Content-Type'] = 'application/json';
122
+
123
+ if (vbasoftwareDatabase != null) {
124
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
125
+ }
126
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
127
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
128
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
129
+ localVarRequestOptions.data = serializeDataIfNeeded(planBenefitCopy, localVarRequestOptions, configuration)
130
+
78
131
  return {
79
132
  url: toPathString(localVarUrlObj),
80
133
  options: localVarRequestOptions,
@@ -104,6 +157,20 @@ export const AdvBenefitsApiFp = function(configuration?: Configuration) {
104
157
  const localVarOperationServerBasePath = operationServerMap['AdvBenefitsApi.copyPlan']?.[localVarOperationServerIndex]?.url;
105
158
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
106
159
  },
160
+ /**
161
+ * Copies an existing Plan Benefit to another existing Plan.
162
+ * @summary Copy Plan Benefit
163
+ * @param {string} vbasoftwareDatabase Target database
164
+ * @param {PlanBenefitCopy} planBenefitCopy
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ async copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanBenefitsVBAResponse>> {
169
+ const localVarAxiosArgs = await localVarAxiosParamCreator.copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options);
170
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
171
+ const localVarOperationServerBasePath = operationServerMap['AdvBenefitsApi.copyPlanBenefit']?.[localVarOperationServerIndex]?.url;
172
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
173
+ },
107
174
  }
108
175
  };
109
176
 
@@ -125,6 +192,17 @@ export const AdvBenefitsApiFactory = function (configuration?: Configuration, ba
125
192
  copyPlan(vbasoftwareDatabase: string, planCopy: PlanCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlansVBAResponse> {
126
193
  return localVarFp.copyPlan(vbasoftwareDatabase, planCopy, options).then((request) => request(axios, basePath));
127
194
  },
195
+ /**
196
+ * Copies an existing Plan Benefit to another existing Plan.
197
+ * @summary Copy Plan Benefit
198
+ * @param {string} vbasoftwareDatabase Target database
199
+ * @param {PlanBenefitCopy} planBenefitCopy
200
+ * @param {*} [options] Override http request option.
201
+ * @throws {RequiredError}
202
+ */
203
+ copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlanBenefitsVBAResponse> {
204
+ return localVarFp.copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options).then((request) => request(axios, basePath));
205
+ },
128
206
  };
129
207
  };
130
208
 
@@ -145,6 +223,17 @@ export interface AdvBenefitsApiInterface {
145
223
  */
146
224
  copyPlan(vbasoftwareDatabase: string, planCopy: PlanCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlansVBAResponse>;
147
225
 
226
+ /**
227
+ * Copies an existing Plan Benefit to another existing Plan.
228
+ * @summary Copy Plan Benefit
229
+ * @param {string} vbasoftwareDatabase Target database
230
+ * @param {PlanBenefitCopy} planBenefitCopy
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ * @memberof AdvBenefitsApiInterface
234
+ */
235
+ copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlanBenefitsVBAResponse>;
236
+
148
237
  }
149
238
 
150
239
  /**
@@ -166,5 +255,18 @@ export class AdvBenefitsApi extends BaseAPI implements AdvBenefitsApiInterface {
166
255
  public copyPlan(vbasoftwareDatabase: string, planCopy: PlanCopy, options?: RawAxiosRequestConfig) {
167
256
  return AdvBenefitsApiFp(this.configuration).copyPlan(vbasoftwareDatabase, planCopy, options).then((request) => request(this.axios, this.basePath));
168
257
  }
258
+
259
+ /**
260
+ * Copies an existing Plan Benefit to another existing Plan.
261
+ * @summary Copy Plan Benefit
262
+ * @param {string} vbasoftwareDatabase Target database
263
+ * @param {PlanBenefitCopy} planBenefitCopy
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ * @memberof AdvBenefitsApi
267
+ */
268
+ public copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig) {
269
+ return AdvBenefitsApiFp(this.configuration).copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options).then((request) => request(this.axios, this.basePath));
270
+ }
169
271
  }
170
272
 
@@ -26,6 +26,8 @@ import type { BenefitCodesListVBAResponse } from '../models';
26
26
  // @ts-ignore
27
27
  import type { MultiCodeResponseListVBAResponse } from '../models';
28
28
  // @ts-ignore
29
+ import type { PlanBenefitCopy } from '../models';
30
+ // @ts-ignore
29
31
  import type { PlanBenefits } from '../models';
30
32
  // @ts-ignore
31
33
  import type { PlanBenefitsListVBAResponse } from '../models';
@@ -37,6 +39,55 @@ import type { PlanBenefitsVBAResponse } from '../models';
37
39
  */
38
40
  export const PlanBenefitsApiAxiosParamCreator = function (configuration?: Configuration) {
39
41
  return {
42
+ /**
43
+ * Copies an existing Plan Benefit to another existing Plan.
44
+ * @summary Copy Plan Benefit
45
+ * @param {string} vbasoftwareDatabase Target database
46
+ * @param {PlanBenefitCopy} planBenefitCopy
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ copyPlanBenefit: async (vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
51
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
52
+ assertParamExists('copyPlanBenefit', 'vbasoftwareDatabase', vbasoftwareDatabase)
53
+ // verify required parameter 'planBenefitCopy' is not null or undefined
54
+ assertParamExists('copyPlanBenefit', 'planBenefitCopy', planBenefitCopy)
55
+ const localVarPath = `/plans-benefits-copy`;
56
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
57
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
58
+ let baseOptions;
59
+ if (configuration) {
60
+ baseOptions = configuration.baseOptions;
61
+ }
62
+
63
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
64
+ const localVarHeaderParameter = {} as any;
65
+ const localVarQueryParameter = {} as any;
66
+
67
+ // authentication apiKeyAuth required
68
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
69
+
70
+ // authentication bearerAuth required
71
+ // http bearer authentication required
72
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
+
74
+
75
+
76
+ localVarHeaderParameter['Content-Type'] = 'application/json';
77
+
78
+ if (vbasoftwareDatabase != null) {
79
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
80
+ }
81
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
82
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
83
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
84
+ localVarRequestOptions.data = serializeDataIfNeeded(planBenefitCopy, localVarRequestOptions, configuration)
85
+
86
+ return {
87
+ url: toPathString(localVarUrlObj),
88
+ options: localVarRequestOptions,
89
+ };
90
+ },
40
91
  /**
41
92
  * Creates a new PlanBenefits
42
93
  * @summary Create PlanBenefits
@@ -410,6 +461,20 @@ export const PlanBenefitsApiAxiosParamCreator = function (configuration?: Config
410
461
  export const PlanBenefitsApiFp = function(configuration?: Configuration) {
411
462
  const localVarAxiosParamCreator = PlanBenefitsApiAxiosParamCreator(configuration)
412
463
  return {
464
+ /**
465
+ * Copies an existing Plan Benefit to another existing Plan.
466
+ * @summary Copy Plan Benefit
467
+ * @param {string} vbasoftwareDatabase Target database
468
+ * @param {PlanBenefitCopy} planBenefitCopy
469
+ * @param {*} [options] Override http request option.
470
+ * @throws {RequiredError}
471
+ */
472
+ async copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanBenefitsVBAResponse>> {
473
+ const localVarAxiosArgs = await localVarAxiosParamCreator.copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options);
474
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
475
+ const localVarOperationServerBasePath = operationServerMap['PlanBenefitsApi.copyPlanBenefit']?.[localVarOperationServerIndex]?.url;
476
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
477
+ },
413
478
  /**
414
479
  * Creates a new PlanBenefits
415
480
  * @summary Create PlanBenefits
@@ -525,6 +590,17 @@ export const PlanBenefitsApiFp = function(configuration?: Configuration) {
525
590
  export const PlanBenefitsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
526
591
  const localVarFp = PlanBenefitsApiFp(configuration)
527
592
  return {
593
+ /**
594
+ * Copies an existing Plan Benefit to another existing Plan.
595
+ * @summary Copy Plan Benefit
596
+ * @param {string} vbasoftwareDatabase Target database
597
+ * @param {PlanBenefitCopy} planBenefitCopy
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlanBenefitsVBAResponse> {
602
+ return localVarFp.copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options).then((request) => request(axios, basePath));
603
+ },
528
604
  /**
529
605
  * Creates a new PlanBenefits
530
606
  * @summary Create PlanBenefits
@@ -618,6 +694,17 @@ export const PlanBenefitsApiFactory = function (configuration?: Configuration, b
618
694
  * @interface PlanBenefitsApi
619
695
  */
620
696
  export interface PlanBenefitsApiInterface {
697
+ /**
698
+ * Copies an existing Plan Benefit to another existing Plan.
699
+ * @summary Copy Plan Benefit
700
+ * @param {string} vbasoftwareDatabase Target database
701
+ * @param {PlanBenefitCopy} planBenefitCopy
702
+ * @param {*} [options] Override http request option.
703
+ * @throws {RequiredError}
704
+ * @memberof PlanBenefitsApiInterface
705
+ */
706
+ copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig): AxiosPromise<PlanBenefitsVBAResponse>;
707
+
621
708
  /**
622
709
  * Creates a new PlanBenefits
623
710
  * @summary Create PlanBenefits
@@ -711,6 +798,19 @@ export interface PlanBenefitsApiInterface {
711
798
  * @extends {BaseAPI}
712
799
  */
713
800
  export class PlanBenefitsApi extends BaseAPI implements PlanBenefitsApiInterface {
801
+ /**
802
+ * Copies an existing Plan Benefit to another existing Plan.
803
+ * @summary Copy Plan Benefit
804
+ * @param {string} vbasoftwareDatabase Target database
805
+ * @param {PlanBenefitCopy} planBenefitCopy
806
+ * @param {*} [options] Override http request option.
807
+ * @throws {RequiredError}
808
+ * @memberof PlanBenefitsApi
809
+ */
810
+ public copyPlanBenefit(vbasoftwareDatabase: string, planBenefitCopy: PlanBenefitCopy, options?: RawAxiosRequestConfig) {
811
+ return PlanBenefitsApiFp(this.configuration).copyPlanBenefit(vbasoftwareDatabase, planBenefitCopy, options).then((request) => request(this.axios, this.basePath));
812
+ }
813
+
714
814
  /**
715
815
  * Creates a new PlanBenefits
716
816
  * @summary Create PlanBenefits
@@ -5,6 +5,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**copyPlan**](#copyplan) | **POST** /plans-copy | Copy Plan|
8
+ |[**copyPlanBenefit**](#copyplanbenefit) | **POST** /plans-benefits-copy | Copy Plan Benefit|
8
9
 
9
10
  # **copyPlan**
10
11
  > PlansVBAResponse copyPlan(planCopy)
@@ -62,3 +63,59 @@ const { status, data } = await apiInstance.copyPlan(
62
63
 
63
64
  [[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)
64
65
 
66
+ # **copyPlanBenefit**
67
+ > PlanBenefitsVBAResponse copyPlanBenefit(planBenefitCopy)
68
+
69
+ Copies an existing Plan Benefit to another existing Plan.
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ AdvBenefitsApi,
76
+ Configuration,
77
+ PlanBenefitCopy
78
+ } from './api';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new AdvBenefitsApi(configuration);
82
+
83
+ let vbasoftwareDatabase: string; //Target database (default to undefined)
84
+ let planBenefitCopy: PlanBenefitCopy; //
85
+
86
+ const { status, data } = await apiInstance.copyPlanBenefit(
87
+ vbasoftwareDatabase,
88
+ planBenefitCopy
89
+ );
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ |Name | Type | Description | Notes|
95
+ |------------- | ------------- | ------------- | -------------|
96
+ | **planBenefitCopy** | **PlanBenefitCopy**| | |
97
+ | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **PlanBenefitsVBAResponse**
103
+
104
+ ### Authorization
105
+
106
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: application/json, text/json, application/*+json
111
+ - **Accept**: text/plain, application/json, text/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | Success | - |
118
+ |**401** | Unauthorized | - |
119
+
120
+ [[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)
121
+
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
16
16
  **division_ID** | **string** | Used in both Rate Copy and Rate Change | [optional] [default to undefined]
17
17
  **keep_Division_ID** | **boolean** | Used in both Rate Copy and Rate Change | [optional] [default to undefined]
18
18
  **premRate_Type** | **string** | Used in both Rate Copy and Rate Change | [optional] [default to undefined]
19
- **rate_Option** | **number** | Used in both Rate Copy and Rate Change 1 - Use Existing; 2 - Update Existing; 3 - Create New; | [optional] [default to undefined]
20
- **payee_Option** | **number** | Used in both Rate Copy and Rate Change 1 - Use Existing Rates; 2 - Create New Rates; 3 - Add; | [optional] [default to undefined]
19
+ **rate_Option** | **number** | Used in both Rate Copy and Rate Change 1 - Use Existing; 2 - Update Existing; 3 - Create New; | [optional] [default to undefined]
20
+ **payee_Option** | **number** | Used in both Rate Copy and Rate Change 1 - Use Existing Rates; 2 - Create New Rates; 3 - Add; | [optional] [default to undefined]
21
21
  **existing_Rate_Term_Date** | **string** | Used only with Rate Change | [optional] [default to undefined]
22
22
  **new_Rate_Effective_Date** | **string** | Used only with Rate Change | [optional] [default to undefined]
23
23
  **new_Rate_Term_Date** | **string** | Used only with Rate Change | [optional] [default to undefined]
@@ -5,17 +5,17 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **criteria_Key** | **number** | Unique identifier of the Criteria for which this Criteria Details object belongs. When creating a new Critiera object, omit this from the payload. | [optional] [default to undefined]
9
- **criteria_Seq** | **number** | The sequential order that the criteria details will be applied. If you have multiple criteria details to add, this is important as it dictates the order in which they are applied and constructed (eg, if you have parenthesis or concatenate with AND\&#39;s / OR\&#39;s). | [default to undefined]
10
- **criteria_AndOr** | **string** | Specifies the AND/OR when multiple conditions are specified for a criteria. If making a complex query, use this to concatenate multiple criteria. For example, use the value \&quot;Or\&quot; if you want to match either this criteria or the next criteria. If not needed, use null or omit. | [optional] [default to undefined]
11
- **criteria_Column** | **string** | Column containing the value for the criteria condition specified, The column within the Criteria_Table for whcih this criteria will be applied. | [optional] [default to undefined]
12
- **criteria_Data_Type** | **string** | Data type of the value for the criteria condition specified The data type of the column value MUST be populated and MUST be one of the following values: string, date, or number | [optional] [default to undefined]
13
- **criteria_From_Value** | **string** | First value of a range or only value for a single value of the criteria condition specified The value to use against the Criteria_Operator when comparing values (eg, &gt;, &gt;&#x3D;, etc). If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the beginning value. If not needed, use null or omit. | [optional] [default to undefined]
14
- **criteria_Left_Paren** | **string** | Optional field used to hold a parenthesis for nesting criteria conditions Allows you to start a parenthetical expression. Add \&quot;(\&quot; to start the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x&#x3D;1 OR x&#x3D;2) OR (y&#x3D;1 OR y&#x3D;2). | [optional] [default to undefined]
8
+ **criteria_Key** | **number** | Unique identifier of the Criteria for which this Criteria Details object belongs. When creating a new Critiera object, omit this from the payload. | [optional] [default to undefined]
9
+ **criteria_Seq** | **number** | The sequential order that the criteria details will be applied. If you have multiple criteria details to add, this is important as it dictates the order in which they are applied and constructed (eg, if you have parenthesis or concatenate with AND\&#39;s / OR\&#39;s). | [default to undefined]
10
+ **criteria_AndOr** | **string** | Specifies the AND/OR when multiple conditions are specified for a criteria. If making a complex query, use this to concatenate multiple criteria. For example, use the value \&quot;Or\&quot; if you want to match either this criteria or the next criteria. If not needed, use null or omit. | [optional] [default to undefined]
11
+ **criteria_Column** | **string** | Column containing the value for the criteria condition specified, The column within the Criteria_Table for whcih this criteria will be applied. | [optional] [default to undefined]
12
+ **criteria_Data_Type** | **string** | Data type of the value for the criteria condition specified The data type of the column value MUST be populated and MUST be one of the following values: string, date, or number | [optional] [default to undefined]
13
+ **criteria_From_Value** | **string** | First value of a range or only value for a single value of the criteria condition specified The value to use against the Criteria_Operator when comparing values (eg, &gt;, &gt;&#x3D;, etc). If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the beginning value. If not needed, use null or omit. | [optional] [default to undefined]
14
+ **criteria_Left_Paren** | **string** | Optional field used to hold a parenthesis for nesting criteria conditions Allows you to start a parenthetical expression. Add \&quot;(\&quot; to start the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x&#x3D;1 OR x&#x3D;2) OR (y&#x3D;1 OR y&#x3D;2). | [optional] [default to undefined]
15
15
  **criteria_Operator** | **string** | | [optional] [default to undefined]
16
- **criteria_Right_Paren** | **string** | Optional field used to hold a parenthesis for nesting criteria conditions Allows you to end a parenthetical expression. Add \&quot;)\&quot; to end the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x&#x3D;1 OR x&#x3D;2) OR (y&#x3D;1 OR y&#x3D;2). | [optional] [default to undefined]
17
- **criteria_Table** | **string** | Table where a column for criteria condition is found The table for which this criteria will be applied. The table should exist within the SearchConfig that this criteria is being applied. | [optional] [default to undefined]
18
- **criteria_Thru_Value** | **string** | Optional ending value of a range for the criteria condition specified If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the ending value. If not needed, use null or omit. | [optional] [default to undefined]
16
+ **criteria_Right_Paren** | **string** | Optional field used to hold a parenthesis for nesting criteria conditions Allows you to end a parenthetical expression. Add \&quot;)\&quot; to end the parenthesis grouping. If not needed, use null or omit. An example of a criteria using parenthesis would be (x&#x3D;1 OR x&#x3D;2) OR (y&#x3D;1 OR y&#x3D;2). | [optional] [default to undefined]
17
+ **criteria_Table** | **string** | Table where a column for criteria condition is found The table for which this criteria will be applied. The table should exist within the SearchConfig that this criteria is being applied. | [optional] [default to undefined]
18
+ **criteria_Thru_Value** | **string** | Optional ending value of a range for the criteria condition specified If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the ending value. If not needed, use null or omit. | [optional] [default to undefined]
19
19
 
20
20
  ## Example
21
21
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **reportId** | **string** | ID of the Report | [optional] [default to undefined]
13
13
  **exportType** | **string** | Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV | [optional] [default to undefined]
14
14
  **filename** | **string** | Filename of the report. | [optional] [default to undefined]
15
- **reportParameters** | **{ [key: string]: string | null; }** | An object of report parameters Required if a report requires them. | [optional] [default to undefined]
15
+ **reportParameters** | **{ [key: string]: string | null; }** | An object of report parameters Required if a report requires them. | [optional] [default to undefined]
16
16
  **recipients** | **Array&lt;string&gt;** | All recipients of the email containing the report. Each entry should be a valid email address. | [optional] [default to undefined]
17
17
  **subject** | **string** | Subject of the email for the report. | [optional] [default to undefined]
18
18
  **body** | **string** | Body content of the email for the report. | [optional] [default to undefined]
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
19
19
  **premium** | **number** | When not using the PremRates list of PremRate_Key values, this indicates the COBRA Premium for some reports. | [optional] [default to undefined]
20
20
  **disenrollFamily** | **number** | The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options). | [default to undefined]
21
21
  **terminateAuth** | **boolean** | The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled. | [default to undefined]
22
- **disenrollFuture** | **number** | The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments | [default to undefined]
22
+ **disenrollFuture** | **number** | The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments | [default to undefined]
23
23
  **premRates** | **Array&lt;number&gt;** | The list of COBRA Rates associated with this Disenroll process. | [optional] [default to undefined]
24
24
  **premInvoiceAdjustments** | [**Array&lt;PremInvoiceAdjustment&gt;**](PremInvoiceAdjustment.md) | If you intend to auto-adjust existing premiums based on this disenroll you would populate your adjustments here. | [optional] [default to undefined]
25
25
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **reason_ID** | **number** | Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons). | [default to undefined]
14
14
  **disenrollFamily** | **number** | The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options). | [default to undefined]
15
15
  **terminateAuth** | **boolean** | The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled. | [default to undefined]
16
- **disenrollFuture** | **number** | The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments | [default to undefined]
16
+ **disenrollFuture** | **number** | The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments | [default to undefined]
17
17
  **groupDisenroll** | **boolean** | The flag is required and is set based on the disenroll you are performing. Set this value to true if you intend to Disenroll the Group. If you send in Divisioni_ID to disenroll a specific Division, this flag will then disenroll the group and the division sent but not other divisions. | [default to undefined]
18
18
 
19
19
  ## Example
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **reportId** | **string** | ID of the Report | [optional] [default to undefined]
13
13
  **exportType** | **string** | Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV | [optional] [default to undefined]
14
14
  **filename** | **string** | Filename of the report. | [optional] [default to undefined]
15
- **reportParameters** | **{ [key: string]: string | null; }** | A json object of report parameters Required if a report requires them. | [optional] [default to undefined]
15
+ **reportParameters** | **{ [key: string]: string | null; }** | A json object of report parameters Required if a report requires them. | [optional] [default to undefined]
16
16
  **faxNumber** | **string** | Fax destination | [optional] [default to undefined]
17
17
 
18
18
  ## Example
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **description** | **string** | User-defined description for the record to help identify the reason for usage. | [default to undefined]
10
10
  **entry_Date** | **string** | Date when the record was first added to the system. | [optional] [default to undefined]
11
11
  **entry_User** | **string** | User that first added the record to the system. | [optional] [default to undefined]
12
- **iP_Address** | **string** | IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges. - **Single IP Address:** Provide a specific IPv4 address (e.g., \&quot;192.168.1.1\&quot;) to whitelist that single address. - **CIDR Block:** Provide a CIDR block (e.g., \&quot;192.168.1.0/24\&quot;) to whitelist a range of addresses. Notes: - The value must be unique within the whitelist. - The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation. - Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors. | [default to undefined]
12
+ **iP_Address** | **string** | IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges. - **Single IP Address:** Provide a specific IPv4 address (e.g., \&quot;192.168.1.1\&quot;) to whitelist that single address. - **CIDR Block:** Provide a CIDR block (e.g., \&quot;192.168.1.0/24\&quot;) to whitelist a range of addresses. Notes: - The value must be unique within the whitelist. - The maximum length of this field is 39 characters to accommodate IPv4 addresses and CIDR notation. - Ensure that the provided IP address or CIDR block is correctly formatted to avoid validation errors. | [default to undefined]
13
13
  **update_Date** | **string** | Date when the record was last updated in the system. | [optional] [default to undefined]
14
14
  **update_User** | **string** | User that last updated the record in the system. | [optional] [default to undefined]
15
15
 
package/docs/Members.md CHANGED
@@ -6,7 +6,7 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **subscriber_ID** | **string** | References the Subscribers.Subscriber_ID value in the parent table. | [default to undefined]
9
- **member_Seq** | **string** | Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier. During creation, if you pass a value for this field, the system will attemot to use the value. If you do not include a value (eg, leave null), the system will generate a value for you. The generated value will be the total_count_of_members for the subscriber_id + 1. | [optional] [default to undefined]
9
+ **member_Seq** | **string** | Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier. During creation, if you pass a value for this field, the system will attemot to use the value. If you do not include a value (eg, leave null), the system will generate a value for you. The generated value will be the total_count_of_members for the subscriber_id + 1. | [optional] [default to undefined]
10
10
  **access_Code** | **string** | Access code defined by the User. | [optional] [default to undefined]
11
11
  **adult_Child** | **string** | Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members. | [optional] [default to undefined]
12
12
  **adult_Dependent** | **boolean** | This flag identifies the Member has been approved to continue coverage past the \&#39;Cutoff Age\&#39; defined at the \&#39;Group level\&#39;. | [default to undefined]
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **messageThread_Key** | **number** | Unique identifier for the message thread. | [default to undefined]
9
9
  **thread_Create_Date** | **string** | Date and time when the thread was created. | [optional] [default to undefined]
10
- **thread_Create_UserId** | **string** | Unique identifier (UUID) of the user who created the thread. If null, this is considered an admin-level action or system-generated. | [optional] [default to undefined]
11
- **thread_Status** | **string** | Current status of the thread, limited to 32 characters. Possible values: \&quot;CLOSED\&quot; - Closed Thread \&quot;NEW\&quot; - New Thread \&quot;NEWREC\&quot; - Active Thread | [optional] [default to undefined]
10
+ **thread_Create_UserId** | **string** | Unique identifier (UUID) of the user who created the thread. If null, this is considered an admin-level action or system-generated. | [optional] [default to undefined]
11
+ **thread_Status** | **string** | Current status of the thread, limited to 32 characters. Possible values: \&quot;CLOSED\&quot; - Closed Thread \&quot;NEW\&quot; - New Thread \&quot;NEWREC\&quot; - Active Thread | [optional] [default to undefined]
12
12
  **thread_Title** | **string** | Title or subject line for the thread, limited to 512 characters. | [optional] [default to undefined]
13
13
  **thread_Type** | **string** | Type or category of the thread, limited to 32 characters. | [optional] [default to undefined]
14
14
 
package/docs/Messages.md CHANGED
@@ -5,13 +5,13 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **message_Key** | **number** | The unique identifier for the message. On creation, set this to 0 as it will be auto-generated by the system. | [optional] [default to undefined]
9
- **messageThread_Key** | **number** | The unique identifier of the message thread this message belongs to. This value must be provided and should reference an existing message thread. | [default to undefined]
10
- **message_Body** | **string** | The content or body of the message being created or updated. This can be any text relevant to the message thread. | [optional] [default to undefined]
11
- **message_Create_Date** | **string** | The date and time when the message was created. This value may be null and, if not provided, the system may assign a timestamp automatically. | [optional] [default to undefined]
12
- **message_Create_UserId** | **string** | The unique identifier (UUID) of the user who created the message. If null, it represents an Admin submission from the VBASoftware system. If provided, it should be the UUID from the Gateway system. This information should be retrieved externally if needed. | [optional] [default to undefined]
13
- **message_Status** | **string** | The status of the message, limited to 32 characters in length. May represent states like \&quot;READ\&quot;, \&quot;UNREAD\&quot;. | [optional] [default to undefined]
14
- **message_Type** | **string** | The type of the message, limited to 32 characters. May represent types \&quot;HIGH\&quot; or \&quot;STANDARD\&quot; | [optional] [default to undefined]
8
+ **message_Key** | **number** | The unique identifier for the message. On creation, set this to 0 as it will be auto-generated by the system. | [optional] [default to undefined]
9
+ **messageThread_Key** | **number** | The unique identifier of the message thread this message belongs to. This value must be provided and should reference an existing message thread. | [default to undefined]
10
+ **message_Body** | **string** | The content or body of the message being created or updated. This can be any text relevant to the message thread. | [optional] [default to undefined]
11
+ **message_Create_Date** | **string** | The date and time when the message was created. This value may be null and, if not provided, the system may assign a timestamp automatically. | [optional] [default to undefined]
12
+ **message_Create_UserId** | **string** | The unique identifier (UUID) of the user who created the message. If null, it represents an Admin submission from the VBASoftware system. If provided, it should be the UUID from the Gateway system. This information should be retrieved externally if needed. | [optional] [default to undefined]
13
+ **message_Status** | **string** | The status of the message, limited to 32 characters in length. May represent states like \&quot;READ\&quot;, \&quot;UNREAD\&quot;. | [optional] [default to undefined]
14
+ **message_Type** | **string** | The type of the message, limited to 32 characters. May represent types \&quot;HIGH\&quot; or \&quot;STANDARD\&quot; | [optional] [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
@@ -0,0 +1,54 @@
1
+ # PlanBenefitCopy
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **sourcePlanID** | **string** | | [optional] [default to undefined]
9
+ **destinationPlanID** | **string** | | [optional] [default to undefined]
10
+ **benefitCode** | **string** | | [optional] [default to undefined]
11
+ **copyPlaces** | **boolean** | | [optional] [default to undefined]
12
+ **copySpecialties** | **boolean** | | [optional] [default to undefined]
13
+ **copyProviderTypes** | **boolean** | | [optional] [default to undefined]
14
+ **copyPlaceExCodes** | **boolean** | | [optional] [default to undefined]
15
+ **copyDiagnosisCodeExCodes** | **boolean** | | [optional] [default to undefined]
16
+ **copyProcedureCodeExCodes** | **boolean** | | [optional] [default to undefined]
17
+ **copyModifierExCodes** | **boolean** | | [optional] [default to undefined]
18
+ **copyBenefitLevels** | **boolean** | | [optional] [default to undefined]
19
+ **copyBenefitMaximums** | **boolean** | | [optional] [default to undefined]
20
+ **copyBenefitRates** | **boolean** | | [optional] [default to undefined]
21
+ **copyPBMCopay** | **boolean** | | [optional] [default to undefined]
22
+ **copyPlaceDetails** | **boolean** | | [optional] [default to undefined]
23
+ **copyDiagnonsisCodes** | **boolean** | | [optional] [default to undefined]
24
+ **copyProcedureCodes** | **boolean** | | [optional] [default to undefined]
25
+ **userID** | **string** | | [optional] [default to undefined]
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import { PlanBenefitCopy } from './api';
31
+
32
+ const instance: PlanBenefitCopy = {
33
+ sourcePlanID,
34
+ destinationPlanID,
35
+ benefitCode,
36
+ copyPlaces,
37
+ copySpecialties,
38
+ copyProviderTypes,
39
+ copyPlaceExCodes,
40
+ copyDiagnosisCodeExCodes,
41
+ copyProcedureCodeExCodes,
42
+ copyModifierExCodes,
43
+ copyBenefitLevels,
44
+ copyBenefitMaximums,
45
+ copyBenefitRates,
46
+ copyPBMCopay,
47
+ copyPlaceDetails,
48
+ copyDiagnonsisCodes,
49
+ copyProcedureCodes,
50
+ userID,
51
+ };
52
+ ```
53
+
54
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)