@matech/thebigpos-sdk 2.16.13-rc.2 → 2.18.0-rc1
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/.husky/pre-commit +1 -1
- package/LICENSE +21 -21
- package/README.md +44 -44
- package/dist/index.d.ts +141 -156
- package/dist/index.js +60 -80
- package/dist/index.js.map +1 -1
- package/package.json +40 -40
- package/src/index.ts +200 -260
- package/tsconfig.json +27 -27
package/.husky/pre-commit
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
yarn build
|
|
1
|
+
yarn build
|
|
2
2
|
git add .
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2024 Mortgage Automation Technologies
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Mortgage Automation Technologies
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
# The BIG POS Typescript SDK
|
|
2
|
-
|
|
3
|
-
## Installation
|
|
4
|
-
Using npm:
|
|
5
|
-
|
|
6
|
-
```bash
|
|
7
|
-
$ npm install @matech/thebigpos-sdk
|
|
8
|
-
```
|
|
9
|
-
|
|
10
|
-
Using yarn:
|
|
11
|
-
|
|
12
|
-
```bash
|
|
13
|
-
$ yarn add @matech/thebigpos-sdk
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Quick Start
|
|
17
|
-
```js
|
|
18
|
-
import { Api } from "@matech/thebigpos-sdk";
|
|
19
|
-
|
|
20
|
-
const securityWorker = (data: any) => {
|
|
21
|
-
return { headers: data }
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
const setBearerSecurityWorker = (accessToken:string) => {
|
|
25
|
-
const data = {
|
|
26
|
-
Authorization: `Bearer ${accessToken}`
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
apiClient.setSecurityData(data);
|
|
30
|
-
};
|
|
31
|
-
|
|
32
|
-
const apiClient = new Api({
|
|
33
|
-
baseURL:
|
|
34
|
-
process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
|
|
35
|
-
securityWorker,
|
|
36
|
-
})
|
|
37
|
-
|
|
38
|
-
apiClient.api.getSiteConfiguration().then((response) => {
|
|
39
|
-
console.log(response.data);
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
____
|
|
44
|
-
© 2024 Mortgage Automation Technologies. All rights reserved
|
|
1
|
+
# The BIG POS Typescript SDK
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
Using npm:
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
$ npm install @matech/thebigpos-sdk
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Using yarn:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
$ yarn add @matech/thebigpos-sdk
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
```js
|
|
18
|
+
import { Api } from "@matech/thebigpos-sdk";
|
|
19
|
+
|
|
20
|
+
const securityWorker = (data: any) => {
|
|
21
|
+
return { headers: data }
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const setBearerSecurityWorker = (accessToken:string) => {
|
|
25
|
+
const data = {
|
|
26
|
+
Authorization: `Bearer ${accessToken}`
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
apiClient.setSecurityData(data);
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
const apiClient = new Api({
|
|
33
|
+
baseURL:
|
|
34
|
+
process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
|
|
35
|
+
securityWorker,
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
apiClient.api.getSiteConfiguration().then((response) => {
|
|
39
|
+
console.log(response.data);
|
|
40
|
+
});
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
____
|
|
44
|
+
© 2024 Mortgage Automation Technologies. All rights reserved
|
package/dist/index.d.ts
CHANGED
|
@@ -58,6 +58,19 @@ export interface Action {
|
|
|
58
58
|
applicationSettings?: any;
|
|
59
59
|
surveysToken?: string | null;
|
|
60
60
|
}
|
|
61
|
+
export interface AddFormToSiteConfigurationRequest {
|
|
62
|
+
slug?: string | null;
|
|
63
|
+
formType?: string | null;
|
|
64
|
+
userRole?: string | null;
|
|
65
|
+
borrowerType?: string | null;
|
|
66
|
+
showProgressBar: boolean;
|
|
67
|
+
showTile: boolean;
|
|
68
|
+
tileLocation?: string | null;
|
|
69
|
+
tileText?: string | null;
|
|
70
|
+
tileSubtitle?: string | null;
|
|
71
|
+
icon?: string | null;
|
|
72
|
+
entityTypes?: string[] | null;
|
|
73
|
+
}
|
|
61
74
|
export interface Address {
|
|
62
75
|
/** @format uuid */
|
|
63
76
|
id: string;
|
|
@@ -188,11 +201,11 @@ export interface ApplicationRowData {
|
|
|
188
201
|
subjectPropertyState?: string | null;
|
|
189
202
|
subjectPropertyZip?: string | null;
|
|
190
203
|
loanPurpose?: string | null;
|
|
191
|
-
buyerAgent?:
|
|
192
|
-
sellerAgent?:
|
|
193
|
-
settlementAgent?:
|
|
194
|
-
escrowAgent?:
|
|
195
|
-
titleInsuranceAgent?:
|
|
204
|
+
buyerAgent?: LoanContact | null;
|
|
205
|
+
sellerAgent?: LoanContact | null;
|
|
206
|
+
settlementAgent?: LoanContact | null;
|
|
207
|
+
escrowAgent?: LoanContact | null;
|
|
208
|
+
titleInsuranceAgent?: LoanContact | null;
|
|
196
209
|
}
|
|
197
210
|
export interface Attachment {
|
|
198
211
|
fileName: string;
|
|
@@ -455,16 +468,15 @@ export interface CreateInviteRequest {
|
|
|
455
468
|
lastName: string;
|
|
456
469
|
/** @format email */
|
|
457
470
|
emailAddress: string;
|
|
458
|
-
phoneNumber
|
|
459
|
-
/** @deprecated */
|
|
471
|
+
phoneNumber: string;
|
|
460
472
|
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
461
473
|
loanID: string;
|
|
462
474
|
route?: string | null;
|
|
463
475
|
/** @format uuid */
|
|
464
476
|
siteConfigurationID: string;
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
477
|
+
userRole?: string | null;
|
|
478
|
+
customData?: any;
|
|
479
|
+
sourceUrl?: string | null;
|
|
468
480
|
}
|
|
469
481
|
export interface CreateUserRelationRequest {
|
|
470
482
|
/**
|
|
@@ -767,6 +779,7 @@ export interface EnabledServices {
|
|
|
767
779
|
fullApp?: boolean | null;
|
|
768
780
|
mobileApp?: boolean | null;
|
|
769
781
|
ringCentral?: boolean | null;
|
|
782
|
+
pricingCalculator?: boolean | null;
|
|
770
783
|
rates?: boolean | null;
|
|
771
784
|
socialSurvey?: boolean | null;
|
|
772
785
|
borrowerTasks?: boolean | null;
|
|
@@ -798,13 +811,6 @@ export interface EnabledServices {
|
|
|
798
811
|
openHouseForm?: boolean | null;
|
|
799
812
|
listingOfferForm?: boolean | null;
|
|
800
813
|
listings?: boolean | null;
|
|
801
|
-
addCoBorrower?: boolean | null;
|
|
802
|
-
}
|
|
803
|
-
export interface EncompassContact {
|
|
804
|
-
name?: string | null;
|
|
805
|
-
email?: string | null;
|
|
806
|
-
phone?: string | null;
|
|
807
|
-
company?: string | null;
|
|
808
814
|
}
|
|
809
815
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
810
816
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
@@ -849,11 +855,11 @@ export interface ExtendedLoan {
|
|
|
849
855
|
status?: string | null;
|
|
850
856
|
loanOfficer?: LoanOfficer | null;
|
|
851
857
|
propertyAddress?: Address | null;
|
|
858
|
+
borrowerContact?: Contact | null;
|
|
859
|
+
coBorrowerContact?: Contact | null;
|
|
852
860
|
loanLogs: LoanLog[];
|
|
853
861
|
isLocked: boolean;
|
|
854
862
|
source?: string | null;
|
|
855
|
-
userLoans: UserLoan[];
|
|
856
|
-
contacts: LoanContact[];
|
|
857
863
|
buyerAgentContact?: Contact | null;
|
|
858
864
|
sellerAgentContact?: Contact | null;
|
|
859
865
|
escrowAgentContact?: Contact | null;
|
|
@@ -1078,7 +1084,6 @@ export interface GenerateDocumentRequest {
|
|
|
1078
1084
|
*/
|
|
1079
1085
|
siteConfigurationID: string;
|
|
1080
1086
|
preview: boolean;
|
|
1081
|
-
recipients: string[];
|
|
1082
1087
|
}
|
|
1083
1088
|
export interface GetApplications {
|
|
1084
1089
|
applications: ApplicationRowData[];
|
|
@@ -1124,6 +1129,34 @@ export interface GetForm {
|
|
|
1124
1129
|
/** @format uuid */
|
|
1125
1130
|
id: string;
|
|
1126
1131
|
}
|
|
1132
|
+
export interface GetPricingCalculationRequest {
|
|
1133
|
+
eppsUserName?: string | null;
|
|
1134
|
+
/** @format int32 */
|
|
1135
|
+
loanAmount: number;
|
|
1136
|
+
/** @format int32 */
|
|
1137
|
+
totalMortgageAmount: number;
|
|
1138
|
+
/** @format int32 */
|
|
1139
|
+
propertyValue: number;
|
|
1140
|
+
propertyType?: string | null;
|
|
1141
|
+
zipCode?: string | null;
|
|
1142
|
+
county?: string | null;
|
|
1143
|
+
city?: string | null;
|
|
1144
|
+
state?: string | null;
|
|
1145
|
+
/** @minLength 1 */
|
|
1146
|
+
loanPurpose: string;
|
|
1147
|
+
propertyOccupancy?: string | null;
|
|
1148
|
+
escrow?: string | null;
|
|
1149
|
+
escrowInsurance: boolean;
|
|
1150
|
+
escrowTaxes: boolean;
|
|
1151
|
+
loanTerm?: string | null;
|
|
1152
|
+
loanType?: string | null;
|
|
1153
|
+
creditScore?: string | null;
|
|
1154
|
+
/** @format uuid */
|
|
1155
|
+
siteConfigurationId: string;
|
|
1156
|
+
}
|
|
1157
|
+
export interface GetPricingForLoanOfficer {
|
|
1158
|
+
rates: PricingRates[];
|
|
1159
|
+
}
|
|
1127
1160
|
export interface GetReport {
|
|
1128
1161
|
loanRecords: LoanRecord[];
|
|
1129
1162
|
invalidFieldIDs: string[];
|
|
@@ -1180,8 +1213,6 @@ export interface ImportUserLoanTaskRequest {
|
|
|
1180
1213
|
userID: string;
|
|
1181
1214
|
}
|
|
1182
1215
|
export interface Invite {
|
|
1183
|
-
/** @format uuid */
|
|
1184
|
-
id: string;
|
|
1185
1216
|
firstName: string;
|
|
1186
1217
|
lastName: string;
|
|
1187
1218
|
emailAddress: string;
|
|
@@ -1194,13 +1225,10 @@ export interface Invite {
|
|
|
1194
1225
|
isExistingAccount: boolean;
|
|
1195
1226
|
completedLoanApplication: boolean;
|
|
1196
1227
|
userRole: string;
|
|
1197
|
-
loanRole
|
|
1228
|
+
loanRole: string;
|
|
1198
1229
|
customData: any;
|
|
1199
|
-
/** @format uuid */
|
|
1200
|
-
oneTimeToken: string;
|
|
1201
1230
|
/** @format date-time */
|
|
1202
1231
|
createdAt: string;
|
|
1203
|
-
invitedBy?: User | null;
|
|
1204
1232
|
}
|
|
1205
1233
|
/** Array of operations to perform */
|
|
1206
1234
|
export type JsonPatchDocument = Operation[];
|
|
@@ -1208,18 +1236,12 @@ export interface LOSIntegration {
|
|
|
1208
1236
|
instanceID: string;
|
|
1209
1237
|
}
|
|
1210
1238
|
export interface LOSSettings {
|
|
1211
|
-
|
|
1212
|
-
wholesaleLoanClosingDateFieldID: string;
|
|
1213
|
-
brokerLoanClosingDateFieldID: string;
|
|
1214
|
-
correspondentLoanClosingDateFieldID: string;
|
|
1239
|
+
loanClosingDateFieldID: string;
|
|
1215
1240
|
customEConsentBucketTitle?: string | null;
|
|
1216
1241
|
loanMilestoneNotificationsEnabled: boolean;
|
|
1217
1242
|
}
|
|
1218
1243
|
export interface LOSSettingsUpdateRequest {
|
|
1219
|
-
|
|
1220
|
-
wholesaleLoanClosingDateFieldID: string;
|
|
1221
|
-
brokerLoanClosingDateFieldID: string;
|
|
1222
|
-
correspondentLoanClosingDateFieldID: string;
|
|
1244
|
+
loanClosingDateFieldID: string;
|
|
1223
1245
|
customEConsentBucketTitle?: string | null;
|
|
1224
1246
|
loanMilestoneNotificationsEnabled: boolean;
|
|
1225
1247
|
}
|
|
@@ -1350,11 +1372,11 @@ export interface Loan {
|
|
|
1350
1372
|
status?: string | null;
|
|
1351
1373
|
loanOfficer?: LoanOfficer | null;
|
|
1352
1374
|
propertyAddress?: Address | null;
|
|
1375
|
+
borrowerContact?: Contact | null;
|
|
1376
|
+
coBorrowerContact?: Contact | null;
|
|
1353
1377
|
loanLogs: LoanLog[];
|
|
1354
1378
|
isLocked: boolean;
|
|
1355
1379
|
source?: string | null;
|
|
1356
|
-
userLoans: UserLoan[];
|
|
1357
|
-
contacts: LoanContact[];
|
|
1358
1380
|
}
|
|
1359
1381
|
export interface LoanComparison {
|
|
1360
1382
|
loanID: string;
|
|
@@ -1393,22 +1415,10 @@ export interface LoanComparisonScenario {
|
|
|
1393
1415
|
fundingFee?: string | null;
|
|
1394
1416
|
}
|
|
1395
1417
|
export interface LoanContact {
|
|
1396
|
-
/** @format date-time */
|
|
1397
|
-
createdAt: string;
|
|
1398
|
-
/** @format date-time */
|
|
1399
|
-
updatedAt?: string | null;
|
|
1400
|
-
/** @format date-time */
|
|
1401
|
-
deletedAt?: string | null;
|
|
1402
|
-
/** @format uuid */
|
|
1403
|
-
id: string;
|
|
1404
|
-
fullName?: string | null;
|
|
1405
|
-
firstName?: string | null;
|
|
1406
|
-
lastName?: string | null;
|
|
1407
1418
|
name?: string | null;
|
|
1408
1419
|
email?: string | null;
|
|
1409
1420
|
phone?: string | null;
|
|
1410
|
-
|
|
1411
|
-
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1421
|
+
company?: string | null;
|
|
1412
1422
|
}
|
|
1413
1423
|
export interface LoanDocument {
|
|
1414
1424
|
/** @format date-time */
|
|
@@ -1532,7 +1542,6 @@ export interface LoanRecord {
|
|
|
1532
1542
|
loanGuid: string;
|
|
1533
1543
|
loanFields: Record<string, string>;
|
|
1534
1544
|
}
|
|
1535
|
-
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1536
1545
|
export interface LoanSearchCriteria {
|
|
1537
1546
|
searchText?: string | null;
|
|
1538
1547
|
/** @format uuid */
|
|
@@ -1544,14 +1553,6 @@ export interface LoanSearchCriteria {
|
|
|
1544
1553
|
/** @format uuid */
|
|
1545
1554
|
siteConfigurationId?: string | null;
|
|
1546
1555
|
}
|
|
1547
|
-
export interface LoanUpdateRequest {
|
|
1548
|
-
/** @format email */
|
|
1549
|
-
borrowerEmail?: string | null;
|
|
1550
|
-
borrowerEConsent?: boolean | null;
|
|
1551
|
-
borrowerCreditAuth?: boolean | null;
|
|
1552
|
-
borrowerTCPAOptIn?: boolean | null;
|
|
1553
|
-
additionalFields?: Record<string, string>;
|
|
1554
|
-
}
|
|
1555
1556
|
export interface LoanUser {
|
|
1556
1557
|
/** @format uuid */
|
|
1557
1558
|
id: string;
|
|
@@ -1811,6 +1812,15 @@ export interface PreliminaryCondition {
|
|
|
1811
1812
|
rerequestedDate?: string | null;
|
|
1812
1813
|
rerequestedBy?: CommentUserInformation | null;
|
|
1813
1814
|
}
|
|
1815
|
+
export interface PricingRates {
|
|
1816
|
+
rate: string;
|
|
1817
|
+
loanProgram: string;
|
|
1818
|
+
apr: string;
|
|
1819
|
+
/** @format float */
|
|
1820
|
+
price: number;
|
|
1821
|
+
/** @format float */
|
|
1822
|
+
payment: number;
|
|
1823
|
+
}
|
|
1814
1824
|
export interface ProblemDetails {
|
|
1815
1825
|
type?: string | null;
|
|
1816
1826
|
title?: string | null;
|
|
@@ -1975,6 +1985,8 @@ export interface SendForgotPasswordRequest {
|
|
|
1975
1985
|
* @minLength 1
|
|
1976
1986
|
*/
|
|
1977
1987
|
email: string;
|
|
1988
|
+
/** @format uuid */
|
|
1989
|
+
siteConfigurationId?: string | null;
|
|
1978
1990
|
}
|
|
1979
1991
|
export interface SendNotificationForLoanRequest {
|
|
1980
1992
|
/** @minLength 1 */
|
|
@@ -2007,7 +2019,11 @@ export interface SiteConfiguration {
|
|
|
2007
2019
|
name: string;
|
|
2008
2020
|
introduction?: string | null;
|
|
2009
2021
|
introductionTitle?: string | null;
|
|
2010
|
-
/**
|
|
2022
|
+
/**
|
|
2023
|
+
* @format int64
|
|
2024
|
+
* @min 1000
|
|
2025
|
+
* @max 999999999999
|
|
2026
|
+
*/
|
|
2011
2027
|
nmlsid: number;
|
|
2012
2028
|
address?: string | null;
|
|
2013
2029
|
address2?: string | null;
|
|
@@ -2197,7 +2213,11 @@ export interface SiteConfigurationByUrl {
|
|
|
2197
2213
|
name: string;
|
|
2198
2214
|
introduction?: string | null;
|
|
2199
2215
|
introductionTitle?: string | null;
|
|
2200
|
-
/**
|
|
2216
|
+
/**
|
|
2217
|
+
* @format int64
|
|
2218
|
+
* @min 1000
|
|
2219
|
+
* @max 999999999999
|
|
2220
|
+
*/
|
|
2201
2221
|
nmlsid: number;
|
|
2202
2222
|
address?: string | null;
|
|
2203
2223
|
address2?: string | null;
|
|
@@ -2389,7 +2409,6 @@ export interface SiteConfigurationForm {
|
|
|
2389
2409
|
tileLocation: string;
|
|
2390
2410
|
icon: string;
|
|
2391
2411
|
entityTypes: string[];
|
|
2392
|
-
siteConfiguration: SiteConfigurationReduced;
|
|
2393
2412
|
}
|
|
2394
2413
|
export interface SiteConfigurationReduced {
|
|
2395
2414
|
/** @format uuid */
|
|
@@ -2888,7 +2907,6 @@ export interface UpdateMeRequest {
|
|
|
2888
2907
|
* @maxLength 255
|
|
2889
2908
|
*/
|
|
2890
2909
|
lastName: string;
|
|
2891
|
-
email: string;
|
|
2892
2910
|
title?: string | null;
|
|
2893
2911
|
forcePasswordReset: boolean;
|
|
2894
2912
|
mfaEnabled: boolean;
|
|
@@ -2909,7 +2927,6 @@ export interface UpdateUserRequest {
|
|
|
2909
2927
|
* @maxLength 255
|
|
2910
2928
|
*/
|
|
2911
2929
|
lastName: string;
|
|
2912
|
-
email: string;
|
|
2913
2930
|
title?: string | null;
|
|
2914
2931
|
/** @format uuid */
|
|
2915
2932
|
branchId?: string | null;
|
|
@@ -2950,19 +2967,7 @@ export interface UserBase {
|
|
|
2950
2967
|
email: string;
|
|
2951
2968
|
}
|
|
2952
2969
|
export interface UserLoan {
|
|
2953
|
-
/** @format date-time */
|
|
2954
|
-
createdAt: string;
|
|
2955
|
-
/** @format date-time */
|
|
2956
|
-
updatedAt?: string | null;
|
|
2957
|
-
/** @format date-time */
|
|
2958
|
-
deletedAt?: string | null;
|
|
2959
2970
|
loanID: string;
|
|
2960
|
-
user?: User | null;
|
|
2961
|
-
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
2962
|
-
/** @format int32 */
|
|
2963
|
-
borrowerPair?: number | null;
|
|
2964
|
-
/** @format int32 */
|
|
2965
|
-
borrowerPosition?: number | null;
|
|
2966
2971
|
customLoanData?: CustomLoanData | null;
|
|
2967
2972
|
}
|
|
2968
2973
|
export interface UserLoanTask {
|
|
@@ -3159,7 +3164,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
3159
3164
|
}
|
|
3160
3165
|
/**
|
|
3161
3166
|
* @title The Big POS API
|
|
3162
|
-
* @version v2.
|
|
3167
|
+
* @version v2.15.4
|
|
3163
3168
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
3164
3169
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
3165
3170
|
*/
|
|
@@ -3996,6 +4001,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3996
4001
|
* @secure
|
|
3997
4002
|
*/
|
|
3998
4003
|
restoreForm: (id: string, params?: RequestParams) => Promise<AxiosResponse<Form, any>>;
|
|
4004
|
+
/**
|
|
4005
|
+
* No description
|
|
4006
|
+
*
|
|
4007
|
+
* @tags Forms
|
|
4008
|
+
* @name AddFormToSiteConfiguration
|
|
4009
|
+
* @summary Add to Site Configuration
|
|
4010
|
+
* @request POST:/api/forms/{formId}/site-configurations/{siteConfigurationId}
|
|
4011
|
+
* @secure
|
|
4012
|
+
*/
|
|
4013
|
+
addFormToSiteConfiguration: (formId: string, siteConfigurationId: string, data: AddFormToSiteConfigurationRequest, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationForm, any>>;
|
|
4014
|
+
/**
|
|
4015
|
+
* No description
|
|
4016
|
+
*
|
|
4017
|
+
* @tags Forms
|
|
4018
|
+
* @name RemoveFormFromSiteConfiguration
|
|
4019
|
+
* @summary Remove from Site Configuration
|
|
4020
|
+
* @request DELETE:/api/forms/{formId}/site-configurations/{siteConfigurationId}
|
|
4021
|
+
* @secure
|
|
4022
|
+
*/
|
|
4023
|
+
removeFormFromSiteConfiguration: (formId: string, siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForms, any>>;
|
|
4024
|
+
/**
|
|
4025
|
+
* No description
|
|
4026
|
+
*
|
|
4027
|
+
* @tags Forms
|
|
4028
|
+
* @name GetSiteConfigurationsByForm
|
|
4029
|
+
* @summary Get Site Configurations by Form
|
|
4030
|
+
* @request GET:/api/forms/{formId}/site-configurations
|
|
4031
|
+
* @secure
|
|
4032
|
+
*/
|
|
4033
|
+
getSiteConfigurationsByForm: (formId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationReduced[], any>>;
|
|
3999
4034
|
/**
|
|
4000
4035
|
* No description
|
|
4001
4036
|
*
|
|
@@ -4680,26 +4715,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4680
4715
|
* @secure
|
|
4681
4716
|
*/
|
|
4682
4717
|
reassignLoanOfficer: (draftId: string, data: DraftLoanOfficerReassignRequest, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
|
|
4683
|
-
/**
|
|
4684
|
-
* No description
|
|
4685
|
-
*
|
|
4686
|
-
* @tags LoanInvites
|
|
4687
|
-
* @name GetLoanInvites
|
|
4688
|
-
* @summary Get Invites
|
|
4689
|
-
* @request GET:/api/loans/{loanId}/invites
|
|
4690
|
-
* @secure
|
|
4691
|
-
*/
|
|
4692
|
-
getLoanInvites: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Invite[], any>>;
|
|
4693
|
-
/**
|
|
4694
|
-
* No description
|
|
4695
|
-
*
|
|
4696
|
-
* @tags LoanInvites
|
|
4697
|
-
* @name InviteLoanContacts
|
|
4698
|
-
* @summary Invite Contacts
|
|
4699
|
-
* @request POST:/api/loans/{loanId}/invites
|
|
4700
|
-
* @secure
|
|
4701
|
-
*/
|
|
4702
|
-
inviteLoanContacts: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<Invite[], any>>;
|
|
4703
4718
|
/**
|
|
4704
4719
|
* No description
|
|
4705
4720
|
*
|
|
@@ -5080,6 +5095,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5080
5095
|
* @secure
|
|
5081
5096
|
*/
|
|
5082
5097
|
createLoanTaskVerification: (loanId: string, loanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any>>;
|
|
5098
|
+
/**
|
|
5099
|
+
* No description
|
|
5100
|
+
*
|
|
5101
|
+
* @tags LoanUsers
|
|
5102
|
+
* @name GetLoanUsers
|
|
5103
|
+
* @summary Get All
|
|
5104
|
+
* @request GET:/api/loans/{loanId}/users
|
|
5105
|
+
* @secure
|
|
5106
|
+
*/
|
|
5107
|
+
getLoanUsers: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanUser[], any>>;
|
|
5083
5108
|
/**
|
|
5084
5109
|
* No description
|
|
5085
5110
|
*
|
|
@@ -5361,6 +5386,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5361
5386
|
replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
|
|
5362
5387
|
applyToChildren?: boolean;
|
|
5363
5388
|
}, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any>>;
|
|
5389
|
+
/**
|
|
5390
|
+
* No description
|
|
5391
|
+
*
|
|
5392
|
+
* @tags Pricing
|
|
5393
|
+
* @name GetPricingCalculation
|
|
5394
|
+
* @summary Get Pricing Calculation
|
|
5395
|
+
* @request POST:/api/pricing/calculator
|
|
5396
|
+
* @secure
|
|
5397
|
+
*/
|
|
5398
|
+
getPricingCalculation: (data: GetPricingCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<GetPricingForLoanOfficer, any>>;
|
|
5364
5399
|
/**
|
|
5365
5400
|
* No description
|
|
5366
5401
|
*
|
|
@@ -5487,67 +5522,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5487
5522
|
* @request GET:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
|
|
5488
5523
|
* @secure
|
|
5489
5524
|
*/
|
|
5490
|
-
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<
|
|
5491
|
-
/**
|
|
5492
|
-
* No description
|
|
5493
|
-
*
|
|
5494
|
-
* @tags SiteConfigurations
|
|
5495
|
-
* @name CreateOrReplaceSamlMetadata
|
|
5496
|
-
* @summary Create or Replace Saml Metadata
|
|
5497
|
-
* @request POST:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
|
|
5498
|
-
* @secure
|
|
5499
|
-
*/
|
|
5500
|
-
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
5501
|
-
/**
|
|
5502
|
-
* No description
|
|
5503
|
-
*
|
|
5504
|
-
* @tags SiteConfigurationWorkflows
|
|
5505
|
-
* @name GetWorkflowSiteConfigurations
|
|
5506
|
-
* @summary List all site configurations assigned to a workflow
|
|
5507
|
-
* @request GET:/api/workflows/{workflowId}/site-configurations
|
|
5508
|
-
* @secure
|
|
5509
|
-
*/
|
|
5510
|
-
getWorkflowSiteConfigurations: (workflowId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationForm[], any>>;
|
|
5511
|
-
/**
|
|
5512
|
-
* No description
|
|
5513
|
-
*
|
|
5514
|
-
* @tags SiteConfigurationWorkflows
|
|
5515
|
-
* @name GetWorkflowSiteConfiguration
|
|
5516
|
-
* @summary Get the workflow-site configuration assignment by composite key
|
|
5517
|
-
* @request GET:/api/workflows/{workflowId}/site-configurations/{siteConfigurationId}
|
|
5518
|
-
* @secure
|
|
5519
|
-
*/
|
|
5520
|
-
getWorkflowSiteConfiguration: (workflowId: string, siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationForm, any>>;
|
|
5525
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
|
|
5521
5526
|
/**
|
|
5522
5527
|
* No description
|
|
5523
5528
|
*
|
|
5524
|
-
* @tags
|
|
5525
|
-
* @name
|
|
5526
|
-
* @summary
|
|
5527
|
-
* @request POST:/api/
|
|
5528
|
-
* @secure
|
|
5529
|
-
*/
|
|
5530
|
-
createWorkflowSiteConfiguration: (workflowId: string, siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationForm, any>>;
|
|
5531
|
-
/**
|
|
5532
|
-
* No description
|
|
5533
|
-
*
|
|
5534
|
-
* @tags SiteConfigurationWorkflows
|
|
5535
|
-
* @name DeleteWorkflowSiteConfiguration
|
|
5536
|
-
* @summary Remove a workflow from a site configuration
|
|
5537
|
-
* @request DELETE:/api/workflows/{workflowId}/site-configurations/{siteConfigurationId}
|
|
5529
|
+
* @tags SiteForms
|
|
5530
|
+
* @name GetFormBySiteConfigurationSlug
|
|
5531
|
+
* @summary Get By Site Configuration Slug
|
|
5532
|
+
* @request POST:/api/site-forms
|
|
5538
5533
|
* @secure
|
|
5539
5534
|
*/
|
|
5540
|
-
|
|
5535
|
+
getFormBySiteConfigurationSlug: (data: GetSiteFormRequest, params?: RequestParams) => Promise<AxiosResponse<GetForm, any>>;
|
|
5541
5536
|
/**
|
|
5542
5537
|
* No description
|
|
5543
5538
|
*
|
|
5544
5539
|
* @tags SiteForms
|
|
5545
|
-
* @name
|
|
5546
|
-
* @summary Get
|
|
5547
|
-
* @request
|
|
5540
|
+
* @name GetSiteForms
|
|
5541
|
+
* @summary Get All Site Forms
|
|
5542
|
+
* @request GET:/api/site-forms
|
|
5548
5543
|
* @secure
|
|
5549
5544
|
*/
|
|
5550
|
-
|
|
5545
|
+
getSiteForms: (params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationForm[], any>>;
|
|
5551
5546
|
/**
|
|
5552
5547
|
* No description
|
|
5553
5548
|
*
|
|
@@ -5725,16 +5720,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5725
5720
|
* @secure
|
|
5726
5721
|
*/
|
|
5727
5722
|
inviteUser: (data: CreateInviteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
5728
|
-
/**
|
|
5729
|
-
* No description
|
|
5730
|
-
*
|
|
5731
|
-
* @tags UserInvites
|
|
5732
|
-
* @name ResendInviteNotification
|
|
5733
|
-
* @summary Re-Send Notification
|
|
5734
|
-
* @request PUT:/api/users/invites/{id}/resend
|
|
5735
|
-
* @secure
|
|
5736
|
-
*/
|
|
5737
|
-
resendInviteNotification: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
5738
5723
|
/**
|
|
5739
5724
|
* No description
|
|
5740
5725
|
*
|