@matech/thebigpos-sdk 2.40.6-rc1 → 2.41.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 +2 -2
- package/LICENSE +21 -21
- package/README.md +73 -73
- package/dist/index.d.ts +87 -126
- package/dist/index.js +19 -7
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/index.ts +375 -552
- package/tsconfig.json +27 -27
package/src/index.ts
CHANGED
|
@@ -356,6 +356,8 @@ export type EncompassLogOperationType =
|
|
|
356
356
|
| "General"
|
|
357
357
|
| "FieldReader";
|
|
358
358
|
|
|
359
|
+
export type EncompassEnvironment = "Production" | "UAT";
|
|
360
|
+
|
|
359
361
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
360
362
|
|
|
361
363
|
export type CustomFieldEntityType = "Loan";
|
|
@@ -483,7 +485,7 @@ export interface AccountBilling {
|
|
|
483
485
|
}
|
|
484
486
|
|
|
485
487
|
export interface AccountBillingRequest {
|
|
486
|
-
billingType:
|
|
488
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
487
489
|
/**
|
|
488
490
|
* @format double
|
|
489
491
|
* @min 0
|
|
@@ -843,7 +845,14 @@ export interface AuditLogEntry {
|
|
|
843
845
|
/** @format uuid */
|
|
844
846
|
id: string;
|
|
845
847
|
entityType: string;
|
|
846
|
-
changeType:
|
|
848
|
+
changeType:
|
|
849
|
+
| "Created"
|
|
850
|
+
| "Modified"
|
|
851
|
+
| "SoftDeleted"
|
|
852
|
+
| "HardDeleted"
|
|
853
|
+
| "Restored"
|
|
854
|
+
| "Deactivated"
|
|
855
|
+
| "Reactivated";
|
|
847
856
|
/** @format uuid */
|
|
848
857
|
entityId: string;
|
|
849
858
|
performedBy?: AuditLogUser | null;
|
|
@@ -1157,7 +1166,7 @@ export interface CorporateSearchCriteria {
|
|
|
1157
1166
|
}
|
|
1158
1167
|
|
|
1159
1168
|
export interface CreateAccessScopeRequest {
|
|
1160
|
-
scopeType:
|
|
1169
|
+
scopeType: "User" | "Branch";
|
|
1161
1170
|
/** @format uuid */
|
|
1162
1171
|
userId?: string | null;
|
|
1163
1172
|
/** @format uuid */
|
|
@@ -1181,7 +1190,7 @@ export interface CreateAccountRequest {
|
|
|
1181
1190
|
*/
|
|
1182
1191
|
nlmsid: number;
|
|
1183
1192
|
settings: AccountSettingsRequest;
|
|
1184
|
-
environment:
|
|
1193
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1185
1194
|
losIntegration: LOSIntegration;
|
|
1186
1195
|
billingSettings: AccountBillingRequest;
|
|
1187
1196
|
}
|
|
@@ -1219,8 +1228,15 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
1219
1228
|
name: string;
|
|
1220
1229
|
defaultValue?: string | null;
|
|
1221
1230
|
regexPattern?: string | null;
|
|
1222
|
-
dataType:
|
|
1223
|
-
|
|
1231
|
+
dataType:
|
|
1232
|
+
| "String"
|
|
1233
|
+
| "Number"
|
|
1234
|
+
| "Decimal"
|
|
1235
|
+
| "Boolean"
|
|
1236
|
+
| "Date"
|
|
1237
|
+
| "SingleSelect"
|
|
1238
|
+
| "MultiSelect";
|
|
1239
|
+
entityType: "Loan";
|
|
1224
1240
|
options?: CustomFieldOptionRequest[] | null;
|
|
1225
1241
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
1226
1242
|
}
|
|
@@ -1242,7 +1258,20 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1242
1258
|
export interface CreateGroupMemberRequest {
|
|
1243
1259
|
/** @format uuid */
|
|
1244
1260
|
userId: string;
|
|
1245
|
-
loanRole:
|
|
1261
|
+
loanRole:
|
|
1262
|
+
| "Borrower"
|
|
1263
|
+
| "CoBorrower"
|
|
1264
|
+
| "NonBorrower"
|
|
1265
|
+
| "LoanOfficer"
|
|
1266
|
+
| "LoanProcessor"
|
|
1267
|
+
| "LoanOfficerAssistant"
|
|
1268
|
+
| "SupportingLoanOfficer"
|
|
1269
|
+
| "BuyerAgent"
|
|
1270
|
+
| "SellerAgent"
|
|
1271
|
+
| "TitleInsuranceAgent"
|
|
1272
|
+
| "EscrowAgent"
|
|
1273
|
+
| "SettlementAgent"
|
|
1274
|
+
| "Admin";
|
|
1246
1275
|
}
|
|
1247
1276
|
|
|
1248
1277
|
export interface CreateInviteRequest {
|
|
@@ -1254,7 +1283,7 @@ export interface CreateInviteRequest {
|
|
|
1254
1283
|
emailAddress: string;
|
|
1255
1284
|
phoneNumber?: string | null;
|
|
1256
1285
|
/** @deprecated */
|
|
1257
|
-
relationship:
|
|
1286
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1258
1287
|
loanID: string;
|
|
1259
1288
|
route?: string | null;
|
|
1260
1289
|
/** @format uuid */
|
|
@@ -1286,7 +1315,7 @@ export interface CreateLoanImportRequest {
|
|
|
1286
1315
|
* @minLength 1
|
|
1287
1316
|
*/
|
|
1288
1317
|
startDate: string;
|
|
1289
|
-
importMode:
|
|
1318
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1290
1319
|
}
|
|
1291
1320
|
|
|
1292
1321
|
export interface CreateSession {
|
|
@@ -1308,7 +1337,20 @@ export interface CreateUserDeviceRequest {
|
|
|
1308
1337
|
}
|
|
1309
1338
|
|
|
1310
1339
|
export interface CreateUserDraft {
|
|
1311
|
-
loanRole:
|
|
1340
|
+
loanRole:
|
|
1341
|
+
| "Borrower"
|
|
1342
|
+
| "CoBorrower"
|
|
1343
|
+
| "NonBorrower"
|
|
1344
|
+
| "LoanOfficer"
|
|
1345
|
+
| "LoanProcessor"
|
|
1346
|
+
| "LoanOfficerAssistant"
|
|
1347
|
+
| "SupportingLoanOfficer"
|
|
1348
|
+
| "BuyerAgent"
|
|
1349
|
+
| "SellerAgent"
|
|
1350
|
+
| "TitleInsuranceAgent"
|
|
1351
|
+
| "EscrowAgent"
|
|
1352
|
+
| "SettlementAgent"
|
|
1353
|
+
| "Admin";
|
|
1312
1354
|
}
|
|
1313
1355
|
|
|
1314
1356
|
export interface CreateUserGroupRequest {
|
|
@@ -1395,8 +1437,15 @@ export interface CustomFieldDefinition {
|
|
|
1395
1437
|
name: string;
|
|
1396
1438
|
defaultValue?: string | null;
|
|
1397
1439
|
regexPattern?: string | null;
|
|
1398
|
-
dataType:
|
|
1399
|
-
|
|
1440
|
+
dataType:
|
|
1441
|
+
| "String"
|
|
1442
|
+
| "Number"
|
|
1443
|
+
| "Decimal"
|
|
1444
|
+
| "Boolean"
|
|
1445
|
+
| "Date"
|
|
1446
|
+
| "SingleSelect"
|
|
1447
|
+
| "MultiSelect";
|
|
1448
|
+
entityType: "Loan";
|
|
1400
1449
|
options: CustomFieldOption[];
|
|
1401
1450
|
permissions: CustomFieldPermission[];
|
|
1402
1451
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1411,7 +1460,14 @@ export interface CustomFieldEntry {
|
|
|
1411
1460
|
displayOrder: number;
|
|
1412
1461
|
name: string;
|
|
1413
1462
|
value: string;
|
|
1414
|
-
dataType:
|
|
1463
|
+
dataType:
|
|
1464
|
+
| "String"
|
|
1465
|
+
| "Number"
|
|
1466
|
+
| "Decimal"
|
|
1467
|
+
| "Boolean"
|
|
1468
|
+
| "Date"
|
|
1469
|
+
| "SingleSelect"
|
|
1470
|
+
| "MultiSelect";
|
|
1415
1471
|
}
|
|
1416
1472
|
|
|
1417
1473
|
export interface CustomFieldOption {
|
|
@@ -1431,13 +1487,31 @@ export interface CustomFieldOptionRequest {
|
|
|
1431
1487
|
export interface CustomFieldPermission {
|
|
1432
1488
|
/** @format uuid */
|
|
1433
1489
|
id: string;
|
|
1434
|
-
role:
|
|
1435
|
-
|
|
1490
|
+
role:
|
|
1491
|
+
| "Borrower"
|
|
1492
|
+
| "LoanOfficer"
|
|
1493
|
+
| "Admin"
|
|
1494
|
+
| "SuperAdmin"
|
|
1495
|
+
| "Realtor"
|
|
1496
|
+
| "SettlementAgent"
|
|
1497
|
+
| "LoanProcessor"
|
|
1498
|
+
| "LoanOfficerAssistant"
|
|
1499
|
+
| "SystemAdmin";
|
|
1500
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1436
1501
|
}
|
|
1437
1502
|
|
|
1438
1503
|
export interface CustomFieldPermissionRequest {
|
|
1439
|
-
role:
|
|
1440
|
-
|
|
1504
|
+
role:
|
|
1505
|
+
| "Borrower"
|
|
1506
|
+
| "LoanOfficer"
|
|
1507
|
+
| "Admin"
|
|
1508
|
+
| "SuperAdmin"
|
|
1509
|
+
| "Realtor"
|
|
1510
|
+
| "SettlementAgent"
|
|
1511
|
+
| "LoanProcessor"
|
|
1512
|
+
| "LoanOfficerAssistant"
|
|
1513
|
+
| "SystemAdmin";
|
|
1514
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1441
1515
|
}
|
|
1442
1516
|
|
|
1443
1517
|
export interface CustomFieldValue {
|
|
@@ -1449,7 +1523,14 @@ export interface CustomFieldValue {
|
|
|
1449
1523
|
customFieldDefinitionID: string;
|
|
1450
1524
|
value: string;
|
|
1451
1525
|
definitionName: string;
|
|
1452
|
-
dataType:
|
|
1526
|
+
dataType:
|
|
1527
|
+
| "String"
|
|
1528
|
+
| "Number"
|
|
1529
|
+
| "Decimal"
|
|
1530
|
+
| "Boolean"
|
|
1531
|
+
| "Date"
|
|
1532
|
+
| "SingleSelect"
|
|
1533
|
+
| "MultiSelect";
|
|
1453
1534
|
}
|
|
1454
1535
|
|
|
1455
1536
|
export interface DetailedUser {
|
|
@@ -1709,7 +1790,7 @@ export interface Draft {
|
|
|
1709
1790
|
siteConfiguration: SiteConfigurationReduced;
|
|
1710
1791
|
/** @format uuid */
|
|
1711
1792
|
loanID?: string | null;
|
|
1712
|
-
type:
|
|
1793
|
+
type: "NewLoan" | "EditLoan";
|
|
1713
1794
|
isCoBorrower: boolean;
|
|
1714
1795
|
}
|
|
1715
1796
|
|
|
@@ -1728,7 +1809,7 @@ export interface DraftContent {
|
|
|
1728
1809
|
siteConfiguration: SiteConfigurationReduced;
|
|
1729
1810
|
/** @format uuid */
|
|
1730
1811
|
loanID?: string | null;
|
|
1731
|
-
type:
|
|
1812
|
+
type: "NewLoan" | "EditLoan";
|
|
1732
1813
|
isCoBorrower: boolean;
|
|
1733
1814
|
applicationPayload: any;
|
|
1734
1815
|
}
|
|
@@ -1817,8 +1898,11 @@ export interface EncompassCredentialsDetail {
|
|
|
1817
1898
|
loanTemplate?: string | null;
|
|
1818
1899
|
defaultLoanOfficerUserName?: string | null;
|
|
1819
1900
|
clearStateIfUnlicensed: boolean;
|
|
1901
|
+
/** @deprecated */
|
|
1820
1902
|
baseUrl?: string | null;
|
|
1821
|
-
|
|
1903
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1904
|
+
consumerConnectWidgetHost?: string | null;
|
|
1905
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1822
1906
|
subscriptionId?: string | null;
|
|
1823
1907
|
environment?: string | null;
|
|
1824
1908
|
}
|
|
@@ -1833,8 +1917,11 @@ export interface EncompassCredentialsRequest {
|
|
|
1833
1917
|
loanTemplate?: string | null;
|
|
1834
1918
|
defaultLoanOfficerUserName?: string | null;
|
|
1835
1919
|
clearStateIfUnlicensed: boolean;
|
|
1920
|
+
/** @deprecated */
|
|
1836
1921
|
baseUrl?: string | null;
|
|
1837
|
-
|
|
1922
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1923
|
+
consumerConnectWidgetHost?: string | null;
|
|
1924
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1838
1925
|
subscriptionId?: string | null;
|
|
1839
1926
|
environment?: string | null;
|
|
1840
1927
|
clientID?: string | null;
|
|
@@ -1873,6 +1960,10 @@ export interface EncompassFieldListItem {
|
|
|
1873
1960
|
inUse: boolean;
|
|
1874
1961
|
}
|
|
1875
1962
|
|
|
1963
|
+
export interface EncompassIntegrationSettings {
|
|
1964
|
+
consumerConnectWidgetHost?: string | null;
|
|
1965
|
+
}
|
|
1966
|
+
|
|
1876
1967
|
export interface EncompassLogSearchCriteria {
|
|
1877
1968
|
searchText?: string | null;
|
|
1878
1969
|
operationTypes?: EncompassLogOperationType[] | null;
|
|
@@ -1951,8 +2042,15 @@ export interface EncompassRequestLog {
|
|
|
1951
2042
|
losId?: string | null;
|
|
1952
2043
|
/** @format uuid */
|
|
1953
2044
|
accountId: string;
|
|
1954
|
-
operationType:
|
|
1955
|
-
|
|
2045
|
+
operationType:
|
|
2046
|
+
| "FieldUpdate"
|
|
2047
|
+
| "ConsentUpdate"
|
|
2048
|
+
| "DocumentSync"
|
|
2049
|
+
| "MilestoneUpdate"
|
|
2050
|
+
| "DocumentAttachment"
|
|
2051
|
+
| "General"
|
|
2052
|
+
| "FieldReader";
|
|
2053
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1956
2054
|
message: string;
|
|
1957
2055
|
endpoint?: string | null;
|
|
1958
2056
|
httpMethod?: string | null;
|
|
@@ -2184,7 +2282,20 @@ export interface FusionFieldDisplay {
|
|
|
2184
2282
|
}
|
|
2185
2283
|
|
|
2186
2284
|
export interface FusionReportFilter {
|
|
2187
|
-
filterType:
|
|
2285
|
+
filterType:
|
|
2286
|
+
| "DateGreaterThanOrEqualTo"
|
|
2287
|
+
| "DateGreaterThan"
|
|
2288
|
+
| "DateLessThan"
|
|
2289
|
+
| "DateLessThanOrEqualTo"
|
|
2290
|
+
| "DateEquals"
|
|
2291
|
+
| "DateDoesntEqual"
|
|
2292
|
+
| "DateNonEmpty"
|
|
2293
|
+
| "DateEmpty"
|
|
2294
|
+
| "StringContains"
|
|
2295
|
+
| "StringEquals"
|
|
2296
|
+
| "StringNotEmpty"
|
|
2297
|
+
| "StringNotEquals"
|
|
2298
|
+
| "StringNotContains";
|
|
2188
2299
|
targetField: string;
|
|
2189
2300
|
targetValue: string;
|
|
2190
2301
|
}
|
|
@@ -2312,7 +2423,40 @@ export interface GuidPatchOperation {
|
|
|
2312
2423
|
}
|
|
2313
2424
|
|
|
2314
2425
|
export interface IPAddress {
|
|
2315
|
-
addressFamily:
|
|
2426
|
+
addressFamily:
|
|
2427
|
+
| "Unspecified"
|
|
2428
|
+
| "Unix"
|
|
2429
|
+
| "InterNetwork"
|
|
2430
|
+
| "ImpLink"
|
|
2431
|
+
| "Pup"
|
|
2432
|
+
| "Chaos"
|
|
2433
|
+
| "NS"
|
|
2434
|
+
| "Ipx"
|
|
2435
|
+
| "Iso"
|
|
2436
|
+
| "Osi"
|
|
2437
|
+
| "Ecma"
|
|
2438
|
+
| "DataKit"
|
|
2439
|
+
| "Ccitt"
|
|
2440
|
+
| "Sna"
|
|
2441
|
+
| "DecNet"
|
|
2442
|
+
| "DataLink"
|
|
2443
|
+
| "Lat"
|
|
2444
|
+
| "HyperChannel"
|
|
2445
|
+
| "AppleTalk"
|
|
2446
|
+
| "NetBios"
|
|
2447
|
+
| "VoiceView"
|
|
2448
|
+
| "FireFox"
|
|
2449
|
+
| "Banyan"
|
|
2450
|
+
| "Atm"
|
|
2451
|
+
| "InterNetworkV6"
|
|
2452
|
+
| "Cluster"
|
|
2453
|
+
| "Ieee12844"
|
|
2454
|
+
| "Irda"
|
|
2455
|
+
| "NetworkDesigners"
|
|
2456
|
+
| "Max"
|
|
2457
|
+
| "Packet"
|
|
2458
|
+
| "ControllerAreaNetwork"
|
|
2459
|
+
| "Unknown";
|
|
2316
2460
|
/** @format int64 */
|
|
2317
2461
|
scopeId: number;
|
|
2318
2462
|
isIPv6Multicast: boolean;
|
|
@@ -2372,6 +2516,10 @@ export interface ImportUserLoanTaskRequest {
|
|
|
2372
2516
|
userID: string;
|
|
2373
2517
|
}
|
|
2374
2518
|
|
|
2519
|
+
export interface IntegrationSettings {
|
|
2520
|
+
encompass?: EncompassIntegrationSettings | null;
|
|
2521
|
+
}
|
|
2522
|
+
|
|
2375
2523
|
export interface Invite {
|
|
2376
2524
|
/** @format uuid */
|
|
2377
2525
|
id: string;
|
|
@@ -2580,7 +2728,7 @@ export interface Loan {
|
|
|
2580
2728
|
userLoans: UserLoan[];
|
|
2581
2729
|
contacts: LoanContact[];
|
|
2582
2730
|
customFields: CustomFieldEntry[];
|
|
2583
|
-
signingMethod:
|
|
2731
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
2584
2732
|
}
|
|
2585
2733
|
|
|
2586
2734
|
export interface LoanApplication {
|
|
@@ -2639,7 +2787,7 @@ export interface LoanBorrower {
|
|
|
2639
2787
|
citizenship?: LoanCitizenship | null;
|
|
2640
2788
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2641
2789
|
languagePreference?: LoanLanguagePreference | null;
|
|
2642
|
-
applicationStatus:
|
|
2790
|
+
applicationStatus: "Draft" | "Complete";
|
|
2643
2791
|
/** @format int32 */
|
|
2644
2792
|
numberOfDependents?: number | null;
|
|
2645
2793
|
isPrimaryBorrower: boolean;
|
|
@@ -3565,7 +3713,20 @@ export interface LoanContact {
|
|
|
3565
3713
|
email?: string | null;
|
|
3566
3714
|
phone?: string | null;
|
|
3567
3715
|
companyName?: string | null;
|
|
3568
|
-
role:
|
|
3716
|
+
role:
|
|
3717
|
+
| "Borrower"
|
|
3718
|
+
| "CoBorrower"
|
|
3719
|
+
| "NonBorrower"
|
|
3720
|
+
| "LoanOfficer"
|
|
3721
|
+
| "LoanProcessor"
|
|
3722
|
+
| "LoanOfficerAssistant"
|
|
3723
|
+
| "SupportingLoanOfficer"
|
|
3724
|
+
| "BuyerAgent"
|
|
3725
|
+
| "SellerAgent"
|
|
3726
|
+
| "TitleInsuranceAgent"
|
|
3727
|
+
| "EscrowAgent"
|
|
3728
|
+
| "SettlementAgent"
|
|
3729
|
+
| "Admin";
|
|
3569
3730
|
}
|
|
3570
3731
|
|
|
3571
3732
|
export interface LoanContactList {
|
|
@@ -3619,13 +3780,39 @@ export interface LoanDocumentFolderPermission {
|
|
|
3619
3780
|
id: string;
|
|
3620
3781
|
/** @format uuid */
|
|
3621
3782
|
loanDocumentFolderID: string;
|
|
3622
|
-
role:
|
|
3623
|
-
|
|
3783
|
+
role:
|
|
3784
|
+
| "Borrower"
|
|
3785
|
+
| "CoBorrower"
|
|
3786
|
+
| "NonBorrower"
|
|
3787
|
+
| "LoanOfficer"
|
|
3788
|
+
| "LoanProcessor"
|
|
3789
|
+
| "LoanOfficerAssistant"
|
|
3790
|
+
| "SupportingLoanOfficer"
|
|
3791
|
+
| "BuyerAgent"
|
|
3792
|
+
| "SellerAgent"
|
|
3793
|
+
| "TitleInsuranceAgent"
|
|
3794
|
+
| "EscrowAgent"
|
|
3795
|
+
| "SettlementAgent"
|
|
3796
|
+
| "Admin";
|
|
3797
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3624
3798
|
}
|
|
3625
3799
|
|
|
3626
3800
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3627
|
-
role:
|
|
3628
|
-
|
|
3801
|
+
role:
|
|
3802
|
+
| "Borrower"
|
|
3803
|
+
| "CoBorrower"
|
|
3804
|
+
| "NonBorrower"
|
|
3805
|
+
| "LoanOfficer"
|
|
3806
|
+
| "LoanProcessor"
|
|
3807
|
+
| "LoanOfficerAssistant"
|
|
3808
|
+
| "SupportingLoanOfficer"
|
|
3809
|
+
| "BuyerAgent"
|
|
3810
|
+
| "SellerAgent"
|
|
3811
|
+
| "TitleInsuranceAgent"
|
|
3812
|
+
| "EscrowAgent"
|
|
3813
|
+
| "SettlementAgent"
|
|
3814
|
+
| "Admin";
|
|
3815
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3629
3816
|
}
|
|
3630
3817
|
|
|
3631
3818
|
export interface LoanDocumentFolderUsage {
|
|
@@ -3743,14 +3930,19 @@ export interface LoanImport {
|
|
|
3743
3930
|
/** @format int32 */
|
|
3744
3931
|
importedCount: number;
|
|
3745
3932
|
statusMessage?: string | null;
|
|
3746
|
-
status:
|
|
3747
|
-
|
|
3933
|
+
status:
|
|
3934
|
+
| "WaitingProcess"
|
|
3935
|
+
| "InProgress"
|
|
3936
|
+
| "Completed"
|
|
3937
|
+
| "Failed"
|
|
3938
|
+
| "Cancelled";
|
|
3939
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3748
3940
|
/** @format date-time */
|
|
3749
3941
|
createdAt?: string | null;
|
|
3750
3942
|
}
|
|
3751
3943
|
|
|
3752
3944
|
export interface LoanImportLog {
|
|
3753
|
-
level:
|
|
3945
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3754
3946
|
message: string;
|
|
3755
3947
|
/** @format date-time */
|
|
3756
3948
|
createdAt: string;
|
|
@@ -3811,8 +4003,24 @@ export interface LoanListPaginated {
|
|
|
3811
4003
|
export interface LoanLog {
|
|
3812
4004
|
/** @format uuid */
|
|
3813
4005
|
id: string;
|
|
3814
|
-
level:
|
|
3815
|
-
type:
|
|
4006
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
4007
|
+
type:
|
|
4008
|
+
| "Loan"
|
|
4009
|
+
| "Queue"
|
|
4010
|
+
| "POSFlagChanged"
|
|
4011
|
+
| "Verification"
|
|
4012
|
+
| "DocumentUploaded"
|
|
4013
|
+
| "LoanCreated"
|
|
4014
|
+
| "WorkflowSubmitted"
|
|
4015
|
+
| "UserInvitationSent"
|
|
4016
|
+
| "CoBorrowerAdded"
|
|
4017
|
+
| "TaskCompleted"
|
|
4018
|
+
| "LoanStatusChanged"
|
|
4019
|
+
| "Consent"
|
|
4020
|
+
| "SensitiveDataPurge"
|
|
4021
|
+
| "ClosingDateUpdated"
|
|
4022
|
+
| "ConsumerConnectAssociation"
|
|
4023
|
+
| "TaskReminderSent";
|
|
3816
4024
|
message: string;
|
|
3817
4025
|
/** @format date-time */
|
|
3818
4026
|
createdAt: string;
|
|
@@ -3821,8 +4029,24 @@ export interface LoanLog {
|
|
|
3821
4029
|
export interface LoanLogDetail {
|
|
3822
4030
|
/** @format uuid */
|
|
3823
4031
|
id: string;
|
|
3824
|
-
level:
|
|
3825
|
-
type:
|
|
4032
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
4033
|
+
type:
|
|
4034
|
+
| "Loan"
|
|
4035
|
+
| "Queue"
|
|
4036
|
+
| "POSFlagChanged"
|
|
4037
|
+
| "Verification"
|
|
4038
|
+
| "DocumentUploaded"
|
|
4039
|
+
| "LoanCreated"
|
|
4040
|
+
| "WorkflowSubmitted"
|
|
4041
|
+
| "UserInvitationSent"
|
|
4042
|
+
| "CoBorrowerAdded"
|
|
4043
|
+
| "TaskCompleted"
|
|
4044
|
+
| "LoanStatusChanged"
|
|
4045
|
+
| "Consent"
|
|
4046
|
+
| "SensitiveDataPurge"
|
|
4047
|
+
| "ClosingDateUpdated"
|
|
4048
|
+
| "ConsumerConnectAssociation"
|
|
4049
|
+
| "TaskReminderSent";
|
|
3826
4050
|
message: string;
|
|
3827
4051
|
/** @format date-time */
|
|
3828
4052
|
createdAt: string;
|
|
@@ -4115,7 +4339,7 @@ export interface LoanTaskSearchRequest {
|
|
|
4115
4339
|
}
|
|
4116
4340
|
|
|
4117
4341
|
export interface LoanTaskStatusSummary {
|
|
4118
|
-
status:
|
|
4342
|
+
status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
4119
4343
|
/** @format int32 */
|
|
4120
4344
|
count: number;
|
|
4121
4345
|
}
|
|
@@ -4128,7 +4352,20 @@ export interface LoanUser {
|
|
|
4128
4352
|
email: string;
|
|
4129
4353
|
phone?: string | null;
|
|
4130
4354
|
role: string;
|
|
4131
|
-
loanRole:
|
|
4355
|
+
loanRole:
|
|
4356
|
+
| "Borrower"
|
|
4357
|
+
| "CoBorrower"
|
|
4358
|
+
| "NonBorrower"
|
|
4359
|
+
| "LoanOfficer"
|
|
4360
|
+
| "LoanProcessor"
|
|
4361
|
+
| "LoanOfficerAssistant"
|
|
4362
|
+
| "SupportingLoanOfficer"
|
|
4363
|
+
| "BuyerAgent"
|
|
4364
|
+
| "SellerAgent"
|
|
4365
|
+
| "TitleInsuranceAgent"
|
|
4366
|
+
| "EscrowAgent"
|
|
4367
|
+
| "SettlementAgent"
|
|
4368
|
+
| "Admin";
|
|
4132
4369
|
isUser: boolean;
|
|
4133
4370
|
/** @format date-time */
|
|
4134
4371
|
createdAt: string;
|
|
@@ -4164,7 +4401,13 @@ export interface LosOperationTracking {
|
|
|
4164
4401
|
operationType: string;
|
|
4165
4402
|
correlationKey: string;
|
|
4166
4403
|
lastTriggerSource?: string | null;
|
|
4167
|
-
status:
|
|
4404
|
+
status:
|
|
4405
|
+
| "Pending"
|
|
4406
|
+
| "Success"
|
|
4407
|
+
| "Failed"
|
|
4408
|
+
| "ConfigurationError"
|
|
4409
|
+
| "PermanentFailure"
|
|
4410
|
+
| "Locked";
|
|
4168
4411
|
/** @format date-time */
|
|
4169
4412
|
createdAt: string;
|
|
4170
4413
|
/** @format date-time */
|
|
@@ -4231,7 +4474,7 @@ export interface LosSyncStep {
|
|
|
4231
4474
|
/** @format int32 */
|
|
4232
4475
|
order: number;
|
|
4233
4476
|
name: string;
|
|
4234
|
-
severity:
|
|
4477
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
4235
4478
|
message: string;
|
|
4236
4479
|
/** @format date-time */
|
|
4237
4480
|
atUtc: string;
|
|
@@ -4564,7 +4807,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4564
4807
|
|
|
4565
4808
|
export interface Operation {
|
|
4566
4809
|
op?: string;
|
|
4567
|
-
value?:
|
|
4810
|
+
value?: string | number | boolean | null | object;
|
|
4568
4811
|
path?: string;
|
|
4569
4812
|
}
|
|
4570
4813
|
|
|
@@ -4920,7 +5163,7 @@ export interface SSOTokenRequest {
|
|
|
4920
5163
|
}
|
|
4921
5164
|
|
|
4922
5165
|
export interface SamlMetadataRequest {
|
|
4923
|
-
ssoIntegration:
|
|
5166
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
4924
5167
|
}
|
|
4925
5168
|
|
|
4926
5169
|
export interface SendForgotPasswordRequest {
|
|
@@ -4978,7 +5221,7 @@ export interface SiteConfiguration {
|
|
|
4978
5221
|
deletedAt?: string | null;
|
|
4979
5222
|
/** @format uuid */
|
|
4980
5223
|
id: string;
|
|
4981
|
-
type:
|
|
5224
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4982
5225
|
/** @format uuid */
|
|
4983
5226
|
entityID: string;
|
|
4984
5227
|
/** @format int32 */
|
|
@@ -5173,7 +5416,7 @@ export interface SiteConfigurationByUrl {
|
|
|
5173
5416
|
deletedAt?: string | null;
|
|
5174
5417
|
/** @format uuid */
|
|
5175
5418
|
id: string;
|
|
5176
|
-
type:
|
|
5419
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5177
5420
|
/** @format uuid */
|
|
5178
5421
|
entityID: string;
|
|
5179
5422
|
/** @format int32 */
|
|
@@ -5386,7 +5629,7 @@ export interface SiteConfigurationForm {
|
|
|
5386
5629
|
export interface SiteConfigurationReduced {
|
|
5387
5630
|
/** @format uuid */
|
|
5388
5631
|
id: string;
|
|
5389
|
-
type:
|
|
5632
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5390
5633
|
url?: string | null;
|
|
5391
5634
|
name: string;
|
|
5392
5635
|
/** @format int64 */
|
|
@@ -5404,7 +5647,7 @@ export interface SiteConfigurationRequest {
|
|
|
5404
5647
|
entityID: string;
|
|
5405
5648
|
/** @format int32 */
|
|
5406
5649
|
entityType: number;
|
|
5407
|
-
type:
|
|
5650
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5408
5651
|
url: string;
|
|
5409
5652
|
name: string;
|
|
5410
5653
|
introduction?: string | null;
|
|
@@ -5581,7 +5824,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5581
5824
|
export interface SiteConfigurationSummary {
|
|
5582
5825
|
/** @format uuid */
|
|
5583
5826
|
id: string;
|
|
5584
|
-
type:
|
|
5827
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5585
5828
|
url?: string | null;
|
|
5586
5829
|
name: string;
|
|
5587
5830
|
/** @format int64 */
|
|
@@ -6249,7 +6492,20 @@ export interface UserDevice {
|
|
|
6249
6492
|
export interface UserDraft {
|
|
6250
6493
|
/** @format uuid */
|
|
6251
6494
|
draftID: string;
|
|
6252
|
-
role:
|
|
6495
|
+
role:
|
|
6496
|
+
| "Borrower"
|
|
6497
|
+
| "CoBorrower"
|
|
6498
|
+
| "NonBorrower"
|
|
6499
|
+
| "LoanOfficer"
|
|
6500
|
+
| "LoanProcessor"
|
|
6501
|
+
| "LoanOfficerAssistant"
|
|
6502
|
+
| "SupportingLoanOfficer"
|
|
6503
|
+
| "BuyerAgent"
|
|
6504
|
+
| "SellerAgent"
|
|
6505
|
+
| "TitleInsuranceAgent"
|
|
6506
|
+
| "EscrowAgent"
|
|
6507
|
+
| "SettlementAgent"
|
|
6508
|
+
| "Admin";
|
|
6253
6509
|
user: User;
|
|
6254
6510
|
}
|
|
6255
6511
|
|
|
@@ -6276,7 +6532,7 @@ export interface UserGroupAccessScope {
|
|
|
6276
6532
|
id: string;
|
|
6277
6533
|
/** @format uuid */
|
|
6278
6534
|
groupId: string;
|
|
6279
|
-
scopeType:
|
|
6535
|
+
scopeType: "User" | "Branch";
|
|
6280
6536
|
/** @format uuid */
|
|
6281
6537
|
userId?: string | null;
|
|
6282
6538
|
/** @format uuid */
|
|
@@ -6312,7 +6568,20 @@ export interface UserLoan {
|
|
|
6312
6568
|
deletedAt?: string | null;
|
|
6313
6569
|
loanID: string;
|
|
6314
6570
|
user: User;
|
|
6315
|
-
role:
|
|
6571
|
+
role:
|
|
6572
|
+
| "Borrower"
|
|
6573
|
+
| "CoBorrower"
|
|
6574
|
+
| "NonBorrower"
|
|
6575
|
+
| "LoanOfficer"
|
|
6576
|
+
| "LoanProcessor"
|
|
6577
|
+
| "LoanOfficerAssistant"
|
|
6578
|
+
| "SupportingLoanOfficer"
|
|
6579
|
+
| "BuyerAgent"
|
|
6580
|
+
| "SellerAgent"
|
|
6581
|
+
| "TitleInsuranceAgent"
|
|
6582
|
+
| "EscrowAgent"
|
|
6583
|
+
| "SettlementAgent"
|
|
6584
|
+
| "Admin";
|
|
6316
6585
|
/** @format int32 */
|
|
6317
6586
|
borrowerPair?: number | null;
|
|
6318
6587
|
/** @format int32 */
|
|
@@ -6325,11 +6594,11 @@ export interface UserLoanConsent {
|
|
|
6325
6594
|
id: string;
|
|
6326
6595
|
/** @format uuid */
|
|
6327
6596
|
userLoanID: string;
|
|
6328
|
-
type:
|
|
6597
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6329
6598
|
providedConsent: boolean;
|
|
6330
6599
|
source?: ConsentSource | null;
|
|
6331
6600
|
ipAddress?: string | null;
|
|
6332
|
-
losSyncStatus:
|
|
6601
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
6333
6602
|
/** @format date-time */
|
|
6334
6603
|
createdAt: string;
|
|
6335
6604
|
/** @format date-time */
|
|
@@ -6484,7 +6753,16 @@ export interface UserSummary {
|
|
|
6484
6753
|
id: string;
|
|
6485
6754
|
name?: string | null;
|
|
6486
6755
|
email?: string | null;
|
|
6487
|
-
role:
|
|
6756
|
+
role:
|
|
6757
|
+
| "Borrower"
|
|
6758
|
+
| "LoanOfficer"
|
|
6759
|
+
| "Admin"
|
|
6760
|
+
| "SuperAdmin"
|
|
6761
|
+
| "Realtor"
|
|
6762
|
+
| "SettlementAgent"
|
|
6763
|
+
| "LoanProcessor"
|
|
6764
|
+
| "LoanOfficerAssistant"
|
|
6765
|
+
| "SystemAdmin";
|
|
6488
6766
|
}
|
|
6489
6767
|
|
|
6490
6768
|
export interface VerifyPasswordRequest {
|
|
@@ -6520,490 +6798,6 @@ export interface Workflow {
|
|
|
6520
6798
|
icon: string;
|
|
6521
6799
|
}
|
|
6522
6800
|
|
|
6523
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6524
|
-
|
|
6525
|
-
export type AuditLogEntryChangeTypeEnum =
|
|
6526
|
-
| "Created"
|
|
6527
|
-
| "Modified"
|
|
6528
|
-
| "SoftDeleted"
|
|
6529
|
-
| "HardDeleted"
|
|
6530
|
-
| "Restored"
|
|
6531
|
-
| "Deactivated"
|
|
6532
|
-
| "Reactivated";
|
|
6533
|
-
|
|
6534
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
6535
|
-
|
|
6536
|
-
export type CreateAccountRequestEnvironmentEnum =
|
|
6537
|
-
| "Development"
|
|
6538
|
-
| "Staging"
|
|
6539
|
-
| "UAT"
|
|
6540
|
-
| "Production";
|
|
6541
|
-
|
|
6542
|
-
export type CreateCustomFieldDefinitionRequestDataTypeEnum =
|
|
6543
|
-
| "String"
|
|
6544
|
-
| "Number"
|
|
6545
|
-
| "Decimal"
|
|
6546
|
-
| "Boolean"
|
|
6547
|
-
| "Date"
|
|
6548
|
-
| "SingleSelect"
|
|
6549
|
-
| "MultiSelect";
|
|
6550
|
-
|
|
6551
|
-
export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
|
|
6552
|
-
|
|
6553
|
-
export type CreateGroupMemberRequestLoanRoleEnum =
|
|
6554
|
-
| "Borrower"
|
|
6555
|
-
| "CoBorrower"
|
|
6556
|
-
| "NonBorrower"
|
|
6557
|
-
| "LoanOfficer"
|
|
6558
|
-
| "LoanProcessor"
|
|
6559
|
-
| "LoanOfficerAssistant"
|
|
6560
|
-
| "SupportingLoanOfficer"
|
|
6561
|
-
| "BuyerAgent"
|
|
6562
|
-
| "SellerAgent"
|
|
6563
|
-
| "TitleInsuranceAgent"
|
|
6564
|
-
| "EscrowAgent"
|
|
6565
|
-
| "SettlementAgent"
|
|
6566
|
-
| "Admin";
|
|
6567
|
-
|
|
6568
|
-
/** @deprecated */
|
|
6569
|
-
export type CreateInviteRequestRelationshipEnum =
|
|
6570
|
-
| "NotApplicable"
|
|
6571
|
-
| "Spouse"
|
|
6572
|
-
| "NonSpouse";
|
|
6573
|
-
|
|
6574
|
-
export type CreateLoanImportRequestImportModeEnum =
|
|
6575
|
-
| "All"
|
|
6576
|
-
| "NewOnly"
|
|
6577
|
-
| "UpdateOnly";
|
|
6578
|
-
|
|
6579
|
-
export type CreateUserDraftLoanRoleEnum =
|
|
6580
|
-
| "Borrower"
|
|
6581
|
-
| "CoBorrower"
|
|
6582
|
-
| "NonBorrower"
|
|
6583
|
-
| "LoanOfficer"
|
|
6584
|
-
| "LoanProcessor"
|
|
6585
|
-
| "LoanOfficerAssistant"
|
|
6586
|
-
| "SupportingLoanOfficer"
|
|
6587
|
-
| "BuyerAgent"
|
|
6588
|
-
| "SellerAgent"
|
|
6589
|
-
| "TitleInsuranceAgent"
|
|
6590
|
-
| "EscrowAgent"
|
|
6591
|
-
| "SettlementAgent"
|
|
6592
|
-
| "Admin";
|
|
6593
|
-
|
|
6594
|
-
export type CustomFieldDefinitionDataTypeEnum =
|
|
6595
|
-
| "String"
|
|
6596
|
-
| "Number"
|
|
6597
|
-
| "Decimal"
|
|
6598
|
-
| "Boolean"
|
|
6599
|
-
| "Date"
|
|
6600
|
-
| "SingleSelect"
|
|
6601
|
-
| "MultiSelect";
|
|
6602
|
-
|
|
6603
|
-
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
6604
|
-
|
|
6605
|
-
export type CustomFieldEntryDataTypeEnum =
|
|
6606
|
-
| "String"
|
|
6607
|
-
| "Number"
|
|
6608
|
-
| "Decimal"
|
|
6609
|
-
| "Boolean"
|
|
6610
|
-
| "Date"
|
|
6611
|
-
| "SingleSelect"
|
|
6612
|
-
| "MultiSelect";
|
|
6613
|
-
|
|
6614
|
-
export type CustomFieldPermissionRoleEnum =
|
|
6615
|
-
| "Borrower"
|
|
6616
|
-
| "LoanOfficer"
|
|
6617
|
-
| "Admin"
|
|
6618
|
-
| "SuperAdmin"
|
|
6619
|
-
| "Realtor"
|
|
6620
|
-
| "SettlementAgent"
|
|
6621
|
-
| "LoanProcessor"
|
|
6622
|
-
| "LoanOfficerAssistant"
|
|
6623
|
-
| "SystemAdmin";
|
|
6624
|
-
|
|
6625
|
-
export type CustomFieldPermissionAccessLevelEnum =
|
|
6626
|
-
| "NoAccess"
|
|
6627
|
-
| "ReadOnly"
|
|
6628
|
-
| "ReadWrite";
|
|
6629
|
-
|
|
6630
|
-
export type CustomFieldPermissionRequestRoleEnum =
|
|
6631
|
-
| "Borrower"
|
|
6632
|
-
| "LoanOfficer"
|
|
6633
|
-
| "Admin"
|
|
6634
|
-
| "SuperAdmin"
|
|
6635
|
-
| "Realtor"
|
|
6636
|
-
| "SettlementAgent"
|
|
6637
|
-
| "LoanProcessor"
|
|
6638
|
-
| "LoanOfficerAssistant"
|
|
6639
|
-
| "SystemAdmin";
|
|
6640
|
-
|
|
6641
|
-
export type CustomFieldPermissionRequestAccessLevelEnum =
|
|
6642
|
-
| "NoAccess"
|
|
6643
|
-
| "ReadOnly"
|
|
6644
|
-
| "ReadWrite";
|
|
6645
|
-
|
|
6646
|
-
export type CustomFieldValueDataTypeEnum =
|
|
6647
|
-
| "String"
|
|
6648
|
-
| "Number"
|
|
6649
|
-
| "Decimal"
|
|
6650
|
-
| "Boolean"
|
|
6651
|
-
| "Date"
|
|
6652
|
-
| "SingleSelect"
|
|
6653
|
-
| "MultiSelect";
|
|
6654
|
-
|
|
6655
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6656
|
-
|
|
6657
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6658
|
-
|
|
6659
|
-
export type EncompassCredentialsDetailSigningMethodEnum =
|
|
6660
|
-
| "ConsumerConnect"
|
|
6661
|
-
| "POSF";
|
|
6662
|
-
|
|
6663
|
-
export type EncompassCredentialsRequestSigningMethodEnum =
|
|
6664
|
-
| "ConsumerConnect"
|
|
6665
|
-
| "POSF";
|
|
6666
|
-
|
|
6667
|
-
export type EncompassRequestLogOperationTypeEnum =
|
|
6668
|
-
| "FieldUpdate"
|
|
6669
|
-
| "ConsentUpdate"
|
|
6670
|
-
| "DocumentSync"
|
|
6671
|
-
| "MilestoneUpdate"
|
|
6672
|
-
| "DocumentAttachment"
|
|
6673
|
-
| "General"
|
|
6674
|
-
| "FieldReader";
|
|
6675
|
-
|
|
6676
|
-
export type EncompassRequestLogOutcomeEnum =
|
|
6677
|
-
| "Success"
|
|
6678
|
-
| "Failure"
|
|
6679
|
-
| "PartialSuccess";
|
|
6680
|
-
|
|
6681
|
-
export type FusionReportFilterFilterTypeEnum =
|
|
6682
|
-
| "DateGreaterThanOrEqualTo"
|
|
6683
|
-
| "DateGreaterThan"
|
|
6684
|
-
| "DateLessThan"
|
|
6685
|
-
| "DateLessThanOrEqualTo"
|
|
6686
|
-
| "DateEquals"
|
|
6687
|
-
| "DateDoesntEqual"
|
|
6688
|
-
| "DateNonEmpty"
|
|
6689
|
-
| "DateEmpty"
|
|
6690
|
-
| "StringContains"
|
|
6691
|
-
| "StringEquals"
|
|
6692
|
-
| "StringNotEmpty"
|
|
6693
|
-
| "StringNotEquals"
|
|
6694
|
-
| "StringNotContains";
|
|
6695
|
-
|
|
6696
|
-
export type IpAddressAddressFamilyEnum =
|
|
6697
|
-
| "Unspecified"
|
|
6698
|
-
| "Unix"
|
|
6699
|
-
| "InterNetwork"
|
|
6700
|
-
| "ImpLink"
|
|
6701
|
-
| "Pup"
|
|
6702
|
-
| "Chaos"
|
|
6703
|
-
| "NS"
|
|
6704
|
-
| "Ipx"
|
|
6705
|
-
| "Iso"
|
|
6706
|
-
| "Osi"
|
|
6707
|
-
| "Ecma"
|
|
6708
|
-
| "DataKit"
|
|
6709
|
-
| "Ccitt"
|
|
6710
|
-
| "Sna"
|
|
6711
|
-
| "DecNet"
|
|
6712
|
-
| "DataLink"
|
|
6713
|
-
| "Lat"
|
|
6714
|
-
| "HyperChannel"
|
|
6715
|
-
| "AppleTalk"
|
|
6716
|
-
| "NetBios"
|
|
6717
|
-
| "VoiceView"
|
|
6718
|
-
| "FireFox"
|
|
6719
|
-
| "Banyan"
|
|
6720
|
-
| "Atm"
|
|
6721
|
-
| "InterNetworkV6"
|
|
6722
|
-
| "Cluster"
|
|
6723
|
-
| "Ieee12844"
|
|
6724
|
-
| "Irda"
|
|
6725
|
-
| "NetworkDesigners"
|
|
6726
|
-
| "Max"
|
|
6727
|
-
| "Packet"
|
|
6728
|
-
| "ControllerAreaNetwork"
|
|
6729
|
-
| "Unknown";
|
|
6730
|
-
|
|
6731
|
-
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6732
|
-
|
|
6733
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6734
|
-
|
|
6735
|
-
export type LoanContactRoleEnum =
|
|
6736
|
-
| "Borrower"
|
|
6737
|
-
| "CoBorrower"
|
|
6738
|
-
| "NonBorrower"
|
|
6739
|
-
| "LoanOfficer"
|
|
6740
|
-
| "LoanProcessor"
|
|
6741
|
-
| "LoanOfficerAssistant"
|
|
6742
|
-
| "SupportingLoanOfficer"
|
|
6743
|
-
| "BuyerAgent"
|
|
6744
|
-
| "SellerAgent"
|
|
6745
|
-
| "TitleInsuranceAgent"
|
|
6746
|
-
| "EscrowAgent"
|
|
6747
|
-
| "SettlementAgent"
|
|
6748
|
-
| "Admin";
|
|
6749
|
-
|
|
6750
|
-
export type LoanDocumentFolderPermissionRoleEnum =
|
|
6751
|
-
| "Borrower"
|
|
6752
|
-
| "CoBorrower"
|
|
6753
|
-
| "NonBorrower"
|
|
6754
|
-
| "LoanOfficer"
|
|
6755
|
-
| "LoanProcessor"
|
|
6756
|
-
| "LoanOfficerAssistant"
|
|
6757
|
-
| "SupportingLoanOfficer"
|
|
6758
|
-
| "BuyerAgent"
|
|
6759
|
-
| "SellerAgent"
|
|
6760
|
-
| "TitleInsuranceAgent"
|
|
6761
|
-
| "EscrowAgent"
|
|
6762
|
-
| "SettlementAgent"
|
|
6763
|
-
| "Admin";
|
|
6764
|
-
|
|
6765
|
-
export type LoanDocumentFolderPermissionLevelEnum =
|
|
6766
|
-
| "None"
|
|
6767
|
-
| "Read"
|
|
6768
|
-
| "Write"
|
|
6769
|
-
| "Manage";
|
|
6770
|
-
|
|
6771
|
-
export type LoanDocumentFolderPermissionRequestRoleEnum =
|
|
6772
|
-
| "Borrower"
|
|
6773
|
-
| "CoBorrower"
|
|
6774
|
-
| "NonBorrower"
|
|
6775
|
-
| "LoanOfficer"
|
|
6776
|
-
| "LoanProcessor"
|
|
6777
|
-
| "LoanOfficerAssistant"
|
|
6778
|
-
| "SupportingLoanOfficer"
|
|
6779
|
-
| "BuyerAgent"
|
|
6780
|
-
| "SellerAgent"
|
|
6781
|
-
| "TitleInsuranceAgent"
|
|
6782
|
-
| "EscrowAgent"
|
|
6783
|
-
| "SettlementAgent"
|
|
6784
|
-
| "Admin";
|
|
6785
|
-
|
|
6786
|
-
export type LoanDocumentFolderPermissionRequestLevelEnum =
|
|
6787
|
-
| "None"
|
|
6788
|
-
| "Read"
|
|
6789
|
-
| "Write"
|
|
6790
|
-
| "Manage";
|
|
6791
|
-
|
|
6792
|
-
export type LoanImportStatusEnum =
|
|
6793
|
-
| "WaitingProcess"
|
|
6794
|
-
| "InProgress"
|
|
6795
|
-
| "Completed"
|
|
6796
|
-
| "Failed"
|
|
6797
|
-
| "Cancelled";
|
|
6798
|
-
|
|
6799
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6800
|
-
|
|
6801
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6802
|
-
|
|
6803
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6804
|
-
|
|
6805
|
-
export type LoanLogTypeEnum =
|
|
6806
|
-
| "Loan"
|
|
6807
|
-
| "Queue"
|
|
6808
|
-
| "POSFlagChanged"
|
|
6809
|
-
| "Verification"
|
|
6810
|
-
| "DocumentUploaded"
|
|
6811
|
-
| "LoanCreated"
|
|
6812
|
-
| "WorkflowSubmitted"
|
|
6813
|
-
| "UserInvitationSent"
|
|
6814
|
-
| "CoBorrowerAdded"
|
|
6815
|
-
| "TaskCompleted"
|
|
6816
|
-
| "LoanStatusChanged"
|
|
6817
|
-
| "Consent"
|
|
6818
|
-
| "SensitiveDataPurge"
|
|
6819
|
-
| "ClosingDateUpdated"
|
|
6820
|
-
| "ConsumerConnectAssociation"
|
|
6821
|
-
| "TaskReminderSent";
|
|
6822
|
-
|
|
6823
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6824
|
-
|
|
6825
|
-
export type LoanLogDetailTypeEnum =
|
|
6826
|
-
| "Loan"
|
|
6827
|
-
| "Queue"
|
|
6828
|
-
| "POSFlagChanged"
|
|
6829
|
-
| "Verification"
|
|
6830
|
-
| "DocumentUploaded"
|
|
6831
|
-
| "LoanCreated"
|
|
6832
|
-
| "WorkflowSubmitted"
|
|
6833
|
-
| "UserInvitationSent"
|
|
6834
|
-
| "CoBorrowerAdded"
|
|
6835
|
-
| "TaskCompleted"
|
|
6836
|
-
| "LoanStatusChanged"
|
|
6837
|
-
| "Consent"
|
|
6838
|
-
| "SensitiveDataPurge"
|
|
6839
|
-
| "ClosingDateUpdated"
|
|
6840
|
-
| "ConsumerConnectAssociation"
|
|
6841
|
-
| "TaskReminderSent";
|
|
6842
|
-
|
|
6843
|
-
export type LoanTaskStatusSummaryStatusEnum =
|
|
6844
|
-
| "Outstanding"
|
|
6845
|
-
| "Pending"
|
|
6846
|
-
| "Completed"
|
|
6847
|
-
| "Rejected"
|
|
6848
|
-
| "Unknown";
|
|
6849
|
-
|
|
6850
|
-
export type LoanUserLoanRoleEnum =
|
|
6851
|
-
| "Borrower"
|
|
6852
|
-
| "CoBorrower"
|
|
6853
|
-
| "NonBorrower"
|
|
6854
|
-
| "LoanOfficer"
|
|
6855
|
-
| "LoanProcessor"
|
|
6856
|
-
| "LoanOfficerAssistant"
|
|
6857
|
-
| "SupportingLoanOfficer"
|
|
6858
|
-
| "BuyerAgent"
|
|
6859
|
-
| "SellerAgent"
|
|
6860
|
-
| "TitleInsuranceAgent"
|
|
6861
|
-
| "EscrowAgent"
|
|
6862
|
-
| "SettlementAgent"
|
|
6863
|
-
| "Admin";
|
|
6864
|
-
|
|
6865
|
-
export type LosOperationTrackingStatusEnum =
|
|
6866
|
-
| "Pending"
|
|
6867
|
-
| "Success"
|
|
6868
|
-
| "Failed"
|
|
6869
|
-
| "ConfigurationError"
|
|
6870
|
-
| "PermanentFailure"
|
|
6871
|
-
| "Locked";
|
|
6872
|
-
|
|
6873
|
-
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
6874
|
-
|
|
6875
|
-
export type SamlMetadataRequestSsoIntegrationEnum =
|
|
6876
|
-
| "ConsumerConnect"
|
|
6877
|
-
| "TheBigPOS"
|
|
6878
|
-
| "POSF";
|
|
6879
|
-
|
|
6880
|
-
export type SiteConfigurationTypeEnum =
|
|
6881
|
-
| "None"
|
|
6882
|
-
| "Account"
|
|
6883
|
-
| "Corporate"
|
|
6884
|
-
| "Branch"
|
|
6885
|
-
| "LoanOfficer"
|
|
6886
|
-
| "Partner";
|
|
6887
|
-
|
|
6888
|
-
export type SiteConfigurationByUrlTypeEnum =
|
|
6889
|
-
| "None"
|
|
6890
|
-
| "Account"
|
|
6891
|
-
| "Corporate"
|
|
6892
|
-
| "Branch"
|
|
6893
|
-
| "LoanOfficer"
|
|
6894
|
-
| "Partner";
|
|
6895
|
-
|
|
6896
|
-
export type SiteConfigurationReducedTypeEnum =
|
|
6897
|
-
| "None"
|
|
6898
|
-
| "Account"
|
|
6899
|
-
| "Corporate"
|
|
6900
|
-
| "Branch"
|
|
6901
|
-
| "LoanOfficer"
|
|
6902
|
-
| "Partner";
|
|
6903
|
-
|
|
6904
|
-
export type SiteConfigurationRequestTypeEnum =
|
|
6905
|
-
| "None"
|
|
6906
|
-
| "Account"
|
|
6907
|
-
| "Corporate"
|
|
6908
|
-
| "Branch"
|
|
6909
|
-
| "LoanOfficer"
|
|
6910
|
-
| "Partner";
|
|
6911
|
-
|
|
6912
|
-
export type SiteConfigurationSummaryTypeEnum =
|
|
6913
|
-
| "None"
|
|
6914
|
-
| "Account"
|
|
6915
|
-
| "Corporate"
|
|
6916
|
-
| "Branch"
|
|
6917
|
-
| "LoanOfficer"
|
|
6918
|
-
| "Partner";
|
|
6919
|
-
|
|
6920
|
-
export type UserDraftRoleEnum =
|
|
6921
|
-
| "Borrower"
|
|
6922
|
-
| "CoBorrower"
|
|
6923
|
-
| "NonBorrower"
|
|
6924
|
-
| "LoanOfficer"
|
|
6925
|
-
| "LoanProcessor"
|
|
6926
|
-
| "LoanOfficerAssistant"
|
|
6927
|
-
| "SupportingLoanOfficer"
|
|
6928
|
-
| "BuyerAgent"
|
|
6929
|
-
| "SellerAgent"
|
|
6930
|
-
| "TitleInsuranceAgent"
|
|
6931
|
-
| "EscrowAgent"
|
|
6932
|
-
| "SettlementAgent"
|
|
6933
|
-
| "Admin";
|
|
6934
|
-
|
|
6935
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6936
|
-
|
|
6937
|
-
export type UserLoanRoleEnum =
|
|
6938
|
-
| "Borrower"
|
|
6939
|
-
| "CoBorrower"
|
|
6940
|
-
| "NonBorrower"
|
|
6941
|
-
| "LoanOfficer"
|
|
6942
|
-
| "LoanProcessor"
|
|
6943
|
-
| "LoanOfficerAssistant"
|
|
6944
|
-
| "SupportingLoanOfficer"
|
|
6945
|
-
| "BuyerAgent"
|
|
6946
|
-
| "SellerAgent"
|
|
6947
|
-
| "TitleInsuranceAgent"
|
|
6948
|
-
| "EscrowAgent"
|
|
6949
|
-
| "SettlementAgent"
|
|
6950
|
-
| "Admin";
|
|
6951
|
-
|
|
6952
|
-
export type UserLoanConsentTypeEnum =
|
|
6953
|
-
| "Econsent"
|
|
6954
|
-
| "CreditAuthorization"
|
|
6955
|
-
| "Tcpa";
|
|
6956
|
-
|
|
6957
|
-
export type UserLoanConsentLosSyncStatusEnum =
|
|
6958
|
-
| "NotStarted"
|
|
6959
|
-
| "Failed"
|
|
6960
|
-
| "Success";
|
|
6961
|
-
|
|
6962
|
-
export type UserSummaryRoleEnum =
|
|
6963
|
-
| "Borrower"
|
|
6964
|
-
| "LoanOfficer"
|
|
6965
|
-
| "Admin"
|
|
6966
|
-
| "SuperAdmin"
|
|
6967
|
-
| "Realtor"
|
|
6968
|
-
| "SettlementAgent"
|
|
6969
|
-
| "LoanProcessor"
|
|
6970
|
-
| "LoanOfficerAssistant"
|
|
6971
|
-
| "SystemAdmin";
|
|
6972
|
-
|
|
6973
|
-
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6974
|
-
|
|
6975
|
-
/** @default "Realtor" */
|
|
6976
|
-
export type GetPartnersParamsRoleEnum =
|
|
6977
|
-
| "Borrower"
|
|
6978
|
-
| "LoanOfficer"
|
|
6979
|
-
| "Admin"
|
|
6980
|
-
| "SuperAdmin"
|
|
6981
|
-
| "Realtor"
|
|
6982
|
-
| "SettlementAgent"
|
|
6983
|
-
| "LoanProcessor"
|
|
6984
|
-
| "LoanOfficerAssistant"
|
|
6985
|
-
| "SystemAdmin";
|
|
6986
|
-
|
|
6987
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
6988
|
-
| "ConsumerConnect"
|
|
6989
|
-
| "TheBigPOS"
|
|
6990
|
-
| "POSF";
|
|
6991
|
-
|
|
6992
|
-
export type GetSamlMetadataParamsEnum =
|
|
6993
|
-
| "ConsumerConnect"
|
|
6994
|
-
| "TheBigPOS"
|
|
6995
|
-
| "POSF";
|
|
6996
|
-
|
|
6997
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
|
|
6998
|
-
| "ConsumerConnect"
|
|
6999
|
-
| "TheBigPOS"
|
|
7000
|
-
| "POSF";
|
|
7001
|
-
|
|
7002
|
-
export type CreateOrReplaceSamlMetadataParamsEnum =
|
|
7003
|
-
| "ConsumerConnect"
|
|
7004
|
-
| "TheBigPOS"
|
|
7005
|
-
| "POSF";
|
|
7006
|
-
|
|
7007
6801
|
import type {
|
|
7008
6802
|
AxiosInstance,
|
|
7009
6803
|
AxiosRequestConfig,
|
|
@@ -7046,6 +6840,7 @@ export interface ApiConfig<SecurityDataType = unknown>
|
|
|
7046
6840
|
}
|
|
7047
6841
|
|
|
7048
6842
|
export enum ContentType {
|
|
6843
|
+
JsonPatch = "application/json-patch+json",
|
|
7049
6844
|
Json = "application/json",
|
|
7050
6845
|
JsonApi = "application/vnd.api+json",
|
|
7051
6846
|
FormData = "multipart/form-data",
|
|
@@ -7181,7 +6976,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
7181
6976
|
|
|
7182
6977
|
/**
|
|
7183
6978
|
* @title The Big POS API
|
|
7184
|
-
* @version v2.
|
|
6979
|
+
* @version v2.41.0
|
|
7185
6980
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
7186
6981
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
7187
6982
|
*/
|
|
@@ -8447,7 +8242,7 @@ export class Api<
|
|
|
8447
8242
|
*/
|
|
8448
8243
|
getCustomFieldDefinitions: (
|
|
8449
8244
|
query?: {
|
|
8450
|
-
entityType?:
|
|
8245
|
+
entityType?: "Loan";
|
|
8451
8246
|
},
|
|
8452
8247
|
params: RequestParams = {},
|
|
8453
8248
|
) =>
|
|
@@ -9870,6 +9665,25 @@ export class Api<
|
|
|
9870
9665
|
...params,
|
|
9871
9666
|
}),
|
|
9872
9667
|
|
|
9668
|
+
/**
|
|
9669
|
+
* No description
|
|
9670
|
+
*
|
|
9671
|
+
* @tags IntegrationSettings
|
|
9672
|
+
* @name GetIntegrationSettings
|
|
9673
|
+
* @summary Get Integration Settings
|
|
9674
|
+
* @request GET:/api/integrations/settings
|
|
9675
|
+
* @secure
|
|
9676
|
+
* @response `200` `IntegrationSettings` Success
|
|
9677
|
+
*/
|
|
9678
|
+
getIntegrationSettings: (params: RequestParams = {}) =>
|
|
9679
|
+
this.request<IntegrationSettings, any>({
|
|
9680
|
+
path: `/api/integrations/settings`,
|
|
9681
|
+
method: "GET",
|
|
9682
|
+
secure: true,
|
|
9683
|
+
format: "json",
|
|
9684
|
+
...params,
|
|
9685
|
+
}),
|
|
9686
|
+
|
|
9873
9687
|
/**
|
|
9874
9688
|
* No description
|
|
9875
9689
|
*
|
|
@@ -9911,7 +9725,7 @@ export class Api<
|
|
|
9911
9725
|
method: "PATCH",
|
|
9912
9726
|
body: data,
|
|
9913
9727
|
secure: true,
|
|
9914
|
-
type: ContentType.
|
|
9728
|
+
type: ContentType.JsonPatch,
|
|
9915
9729
|
format: "json",
|
|
9916
9730
|
...params,
|
|
9917
9731
|
}),
|
|
@@ -10021,7 +9835,7 @@ export class Api<
|
|
|
10021
9835
|
method: "PATCH",
|
|
10022
9836
|
body: data,
|
|
10023
9837
|
secure: true,
|
|
10024
|
-
type: ContentType.
|
|
9838
|
+
type: ContentType.JsonPatch,
|
|
10025
9839
|
format: "json",
|
|
10026
9840
|
...params,
|
|
10027
9841
|
}),
|
|
@@ -10048,7 +9862,7 @@ export class Api<
|
|
|
10048
9862
|
method: "PATCH",
|
|
10049
9863
|
body: data,
|
|
10050
9864
|
secure: true,
|
|
10051
|
-
type: ContentType.
|
|
9865
|
+
type: ContentType.JsonPatch,
|
|
10052
9866
|
format: "json",
|
|
10053
9867
|
...params,
|
|
10054
9868
|
}),
|
|
@@ -10290,7 +10104,7 @@ export class Api<
|
|
|
10290
10104
|
method: "PATCH",
|
|
10291
10105
|
body: data,
|
|
10292
10106
|
secure: true,
|
|
10293
|
-
type: ContentType.
|
|
10107
|
+
type: ContentType.JsonPatch,
|
|
10294
10108
|
format: "json",
|
|
10295
10109
|
...params,
|
|
10296
10110
|
}),
|
|
@@ -10370,7 +10184,7 @@ export class Api<
|
|
|
10370
10184
|
method: "PATCH",
|
|
10371
10185
|
body: data,
|
|
10372
10186
|
secure: true,
|
|
10373
|
-
type: ContentType.
|
|
10187
|
+
type: ContentType.JsonPatch,
|
|
10374
10188
|
format: "json",
|
|
10375
10189
|
...params,
|
|
10376
10190
|
}),
|
|
@@ -12294,7 +12108,7 @@ export class Api<
|
|
|
12294
12108
|
method: "POST",
|
|
12295
12109
|
body: data,
|
|
12296
12110
|
secure: true,
|
|
12297
|
-
type: ContentType.
|
|
12111
|
+
type: ContentType.JsonPatch,
|
|
12298
12112
|
format: "json",
|
|
12299
12113
|
...params,
|
|
12300
12114
|
}),
|
|
@@ -13522,7 +13336,16 @@ export class Api<
|
|
|
13522
13336
|
query?: {
|
|
13523
13337
|
showAll?: boolean;
|
|
13524
13338
|
/** @default "Realtor" */
|
|
13525
|
-
role?:
|
|
13339
|
+
role?:
|
|
13340
|
+
| "Borrower"
|
|
13341
|
+
| "LoanOfficer"
|
|
13342
|
+
| "Admin"
|
|
13343
|
+
| "SuperAdmin"
|
|
13344
|
+
| "Realtor"
|
|
13345
|
+
| "SettlementAgent"
|
|
13346
|
+
| "LoanProcessor"
|
|
13347
|
+
| "LoanOfficerAssistant"
|
|
13348
|
+
| "SystemAdmin";
|
|
13526
13349
|
/** @format int32 */
|
|
13527
13350
|
pageSize?: number;
|
|
13528
13351
|
/** @format int32 */
|
|
@@ -13858,7 +13681,7 @@ export class Api<
|
|
|
13858
13681
|
* @response `404` `ProblemDetails` Not Found
|
|
13859
13682
|
*/
|
|
13860
13683
|
getSamlMetadata: (
|
|
13861
|
-
sSoIntegration:
|
|
13684
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
13862
13685
|
ssoIntegration: string,
|
|
13863
13686
|
params: RequestParams = {},
|
|
13864
13687
|
) =>
|
|
@@ -13880,7 +13703,7 @@ export class Api<
|
|
|
13880
13703
|
* @response `200` `File` Success
|
|
13881
13704
|
*/
|
|
13882
13705
|
createOrReplaceSamlMetadata: (
|
|
13883
|
-
sSoIntegration:
|
|
13706
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
13884
13707
|
ssoIntegration: string,
|
|
13885
13708
|
params: RequestParams = {},
|
|
13886
13709
|
) =>
|