@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250502.1 → 1.20250620.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.
- package/.openapi-generator/FILES +40 -0
- package/api/adv-billing-api.ts +184 -0
- package/api/adv-care-management-api.ts +166 -0
- package/api/adv-claim-api.ts +204 -6
- package/api/adv-commission-api.ts +96 -0
- package/api/adv-enrollment-api.ts +88 -0
- package/api/adv-vbagateway-api.ts +168 -0
- package/api/authentication-api.ts +96 -0
- package/api/care-cases-api.ts +609 -0
- package/api/claim-offset-api.ts +685 -0
- package/api/claim-offset-detail-api.ts +694 -0
- package/api/claims-api.ts +25 -25
- package/api/company-data-api.ts +90 -0
- package/api/funding-reconciliations-api.ts +96 -0
- package/api/funding-request-claim-remove-api.ts +773 -0
- package/api/plans-api.ts +26 -8
- package/api/premium-invoices-api.ts +88 -0
- package/api/user-api.ts +22 -13
- package/api.ts +5 -0
- package/docs/AdjudicationSummary.md +34 -0
- package/docs/AdvBillingApi.md +109 -0
- package/docs/AdvCareManagementApi.md +63 -0
- package/docs/AdvClaimApi.md +117 -4
- package/docs/AdvCommissionApi.md +56 -0
- package/docs/AdvEnrollmentApi.md +53 -0
- package/docs/AdvVBAGatewayApi.md +64 -0
- package/docs/AuthenticationApi.md +56 -0
- package/docs/CareCasesApi.md +347 -0
- package/docs/ClaimOffset.md +30 -0
- package/docs/ClaimOffsetApi.md +354 -0
- package/docs/ClaimOffsetDetail.md +36 -0
- package/docs/ClaimOffsetDetailApi.md +357 -0
- package/docs/ClaimOffsetDetailListVBAResponse.md +24 -0
- package/docs/ClaimOffsetDetailVBAResponse.md +24 -0
- package/docs/ClaimOffsetListVBAResponse.md +24 -0
- package/docs/ClaimOffsetVBAResponse.md +24 -0
- package/docs/ClaimsApi.md +5 -5
- package/docs/CompanyData.md +2 -0
- package/docs/CompanyDataApi.md +53 -0
- package/docs/FundingReconciliationsApi.md +56 -0
- package/docs/FundingRequestClaimRemove.md +38 -0
- package/docs/FundingRequestClaimRemoveApi.md +387 -0
- package/docs/FundingRequestClaimRemoveListVBAResponse.md +24 -0
- package/docs/FundingRequestClaimRemoveVBAResponse.md +24 -0
- package/docs/MemberBeneficiary.md +1 -1
- package/docs/Members.md +4 -0
- package/docs/PlansApi.md +7 -1
- package/docs/PremiumInvoicesApi.md +53 -0
- package/docs/ReportSeriesProcess.md +2 -0
- package/docs/ReportSeriesStep.md +16 -0
- package/docs/UserApi.md +5 -2
- package/docs/VBAClaimBatchCopy.md +60 -0
- package/docs/VBAClaimBatchCopyVBAResponse.md +24 -0
- package/docs/VBAClientSummary.md +48 -0
- package/docs/VBAClientSummaryVBAResponse.md +24 -0
- package/docs/VBAProcessPaymentFile.md +9 -9
- package/docs/VBAVBAGatewayProcessRequest.md +32 -0
- package/models/adjudication-summary.ts +72 -0
- package/models/claim-offset-detail-list-vbaresponse.ts +51 -0
- package/models/claim-offset-detail-vbaresponse.ts +51 -0
- package/models/claim-offset-detail.ts +78 -0
- package/models/claim-offset-list-vbaresponse.ts +51 -0
- package/models/claim-offset-vbaresponse.ts +51 -0
- package/models/claim-offset.ts +60 -0
- package/models/company-data.ts +6 -0
- package/models/funding-request-claim-remove-list-vbaresponse.ts +51 -0
- package/models/funding-request-claim-remove-vbaresponse.ts +51 -0
- package/models/funding-request-claim-remove.ts +84 -0
- package/models/index.ts +15 -0
- package/models/member-beneficiary.ts +1 -1
- package/models/members.ts +12 -0
- package/models/report-series-process.ts +6 -0
- package/models/report-series-step.ts +48 -0
- package/models/vbaclaim-batch-copy-vbaresponse.ts +51 -0
- package/models/vbaclaim-batch-copy.ts +150 -0
- package/models/vbaclient-summary-vbaresponse.ts +51 -0
- package/models/vbaclient-summary.ts +117 -0
- package/models/vbaprocess-payment-file.ts +9 -9
- package/models/vbavbagateway-process-request.ts +66 -0
- package/package.json +1 -1
|
@@ -0,0 +1,387 @@
|
|
|
1
|
+
# FundingRequestClaimRemoveApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createFundingRequestClaimRemove**](#createfundingrequestclaimremove) | **POST** /funding-requests/{requestKey}/claims-remove/{batchNumber}/{batchClaim} | Create FundingRequestClaimRemove|
|
|
8
|
+
|[**deleteFundingRequestClaimRemove**](#deletefundingrequestclaimremove) | **DELETE** /funding-requests/{requestKey}/claims-remove/{batchNumber}/{batchClaim} | Delete FundingRequestClaimRemove|
|
|
9
|
+
|[**getFundingRequestClaimRemove**](#getfundingrequestclaimremove) | **GET** /funding-requests/{requestKey}/claims-remove/{batchNumber}/{batchClaim} | Get FundingRequestClaimRemove|
|
|
10
|
+
|[**listFundingRequestClaimRemove**](#listfundingrequestclaimremove) | **GET** /funding-requests/{requestKey}/claims-remove | List FundingRequestClaimRemove|
|
|
11
|
+
|[**updateBatchFundingRequestClaimRemove**](#updatebatchfundingrequestclaimremove) | **PUT** /funding-requests/{requestKey}/claims-remove-batch | Create or Update Batch FundingRequestClaimRemove|
|
|
12
|
+
|[**updateFundingRequestClaimRemove**](#updatefundingrequestclaimremove) | **PUT** /funding-requests/{requestKey}/claims-remove/{batchNumber}/{batchClaim} | Update FundingRequestClaimRemove|
|
|
13
|
+
|
|
14
|
+
# **createFundingRequestClaimRemove**
|
|
15
|
+
> FundingRequestClaimRemoveVBAResponse createFundingRequestClaimRemove(fundingRequestClaimRemove)
|
|
16
|
+
|
|
17
|
+
Creates a new FundingRequestClaimRemove
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
FundingRequestClaimRemoveApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
FundingRequestClaimRemove
|
|
26
|
+
} from './api';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
30
|
+
|
|
31
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
32
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
33
|
+
let batchNumber: number; //Batch Number (default to undefined)
|
|
34
|
+
let batchClaim: number; //Batch Claim (default to undefined)
|
|
35
|
+
let fundingRequestClaimRemove: FundingRequestClaimRemove; //
|
|
36
|
+
|
|
37
|
+
const { status, data } = await apiInstance.createFundingRequestClaimRemove(
|
|
38
|
+
vbasoftwareDatabase,
|
|
39
|
+
requestKey,
|
|
40
|
+
batchNumber,
|
|
41
|
+
batchClaim,
|
|
42
|
+
fundingRequestClaimRemove
|
|
43
|
+
);
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
|Name | Type | Description | Notes|
|
|
49
|
+
|------------- | ------------- | ------------- | -------------|
|
|
50
|
+
| **fundingRequestClaimRemove** | **FundingRequestClaimRemove**| | |
|
|
51
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
52
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
53
|
+
| **batchNumber** | [**number**] | Batch Number | defaults to undefined|
|
|
54
|
+
| **batchClaim** | [**number**] | Batch Claim | defaults to undefined|
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
**FundingRequestClaimRemoveVBAResponse**
|
|
60
|
+
|
|
61
|
+
### Authorization
|
|
62
|
+
|
|
63
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
64
|
+
|
|
65
|
+
### HTTP request headers
|
|
66
|
+
|
|
67
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
68
|
+
- **Accept**: text/plain, application/json, text/json
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### HTTP response details
|
|
72
|
+
| Status code | Description | Response headers |
|
|
73
|
+
|-------------|-------------|------------------|
|
|
74
|
+
|**200** | Success | - |
|
|
75
|
+
|**401** | Unauthorized | - |
|
|
76
|
+
|
|
77
|
+
[[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)
|
|
78
|
+
|
|
79
|
+
# **deleteFundingRequestClaimRemove**
|
|
80
|
+
> deleteFundingRequestClaimRemove()
|
|
81
|
+
|
|
82
|
+
Deletes an FundingRequestClaimRemove
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import {
|
|
88
|
+
FundingRequestClaimRemoveApi,
|
|
89
|
+
Configuration
|
|
90
|
+
} from './api';
|
|
91
|
+
|
|
92
|
+
const configuration = new Configuration();
|
|
93
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
94
|
+
|
|
95
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
96
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
97
|
+
let batchNumber: number; //Batch Number (default to undefined)
|
|
98
|
+
let batchClaim: number; //Batch Claim (default to undefined)
|
|
99
|
+
|
|
100
|
+
const { status, data } = await apiInstance.deleteFundingRequestClaimRemove(
|
|
101
|
+
vbasoftwareDatabase,
|
|
102
|
+
requestKey,
|
|
103
|
+
batchNumber,
|
|
104
|
+
batchClaim
|
|
105
|
+
);
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
|Name | Type | Description | Notes|
|
|
111
|
+
|------------- | ------------- | ------------- | -------------|
|
|
112
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
113
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
114
|
+
| **batchNumber** | [**number**] | Batch Number | defaults to undefined|
|
|
115
|
+
| **batchClaim** | [**number**] | Batch Claim | defaults to undefined|
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
void (empty response body)
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: Not defined
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### HTTP response details
|
|
133
|
+
| Status code | Description | Response headers |
|
|
134
|
+
|-------------|-------------|------------------|
|
|
135
|
+
|**204** | Success | - |
|
|
136
|
+
|**401** | Unauthorized | - |
|
|
137
|
+
|
|
138
|
+
[[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)
|
|
139
|
+
|
|
140
|
+
# **getFundingRequestClaimRemove**
|
|
141
|
+
> FundingRequestClaimRemoveVBAResponse getFundingRequestClaimRemove()
|
|
142
|
+
|
|
143
|
+
Gets FundingRequestClaimRemove
|
|
144
|
+
|
|
145
|
+
### Example
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
import {
|
|
149
|
+
FundingRequestClaimRemoveApi,
|
|
150
|
+
Configuration
|
|
151
|
+
} from './api';
|
|
152
|
+
|
|
153
|
+
const configuration = new Configuration();
|
|
154
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
155
|
+
|
|
156
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
157
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
158
|
+
let batchNumber: number; //Batch Number (default to undefined)
|
|
159
|
+
let batchClaim: number; //Batch Claim (default to undefined)
|
|
160
|
+
|
|
161
|
+
const { status, data } = await apiInstance.getFundingRequestClaimRemove(
|
|
162
|
+
vbasoftwareDatabase,
|
|
163
|
+
requestKey,
|
|
164
|
+
batchNumber,
|
|
165
|
+
batchClaim
|
|
166
|
+
);
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Parameters
|
|
170
|
+
|
|
171
|
+
|Name | Type | Description | Notes|
|
|
172
|
+
|------------- | ------------- | ------------- | -------------|
|
|
173
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
174
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
175
|
+
| **batchNumber** | [**number**] | Batch Number | defaults to undefined|
|
|
176
|
+
| **batchClaim** | [**number**] | Batch Claim | defaults to undefined|
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
**FundingRequestClaimRemoveVBAResponse**
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: Not defined
|
|
190
|
+
- **Accept**: text/plain, application/json, text/json
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
### HTTP response details
|
|
194
|
+
| Status code | Description | Response headers |
|
|
195
|
+
|-------------|-------------|------------------|
|
|
196
|
+
|**200** | Success | - |
|
|
197
|
+
|**401** | Unauthorized | - |
|
|
198
|
+
|
|
199
|
+
[[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)
|
|
200
|
+
|
|
201
|
+
# **listFundingRequestClaimRemove**
|
|
202
|
+
> FundingRequestClaimRemoveListVBAResponse listFundingRequestClaimRemove()
|
|
203
|
+
|
|
204
|
+
Lists all FundingRequestClaimRemove for the given requestKey
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import {
|
|
210
|
+
FundingRequestClaimRemoveApi,
|
|
211
|
+
Configuration
|
|
212
|
+
} from './api';
|
|
213
|
+
|
|
214
|
+
const configuration = new Configuration();
|
|
215
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
216
|
+
|
|
217
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
218
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
219
|
+
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)
|
|
220
|
+
let page: number; //Page (optional) (default to 1)
|
|
221
|
+
let pageSize: number; //Page Size (optional) (default to 100)
|
|
222
|
+
|
|
223
|
+
const { status, data } = await apiInstance.listFundingRequestClaimRemove(
|
|
224
|
+
vbasoftwareDatabase,
|
|
225
|
+
requestKey,
|
|
226
|
+
sortBy,
|
|
227
|
+
page,
|
|
228
|
+
pageSize
|
|
229
|
+
);
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Parameters
|
|
233
|
+
|
|
234
|
+
|Name | Type | Description | Notes|
|
|
235
|
+
|------------- | ------------- | ------------- | -------------|
|
|
236
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
237
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
238
|
+
| **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|
|
|
239
|
+
| **page** | [**number**] | Page | (optional) defaults to 1|
|
|
240
|
+
| **pageSize** | [**number**] | Page Size | (optional) defaults to 100|
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
### Return type
|
|
244
|
+
|
|
245
|
+
**FundingRequestClaimRemoveListVBAResponse**
|
|
246
|
+
|
|
247
|
+
### Authorization
|
|
248
|
+
|
|
249
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
250
|
+
|
|
251
|
+
### HTTP request headers
|
|
252
|
+
|
|
253
|
+
- **Content-Type**: Not defined
|
|
254
|
+
- **Accept**: text/plain, application/json, text/json
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### HTTP response details
|
|
258
|
+
| Status code | Description | Response headers |
|
|
259
|
+
|-------------|-------------|------------------|
|
|
260
|
+
|**200** | Success | - |
|
|
261
|
+
|**401** | Unauthorized | - |
|
|
262
|
+
|
|
263
|
+
[[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)
|
|
264
|
+
|
|
265
|
+
# **updateBatchFundingRequestClaimRemove**
|
|
266
|
+
> MultiCodeResponseListVBAResponse updateBatchFundingRequestClaimRemove(fundingRequestClaimRemove)
|
|
267
|
+
|
|
268
|
+
Create or Update multiple FundingRequestClaimRemove at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
|
|
269
|
+
|
|
270
|
+
### Example
|
|
271
|
+
|
|
272
|
+
```typescript
|
|
273
|
+
import {
|
|
274
|
+
FundingRequestClaimRemoveApi,
|
|
275
|
+
Configuration
|
|
276
|
+
} from './api';
|
|
277
|
+
|
|
278
|
+
const configuration = new Configuration();
|
|
279
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
280
|
+
|
|
281
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
282
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
283
|
+
let fundingRequestClaimRemove: Array<FundingRequestClaimRemove>; //
|
|
284
|
+
|
|
285
|
+
const { status, data } = await apiInstance.updateBatchFundingRequestClaimRemove(
|
|
286
|
+
vbasoftwareDatabase,
|
|
287
|
+
requestKey,
|
|
288
|
+
fundingRequestClaimRemove
|
|
289
|
+
);
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
### Parameters
|
|
293
|
+
|
|
294
|
+
|Name | Type | Description | Notes|
|
|
295
|
+
|------------- | ------------- | ------------- | -------------|
|
|
296
|
+
| **fundingRequestClaimRemove** | **Array<FundingRequestClaimRemove>**| | |
|
|
297
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
298
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
### Return type
|
|
302
|
+
|
|
303
|
+
**MultiCodeResponseListVBAResponse**
|
|
304
|
+
|
|
305
|
+
### Authorization
|
|
306
|
+
|
|
307
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
308
|
+
|
|
309
|
+
### HTTP request headers
|
|
310
|
+
|
|
311
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
312
|
+
- **Accept**: text/plain, application/json, text/json
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### HTTP response details
|
|
316
|
+
| Status code | Description | Response headers |
|
|
317
|
+
|-------------|-------------|------------------|
|
|
318
|
+
|**207** | Success | - |
|
|
319
|
+
|**401** | Unauthorized | - |
|
|
320
|
+
|
|
321
|
+
[[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)
|
|
322
|
+
|
|
323
|
+
# **updateFundingRequestClaimRemove**
|
|
324
|
+
> FundingRequestClaimRemoveVBAResponse updateFundingRequestClaimRemove(fundingRequestClaimRemove)
|
|
325
|
+
|
|
326
|
+
Updates a specific FundingRequestClaimRemove.
|
|
327
|
+
|
|
328
|
+
### Example
|
|
329
|
+
|
|
330
|
+
```typescript
|
|
331
|
+
import {
|
|
332
|
+
FundingRequestClaimRemoveApi,
|
|
333
|
+
Configuration,
|
|
334
|
+
FundingRequestClaimRemove
|
|
335
|
+
} from './api';
|
|
336
|
+
|
|
337
|
+
const configuration = new Configuration();
|
|
338
|
+
const apiInstance = new FundingRequestClaimRemoveApi(configuration);
|
|
339
|
+
|
|
340
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
341
|
+
let requestKey: number; //Request Key (default to undefined)
|
|
342
|
+
let batchNumber: number; //Batch Number (default to undefined)
|
|
343
|
+
let batchClaim: number; //Batch Claim (default to undefined)
|
|
344
|
+
let fundingRequestClaimRemove: FundingRequestClaimRemove; //
|
|
345
|
+
|
|
346
|
+
const { status, data } = await apiInstance.updateFundingRequestClaimRemove(
|
|
347
|
+
vbasoftwareDatabase,
|
|
348
|
+
requestKey,
|
|
349
|
+
batchNumber,
|
|
350
|
+
batchClaim,
|
|
351
|
+
fundingRequestClaimRemove
|
|
352
|
+
);
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
|Name | Type | Description | Notes|
|
|
358
|
+
|------------- | ------------- | ------------- | -------------|
|
|
359
|
+
| **fundingRequestClaimRemove** | **FundingRequestClaimRemove**| | |
|
|
360
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
361
|
+
| **requestKey** | [**number**] | Request Key | defaults to undefined|
|
|
362
|
+
| **batchNumber** | [**number**] | Batch Number | defaults to undefined|
|
|
363
|
+
| **batchClaim** | [**number**] | Batch Claim | defaults to undefined|
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
**FundingRequestClaimRemoveVBAResponse**
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
377
|
+
- **Accept**: text/plain, application/json, text/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
### HTTP response details
|
|
381
|
+
| Status code | Description | Response headers |
|
|
382
|
+
|-------------|-------------|------------------|
|
|
383
|
+
|**200** | Success | - |
|
|
384
|
+
|**401** | Unauthorized | - |
|
|
385
|
+
|
|
386
|
+
[[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)
|
|
387
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FundingRequestClaimRemoveListVBAResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**Array<FundingRequestClaimRemove>**](FundingRequestClaimRemove.md) | | [optional] [default to undefined]
|
|
9
|
+
**error** | [**VBAProblemDetails**](VBAProblemDetails.md) | | [optional] [default to undefined]
|
|
10
|
+
**debug** | [**Debug**](Debug.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FundingRequestClaimRemoveListVBAResponse } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: FundingRequestClaimRemoveListVBAResponse = {
|
|
18
|
+
data,
|
|
19
|
+
error,
|
|
20
|
+
debug,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FundingRequestClaimRemoveVBAResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**FundingRequestClaimRemove**](FundingRequestClaimRemove.md) | | [optional] [default to undefined]
|
|
9
|
+
**error** | [**VBAProblemDetails**](VBAProblemDetails.md) | | [optional] [default to undefined]
|
|
10
|
+
**debug** | [**Debug**](Debug.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FundingRequestClaimRemoveVBAResponse } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: FundingRequestClaimRemoveVBAResponse = {
|
|
18
|
+
data,
|
|
19
|
+
error,
|
|
20
|
+
debug,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**subscriber_ID** | **string** | References Members.Subscriber_ID value on the parent record. | [default to undefined]
|
|
9
9
|
**member_Seq** | **string** | References Members.Member_Seq value on the parent record. | [default to undefined]
|
|
10
|
-
**beneficiary_ID** | **string** | Unique identifier for this beneficiary on this member. | [default to undefined]
|
|
10
|
+
**beneficiary_ID** | **string** | Unique identifier for this beneficiary on this member. | [optional] [default to undefined]
|
|
11
11
|
**address** | **string** | Primary address of the Beneficiary. | [optional] [default to undefined]
|
|
12
12
|
**address2** | **string** | Address line 2 of the Beneficiary\'s primary address. | [optional] [default to undefined]
|
|
13
13
|
**assignment** | **number** | A set amount paid to a beneficiary. | [optional] [default to undefined]
|
package/docs/Members.md
CHANGED
|
@@ -53,6 +53,8 @@ Name | Type | Description | Notes
|
|
|
53
53
|
**use_Member_Plan_Year** | **boolean** | Identifies the Member\'s Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member\'s Plan year will begin on the first day of enrollment. | [default to undefined]
|
|
54
54
|
**viP_Flag** | **string** | VIP status of the Member. This status can be used as a search filter but is otherwise informational only. | [optional] [default to undefined]
|
|
55
55
|
**weight** | **number** | The members weight in pounds. | [optional] [default to undefined]
|
|
56
|
+
**preferred_Pronoun** | **string** | | [optional] [default to undefined]
|
|
57
|
+
**initial_Premium** | **number** | | [optional] [default to undefined]
|
|
56
58
|
|
|
57
59
|
## Example
|
|
58
60
|
|
|
@@ -108,6 +110,8 @@ const instance: Members = {
|
|
|
108
110
|
use_Member_Plan_Year,
|
|
109
111
|
viP_Flag,
|
|
110
112
|
weight,
|
|
113
|
+
preferred_Pronoun,
|
|
114
|
+
initial_Premium,
|
|
111
115
|
};
|
|
112
116
|
```
|
|
113
117
|
|
package/docs/PlansApi.md
CHANGED
|
@@ -252,10 +252,14 @@ const apiInstance = new PlansApi(configuration);
|
|
|
252
252
|
|
|
253
253
|
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
254
254
|
let planType: string; //Plan Type (optional) (default to undefined)
|
|
255
|
+
let page: number; //Page (optional) (default to 1)
|
|
256
|
+
let pageSize: number; //Page Size (optional) (default to 2147483647)
|
|
255
257
|
|
|
256
258
|
const { status, data } = await apiInstance.listPlans(
|
|
257
259
|
vbasoftwareDatabase,
|
|
258
|
-
planType
|
|
260
|
+
planType,
|
|
261
|
+
page,
|
|
262
|
+
pageSize
|
|
259
263
|
);
|
|
260
264
|
```
|
|
261
265
|
|
|
@@ -265,6 +269,8 @@ const { status, data } = await apiInstance.listPlans(
|
|
|
265
269
|
|------------- | ------------- | ------------- | -------------|
|
|
266
270
|
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
267
271
|
| **planType** | [**string**] | Plan Type | (optional) defaults to undefined|
|
|
272
|
+
| **page** | [**number**] | Page | (optional) defaults to 1|
|
|
273
|
+
| **pageSize** | [**number**] | Page Size | (optional) defaults to 2147483647|
|
|
268
274
|
|
|
269
275
|
|
|
270
276
|
### Return type
|
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**billingPastDueProcessAutomation**](#billingpastdueprocessautomation) | **POST** /billing-past-due-process-automation | Check Past Due settings and trigger Process Automation|
|
|
7
8
|
|[**createPremInvoice**](#createpreminvoice) | **POST** /premium-invoices | Create PremInvoice|
|
|
8
9
|
|[**deletePremInvoice**](#deletepreminvoice) | **DELETE** /premium-invoices/{invoiceKey} | Delete PremInvoice|
|
|
9
10
|
|[**finalizeInvoice**](#finalizeinvoice) | **POST** /invoice-finalize/{invoiceKey} | Finalize Invoice|
|
|
@@ -36,6 +37,58 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
|
|
|
36
37
|
|[**updateBatchPremInvoice**](#updatebatchpreminvoice) | **PUT** /premium-invoices-batch | Create or Update Batch PremInvoice|
|
|
37
38
|
|[**updatePremInvoice**](#updatepreminvoice) | **PUT** /premium-invoices/{invoiceKey} | Update PremInvoice|
|
|
38
39
|
|
|
40
|
+
# **billingPastDueProcessAutomation**
|
|
41
|
+
> billingPastDueProcessAutomation()
|
|
42
|
+
|
|
43
|
+
Based on configured Past Due settings, interrogate Premium Billing invoices for past due invoices and fire configured process automation triggers.
|
|
44
|
+
|
|
45
|
+
### Example
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
import {
|
|
49
|
+
PremiumInvoicesApi,
|
|
50
|
+
Configuration
|
|
51
|
+
} from './api';
|
|
52
|
+
|
|
53
|
+
const configuration = new Configuration();
|
|
54
|
+
const apiInstance = new PremiumInvoicesApi(configuration);
|
|
55
|
+
|
|
56
|
+
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
57
|
+
|
|
58
|
+
const { status, data } = await apiInstance.billingPastDueProcessAutomation(
|
|
59
|
+
vbasoftwareDatabase
|
|
60
|
+
);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
|Name | Type | Description | Notes|
|
|
66
|
+
|------------- | ------------- | ------------- | -------------|
|
|
67
|
+
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
void (empty response body)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: Not defined
|
|
81
|
+
- **Accept**: Not defined
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
### HTTP response details
|
|
85
|
+
| Status code | Description | Response headers |
|
|
86
|
+
|-------------|-------------|------------------|
|
|
87
|
+
|**202** | Accepted for processing | - |
|
|
88
|
+
|**401** | Unauthorized | - |
|
|
89
|
+
|
|
90
|
+
[[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)
|
|
91
|
+
|
|
39
92
|
# **createPremInvoice**
|
|
40
93
|
> PremInvoiceVBAResponse createPremInvoice(premInvoice)
|
|
41
94
|
|
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**trigger_Option** | **string** | This flag enables an option used by Process Automation. | [optional] [default to undefined]
|
|
16
16
|
**update_Date** | **string** | Date the record was last updated in the system | [optional] [default to undefined]
|
|
17
17
|
**update_User** | **string** | User that last updated the record in the system | [optional] [default to undefined]
|
|
18
|
+
**vbAutomate_Trigger** | **boolean** | | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,6 +33,7 @@ const instance: ReportSeriesProcess = {
|
|
|
32
33
|
trigger_Option,
|
|
33
34
|
update_Date,
|
|
34
35
|
update_User,
|
|
36
|
+
vbAutomate_Trigger,
|
|
35
37
|
};
|
|
36
38
|
```
|
|
37
39
|
|
package/docs/ReportSeriesStep.md
CHANGED
|
@@ -77,6 +77,14 @@ Name | Type | Description | Notes
|
|
|
77
77
|
**fax_Number** | **string** | For FAX step type, this indicates the fax number to send the fax to. | [optional] [default to undefined]
|
|
78
78
|
**text_Number** | **string** | For TEXT step type, this indicates the phone number to send the text to. | [optional] [default to undefined]
|
|
79
79
|
**text_Message** | **string** | For TEXT step type, this indicates the message to send in the text. | [optional] [default to undefined]
|
|
80
|
+
**sftP_User** | **string** | | [optional] [default to undefined]
|
|
81
|
+
**sftP_Password** | **string** | | [optional] [default to undefined]
|
|
82
|
+
**sftP_Host** | **string** | | [optional] [default to undefined]
|
|
83
|
+
**sftP_Port** | **number** | | [optional] [default to undefined]
|
|
84
|
+
**sftP_Protocol** | **number** | | [optional] [default to undefined]
|
|
85
|
+
**sftP_Passive** | **boolean** | | [optional] [default to undefined]
|
|
86
|
+
**sftP_Path** | **string** | | [optional] [default to undefined]
|
|
87
|
+
**sftP_File_Name** | **string** | | [optional] [default to undefined]
|
|
80
88
|
|
|
81
89
|
## Example
|
|
82
90
|
|
|
@@ -156,6 +164,14 @@ const instance: ReportSeriesStep = {
|
|
|
156
164
|
fax_Number,
|
|
157
165
|
text_Number,
|
|
158
166
|
text_Message,
|
|
167
|
+
sftP_User,
|
|
168
|
+
sftP_Password,
|
|
169
|
+
sftP_Host,
|
|
170
|
+
sftP_Port,
|
|
171
|
+
sftP_Protocol,
|
|
172
|
+
sftP_Passive,
|
|
173
|
+
sftP_Path,
|
|
174
|
+
sftP_File_Name,
|
|
159
175
|
};
|
|
160
176
|
```
|
|
161
177
|
|
package/docs/UserApi.md
CHANGED
|
@@ -536,7 +536,7 @@ const { status, data } = await apiInstance.getUser(
|
|
|
536
536
|
# **listUsers**
|
|
537
537
|
> UsersListVBAResponse listUsers()
|
|
538
538
|
|
|
539
|
-
Lists all Users
|
|
539
|
+
Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
|
|
540
540
|
|
|
541
541
|
### Example
|
|
542
542
|
|
|
@@ -550,9 +550,11 @@ const configuration = new Configuration();
|
|
|
550
550
|
const apiInstance = new UserApi(configuration);
|
|
551
551
|
|
|
552
552
|
let vbasoftwareDatabase: string; //Target database (default to undefined)
|
|
553
|
+
let loginStatus: number; //Optional filter for login status (1=Logged In, 2=Logged Out, 3=Kicked) (optional) (default to undefined)
|
|
553
554
|
|
|
554
555
|
const { status, data } = await apiInstance.listUsers(
|
|
555
|
-
vbasoftwareDatabase
|
|
556
|
+
vbasoftwareDatabase,
|
|
557
|
+
loginStatus
|
|
556
558
|
);
|
|
557
559
|
```
|
|
558
560
|
|
|
@@ -561,6 +563,7 @@ const { status, data } = await apiInstance.listUsers(
|
|
|
561
563
|
|Name | Type | Description | Notes|
|
|
562
564
|
|------------- | ------------- | ------------- | -------------|
|
|
563
565
|
| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
|
|
566
|
+
| **loginStatus** | [**number**] | Optional filter for login status (1=Logged In, 2=Logged Out, 3=Kicked) | (optional) defaults to undefined|
|
|
564
567
|
|
|
565
568
|
|
|
566
569
|
### Return type
|