@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250620.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.
- package/.openapi-generator/FILES +2 -0
- package/.openapi-generator/VERSION +1 -1
- package/api/adv-benefits-api.ts +102 -0
- package/api/plan-benefits-api.ts +100 -0
- package/api/security-area-user-groups-api.ts +119 -13
- package/common.ts +4 -4
- package/docs/AdvBenefitsApi.md +57 -0
- package/docs/BillingRateModifyConfig.md +2 -2
- package/docs/ClaimBatchPayee.md +2 -0
- package/docs/ClaimPayee.md +2 -0
- package/docs/CriteriaDetail.md +10 -10
- package/docs/EmailReportDTO.md +1 -1
- package/docs/EnrollmentDisenroll.md +1 -1
- package/docs/EnrollmentDisenrollGroup.md +1 -1
- package/docs/FaxReportDTO.md +1 -1
- package/docs/IPWhitelist.md +1 -1
- package/docs/Members.md +1 -1
- package/docs/MessageThread.md +2 -2
- package/docs/Messages.md +7 -7
- package/docs/PlanBenefitCopy.md +54 -0
- package/docs/PlanBenefitsApi.md +57 -0
- package/docs/PremInvoiceApplyPayment.md +4 -4
- package/docs/ReinsContract.md +1 -1
- package/docs/SecurityAreaUserGroupsApi.md +61 -2
- package/docs/UserAuthenticationResponse.md +1 -1
- package/docs/UserChangeTempPasswordResponse.md +1 -1
- package/docs/VBAProblemDetails.md +4 -4
- package/docs/VBAProcessPaymentFile.md +1 -1
- package/docs/VBAUserStatus.md +1 -1
- package/models/billing-rate-modify-config.ts +2 -2
- package/models/claim-batch-payee.ts +6 -0
- package/models/claim-payee.ts +6 -0
- package/models/criteria-detail.ts +10 -10
- package/models/email-report-dto.ts +1 -1
- package/models/enrollment-disenroll-group.ts +1 -1
- package/models/enrollment-disenroll.ts +1 -1
- package/models/fax-report-dto.ts +1 -1
- package/models/index.ts +1 -0
- package/models/ipwhitelist.ts +1 -1
- package/models/members.ts +1 -1
- package/models/message-thread.ts +2 -2
- package/models/messages.ts +7 -7
- package/models/plan-benefit-copy.ts +132 -0
- package/models/prem-invoice-apply-payment.ts +4 -4
- package/models/reins-contract.ts +1 -1
- package/models/user-authentication-response.ts +1 -1
- package/models/user-change-temp-password-response.ts +1 -1
- package/models/vbaproblem-details.ts +4 -4
- package/models/vbaprocess-payment-file.ts +1 -1
- package/models/vbauser-status.ts +1 -1
- package/package.json +1 -1
package/models/fax-report-dto.ts
CHANGED
|
@@ -66,7 +66,7 @@ export interface FaxReportDTO {
|
|
|
66
66
|
*/
|
|
67
67
|
'filename'?: string | null;
|
|
68
68
|
/**
|
|
69
|
-
* A json object of report parameters
|
|
69
|
+
* A json object of report parameters Required if a report requires them.
|
|
70
70
|
* @type {{ [key: string]: string | null; }}
|
|
71
71
|
* @memberof FaxReportDTO
|
|
72
72
|
*/
|
package/models/index.ts
CHANGED
|
@@ -1742,6 +1742,7 @@ export * from './plan-benefit-cascade-vbaresponse';
|
|
|
1742
1742
|
export * from './plan-benefit-cluster';
|
|
1743
1743
|
export * from './plan-benefit-cluster-list-vbaresponse';
|
|
1744
1744
|
export * from './plan-benefit-cluster-vbaresponse';
|
|
1745
|
+
export * from './plan-benefit-copy';
|
|
1745
1746
|
export * from './plan-benefit-level';
|
|
1746
1747
|
export * from './plan-benefit-level-list-vbaresponse';
|
|
1747
1748
|
export * from './plan-benefit-level-vbaresponse';
|
package/models/ipwhitelist.ts
CHANGED
|
@@ -45,7 +45,7 @@ export interface IPWhitelist {
|
|
|
45
45
|
*/
|
|
46
46
|
'entry_User'?: string | null;
|
|
47
47
|
/**
|
|
48
|
-
* IP Address that will be whitelisted for accessing the APIs. This field supports both single IPv4 addresses and CIDR blocks for specifying IP ranges.
|
|
48
|
+
* 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., \"192.168.1.1\") to whitelist that single address. - **CIDR Block:** Provide a CIDR block (e.g., \"192.168.1.0/24\") 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.
|
|
49
49
|
* @type {string}
|
|
50
50
|
* @memberof IPWhitelist
|
|
51
51
|
*/
|
package/models/members.ts
CHANGED
|
@@ -27,7 +27,7 @@ export interface Members {
|
|
|
27
27
|
*/
|
|
28
28
|
'subscriber_ID': string;
|
|
29
29
|
/**
|
|
30
|
-
* Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
|
|
30
|
+
* 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.
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof Members
|
|
33
33
|
*/
|
package/models/message-thread.ts
CHANGED
|
@@ -33,13 +33,13 @@ export interface MessageThread {
|
|
|
33
33
|
*/
|
|
34
34
|
'thread_Create_Date'?: string | null;
|
|
35
35
|
/**
|
|
36
|
-
* Unique identifier (UUID) of the user who created the thread.
|
|
36
|
+
* Unique identifier (UUID) of the user who created the thread. If null, this is considered an admin-level action or system-generated.
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof MessageThread
|
|
39
39
|
*/
|
|
40
40
|
'thread_Create_UserId'?: string | null;
|
|
41
41
|
/**
|
|
42
|
-
* Current status of the thread, limited to 32 characters.
|
|
42
|
+
* Current status of the thread, limited to 32 characters. Possible values: \"CLOSED\" - Closed Thread \"NEW\" - New Thread \"NEWREC\" - Active Thread
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof MessageThread
|
|
45
45
|
*/
|
package/models/messages.ts
CHANGED
|
@@ -21,43 +21,43 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface Messages {
|
|
23
23
|
/**
|
|
24
|
-
* The unique identifier for the message.
|
|
24
|
+
* The unique identifier for the message. On creation, set this to 0 as it will be auto-generated by the system.
|
|
25
25
|
* @type {number}
|
|
26
26
|
* @memberof Messages
|
|
27
27
|
*/
|
|
28
28
|
'message_Key'?: number;
|
|
29
29
|
/**
|
|
30
|
-
* The unique identifier of the message thread this message belongs to.
|
|
30
|
+
* The unique identifier of the message thread this message belongs to. This value must be provided and should reference an existing message thread.
|
|
31
31
|
* @type {number}
|
|
32
32
|
* @memberof Messages
|
|
33
33
|
*/
|
|
34
34
|
'messageThread_Key': number;
|
|
35
35
|
/**
|
|
36
|
-
* The content or body of the message being created or updated.
|
|
36
|
+
* The content or body of the message being created or updated. This can be any text relevant to the message thread.
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof Messages
|
|
39
39
|
*/
|
|
40
40
|
'message_Body'?: string | null;
|
|
41
41
|
/**
|
|
42
|
-
* The date and time when the message was created.
|
|
42
|
+
* 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.
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof Messages
|
|
45
45
|
*/
|
|
46
46
|
'message_Create_Date'?: string | null;
|
|
47
47
|
/**
|
|
48
|
-
* The unique identifier (UUID) of the user who created the message.
|
|
48
|
+
* 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.
|
|
49
49
|
* @type {string}
|
|
50
50
|
* @memberof Messages
|
|
51
51
|
*/
|
|
52
52
|
'message_Create_UserId'?: string | null;
|
|
53
53
|
/**
|
|
54
|
-
* The status of the message, limited to 32 characters in length.
|
|
54
|
+
* The status of the message, limited to 32 characters in length. May represent states like \"READ\", \"UNREAD\".
|
|
55
55
|
* @type {string}
|
|
56
56
|
* @memberof Messages
|
|
57
57
|
*/
|
|
58
58
|
'message_Status'?: string | null;
|
|
59
59
|
/**
|
|
60
|
-
* The type of the message, limited to 32 characters.
|
|
60
|
+
* The type of the message, limited to 32 characters. May represent types \"HIGH\" or \"STANDARD\"
|
|
61
61
|
* @type {string}
|
|
62
62
|
* @memberof Messages
|
|
63
63
|
*/
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* VBASoftware
|
|
5
|
+
* APIs for VBASoftware
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface PlanBenefitCopy
|
|
21
|
+
*/
|
|
22
|
+
export interface PlanBenefitCopy {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof PlanBenefitCopy
|
|
27
|
+
*/
|
|
28
|
+
'sourcePlanID'?: string | null;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof PlanBenefitCopy
|
|
33
|
+
*/
|
|
34
|
+
'destinationPlanID'?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof PlanBenefitCopy
|
|
39
|
+
*/
|
|
40
|
+
'benefitCode'?: string | null;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @type {boolean}
|
|
44
|
+
* @memberof PlanBenefitCopy
|
|
45
|
+
*/
|
|
46
|
+
'copyPlaces'?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {boolean}
|
|
50
|
+
* @memberof PlanBenefitCopy
|
|
51
|
+
*/
|
|
52
|
+
'copySpecialties'?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {boolean}
|
|
56
|
+
* @memberof PlanBenefitCopy
|
|
57
|
+
*/
|
|
58
|
+
'copyProviderTypes'?: boolean;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof PlanBenefitCopy
|
|
63
|
+
*/
|
|
64
|
+
'copyPlaceExCodes'?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {boolean}
|
|
68
|
+
* @memberof PlanBenefitCopy
|
|
69
|
+
*/
|
|
70
|
+
'copyDiagnosisCodeExCodes'?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {boolean}
|
|
74
|
+
* @memberof PlanBenefitCopy
|
|
75
|
+
*/
|
|
76
|
+
'copyProcedureCodeExCodes'?: boolean;
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {boolean}
|
|
80
|
+
* @memberof PlanBenefitCopy
|
|
81
|
+
*/
|
|
82
|
+
'copyModifierExCodes'?: boolean;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {boolean}
|
|
86
|
+
* @memberof PlanBenefitCopy
|
|
87
|
+
*/
|
|
88
|
+
'copyBenefitLevels'?: boolean;
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @type {boolean}
|
|
92
|
+
* @memberof PlanBenefitCopy
|
|
93
|
+
*/
|
|
94
|
+
'copyBenefitMaximums'?: boolean;
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @type {boolean}
|
|
98
|
+
* @memberof PlanBenefitCopy
|
|
99
|
+
*/
|
|
100
|
+
'copyBenefitRates'?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {boolean}
|
|
104
|
+
* @memberof PlanBenefitCopy
|
|
105
|
+
*/
|
|
106
|
+
'copyPBMCopay'?: boolean;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {boolean}
|
|
110
|
+
* @memberof PlanBenefitCopy
|
|
111
|
+
*/
|
|
112
|
+
'copyPlaceDetails'?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @type {boolean}
|
|
116
|
+
* @memberof PlanBenefitCopy
|
|
117
|
+
*/
|
|
118
|
+
'copyDiagnonsisCodes'?: boolean;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @type {boolean}
|
|
122
|
+
* @memberof PlanBenefitCopy
|
|
123
|
+
*/
|
|
124
|
+
'copyProcedureCodes'?: boolean;
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @type {string}
|
|
128
|
+
* @memberof PlanBenefitCopy
|
|
129
|
+
*/
|
|
130
|
+
'userID'?: string | null;
|
|
131
|
+
}
|
|
132
|
+
|
|
@@ -30,19 +30,19 @@ export interface PremInvoiceApplyPayment {
|
|
|
30
30
|
*/
|
|
31
31
|
'invoice_Key': number;
|
|
32
32
|
/**
|
|
33
|
-
* Required for:
|
|
33
|
+
* Required for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentSubscriberPlanType ApplyPaymentSelfAdmin Not used for: ApplyPaymentHeaderAdjustment
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof PremInvoiceApplyPayment
|
|
36
36
|
*/
|
|
37
37
|
'subscriber_ID'?: string | null;
|
|
38
38
|
/**
|
|
39
|
-
* Required for:
|
|
39
|
+
* Required for: ApplyPaymentSubscriberPlanType Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentHeaderAdjustment
|
|
40
40
|
* @type {string}
|
|
41
41
|
* @memberof PremInvoiceApplyPayment
|
|
42
42
|
*/
|
|
43
43
|
'plan_Type'?: string | null;
|
|
44
44
|
/**
|
|
45
|
-
* Required for:
|
|
45
|
+
* Required for: ApplyPaymentSubscriberPayorID Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPlanType ApplyPaymentHeaderAdjustment
|
|
46
46
|
* @type {string}
|
|
47
47
|
* @memberof PremInvoiceApplyPayment
|
|
48
48
|
*/
|
|
@@ -54,7 +54,7 @@ export interface PremInvoiceApplyPayment {
|
|
|
54
54
|
*/
|
|
55
55
|
'premPayment_Key': number;
|
|
56
56
|
/**
|
|
57
|
-
* Required for:
|
|
57
|
+
* Required for: ApplyPaymentHeaderAdjustment Not used for: ApplyPaymentSubscriber ApplyPaymentSubscriberPayorID ApplyPaymentSubscriberPlanType
|
|
58
58
|
* @type {number}
|
|
59
59
|
* @memberof PremInvoiceApplyPayment
|
|
60
60
|
*/
|
package/models/reins-contract.ts
CHANGED
|
@@ -183,7 +183,7 @@ export interface ReinsContract {
|
|
|
183
183
|
*/
|
|
184
184
|
'policy_Number'?: string | null;
|
|
185
185
|
/**
|
|
186
|
-
* Notes if this is \"Spec. Advance Fund\" where all claims are included or \"Pay and Reimburse\" where only paid claims are included in the calculation.
|
|
186
|
+
* Notes if this is \"Spec. Advance Fund\" where all claims are included or \"Pay and Reimburse\" where only paid claims are included in the calculation. IMPORTANT: While you may enter any value here via API, Reports that use this data will will look for the value of \"S\" for \"Spec. Advance Fund\" or \"P\" for \"Pay and Reimburse\".
|
|
187
187
|
* @type {string}
|
|
188
188
|
* @memberof ReinsContract
|
|
189
189
|
*/
|
|
@@ -24,7 +24,7 @@ import type { AuthenticationResult } from './authentication-result';
|
|
|
24
24
|
*/
|
|
25
25
|
export interface UserAuthenticationResponse {
|
|
26
26
|
/**
|
|
27
|
-
* The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field\'s value.
|
|
27
|
+
* The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field\'s value. Valid values: NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof UserAuthenticationResponse
|
|
30
30
|
*/
|
|
@@ -24,7 +24,7 @@ import type { AuthenticationResult } from './authentication-result';
|
|
|
24
24
|
*/
|
|
25
25
|
export interface UserChangeTempPasswordResponse {
|
|
26
26
|
/**
|
|
27
|
-
* The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field\'s value.
|
|
27
|
+
* The name of the challenge. This field will be filled if the Authentication process requires additional steps. You may programatically build application logic based on this field\'s value. Valid values: NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof UserChangeTempPasswordResponse
|
|
30
30
|
*/
|
|
@@ -27,25 +27,25 @@ export interface VBAProblemDetails {
|
|
|
27
27
|
*/
|
|
28
28
|
'detail'?: string | null;
|
|
29
29
|
/**
|
|
30
|
-
* A URI reference that identifies the specific occurrence of the problem.It may
|
|
30
|
+
* A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced.
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof VBAProblemDetails
|
|
33
33
|
*/
|
|
34
34
|
'instance'?: string | null;
|
|
35
35
|
/**
|
|
36
|
-
* The HTTP status code([RFC7231], Section 6) generated by the origin server for
|
|
36
|
+
* The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
|
|
37
37
|
* @type {number}
|
|
38
38
|
* @memberof VBAProblemDetails
|
|
39
39
|
*/
|
|
40
40
|
'status'?: number;
|
|
41
41
|
/**
|
|
42
|
-
* A short, human-readable summary of the problem type.It SHOULD NOT change from
|
|
42
|
+
* A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4).
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof VBAProblemDetails
|
|
45
45
|
*/
|
|
46
46
|
'title'?: string | null;
|
|
47
47
|
/**
|
|
48
|
-
* A URI reference [RFC3986] that identifies the problem type. This specification
|
|
48
|
+
* A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be \"about:blank\".
|
|
49
49
|
* @type {string}
|
|
50
50
|
* @memberof VBAProblemDetails
|
|
51
51
|
*/
|
|
@@ -27,7 +27,7 @@ export interface VBAProcessPaymentFile {
|
|
|
27
27
|
*/
|
|
28
28
|
'payment_File_Format_Key'?: number;
|
|
29
29
|
/**
|
|
30
|
-
* A .csv file with headers and the following columns:
|
|
30
|
+
* A .csv file with headers and the following columns: - **Payment_Type**: Value from the PremPaymentType table (optional) - **Payment_Batch**: Source system batch indicator (optional) - **Payment_Batch_Seq**: Source system batch sequence (optional) - **Payment_Account**: Name of the paying account (required) - **Payment_ID**: Unique identifier for the payment (required) - **Payment_Date**: Date of payment in YYYY-MM-DD format (required) - **Payment_Amount**: Amount of the payment (required) - **Payment_Name**: Name of the payer (required) - **Group_ID**: Group identifier if applicable (optional) - **Division_ID**: Division identifier if applicable (optional) - **Subscriber_ID**: Subscriber identifier if applicable (optional) - **Payor_ID**: Payor ID for created payments (required) - **Account_Key**: Account key for created payments (required) - **Invoice_Key**: Invoice key to apply the payment to (optional) - **PremRate_Key**: Rate key to apply the payment to (optional) - **PremPayment_Key**: Existing payment key to apply the payment to (optional)
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof VBAProcessPaymentFile
|
|
33
33
|
*/
|
package/models/vbauser-status.ts
CHANGED
|
@@ -30,7 +30,7 @@ export interface VBAUserStatus {
|
|
|
30
30
|
*/
|
|
31
31
|
'reminders'?: Array<Event> | null;
|
|
32
32
|
/**
|
|
33
|
-
* Gets or sets the current login status of the user.
|
|
33
|
+
* Gets or sets the current login status of the user. 1: LoggedIn 2: LoggedOut 3: Kicked
|
|
34
34
|
* @type {number}
|
|
35
35
|
* @memberof VBAUserStatus
|
|
36
36
|
*/
|