@matech/thebigpos-sdk 2.38.1 → 2.38.2-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 +310 -57
- package/dist/index.js +118 -13
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -149
- package/package.json +39 -43
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +751 -242
- package/tsconfig.json +27 -27
package/src/index.ts
CHANGED
|
@@ -23,6 +23,13 @@ export type UserRole =
|
|
|
23
23
|
| "LoanOfficerAssistant"
|
|
24
24
|
| "SystemAdmin";
|
|
25
25
|
|
|
26
|
+
export type TaskStatus =
|
|
27
|
+
| "Outstanding"
|
|
28
|
+
| "Pending"
|
|
29
|
+
| "Completed"
|
|
30
|
+
| "Rejected"
|
|
31
|
+
| "Unknown";
|
|
32
|
+
|
|
26
33
|
export type SiteConfigurationType =
|
|
27
34
|
| "None"
|
|
28
35
|
| "Account"
|
|
@@ -31,7 +38,7 @@ export type SiteConfigurationType =
|
|
|
31
38
|
| "LoanOfficer"
|
|
32
39
|
| "Partner";
|
|
33
40
|
|
|
34
|
-
export type SigningMethod = "
|
|
41
|
+
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
35
42
|
|
|
36
43
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
37
44
|
|
|
@@ -46,6 +53,8 @@ export type LoanTitleHeld =
|
|
|
46
53
|
| "JointWithSpouse"
|
|
47
54
|
| "JointWithOtherThanSpouse";
|
|
48
55
|
|
|
56
|
+
export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
|
|
57
|
+
|
|
49
58
|
export type LoanRole =
|
|
50
59
|
| "Borrower"
|
|
51
60
|
| "CoBorrower"
|
|
@@ -189,7 +198,8 @@ export type LoanLogType =
|
|
|
189
198
|
| "LoanStatusChanged"
|
|
190
199
|
| "EConsent"
|
|
191
200
|
| "SensitiveDataPurge"
|
|
192
|
-
| "ClosingDateUpdated"
|
|
201
|
+
| "ClosingDateUpdated"
|
|
202
|
+
| "ConsumerConnectAssociation";
|
|
193
203
|
|
|
194
204
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
195
205
|
|
|
@@ -330,6 +340,14 @@ export type EncompassLogOperationType =
|
|
|
330
340
|
|
|
331
341
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
332
342
|
|
|
343
|
+
export type ConsumerConnectAssociationStatus =
|
|
344
|
+
| "Legacy"
|
|
345
|
+
| "Pending"
|
|
346
|
+
| "Success"
|
|
347
|
+
| "Failed"
|
|
348
|
+
| "ConfigurationError"
|
|
349
|
+
| "PermanentFailure";
|
|
350
|
+
|
|
333
351
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
334
352
|
|
|
335
353
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
@@ -438,7 +456,7 @@ export interface AccountBilling {
|
|
|
438
456
|
}
|
|
439
457
|
|
|
440
458
|
export interface AccountBillingRequest {
|
|
441
|
-
billingType:
|
|
459
|
+
billingType: AccountBillingRequestBillingTypeEnum;
|
|
442
460
|
/**
|
|
443
461
|
* @format double
|
|
444
462
|
* @min 0
|
|
@@ -767,16 +785,16 @@ export interface Attachment {
|
|
|
767
785
|
base64Data: string;
|
|
768
786
|
}
|
|
769
787
|
|
|
788
|
+
export interface AuditEntityType {
|
|
789
|
+
entityType: string;
|
|
790
|
+
rootEntityType?: string | null;
|
|
791
|
+
}
|
|
792
|
+
|
|
770
793
|
export interface AuditLogEntry {
|
|
771
794
|
/** @format uuid */
|
|
772
795
|
id: string;
|
|
773
796
|
entityType: string;
|
|
774
|
-
changeType:
|
|
775
|
-
| "Created"
|
|
776
|
-
| "Modified"
|
|
777
|
-
| "SoftDeleted"
|
|
778
|
-
| "HardDeleted"
|
|
779
|
-
| "Restored";
|
|
797
|
+
changeType: AuditLogEntryChangeTypeEnum;
|
|
780
798
|
/** @format uuid */
|
|
781
799
|
entityId: string;
|
|
782
800
|
performedBy?: AuditLogUser | null;
|
|
@@ -806,9 +824,6 @@ export interface AuditLogSearchCriteria {
|
|
|
806
824
|
startDate?: string | null;
|
|
807
825
|
/** @format date-time */
|
|
808
826
|
endDate?: string | null;
|
|
809
|
-
rootEntityType?: string | null;
|
|
810
|
-
/** @format uuid */
|
|
811
|
-
rootEntityId?: string | null;
|
|
812
827
|
}
|
|
813
828
|
|
|
814
829
|
export interface AuditLogUser {
|
|
@@ -1013,6 +1028,30 @@ export interface ConditionComment {
|
|
|
1013
1028
|
createdByName: string;
|
|
1014
1029
|
}
|
|
1015
1030
|
|
|
1031
|
+
export interface ConsumerConnectRetry {
|
|
1032
|
+
/** @format uuid */
|
|
1033
|
+
userLoanId: string;
|
|
1034
|
+
email: string;
|
|
1035
|
+
status?: ConsumerConnectAssociationStatus | null;
|
|
1036
|
+
success: boolean;
|
|
1037
|
+
}
|
|
1038
|
+
|
|
1039
|
+
export interface ConsumerConnectStatus {
|
|
1040
|
+
/** @format uuid */
|
|
1041
|
+
userLoanId: string;
|
|
1042
|
+
/** @format uuid */
|
|
1043
|
+
userId: string;
|
|
1044
|
+
email: string;
|
|
1045
|
+
role: ConsumerConnectStatusRoleEnum;
|
|
1046
|
+
status?: ConsumerConnectAssociationStatus | null;
|
|
1047
|
+
/** @format int32 */
|
|
1048
|
+
attemptCount: number;
|
|
1049
|
+
/** @format date-time */
|
|
1050
|
+
lastAttemptAt?: string | null;
|
|
1051
|
+
/** @format date-time */
|
|
1052
|
+
nextRetryAt?: string | null;
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1016
1055
|
export interface ContactInfo {
|
|
1017
1056
|
phone: string;
|
|
1018
1057
|
tollFreePhone?: string | null;
|
|
@@ -1067,7 +1106,7 @@ export interface CorporateSearchCriteria {
|
|
|
1067
1106
|
}
|
|
1068
1107
|
|
|
1069
1108
|
export interface CreateAccessScopeRequest {
|
|
1070
|
-
scopeType:
|
|
1109
|
+
scopeType: CreateAccessScopeRequestScopeTypeEnum;
|
|
1071
1110
|
/** @format uuid */
|
|
1072
1111
|
userId?: string | null;
|
|
1073
1112
|
/** @format uuid */
|
|
@@ -1091,7 +1130,7 @@ export interface CreateAccountRequest {
|
|
|
1091
1130
|
*/
|
|
1092
1131
|
nlmsid: number;
|
|
1093
1132
|
settings: AccountSettingsRequest;
|
|
1094
|
-
environment:
|
|
1133
|
+
environment: CreateAccountRequestEnvironmentEnum;
|
|
1095
1134
|
losIntegration: LOSIntegration;
|
|
1096
1135
|
billingSettings: AccountBillingRequest;
|
|
1097
1136
|
}
|
|
@@ -1124,19 +1163,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1124
1163
|
export interface CreateGroupMemberRequest {
|
|
1125
1164
|
/** @format uuid */
|
|
1126
1165
|
userId: string;
|
|
1127
|
-
loanRole:
|
|
1128
|
-
| "Borrower"
|
|
1129
|
-
| "CoBorrower"
|
|
1130
|
-
| "NonBorrower"
|
|
1131
|
-
| "LoanOfficer"
|
|
1132
|
-
| "LoanProcessor"
|
|
1133
|
-
| "LoanOfficerAssistant"
|
|
1134
|
-
| "SupportingLoanOfficer"
|
|
1135
|
-
| "BuyerAgent"
|
|
1136
|
-
| "SellerAgent"
|
|
1137
|
-
| "TitleInsuranceAgent"
|
|
1138
|
-
| "EscrowAgent"
|
|
1139
|
-
| "SettlementAgent";
|
|
1166
|
+
loanRole: CreateGroupMemberRequestLoanRoleEnum;
|
|
1140
1167
|
}
|
|
1141
1168
|
|
|
1142
1169
|
export interface CreateInviteRequest {
|
|
@@ -1148,7 +1175,7 @@ export interface CreateInviteRequest {
|
|
|
1148
1175
|
emailAddress: string;
|
|
1149
1176
|
phoneNumber?: string | null;
|
|
1150
1177
|
/** @deprecated */
|
|
1151
|
-
relationship:
|
|
1178
|
+
relationship: CreateInviteRequestRelationshipEnum;
|
|
1152
1179
|
loanID: string;
|
|
1153
1180
|
route?: string | null;
|
|
1154
1181
|
/** @format uuid */
|
|
@@ -1171,7 +1198,7 @@ export interface CreateLoanImportRequest {
|
|
|
1171
1198
|
* @minLength 1
|
|
1172
1199
|
*/
|
|
1173
1200
|
startDate: string;
|
|
1174
|
-
importMode:
|
|
1201
|
+
importMode: CreateLoanImportRequestImportModeEnum;
|
|
1175
1202
|
}
|
|
1176
1203
|
|
|
1177
1204
|
export interface CreateSession {
|
|
@@ -1193,19 +1220,7 @@ export interface CreateUserDeviceRequest {
|
|
|
1193
1220
|
}
|
|
1194
1221
|
|
|
1195
1222
|
export interface CreateUserDraft {
|
|
1196
|
-
loanRole:
|
|
1197
|
-
| "Borrower"
|
|
1198
|
-
| "CoBorrower"
|
|
1199
|
-
| "NonBorrower"
|
|
1200
|
-
| "LoanOfficer"
|
|
1201
|
-
| "LoanProcessor"
|
|
1202
|
-
| "LoanOfficerAssistant"
|
|
1203
|
-
| "SupportingLoanOfficer"
|
|
1204
|
-
| "BuyerAgent"
|
|
1205
|
-
| "SellerAgent"
|
|
1206
|
-
| "TitleInsuranceAgent"
|
|
1207
|
-
| "EscrowAgent"
|
|
1208
|
-
| "SettlementAgent";
|
|
1223
|
+
loanRole: CreateUserDraftLoanRoleEnum;
|
|
1209
1224
|
}
|
|
1210
1225
|
|
|
1211
1226
|
export interface CreateUserGroupRequest {
|
|
@@ -1262,6 +1277,10 @@ export interface CreateUserRequest {
|
|
|
1262
1277
|
isInternal?: boolean | null;
|
|
1263
1278
|
}
|
|
1264
1279
|
|
|
1280
|
+
export interface CreateWebhookRequest {
|
|
1281
|
+
webhookPath: string;
|
|
1282
|
+
}
|
|
1283
|
+
|
|
1265
1284
|
export interface CustomLoanData {
|
|
1266
1285
|
eConsentInformation?: EConsentInformation | null;
|
|
1267
1286
|
}
|
|
@@ -1523,7 +1542,7 @@ export interface Draft {
|
|
|
1523
1542
|
siteConfiguration: SiteConfigurationReduced;
|
|
1524
1543
|
/** @format uuid */
|
|
1525
1544
|
loanID?: string | null;
|
|
1526
|
-
type:
|
|
1545
|
+
type: DraftTypeEnum;
|
|
1527
1546
|
isCoBorrower: boolean;
|
|
1528
1547
|
}
|
|
1529
1548
|
|
|
@@ -1542,7 +1561,7 @@ export interface DraftContent {
|
|
|
1542
1561
|
siteConfiguration: SiteConfigurationReduced;
|
|
1543
1562
|
/** @format uuid */
|
|
1544
1563
|
loanID?: string | null;
|
|
1545
|
-
type:
|
|
1564
|
+
type: DraftContentTypeEnum;
|
|
1546
1565
|
isCoBorrower: boolean;
|
|
1547
1566
|
applicationPayload: any;
|
|
1548
1567
|
}
|
|
@@ -1629,6 +1648,42 @@ export interface EncompassContact {
|
|
|
1629
1648
|
company?: string | null;
|
|
1630
1649
|
}
|
|
1631
1650
|
|
|
1651
|
+
export interface EncompassCredentialsDetail {
|
|
1652
|
+
/** @format uuid */
|
|
1653
|
+
id: string;
|
|
1654
|
+
/** @format uuid */
|
|
1655
|
+
accountID: string;
|
|
1656
|
+
instanceID: string;
|
|
1657
|
+
loanAssignmentRole?: string | null;
|
|
1658
|
+
loanTemplate?: string | null;
|
|
1659
|
+
defaultLoanOfficerUserName?: string | null;
|
|
1660
|
+
clearStateIfUnlicensed: boolean;
|
|
1661
|
+
baseUrl?: string | null;
|
|
1662
|
+
signingMethod: EncompassCredentialsDetailSigningMethodEnum;
|
|
1663
|
+
subscriptionId?: string | null;
|
|
1664
|
+
environment?: string | null;
|
|
1665
|
+
}
|
|
1666
|
+
|
|
1667
|
+
export interface EncompassCredentialsRequest {
|
|
1668
|
+
/** @format uuid */
|
|
1669
|
+
id: string;
|
|
1670
|
+
/** @format uuid */
|
|
1671
|
+
accountID: string;
|
|
1672
|
+
instanceID: string;
|
|
1673
|
+
loanAssignmentRole?: string | null;
|
|
1674
|
+
loanTemplate?: string | null;
|
|
1675
|
+
defaultLoanOfficerUserName?: string | null;
|
|
1676
|
+
clearStateIfUnlicensed: boolean;
|
|
1677
|
+
baseUrl?: string | null;
|
|
1678
|
+
signingMethod: EncompassCredentialsRequestSigningMethodEnum;
|
|
1679
|
+
subscriptionId?: string | null;
|
|
1680
|
+
environment?: string | null;
|
|
1681
|
+
clientID?: string | null;
|
|
1682
|
+
clientSecret?: string | null;
|
|
1683
|
+
signingKeyId?: string | null;
|
|
1684
|
+
signingKey?: string | null;
|
|
1685
|
+
}
|
|
1686
|
+
|
|
1632
1687
|
export interface EncompassError {
|
|
1633
1688
|
errorCode: string;
|
|
1634
1689
|
message: string;
|
|
@@ -1684,15 +1739,8 @@ export interface EncompassRequestLog {
|
|
|
1684
1739
|
losId?: string | null;
|
|
1685
1740
|
/** @format uuid */
|
|
1686
1741
|
accountId: string;
|
|
1687
|
-
operationType:
|
|
1688
|
-
|
|
1689
|
-
| "EConsentUpdate"
|
|
1690
|
-
| "DocumentSync"
|
|
1691
|
-
| "MilestoneUpdate"
|
|
1692
|
-
| "DocumentAttachment"
|
|
1693
|
-
| "General"
|
|
1694
|
-
| "FieldReader";
|
|
1695
|
-
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1742
|
+
operationType: EncompassRequestLogOperationTypeEnum;
|
|
1743
|
+
outcome: EncompassRequestLogOutcomeEnum;
|
|
1696
1744
|
message: string;
|
|
1697
1745
|
endpoint?: string | null;
|
|
1698
1746
|
httpMethod?: string | null;
|
|
@@ -1750,7 +1798,7 @@ export interface FileSearchCriteria {
|
|
|
1750
1798
|
export interface FileWithBytes {
|
|
1751
1799
|
name: string;
|
|
1752
1800
|
/** @format byte */
|
|
1753
|
-
data:
|
|
1801
|
+
data: Blob;
|
|
1754
1802
|
fileName: string;
|
|
1755
1803
|
mimeType?: string | null;
|
|
1756
1804
|
extension?: string | null;
|
|
@@ -1929,20 +1977,7 @@ export interface FusionFieldDisplay {
|
|
|
1929
1977
|
}
|
|
1930
1978
|
|
|
1931
1979
|
export interface FusionReportFilter {
|
|
1932
|
-
filterType:
|
|
1933
|
-
| "DateGreaterThanOrEqualTo"
|
|
1934
|
-
| "DateGreaterThan"
|
|
1935
|
-
| "DateLessThan"
|
|
1936
|
-
| "DateLessThanOrEqualTo"
|
|
1937
|
-
| "DateEquals"
|
|
1938
|
-
| "DateDoesntEqual"
|
|
1939
|
-
| "DateNonEmpty"
|
|
1940
|
-
| "DateEmpty"
|
|
1941
|
-
| "StringContains"
|
|
1942
|
-
| "StringEquals"
|
|
1943
|
-
| "StringNotEmpty"
|
|
1944
|
-
| "StringNotEquals"
|
|
1945
|
-
| "StringNotContains";
|
|
1980
|
+
filterType: FusionReportFilterFilterTypeEnum;
|
|
1946
1981
|
targetField: string;
|
|
1947
1982
|
targetValue: string;
|
|
1948
1983
|
}
|
|
@@ -2070,40 +2105,7 @@ export interface GuidPatchOperation {
|
|
|
2070
2105
|
}
|
|
2071
2106
|
|
|
2072
2107
|
export interface IPAddress {
|
|
2073
|
-
addressFamily:
|
|
2074
|
-
| "Unspecified"
|
|
2075
|
-
| "Unix"
|
|
2076
|
-
| "InterNetwork"
|
|
2077
|
-
| "ImpLink"
|
|
2078
|
-
| "Pup"
|
|
2079
|
-
| "Chaos"
|
|
2080
|
-
| "NS"
|
|
2081
|
-
| "Ipx"
|
|
2082
|
-
| "Iso"
|
|
2083
|
-
| "Osi"
|
|
2084
|
-
| "Ecma"
|
|
2085
|
-
| "DataKit"
|
|
2086
|
-
| "Ccitt"
|
|
2087
|
-
| "Sna"
|
|
2088
|
-
| "DecNet"
|
|
2089
|
-
| "DataLink"
|
|
2090
|
-
| "Lat"
|
|
2091
|
-
| "HyperChannel"
|
|
2092
|
-
| "AppleTalk"
|
|
2093
|
-
| "NetBios"
|
|
2094
|
-
| "VoiceView"
|
|
2095
|
-
| "FireFox"
|
|
2096
|
-
| "Banyan"
|
|
2097
|
-
| "Atm"
|
|
2098
|
-
| "InterNetworkV6"
|
|
2099
|
-
| "Cluster"
|
|
2100
|
-
| "Ieee12844"
|
|
2101
|
-
| "Irda"
|
|
2102
|
-
| "NetworkDesigners"
|
|
2103
|
-
| "Max"
|
|
2104
|
-
| "Packet"
|
|
2105
|
-
| "ControllerAreaNetwork"
|
|
2106
|
-
| "Unknown";
|
|
2108
|
+
addressFamily: IpAddressAddressFamilyEnum;
|
|
2107
2109
|
/** @format int64 */
|
|
2108
2110
|
scopeId: number;
|
|
2109
2111
|
isIPv6Multicast: boolean;
|
|
@@ -2370,7 +2372,7 @@ export interface Loan {
|
|
|
2370
2372
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2371
2373
|
userLoans: UserLoan[];
|
|
2372
2374
|
contacts: LoanContact[];
|
|
2373
|
-
signingMethod:
|
|
2375
|
+
signingMethod: LoanSigningMethodEnum;
|
|
2374
2376
|
}
|
|
2375
2377
|
|
|
2376
2378
|
export interface LoanApplication {
|
|
@@ -2428,7 +2430,7 @@ export interface LoanBorrower {
|
|
|
2428
2430
|
citizenship?: LoanCitizenship | null;
|
|
2429
2431
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2430
2432
|
languagePreference?: LoanLanguagePreference | null;
|
|
2431
|
-
applicationStatus:
|
|
2433
|
+
applicationStatus: LoanBorrowerApplicationStatusEnum;
|
|
2432
2434
|
/** @format int32 */
|
|
2433
2435
|
numberOfDependents?: number | null;
|
|
2434
2436
|
isPrimaryBorrower: boolean;
|
|
@@ -3353,19 +3355,7 @@ export interface LoanContact {
|
|
|
3353
3355
|
email?: string | null;
|
|
3354
3356
|
phone?: string | null;
|
|
3355
3357
|
companyName?: string | null;
|
|
3356
|
-
role:
|
|
3357
|
-
| "Borrower"
|
|
3358
|
-
| "CoBorrower"
|
|
3359
|
-
| "NonBorrower"
|
|
3360
|
-
| "LoanOfficer"
|
|
3361
|
-
| "LoanProcessor"
|
|
3362
|
-
| "LoanOfficerAssistant"
|
|
3363
|
-
| "SupportingLoanOfficer"
|
|
3364
|
-
| "BuyerAgent"
|
|
3365
|
-
| "SellerAgent"
|
|
3366
|
-
| "TitleInsuranceAgent"
|
|
3367
|
-
| "EscrowAgent"
|
|
3368
|
-
| "SettlementAgent";
|
|
3358
|
+
role: LoanContactRoleEnum;
|
|
3369
3359
|
}
|
|
3370
3360
|
|
|
3371
3361
|
export interface LoanContactList {
|
|
@@ -3486,6 +3476,7 @@ export interface LoanIdentifier {
|
|
|
3486
3476
|
/** @format uuid */
|
|
3487
3477
|
id: string;
|
|
3488
3478
|
losLoanID: string;
|
|
3479
|
+
number?: string | null;
|
|
3489
3480
|
}
|
|
3490
3481
|
|
|
3491
3482
|
export interface LoanImport {
|
|
@@ -3501,19 +3492,14 @@ export interface LoanImport {
|
|
|
3501
3492
|
/** @format int32 */
|
|
3502
3493
|
importedCount: number;
|
|
3503
3494
|
statusMessage?: string | null;
|
|
3504
|
-
status:
|
|
3505
|
-
|
|
3506
|
-
| "InProgress"
|
|
3507
|
-
| "Completed"
|
|
3508
|
-
| "Failed"
|
|
3509
|
-
| "Cancelled";
|
|
3510
|
-
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3495
|
+
status: LoanImportStatusEnum;
|
|
3496
|
+
importMode: LoanImportImportModeEnum;
|
|
3511
3497
|
/** @format date-time */
|
|
3512
3498
|
createdAt?: string | null;
|
|
3513
3499
|
}
|
|
3514
3500
|
|
|
3515
3501
|
export interface LoanImportLog {
|
|
3516
|
-
level:
|
|
3502
|
+
level: LoanImportLogLevelEnum;
|
|
3517
3503
|
message: string;
|
|
3518
3504
|
/** @format date-time */
|
|
3519
3505
|
createdAt: string;
|
|
@@ -3574,22 +3560,8 @@ export interface LoanListPaginated {
|
|
|
3574
3560
|
export interface LoanLog {
|
|
3575
3561
|
/** @format uuid */
|
|
3576
3562
|
id: string;
|
|
3577
|
-
level:
|
|
3578
|
-
type:
|
|
3579
|
-
| "Loan"
|
|
3580
|
-
| "Queue"
|
|
3581
|
-
| "POSFlagChanged"
|
|
3582
|
-
| "Verification"
|
|
3583
|
-
| "DocumentUploaded"
|
|
3584
|
-
| "LoanCreated"
|
|
3585
|
-
| "WorkflowSubmitted"
|
|
3586
|
-
| "UserInvitationSent"
|
|
3587
|
-
| "CoBorrowerAdded"
|
|
3588
|
-
| "TaskCompleted"
|
|
3589
|
-
| "LoanStatusChanged"
|
|
3590
|
-
| "EConsent"
|
|
3591
|
-
| "SensitiveDataPurge"
|
|
3592
|
-
| "ClosingDateUpdated";
|
|
3563
|
+
level: LoanLogLevelEnum;
|
|
3564
|
+
type: LoanLogTypeEnum;
|
|
3593
3565
|
message: string;
|
|
3594
3566
|
/** @format date-time */
|
|
3595
3567
|
createdAt: string;
|
|
@@ -3598,22 +3570,8 @@ export interface LoanLog {
|
|
|
3598
3570
|
export interface LoanLogDetail {
|
|
3599
3571
|
/** @format uuid */
|
|
3600
3572
|
id: string;
|
|
3601
|
-
level:
|
|
3602
|
-
type:
|
|
3603
|
-
| "Loan"
|
|
3604
|
-
| "Queue"
|
|
3605
|
-
| "POSFlagChanged"
|
|
3606
|
-
| "Verification"
|
|
3607
|
-
| "DocumentUploaded"
|
|
3608
|
-
| "LoanCreated"
|
|
3609
|
-
| "WorkflowSubmitted"
|
|
3610
|
-
| "UserInvitationSent"
|
|
3611
|
-
| "CoBorrowerAdded"
|
|
3612
|
-
| "TaskCompleted"
|
|
3613
|
-
| "LoanStatusChanged"
|
|
3614
|
-
| "EConsent"
|
|
3615
|
-
| "SensitiveDataPurge"
|
|
3616
|
-
| "ClosingDateUpdated";
|
|
3573
|
+
level: LoanLogDetailLevelEnum;
|
|
3574
|
+
type: LoanLogDetailTypeEnum;
|
|
3617
3575
|
message: string;
|
|
3618
3576
|
/** @format date-time */
|
|
3619
3577
|
createdAt: string;
|
|
@@ -3889,6 +3847,17 @@ export interface LoanSettings {
|
|
|
3889
3847
|
excludeFromAutoTaskReminders: boolean;
|
|
3890
3848
|
}
|
|
3891
3849
|
|
|
3850
|
+
export interface LoanTaskSearchRequest {
|
|
3851
|
+
searchText?: string | null;
|
|
3852
|
+
statuses?: TaskStatus[] | null;
|
|
3853
|
+
loanNumber?: string | null;
|
|
3854
|
+
/** @format uuid */
|
|
3855
|
+
borrowerId?: string | null;
|
|
3856
|
+
/** @format uuid */
|
|
3857
|
+
loanId?: string | null;
|
|
3858
|
+
loanStatus?: LoanTaskActivityFilter | null;
|
|
3859
|
+
}
|
|
3860
|
+
|
|
3892
3861
|
export interface LoanUser {
|
|
3893
3862
|
/** @format uuid */
|
|
3894
3863
|
id: string;
|
|
@@ -3897,24 +3866,20 @@ export interface LoanUser {
|
|
|
3897
3866
|
email: string;
|
|
3898
3867
|
phone?: string | null;
|
|
3899
3868
|
role: string;
|
|
3900
|
-
loanRole:
|
|
3901
|
-
| "Borrower"
|
|
3902
|
-
| "CoBorrower"
|
|
3903
|
-
| "NonBorrower"
|
|
3904
|
-
| "LoanOfficer"
|
|
3905
|
-
| "LoanProcessor"
|
|
3906
|
-
| "LoanOfficerAssistant"
|
|
3907
|
-
| "SupportingLoanOfficer"
|
|
3908
|
-
| "BuyerAgent"
|
|
3909
|
-
| "SellerAgent"
|
|
3910
|
-
| "TitleInsuranceAgent"
|
|
3911
|
-
| "EscrowAgent"
|
|
3912
|
-
| "SettlementAgent";
|
|
3869
|
+
loanRole: LoanUserLoanRoleEnum;
|
|
3913
3870
|
isUser: boolean;
|
|
3914
3871
|
/** @format date-time */
|
|
3915
3872
|
createdAt: string;
|
|
3916
3873
|
}
|
|
3917
3874
|
|
|
3875
|
+
export interface LosCredentials {
|
|
3876
|
+
/** @format uuid */
|
|
3877
|
+
id: string;
|
|
3878
|
+
/** @format uuid */
|
|
3879
|
+
accountID: string;
|
|
3880
|
+
instanceID: string;
|
|
3881
|
+
}
|
|
3882
|
+
|
|
3918
3883
|
export interface LosLoanCreationRequest {
|
|
3919
3884
|
loanOfficerUserName?: string | null;
|
|
3920
3885
|
loanTemplate?: string | null;
|
|
@@ -3927,6 +3892,15 @@ export interface LosLoanCreationRequest {
|
|
|
3927
3892
|
existingLoanID?: string | null;
|
|
3928
3893
|
}
|
|
3929
3894
|
|
|
3895
|
+
export interface LosWebhook {
|
|
3896
|
+
/** @format uuid */
|
|
3897
|
+
id: string;
|
|
3898
|
+
endpoint: string;
|
|
3899
|
+
resource: string;
|
|
3900
|
+
events: string[];
|
|
3901
|
+
enableSubscription: boolean;
|
|
3902
|
+
}
|
|
3903
|
+
|
|
3930
3904
|
export interface MdmUser {
|
|
3931
3905
|
user_email?: string | null;
|
|
3932
3906
|
user_id?: string | null;
|
|
@@ -4572,7 +4546,7 @@ export interface SSOTokenRequest {
|
|
|
4572
4546
|
}
|
|
4573
4547
|
|
|
4574
4548
|
export interface SamlMetadataRequest {
|
|
4575
|
-
ssoIntegration:
|
|
4549
|
+
ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
|
|
4576
4550
|
}
|
|
4577
4551
|
|
|
4578
4552
|
export interface SendForgotPasswordRequest {
|
|
@@ -4611,7 +4585,7 @@ export interface SiteConfiguration {
|
|
|
4611
4585
|
deletedAt?: string | null;
|
|
4612
4586
|
/** @format uuid */
|
|
4613
4587
|
id: string;
|
|
4614
|
-
type:
|
|
4588
|
+
type: SiteConfigurationTypeEnum;
|
|
4615
4589
|
/** @format uuid */
|
|
4616
4590
|
entityID: string;
|
|
4617
4591
|
/** @format int32 */
|
|
@@ -4806,7 +4780,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4806
4780
|
deletedAt?: string | null;
|
|
4807
4781
|
/** @format uuid */
|
|
4808
4782
|
id: string;
|
|
4809
|
-
type:
|
|
4783
|
+
type: SiteConfigurationByUrlTypeEnum;
|
|
4810
4784
|
/** @format uuid */
|
|
4811
4785
|
entityID: string;
|
|
4812
4786
|
/** @format int32 */
|
|
@@ -5019,7 +4993,7 @@ export interface SiteConfigurationForm {
|
|
|
5019
4993
|
export interface SiteConfigurationReduced {
|
|
5020
4994
|
/** @format uuid */
|
|
5021
4995
|
id: string;
|
|
5022
|
-
type:
|
|
4996
|
+
type: SiteConfigurationReducedTypeEnum;
|
|
5023
4997
|
url?: string | null;
|
|
5024
4998
|
name: string;
|
|
5025
4999
|
/** @format int64 */
|
|
@@ -5037,7 +5011,7 @@ export interface SiteConfigurationRequest {
|
|
|
5037
5011
|
entityID: string;
|
|
5038
5012
|
/** @format int32 */
|
|
5039
5013
|
entityType: number;
|
|
5040
|
-
type:
|
|
5014
|
+
type: SiteConfigurationRequestTypeEnum;
|
|
5041
5015
|
url: string;
|
|
5042
5016
|
name: string;
|
|
5043
5017
|
introduction?: string | null;
|
|
@@ -5214,7 +5188,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5214
5188
|
export interface SiteConfigurationSummary {
|
|
5215
5189
|
/** @format uuid */
|
|
5216
5190
|
id: string;
|
|
5217
|
-
type:
|
|
5191
|
+
type: SiteConfigurationSummaryTypeEnum;
|
|
5218
5192
|
url?: string | null;
|
|
5219
5193
|
name: string;
|
|
5220
5194
|
/** @format int64 */
|
|
@@ -5842,19 +5816,7 @@ export interface UserDevice {
|
|
|
5842
5816
|
export interface UserDraft {
|
|
5843
5817
|
/** @format uuid */
|
|
5844
5818
|
draftID: string;
|
|
5845
|
-
role:
|
|
5846
|
-
| "Borrower"
|
|
5847
|
-
| "CoBorrower"
|
|
5848
|
-
| "NonBorrower"
|
|
5849
|
-
| "LoanOfficer"
|
|
5850
|
-
| "LoanProcessor"
|
|
5851
|
-
| "LoanOfficerAssistant"
|
|
5852
|
-
| "SupportingLoanOfficer"
|
|
5853
|
-
| "BuyerAgent"
|
|
5854
|
-
| "SellerAgent"
|
|
5855
|
-
| "TitleInsuranceAgent"
|
|
5856
|
-
| "EscrowAgent"
|
|
5857
|
-
| "SettlementAgent";
|
|
5819
|
+
role: UserDraftRoleEnum;
|
|
5858
5820
|
user: User;
|
|
5859
5821
|
}
|
|
5860
5822
|
|
|
@@ -5881,7 +5843,7 @@ export interface UserGroupAccessScope {
|
|
|
5881
5843
|
id: string;
|
|
5882
5844
|
/** @format uuid */
|
|
5883
5845
|
groupId: string;
|
|
5884
|
-
scopeType:
|
|
5846
|
+
scopeType: UserGroupAccessScopeScopeTypeEnum;
|
|
5885
5847
|
/** @format uuid */
|
|
5886
5848
|
userId?: string | null;
|
|
5887
5849
|
/** @format uuid */
|
|
@@ -5917,19 +5879,7 @@ export interface UserLoan {
|
|
|
5917
5879
|
deletedAt?: string | null;
|
|
5918
5880
|
loanID: string;
|
|
5919
5881
|
user: User;
|
|
5920
|
-
role:
|
|
5921
|
-
| "Borrower"
|
|
5922
|
-
| "CoBorrower"
|
|
5923
|
-
| "NonBorrower"
|
|
5924
|
-
| "LoanOfficer"
|
|
5925
|
-
| "LoanProcessor"
|
|
5926
|
-
| "LoanOfficerAssistant"
|
|
5927
|
-
| "SupportingLoanOfficer"
|
|
5928
|
-
| "BuyerAgent"
|
|
5929
|
-
| "SellerAgent"
|
|
5930
|
-
| "TitleInsuranceAgent"
|
|
5931
|
-
| "EscrowAgent"
|
|
5932
|
-
| "SettlementAgent";
|
|
5882
|
+
role: UserLoanRoleEnum;
|
|
5933
5883
|
/** @format int32 */
|
|
5934
5884
|
borrowerPair?: number | null;
|
|
5935
5885
|
/** @format int32 */
|
|
@@ -5942,10 +5892,10 @@ export interface UserLoanConsent {
|
|
|
5942
5892
|
id: string;
|
|
5943
5893
|
/** @format uuid */
|
|
5944
5894
|
userLoanID: string;
|
|
5945
|
-
type:
|
|
5895
|
+
type: UserLoanConsentTypeEnum;
|
|
5946
5896
|
providedConsent: boolean;
|
|
5947
5897
|
ipAddress?: string | null;
|
|
5948
|
-
losSyncStatus:
|
|
5898
|
+
losSyncStatus: UserLoanConsentLosSyncStatusEnum;
|
|
5949
5899
|
/** @format date-time */
|
|
5950
5900
|
createdAt: string;
|
|
5951
5901
|
}
|
|
@@ -5961,7 +5911,6 @@ export interface UserLoanTask {
|
|
|
5961
5911
|
value?: string | null;
|
|
5962
5912
|
documents: LoanDocument[];
|
|
5963
5913
|
loan: LoanIdentifier;
|
|
5964
|
-
/** @deprecated */
|
|
5965
5914
|
loanID: string;
|
|
5966
5915
|
/** @format date-time */
|
|
5967
5916
|
completedDate?: string | null;
|
|
@@ -5974,6 +5923,13 @@ export interface UserLoanTask {
|
|
|
5974
5923
|
commentsCount: number;
|
|
5975
5924
|
}
|
|
5976
5925
|
|
|
5926
|
+
export interface UserLoanTaskPaginated {
|
|
5927
|
+
rows: UserLoanTask[];
|
|
5928
|
+
pagination: Pagination;
|
|
5929
|
+
/** @format int64 */
|
|
5930
|
+
count: number;
|
|
5931
|
+
}
|
|
5932
|
+
|
|
5977
5933
|
export interface UserLoanTaskRequest {
|
|
5978
5934
|
value?: string | null;
|
|
5979
5935
|
/**
|
|
@@ -6090,16 +6046,7 @@ export interface UserSummary {
|
|
|
6090
6046
|
id: string;
|
|
6091
6047
|
name?: string | null;
|
|
6092
6048
|
email?: string | null;
|
|
6093
|
-
role:
|
|
6094
|
-
| "Borrower"
|
|
6095
|
-
| "LoanOfficer"
|
|
6096
|
-
| "Admin"
|
|
6097
|
-
| "SuperAdmin"
|
|
6098
|
-
| "Realtor"
|
|
6099
|
-
| "SettlementAgent"
|
|
6100
|
-
| "LoanProcessor"
|
|
6101
|
-
| "LoanOfficerAssistant"
|
|
6102
|
-
| "SystemAdmin";
|
|
6049
|
+
role: UserSummaryRoleEnum;
|
|
6103
6050
|
}
|
|
6104
6051
|
|
|
6105
6052
|
export interface VerifyPasswordRequest {
|
|
@@ -6135,6 +6082,361 @@ export interface Workflow {
|
|
|
6135
6082
|
icon: string;
|
|
6136
6083
|
}
|
|
6137
6084
|
|
|
6085
|
+
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6086
|
+
|
|
6087
|
+
export type AuditLogEntryChangeTypeEnum =
|
|
6088
|
+
| "Created"
|
|
6089
|
+
| "Modified"
|
|
6090
|
+
| "SoftDeleted"
|
|
6091
|
+
| "HardDeleted"
|
|
6092
|
+
| "Restored";
|
|
6093
|
+
|
|
6094
|
+
export type ConsumerConnectStatusRoleEnum =
|
|
6095
|
+
| "Borrower"
|
|
6096
|
+
| "CoBorrower"
|
|
6097
|
+
| "NonBorrower"
|
|
6098
|
+
| "LoanOfficer"
|
|
6099
|
+
| "LoanProcessor"
|
|
6100
|
+
| "LoanOfficerAssistant"
|
|
6101
|
+
| "SupportingLoanOfficer"
|
|
6102
|
+
| "BuyerAgent"
|
|
6103
|
+
| "SellerAgent"
|
|
6104
|
+
| "TitleInsuranceAgent"
|
|
6105
|
+
| "EscrowAgent"
|
|
6106
|
+
| "SettlementAgent";
|
|
6107
|
+
|
|
6108
|
+
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
6109
|
+
|
|
6110
|
+
export type CreateAccountRequestEnvironmentEnum =
|
|
6111
|
+
| "Development"
|
|
6112
|
+
| "Staging"
|
|
6113
|
+
| "UAT"
|
|
6114
|
+
| "Production";
|
|
6115
|
+
|
|
6116
|
+
export type CreateGroupMemberRequestLoanRoleEnum =
|
|
6117
|
+
| "Borrower"
|
|
6118
|
+
| "CoBorrower"
|
|
6119
|
+
| "NonBorrower"
|
|
6120
|
+
| "LoanOfficer"
|
|
6121
|
+
| "LoanProcessor"
|
|
6122
|
+
| "LoanOfficerAssistant"
|
|
6123
|
+
| "SupportingLoanOfficer"
|
|
6124
|
+
| "BuyerAgent"
|
|
6125
|
+
| "SellerAgent"
|
|
6126
|
+
| "TitleInsuranceAgent"
|
|
6127
|
+
| "EscrowAgent"
|
|
6128
|
+
| "SettlementAgent";
|
|
6129
|
+
|
|
6130
|
+
/** @deprecated */
|
|
6131
|
+
export type CreateInviteRequestRelationshipEnum =
|
|
6132
|
+
| "NotApplicable"
|
|
6133
|
+
| "Spouse"
|
|
6134
|
+
| "NonSpouse";
|
|
6135
|
+
|
|
6136
|
+
export type CreateLoanImportRequestImportModeEnum =
|
|
6137
|
+
| "All"
|
|
6138
|
+
| "NewOnly"
|
|
6139
|
+
| "UpdateOnly";
|
|
6140
|
+
|
|
6141
|
+
export type CreateUserDraftLoanRoleEnum =
|
|
6142
|
+
| "Borrower"
|
|
6143
|
+
| "CoBorrower"
|
|
6144
|
+
| "NonBorrower"
|
|
6145
|
+
| "LoanOfficer"
|
|
6146
|
+
| "LoanProcessor"
|
|
6147
|
+
| "LoanOfficerAssistant"
|
|
6148
|
+
| "SupportingLoanOfficer"
|
|
6149
|
+
| "BuyerAgent"
|
|
6150
|
+
| "SellerAgent"
|
|
6151
|
+
| "TitleInsuranceAgent"
|
|
6152
|
+
| "EscrowAgent"
|
|
6153
|
+
| "SettlementAgent";
|
|
6154
|
+
|
|
6155
|
+
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6156
|
+
|
|
6157
|
+
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6158
|
+
|
|
6159
|
+
export type EncompassCredentialsDetailSigningMethodEnum =
|
|
6160
|
+
| "ConsumerConnect"
|
|
6161
|
+
| "POSF";
|
|
6162
|
+
|
|
6163
|
+
export type EncompassCredentialsRequestSigningMethodEnum =
|
|
6164
|
+
| "ConsumerConnect"
|
|
6165
|
+
| "POSF";
|
|
6166
|
+
|
|
6167
|
+
export type EncompassRequestLogOperationTypeEnum =
|
|
6168
|
+
| "FieldUpdate"
|
|
6169
|
+
| "EConsentUpdate"
|
|
6170
|
+
| "DocumentSync"
|
|
6171
|
+
| "MilestoneUpdate"
|
|
6172
|
+
| "DocumentAttachment"
|
|
6173
|
+
| "General"
|
|
6174
|
+
| "FieldReader";
|
|
6175
|
+
|
|
6176
|
+
export type EncompassRequestLogOutcomeEnum =
|
|
6177
|
+
| "Success"
|
|
6178
|
+
| "Failure"
|
|
6179
|
+
| "PartialSuccess";
|
|
6180
|
+
|
|
6181
|
+
export type FusionReportFilterFilterTypeEnum =
|
|
6182
|
+
| "DateGreaterThanOrEqualTo"
|
|
6183
|
+
| "DateGreaterThan"
|
|
6184
|
+
| "DateLessThan"
|
|
6185
|
+
| "DateLessThanOrEqualTo"
|
|
6186
|
+
| "DateEquals"
|
|
6187
|
+
| "DateDoesntEqual"
|
|
6188
|
+
| "DateNonEmpty"
|
|
6189
|
+
| "DateEmpty"
|
|
6190
|
+
| "StringContains"
|
|
6191
|
+
| "StringEquals"
|
|
6192
|
+
| "StringNotEmpty"
|
|
6193
|
+
| "StringNotEquals"
|
|
6194
|
+
| "StringNotContains";
|
|
6195
|
+
|
|
6196
|
+
export type IpAddressAddressFamilyEnum =
|
|
6197
|
+
| "Unspecified"
|
|
6198
|
+
| "Unix"
|
|
6199
|
+
| "InterNetwork"
|
|
6200
|
+
| "ImpLink"
|
|
6201
|
+
| "Pup"
|
|
6202
|
+
| "Chaos"
|
|
6203
|
+
| "NS"
|
|
6204
|
+
| "Ipx"
|
|
6205
|
+
| "Iso"
|
|
6206
|
+
| "Osi"
|
|
6207
|
+
| "Ecma"
|
|
6208
|
+
| "DataKit"
|
|
6209
|
+
| "Ccitt"
|
|
6210
|
+
| "Sna"
|
|
6211
|
+
| "DecNet"
|
|
6212
|
+
| "DataLink"
|
|
6213
|
+
| "Lat"
|
|
6214
|
+
| "HyperChannel"
|
|
6215
|
+
| "AppleTalk"
|
|
6216
|
+
| "NetBios"
|
|
6217
|
+
| "VoiceView"
|
|
6218
|
+
| "FireFox"
|
|
6219
|
+
| "Banyan"
|
|
6220
|
+
| "Atm"
|
|
6221
|
+
| "InterNetworkV6"
|
|
6222
|
+
| "Cluster"
|
|
6223
|
+
| "Ieee12844"
|
|
6224
|
+
| "Irda"
|
|
6225
|
+
| "NetworkDesigners"
|
|
6226
|
+
| "Max"
|
|
6227
|
+
| "Packet"
|
|
6228
|
+
| "ControllerAreaNetwork"
|
|
6229
|
+
| "Unknown";
|
|
6230
|
+
|
|
6231
|
+
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6232
|
+
|
|
6233
|
+
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6234
|
+
|
|
6235
|
+
export type LoanContactRoleEnum =
|
|
6236
|
+
| "Borrower"
|
|
6237
|
+
| "CoBorrower"
|
|
6238
|
+
| "NonBorrower"
|
|
6239
|
+
| "LoanOfficer"
|
|
6240
|
+
| "LoanProcessor"
|
|
6241
|
+
| "LoanOfficerAssistant"
|
|
6242
|
+
| "SupportingLoanOfficer"
|
|
6243
|
+
| "BuyerAgent"
|
|
6244
|
+
| "SellerAgent"
|
|
6245
|
+
| "TitleInsuranceAgent"
|
|
6246
|
+
| "EscrowAgent"
|
|
6247
|
+
| "SettlementAgent";
|
|
6248
|
+
|
|
6249
|
+
export type LoanImportStatusEnum =
|
|
6250
|
+
| "WaitingProcess"
|
|
6251
|
+
| "InProgress"
|
|
6252
|
+
| "Completed"
|
|
6253
|
+
| "Failed"
|
|
6254
|
+
| "Cancelled";
|
|
6255
|
+
|
|
6256
|
+
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6257
|
+
|
|
6258
|
+
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6259
|
+
|
|
6260
|
+
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6261
|
+
|
|
6262
|
+
export type LoanLogTypeEnum =
|
|
6263
|
+
| "Loan"
|
|
6264
|
+
| "Queue"
|
|
6265
|
+
| "POSFlagChanged"
|
|
6266
|
+
| "Verification"
|
|
6267
|
+
| "DocumentUploaded"
|
|
6268
|
+
| "LoanCreated"
|
|
6269
|
+
| "WorkflowSubmitted"
|
|
6270
|
+
| "UserInvitationSent"
|
|
6271
|
+
| "CoBorrowerAdded"
|
|
6272
|
+
| "TaskCompleted"
|
|
6273
|
+
| "LoanStatusChanged"
|
|
6274
|
+
| "EConsent"
|
|
6275
|
+
| "SensitiveDataPurge"
|
|
6276
|
+
| "ClosingDateUpdated"
|
|
6277
|
+
| "ConsumerConnectAssociation";
|
|
6278
|
+
|
|
6279
|
+
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6280
|
+
|
|
6281
|
+
export type LoanLogDetailTypeEnum =
|
|
6282
|
+
| "Loan"
|
|
6283
|
+
| "Queue"
|
|
6284
|
+
| "POSFlagChanged"
|
|
6285
|
+
| "Verification"
|
|
6286
|
+
| "DocumentUploaded"
|
|
6287
|
+
| "LoanCreated"
|
|
6288
|
+
| "WorkflowSubmitted"
|
|
6289
|
+
| "UserInvitationSent"
|
|
6290
|
+
| "CoBorrowerAdded"
|
|
6291
|
+
| "TaskCompleted"
|
|
6292
|
+
| "LoanStatusChanged"
|
|
6293
|
+
| "EConsent"
|
|
6294
|
+
| "SensitiveDataPurge"
|
|
6295
|
+
| "ClosingDateUpdated"
|
|
6296
|
+
| "ConsumerConnectAssociation";
|
|
6297
|
+
|
|
6298
|
+
export type LoanUserLoanRoleEnum =
|
|
6299
|
+
| "Borrower"
|
|
6300
|
+
| "CoBorrower"
|
|
6301
|
+
| "NonBorrower"
|
|
6302
|
+
| "LoanOfficer"
|
|
6303
|
+
| "LoanProcessor"
|
|
6304
|
+
| "LoanOfficerAssistant"
|
|
6305
|
+
| "SupportingLoanOfficer"
|
|
6306
|
+
| "BuyerAgent"
|
|
6307
|
+
| "SellerAgent"
|
|
6308
|
+
| "TitleInsuranceAgent"
|
|
6309
|
+
| "EscrowAgent"
|
|
6310
|
+
| "SettlementAgent";
|
|
6311
|
+
|
|
6312
|
+
export type SamlMetadataRequestSsoIntegrationEnum =
|
|
6313
|
+
| "ConsumerConnect"
|
|
6314
|
+
| "TheBigPOS"
|
|
6315
|
+
| "POSF";
|
|
6316
|
+
|
|
6317
|
+
export type SiteConfigurationTypeEnum =
|
|
6318
|
+
| "None"
|
|
6319
|
+
| "Account"
|
|
6320
|
+
| "Corporate"
|
|
6321
|
+
| "Branch"
|
|
6322
|
+
| "LoanOfficer"
|
|
6323
|
+
| "Partner";
|
|
6324
|
+
|
|
6325
|
+
export type SiteConfigurationByUrlTypeEnum =
|
|
6326
|
+
| "None"
|
|
6327
|
+
| "Account"
|
|
6328
|
+
| "Corporate"
|
|
6329
|
+
| "Branch"
|
|
6330
|
+
| "LoanOfficer"
|
|
6331
|
+
| "Partner";
|
|
6332
|
+
|
|
6333
|
+
export type SiteConfigurationReducedTypeEnum =
|
|
6334
|
+
| "None"
|
|
6335
|
+
| "Account"
|
|
6336
|
+
| "Corporate"
|
|
6337
|
+
| "Branch"
|
|
6338
|
+
| "LoanOfficer"
|
|
6339
|
+
| "Partner";
|
|
6340
|
+
|
|
6341
|
+
export type SiteConfigurationRequestTypeEnum =
|
|
6342
|
+
| "None"
|
|
6343
|
+
| "Account"
|
|
6344
|
+
| "Corporate"
|
|
6345
|
+
| "Branch"
|
|
6346
|
+
| "LoanOfficer"
|
|
6347
|
+
| "Partner";
|
|
6348
|
+
|
|
6349
|
+
export type SiteConfigurationSummaryTypeEnum =
|
|
6350
|
+
| "None"
|
|
6351
|
+
| "Account"
|
|
6352
|
+
| "Corporate"
|
|
6353
|
+
| "Branch"
|
|
6354
|
+
| "LoanOfficer"
|
|
6355
|
+
| "Partner";
|
|
6356
|
+
|
|
6357
|
+
export type UserDraftRoleEnum =
|
|
6358
|
+
| "Borrower"
|
|
6359
|
+
| "CoBorrower"
|
|
6360
|
+
| "NonBorrower"
|
|
6361
|
+
| "LoanOfficer"
|
|
6362
|
+
| "LoanProcessor"
|
|
6363
|
+
| "LoanOfficerAssistant"
|
|
6364
|
+
| "SupportingLoanOfficer"
|
|
6365
|
+
| "BuyerAgent"
|
|
6366
|
+
| "SellerAgent"
|
|
6367
|
+
| "TitleInsuranceAgent"
|
|
6368
|
+
| "EscrowAgent"
|
|
6369
|
+
| "SettlementAgent";
|
|
6370
|
+
|
|
6371
|
+
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6372
|
+
|
|
6373
|
+
export type UserLoanRoleEnum =
|
|
6374
|
+
| "Borrower"
|
|
6375
|
+
| "CoBorrower"
|
|
6376
|
+
| "NonBorrower"
|
|
6377
|
+
| "LoanOfficer"
|
|
6378
|
+
| "LoanProcessor"
|
|
6379
|
+
| "LoanOfficerAssistant"
|
|
6380
|
+
| "SupportingLoanOfficer"
|
|
6381
|
+
| "BuyerAgent"
|
|
6382
|
+
| "SellerAgent"
|
|
6383
|
+
| "TitleInsuranceAgent"
|
|
6384
|
+
| "EscrowAgent"
|
|
6385
|
+
| "SettlementAgent";
|
|
6386
|
+
|
|
6387
|
+
export type UserLoanConsentTypeEnum =
|
|
6388
|
+
| "Econsent"
|
|
6389
|
+
| "CreditAuthorization"
|
|
6390
|
+
| "Tcpa";
|
|
6391
|
+
|
|
6392
|
+
export type UserLoanConsentLosSyncStatusEnum =
|
|
6393
|
+
| "NotStarted"
|
|
6394
|
+
| "Failed"
|
|
6395
|
+
| "Success";
|
|
6396
|
+
|
|
6397
|
+
export type UserSummaryRoleEnum =
|
|
6398
|
+
| "Borrower"
|
|
6399
|
+
| "LoanOfficer"
|
|
6400
|
+
| "Admin"
|
|
6401
|
+
| "SuperAdmin"
|
|
6402
|
+
| "Realtor"
|
|
6403
|
+
| "SettlementAgent"
|
|
6404
|
+
| "LoanProcessor"
|
|
6405
|
+
| "LoanOfficerAssistant"
|
|
6406
|
+
| "SystemAdmin";
|
|
6407
|
+
|
|
6408
|
+
/** @default "Realtor" */
|
|
6409
|
+
export type GetPartnersParamsRoleEnum =
|
|
6410
|
+
| "Borrower"
|
|
6411
|
+
| "LoanOfficer"
|
|
6412
|
+
| "Admin"
|
|
6413
|
+
| "SuperAdmin"
|
|
6414
|
+
| "Realtor"
|
|
6415
|
+
| "SettlementAgent"
|
|
6416
|
+
| "LoanProcessor"
|
|
6417
|
+
| "LoanOfficerAssistant"
|
|
6418
|
+
| "SystemAdmin";
|
|
6419
|
+
|
|
6420
|
+
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
6421
|
+
| "ConsumerConnect"
|
|
6422
|
+
| "TheBigPOS"
|
|
6423
|
+
| "POSF";
|
|
6424
|
+
|
|
6425
|
+
export type GetSamlMetadataParamsEnum =
|
|
6426
|
+
| "ConsumerConnect"
|
|
6427
|
+
| "TheBigPOS"
|
|
6428
|
+
| "POSF";
|
|
6429
|
+
|
|
6430
|
+
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
|
|
6431
|
+
| "ConsumerConnect"
|
|
6432
|
+
| "TheBigPOS"
|
|
6433
|
+
| "POSF";
|
|
6434
|
+
|
|
6435
|
+
export type CreateOrReplaceSamlMetadataParamsEnum =
|
|
6436
|
+
| "ConsumerConnect"
|
|
6437
|
+
| "TheBigPOS"
|
|
6438
|
+
| "POSF";
|
|
6439
|
+
|
|
6138
6440
|
import type {
|
|
6139
6441
|
AxiosInstance,
|
|
6140
6442
|
AxiosRequestConfig,
|
|
@@ -6313,7 +6615,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
6313
6615
|
|
|
6314
6616
|
/**
|
|
6315
6617
|
* @title The Big POS API
|
|
6316
|
-
* @version v2.38.
|
|
6618
|
+
* @version v2.38.1
|
|
6317
6619
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6318
6620
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6319
6621
|
*/
|
|
@@ -6595,6 +6897,25 @@ export class Api<
|
|
|
6595
6897
|
...params,
|
|
6596
6898
|
}),
|
|
6597
6899
|
|
|
6900
|
+
/**
|
|
6901
|
+
* No description
|
|
6902
|
+
*
|
|
6903
|
+
* @tags AuditLog
|
|
6904
|
+
* @name GetAuditLogEntityTypes
|
|
6905
|
+
* @summary Get entity types
|
|
6906
|
+
* @request GET:/api/audit-logs/entity-types
|
|
6907
|
+
* @secure
|
|
6908
|
+
* @response `200` `(AuditEntityType)[]` Success
|
|
6909
|
+
*/
|
|
6910
|
+
getAuditLogEntityTypes: (params: RequestParams = {}) =>
|
|
6911
|
+
this.request<AuditEntityType[], any>({
|
|
6912
|
+
path: `/api/audit-logs/entity-types`,
|
|
6913
|
+
method: "GET",
|
|
6914
|
+
secure: true,
|
|
6915
|
+
format: "json",
|
|
6916
|
+
...params,
|
|
6917
|
+
}),
|
|
6918
|
+
|
|
6598
6919
|
/**
|
|
6599
6920
|
* No description
|
|
6600
6921
|
*
|
|
@@ -7175,6 +7496,47 @@ export class Api<
|
|
|
7175
7496
|
...params,
|
|
7176
7497
|
}),
|
|
7177
7498
|
|
|
7499
|
+
/**
|
|
7500
|
+
* No description
|
|
7501
|
+
*
|
|
7502
|
+
* @tags ConsumerConnect
|
|
7503
|
+
* @name GetConsumerConnectStatus
|
|
7504
|
+
* @summary Get Consumer Connect association status for all borrowers on a loan
|
|
7505
|
+
* @request GET:/api/loans/{loanId}/consumer-connect/status
|
|
7506
|
+
* @secure
|
|
7507
|
+
* @response `200` `(ConsumerConnectStatus)[]` Success
|
|
7508
|
+
*/
|
|
7509
|
+
getConsumerConnectStatus: (loanId: string, params: RequestParams = {}) =>
|
|
7510
|
+
this.request<ConsumerConnectStatus[], any>({
|
|
7511
|
+
path: `/api/loans/${loanId}/consumer-connect/status`,
|
|
7512
|
+
method: "GET",
|
|
7513
|
+
secure: true,
|
|
7514
|
+
format: "json",
|
|
7515
|
+
...params,
|
|
7516
|
+
}),
|
|
7517
|
+
|
|
7518
|
+
/**
|
|
7519
|
+
* No description
|
|
7520
|
+
*
|
|
7521
|
+
* @tags ConsumerConnect
|
|
7522
|
+
* @name RetryConsumerConnectAssociation
|
|
7523
|
+
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
|
|
7524
|
+
* @request POST:/api/loans/{loanId}/consumer-connect/retry
|
|
7525
|
+
* @secure
|
|
7526
|
+
* @response `200` `(ConsumerConnectRetry)[]` Success
|
|
7527
|
+
*/
|
|
7528
|
+
retryConsumerConnectAssociation: (
|
|
7529
|
+
loanId: string,
|
|
7530
|
+
params: RequestParams = {},
|
|
7531
|
+
) =>
|
|
7532
|
+
this.request<ConsumerConnectRetry[], any>({
|
|
7533
|
+
path: `/api/loans/${loanId}/consumer-connect/retry`,
|
|
7534
|
+
method: "POST",
|
|
7535
|
+
secure: true,
|
|
7536
|
+
format: "json",
|
|
7537
|
+
...params,
|
|
7538
|
+
}),
|
|
7539
|
+
|
|
7178
7540
|
/**
|
|
7179
7541
|
* No description
|
|
7180
7542
|
*
|
|
@@ -8665,7 +9027,7 @@ export class Api<
|
|
|
8665
9027
|
method: "POST",
|
|
8666
9028
|
body: data,
|
|
8667
9029
|
secure: true,
|
|
8668
|
-
type: ContentType.
|
|
9030
|
+
type: ContentType.Json,
|
|
8669
9031
|
format: "json",
|
|
8670
9032
|
...params,
|
|
8671
9033
|
}),
|
|
@@ -8938,7 +9300,7 @@ export class Api<
|
|
|
8938
9300
|
method: "POST",
|
|
8939
9301
|
body: data,
|
|
8940
9302
|
secure: true,
|
|
8941
|
-
type: ContentType.
|
|
9303
|
+
type: ContentType.Json,
|
|
8942
9304
|
format: "json",
|
|
8943
9305
|
...params,
|
|
8944
9306
|
}),
|
|
@@ -9177,7 +9539,7 @@ export class Api<
|
|
|
9177
9539
|
method: "POST",
|
|
9178
9540
|
body: data,
|
|
9179
9541
|
secure: true,
|
|
9180
|
-
type: ContentType.
|
|
9542
|
+
type: ContentType.Json,
|
|
9181
9543
|
format: "json",
|
|
9182
9544
|
...params,
|
|
9183
9545
|
}),
|
|
@@ -9646,7 +10008,7 @@ export class Api<
|
|
|
9646
10008
|
* @summary Download By ID
|
|
9647
10009
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
9648
10010
|
* @secure
|
|
9649
|
-
* @response `200` `
|
|
10011
|
+
* @response `200` `Blob` Success
|
|
9650
10012
|
* @response `404` `ProblemDetails` Not Found
|
|
9651
10013
|
*/
|
|
9652
10014
|
downloadLoanDocument: (
|
|
@@ -9654,7 +10016,7 @@ export class Api<
|
|
|
9654
10016
|
documentId: string,
|
|
9655
10017
|
params: RequestParams = {},
|
|
9656
10018
|
) =>
|
|
9657
|
-
this.request<
|
|
10019
|
+
this.request<Blob, ProblemDetails>({
|
|
9658
10020
|
path: `/api/loans/${loanId}/documents/${documentId}/download`,
|
|
9659
10021
|
method: "GET",
|
|
9660
10022
|
secure: true,
|
|
@@ -10749,7 +11111,7 @@ export class Api<
|
|
|
10749
11111
|
method: "POST",
|
|
10750
11112
|
body: data,
|
|
10751
11113
|
secure: true,
|
|
10752
|
-
type: ContentType.
|
|
11114
|
+
type: ContentType.Json,
|
|
10753
11115
|
format: "json",
|
|
10754
11116
|
...params,
|
|
10755
11117
|
}),
|
|
@@ -10886,9 +11248,42 @@ export class Api<
|
|
|
10886
11248
|
}),
|
|
10887
11249
|
|
|
10888
11250
|
/**
|
|
10889
|
-
*
|
|
11251
|
+
* @description Search tasks across all loans
|
|
10890
11252
|
*
|
|
10891
11253
|
* @tags LoanTasks
|
|
11254
|
+
* @name SearchLoanTasks
|
|
11255
|
+
* @summary Search
|
|
11256
|
+
* @request POST:/api/loans/tasks/search
|
|
11257
|
+
* @secure
|
|
11258
|
+
* @response `200` `UserLoanTaskPaginated` Success
|
|
11259
|
+
*/
|
|
11260
|
+
searchLoanTasks: (
|
|
11261
|
+
data: LoanTaskSearchRequest,
|
|
11262
|
+
query?: {
|
|
11263
|
+
/** @format int32 */
|
|
11264
|
+
pageSize?: number;
|
|
11265
|
+
/** @format int32 */
|
|
11266
|
+
pageNumber?: number;
|
|
11267
|
+
sortBy?: string;
|
|
11268
|
+
sortDirection?: string;
|
|
11269
|
+
},
|
|
11270
|
+
params: RequestParams = {},
|
|
11271
|
+
) =>
|
|
11272
|
+
this.request<UserLoanTaskPaginated, any>({
|
|
11273
|
+
path: `/api/loans/tasks/search`,
|
|
11274
|
+
method: "POST",
|
|
11275
|
+
query: query,
|
|
11276
|
+
body: data,
|
|
11277
|
+
secure: true,
|
|
11278
|
+
type: ContentType.Json,
|
|
11279
|
+
format: "json",
|
|
11280
|
+
...params,
|
|
11281
|
+
}),
|
|
11282
|
+
|
|
11283
|
+
/**
|
|
11284
|
+
* No description
|
|
11285
|
+
*
|
|
11286
|
+
* @tags LoanTasksForSingleLoan
|
|
10892
11287
|
* @name GetLoanTasks
|
|
10893
11288
|
* @summary Get All
|
|
10894
11289
|
* @request GET:/api/loans/{loanID}/tasks
|
|
@@ -10908,7 +11303,7 @@ export class Api<
|
|
|
10908
11303
|
/**
|
|
10909
11304
|
* No description
|
|
10910
11305
|
*
|
|
10911
|
-
* @tags
|
|
11306
|
+
* @tags LoanTasksForSingleLoan
|
|
10912
11307
|
* @name GetLoanTask
|
|
10913
11308
|
* @summary Get by ID
|
|
10914
11309
|
* @request GET:/api/loans/{loanID}/tasks/{id}
|
|
@@ -10928,7 +11323,7 @@ export class Api<
|
|
|
10928
11323
|
/**
|
|
10929
11324
|
* @description Get the difference between the current loan tasks and the tasks generated by business rules
|
|
10930
11325
|
*
|
|
10931
|
-
* @tags
|
|
11326
|
+
* @tags LoanTasksForSingleLoan
|
|
10932
11327
|
* @name GetLoanTaskDifference
|
|
10933
11328
|
* @summary Get Difference
|
|
10934
11329
|
* @request GET:/api/loans/{loanID}/tasks/diff
|
|
@@ -10948,7 +11343,7 @@ export class Api<
|
|
|
10948
11343
|
/**
|
|
10949
11344
|
* No description
|
|
10950
11345
|
*
|
|
10951
|
-
* @tags
|
|
11346
|
+
* @tags LoanTasksForSingleLoan
|
|
10952
11347
|
* @name CreateLoanTask
|
|
10953
11348
|
* @summary Create
|
|
10954
11349
|
* @request POST:/api/loans/{loanID}/tasks/{taskID}
|
|
@@ -10975,7 +11370,7 @@ export class Api<
|
|
|
10975
11370
|
/**
|
|
10976
11371
|
* No description
|
|
10977
11372
|
*
|
|
10978
|
-
* @tags
|
|
11373
|
+
* @tags LoanTasksForSingleLoan
|
|
10979
11374
|
* @name ImportLoanTask
|
|
10980
11375
|
* @summary Import
|
|
10981
11376
|
* @request POST:/api/loans/{loanID}/tasks/import
|
|
@@ -11001,7 +11396,7 @@ export class Api<
|
|
|
11001
11396
|
/**
|
|
11002
11397
|
* No description
|
|
11003
11398
|
*
|
|
11004
|
-
* @tags
|
|
11399
|
+
* @tags LoanTasksForSingleLoan
|
|
11005
11400
|
* @name ReplaceLoanTask
|
|
11006
11401
|
* @summary Replace
|
|
11007
11402
|
* @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -11028,7 +11423,7 @@ export class Api<
|
|
|
11028
11423
|
/**
|
|
11029
11424
|
* No description
|
|
11030
11425
|
*
|
|
11031
|
-
* @tags
|
|
11426
|
+
* @tags LoanTasksForSingleLoan
|
|
11032
11427
|
* @name DeleteLoanTask
|
|
11033
11428
|
* @summary Delete
|
|
11034
11429
|
* @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -11742,16 +12137,7 @@ export class Api<
|
|
|
11742
12137
|
query?: {
|
|
11743
12138
|
showAll?: boolean;
|
|
11744
12139
|
/** @default "Realtor" */
|
|
11745
|
-
role?:
|
|
11746
|
-
| "Borrower"
|
|
11747
|
-
| "LoanOfficer"
|
|
11748
|
-
| "Admin"
|
|
11749
|
-
| "SuperAdmin"
|
|
11750
|
-
| "Realtor"
|
|
11751
|
-
| "SettlementAgent"
|
|
11752
|
-
| "LoanProcessor"
|
|
11753
|
-
| "LoanOfficerAssistant"
|
|
11754
|
-
| "SystemAdmin";
|
|
12140
|
+
role?: GetPartnersParamsRoleEnum;
|
|
11755
12141
|
/** @format int32 */
|
|
11756
12142
|
pageSize?: number;
|
|
11757
12143
|
/** @format int32 */
|
|
@@ -12087,7 +12473,7 @@ export class Api<
|
|
|
12087
12473
|
* @response `404` `ProblemDetails` Not Found
|
|
12088
12474
|
*/
|
|
12089
12475
|
getSamlMetadata: (
|
|
12090
|
-
sSoIntegration:
|
|
12476
|
+
sSoIntegration: GetSamlMetadataParamsEnum,
|
|
12091
12477
|
ssoIntegration: string,
|
|
12092
12478
|
params: RequestParams = {},
|
|
12093
12479
|
) =>
|
|
@@ -12109,7 +12495,7 @@ export class Api<
|
|
|
12109
12495
|
* @response `200` `File` Success
|
|
12110
12496
|
*/
|
|
12111
12497
|
createOrReplaceSamlMetadata: (
|
|
12112
|
-
sSoIntegration:
|
|
12498
|
+
sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
|
|
12113
12499
|
ssoIntegration: string,
|
|
12114
12500
|
params: RequestParams = {},
|
|
12115
12501
|
) =>
|
|
@@ -12487,6 +12873,129 @@ export class Api<
|
|
|
12487
12873
|
...params,
|
|
12488
12874
|
}),
|
|
12489
12875
|
|
|
12876
|
+
/**
|
|
12877
|
+
* No description
|
|
12878
|
+
*
|
|
12879
|
+
* @tags TheBigPOS
|
|
12880
|
+
* @name GetEncompassCredentials
|
|
12881
|
+
* @request GET:/api/los/encompass/credentials
|
|
12882
|
+
* @secure
|
|
12883
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
12884
|
+
* @response `204` `void` No Content
|
|
12885
|
+
*/
|
|
12886
|
+
getEncompassCredentials: (params: RequestParams = {}) =>
|
|
12887
|
+
this.request<EncompassCredentialsDetail, any>({
|
|
12888
|
+
path: `/api/los/encompass/credentials`,
|
|
12889
|
+
method: "GET",
|
|
12890
|
+
secure: true,
|
|
12891
|
+
format: "json",
|
|
12892
|
+
...params,
|
|
12893
|
+
}),
|
|
12894
|
+
|
|
12895
|
+
/**
|
|
12896
|
+
* No description
|
|
12897
|
+
*
|
|
12898
|
+
* @tags TheBigPOS
|
|
12899
|
+
* @name CreateEncompassCredentials
|
|
12900
|
+
* @request POST:/api/los/encompass/credentials
|
|
12901
|
+
* @secure
|
|
12902
|
+
* @response `201` `LosCredentials` Created
|
|
12903
|
+
*/
|
|
12904
|
+
createEncompassCredentials: (
|
|
12905
|
+
data: EncompassCredentialsRequest,
|
|
12906
|
+
params: RequestParams = {},
|
|
12907
|
+
) =>
|
|
12908
|
+
this.request<LosCredentials, any>({
|
|
12909
|
+
path: `/api/los/encompass/credentials`,
|
|
12910
|
+
method: "POST",
|
|
12911
|
+
body: data,
|
|
12912
|
+
secure: true,
|
|
12913
|
+
type: ContentType.Json,
|
|
12914
|
+
format: "json",
|
|
12915
|
+
...params,
|
|
12916
|
+
}),
|
|
12917
|
+
|
|
12918
|
+
/**
|
|
12919
|
+
* No description
|
|
12920
|
+
*
|
|
12921
|
+
* @tags TheBigPOS
|
|
12922
|
+
* @name UpdateEncompassCredentials
|
|
12923
|
+
* @request PUT:/api/los/encompass/credentials
|
|
12924
|
+
* @secure
|
|
12925
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
12926
|
+
*/
|
|
12927
|
+
updateEncompassCredentials: (
|
|
12928
|
+
data: EncompassCredentialsRequest,
|
|
12929
|
+
params: RequestParams = {},
|
|
12930
|
+
) =>
|
|
12931
|
+
this.request<EncompassCredentialsDetail, any>({
|
|
12932
|
+
path: `/api/los/encompass/credentials`,
|
|
12933
|
+
method: "PUT",
|
|
12934
|
+
body: data,
|
|
12935
|
+
secure: true,
|
|
12936
|
+
type: ContentType.Json,
|
|
12937
|
+
format: "json",
|
|
12938
|
+
...params,
|
|
12939
|
+
}),
|
|
12940
|
+
|
|
12941
|
+
/**
|
|
12942
|
+
* No description
|
|
12943
|
+
*
|
|
12944
|
+
* @tags TheBigPOS
|
|
12945
|
+
* @name GetEncompassWebhooks
|
|
12946
|
+
* @request GET:/api/los/encompass/webhooks
|
|
12947
|
+
* @secure
|
|
12948
|
+
* @response `200` `(LosWebhook)[]` Success
|
|
12949
|
+
*/
|
|
12950
|
+
getEncompassWebhooks: (params: RequestParams = {}) =>
|
|
12951
|
+
this.request<LosWebhook[], any>({
|
|
12952
|
+
path: `/api/los/encompass/webhooks`,
|
|
12953
|
+
method: "GET",
|
|
12954
|
+
secure: true,
|
|
12955
|
+
format: "json",
|
|
12956
|
+
...params,
|
|
12957
|
+
}),
|
|
12958
|
+
|
|
12959
|
+
/**
|
|
12960
|
+
* No description
|
|
12961
|
+
*
|
|
12962
|
+
* @tags TheBigPOS
|
|
12963
|
+
* @name CreateEncompassWebhook
|
|
12964
|
+
* @request POST:/api/los/encompass/webhooks
|
|
12965
|
+
* @secure
|
|
12966
|
+
* @response `201` `LosWebhook` Created
|
|
12967
|
+
*/
|
|
12968
|
+
createEncompassWebhook: (
|
|
12969
|
+
data: CreateWebhookRequest,
|
|
12970
|
+
params: RequestParams = {},
|
|
12971
|
+
) =>
|
|
12972
|
+
this.request<LosWebhook, any>({
|
|
12973
|
+
path: `/api/los/encompass/webhooks`,
|
|
12974
|
+
method: "POST",
|
|
12975
|
+
body: data,
|
|
12976
|
+
secure: true,
|
|
12977
|
+
type: ContentType.Json,
|
|
12978
|
+
format: "json",
|
|
12979
|
+
...params,
|
|
12980
|
+
}),
|
|
12981
|
+
|
|
12982
|
+
/**
|
|
12983
|
+
* No description
|
|
12984
|
+
*
|
|
12985
|
+
* @tags TheBigPOS
|
|
12986
|
+
* @name DeleteEncompassWebhook
|
|
12987
|
+
* @request DELETE:/api/los/encompass/webhooks/{webhookId}
|
|
12988
|
+
* @secure
|
|
12989
|
+
* @response `204` `void` No Content
|
|
12990
|
+
*/
|
|
12991
|
+
deleteEncompassWebhook: (webhookId: string, params: RequestParams = {}) =>
|
|
12992
|
+
this.request<void, any>({
|
|
12993
|
+
path: `/api/los/encompass/webhooks/${webhookId}`,
|
|
12994
|
+
method: "DELETE",
|
|
12995
|
+
secure: true,
|
|
12996
|
+
...params,
|
|
12997
|
+
}),
|
|
12998
|
+
|
|
12490
12999
|
/**
|
|
12491
13000
|
* No description
|
|
12492
13001
|
*
|