@matech/thebigpos-sdk 2.38.0 → 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 -55
- 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 +752 -240
- package/tsconfig.json +27 -27
- package/.claude/settings.local.json +0 -12
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,6 +38,8 @@ export type SiteConfigurationType =
|
|
|
31
38
|
| "LoanOfficer"
|
|
32
39
|
| "Partner";
|
|
33
40
|
|
|
41
|
+
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
42
|
+
|
|
34
43
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
35
44
|
|
|
36
45
|
export type LogLevel = "None" | "Info" | "Warning" | "Error";
|
|
@@ -44,6 +53,8 @@ export type LoanTitleHeld =
|
|
|
44
53
|
| "JointWithSpouse"
|
|
45
54
|
| "JointWithOtherThanSpouse";
|
|
46
55
|
|
|
56
|
+
export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
|
|
57
|
+
|
|
47
58
|
export type LoanRole =
|
|
48
59
|
| "Borrower"
|
|
49
60
|
| "CoBorrower"
|
|
@@ -187,7 +198,8 @@ export type LoanLogType =
|
|
|
187
198
|
| "LoanStatusChanged"
|
|
188
199
|
| "EConsent"
|
|
189
200
|
| "SensitiveDataPurge"
|
|
190
|
-
| "ClosingDateUpdated"
|
|
201
|
+
| "ClosingDateUpdated"
|
|
202
|
+
| "ConsumerConnectAssociation";
|
|
191
203
|
|
|
192
204
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
193
205
|
|
|
@@ -328,6 +340,14 @@ export type EncompassLogOperationType =
|
|
|
328
340
|
|
|
329
341
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
330
342
|
|
|
343
|
+
export type ConsumerConnectAssociationStatus =
|
|
344
|
+
| "Legacy"
|
|
345
|
+
| "Pending"
|
|
346
|
+
| "Success"
|
|
347
|
+
| "Failed"
|
|
348
|
+
| "ConfigurationError"
|
|
349
|
+
| "PermanentFailure";
|
|
350
|
+
|
|
331
351
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
332
352
|
|
|
333
353
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
@@ -436,7 +456,7 @@ export interface AccountBilling {
|
|
|
436
456
|
}
|
|
437
457
|
|
|
438
458
|
export interface AccountBillingRequest {
|
|
439
|
-
billingType:
|
|
459
|
+
billingType: AccountBillingRequestBillingTypeEnum;
|
|
440
460
|
/**
|
|
441
461
|
* @format double
|
|
442
462
|
* @min 0
|
|
@@ -765,16 +785,16 @@ export interface Attachment {
|
|
|
765
785
|
base64Data: string;
|
|
766
786
|
}
|
|
767
787
|
|
|
788
|
+
export interface AuditEntityType {
|
|
789
|
+
entityType: string;
|
|
790
|
+
rootEntityType?: string | null;
|
|
791
|
+
}
|
|
792
|
+
|
|
768
793
|
export interface AuditLogEntry {
|
|
769
794
|
/** @format uuid */
|
|
770
795
|
id: string;
|
|
771
796
|
entityType: string;
|
|
772
|
-
changeType:
|
|
773
|
-
| "Created"
|
|
774
|
-
| "Modified"
|
|
775
|
-
| "SoftDeleted"
|
|
776
|
-
| "HardDeleted"
|
|
777
|
-
| "Restored";
|
|
797
|
+
changeType: AuditLogEntryChangeTypeEnum;
|
|
778
798
|
/** @format uuid */
|
|
779
799
|
entityId: string;
|
|
780
800
|
performedBy?: AuditLogUser | null;
|
|
@@ -804,9 +824,6 @@ export interface AuditLogSearchCriteria {
|
|
|
804
824
|
startDate?: string | null;
|
|
805
825
|
/** @format date-time */
|
|
806
826
|
endDate?: string | null;
|
|
807
|
-
rootEntityType?: string | null;
|
|
808
|
-
/** @format uuid */
|
|
809
|
-
rootEntityId?: string | null;
|
|
810
827
|
}
|
|
811
828
|
|
|
812
829
|
export interface AuditLogUser {
|
|
@@ -1011,6 +1028,30 @@ export interface ConditionComment {
|
|
|
1011
1028
|
createdByName: string;
|
|
1012
1029
|
}
|
|
1013
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
|
+
|
|
1014
1055
|
export interface ContactInfo {
|
|
1015
1056
|
phone: string;
|
|
1016
1057
|
tollFreePhone?: string | null;
|
|
@@ -1065,7 +1106,7 @@ export interface CorporateSearchCriteria {
|
|
|
1065
1106
|
}
|
|
1066
1107
|
|
|
1067
1108
|
export interface CreateAccessScopeRequest {
|
|
1068
|
-
scopeType:
|
|
1109
|
+
scopeType: CreateAccessScopeRequestScopeTypeEnum;
|
|
1069
1110
|
/** @format uuid */
|
|
1070
1111
|
userId?: string | null;
|
|
1071
1112
|
/** @format uuid */
|
|
@@ -1089,7 +1130,7 @@ export interface CreateAccountRequest {
|
|
|
1089
1130
|
*/
|
|
1090
1131
|
nlmsid: number;
|
|
1091
1132
|
settings: AccountSettingsRequest;
|
|
1092
|
-
environment:
|
|
1133
|
+
environment: CreateAccountRequestEnvironmentEnum;
|
|
1093
1134
|
losIntegration: LOSIntegration;
|
|
1094
1135
|
billingSettings: AccountBillingRequest;
|
|
1095
1136
|
}
|
|
@@ -1122,19 +1163,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1122
1163
|
export interface CreateGroupMemberRequest {
|
|
1123
1164
|
/** @format uuid */
|
|
1124
1165
|
userId: string;
|
|
1125
|
-
loanRole:
|
|
1126
|
-
| "Borrower"
|
|
1127
|
-
| "CoBorrower"
|
|
1128
|
-
| "NonBorrower"
|
|
1129
|
-
| "LoanOfficer"
|
|
1130
|
-
| "LoanProcessor"
|
|
1131
|
-
| "LoanOfficerAssistant"
|
|
1132
|
-
| "SupportingLoanOfficer"
|
|
1133
|
-
| "BuyerAgent"
|
|
1134
|
-
| "SellerAgent"
|
|
1135
|
-
| "TitleInsuranceAgent"
|
|
1136
|
-
| "EscrowAgent"
|
|
1137
|
-
| "SettlementAgent";
|
|
1166
|
+
loanRole: CreateGroupMemberRequestLoanRoleEnum;
|
|
1138
1167
|
}
|
|
1139
1168
|
|
|
1140
1169
|
export interface CreateInviteRequest {
|
|
@@ -1146,7 +1175,7 @@ export interface CreateInviteRequest {
|
|
|
1146
1175
|
emailAddress: string;
|
|
1147
1176
|
phoneNumber?: string | null;
|
|
1148
1177
|
/** @deprecated */
|
|
1149
|
-
relationship:
|
|
1178
|
+
relationship: CreateInviteRequestRelationshipEnum;
|
|
1150
1179
|
loanID: string;
|
|
1151
1180
|
route?: string | null;
|
|
1152
1181
|
/** @format uuid */
|
|
@@ -1169,7 +1198,7 @@ export interface CreateLoanImportRequest {
|
|
|
1169
1198
|
* @minLength 1
|
|
1170
1199
|
*/
|
|
1171
1200
|
startDate: string;
|
|
1172
|
-
importMode:
|
|
1201
|
+
importMode: CreateLoanImportRequestImportModeEnum;
|
|
1173
1202
|
}
|
|
1174
1203
|
|
|
1175
1204
|
export interface CreateSession {
|
|
@@ -1191,19 +1220,7 @@ export interface CreateUserDeviceRequest {
|
|
|
1191
1220
|
}
|
|
1192
1221
|
|
|
1193
1222
|
export interface CreateUserDraft {
|
|
1194
|
-
loanRole:
|
|
1195
|
-
| "Borrower"
|
|
1196
|
-
| "CoBorrower"
|
|
1197
|
-
| "NonBorrower"
|
|
1198
|
-
| "LoanOfficer"
|
|
1199
|
-
| "LoanProcessor"
|
|
1200
|
-
| "LoanOfficerAssistant"
|
|
1201
|
-
| "SupportingLoanOfficer"
|
|
1202
|
-
| "BuyerAgent"
|
|
1203
|
-
| "SellerAgent"
|
|
1204
|
-
| "TitleInsuranceAgent"
|
|
1205
|
-
| "EscrowAgent"
|
|
1206
|
-
| "SettlementAgent";
|
|
1223
|
+
loanRole: CreateUserDraftLoanRoleEnum;
|
|
1207
1224
|
}
|
|
1208
1225
|
|
|
1209
1226
|
export interface CreateUserGroupRequest {
|
|
@@ -1260,6 +1277,10 @@ export interface CreateUserRequest {
|
|
|
1260
1277
|
isInternal?: boolean | null;
|
|
1261
1278
|
}
|
|
1262
1279
|
|
|
1280
|
+
export interface CreateWebhookRequest {
|
|
1281
|
+
webhookPath: string;
|
|
1282
|
+
}
|
|
1283
|
+
|
|
1263
1284
|
export interface CustomLoanData {
|
|
1264
1285
|
eConsentInformation?: EConsentInformation | null;
|
|
1265
1286
|
}
|
|
@@ -1521,7 +1542,7 @@ export interface Draft {
|
|
|
1521
1542
|
siteConfiguration: SiteConfigurationReduced;
|
|
1522
1543
|
/** @format uuid */
|
|
1523
1544
|
loanID?: string | null;
|
|
1524
|
-
type:
|
|
1545
|
+
type: DraftTypeEnum;
|
|
1525
1546
|
isCoBorrower: boolean;
|
|
1526
1547
|
}
|
|
1527
1548
|
|
|
@@ -1540,7 +1561,7 @@ export interface DraftContent {
|
|
|
1540
1561
|
siteConfiguration: SiteConfigurationReduced;
|
|
1541
1562
|
/** @format uuid */
|
|
1542
1563
|
loanID?: string | null;
|
|
1543
|
-
type:
|
|
1564
|
+
type: DraftContentTypeEnum;
|
|
1544
1565
|
isCoBorrower: boolean;
|
|
1545
1566
|
applicationPayload: any;
|
|
1546
1567
|
}
|
|
@@ -1627,6 +1648,42 @@ export interface EncompassContact {
|
|
|
1627
1648
|
company?: string | null;
|
|
1628
1649
|
}
|
|
1629
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
|
+
|
|
1630
1687
|
export interface EncompassError {
|
|
1631
1688
|
errorCode: string;
|
|
1632
1689
|
message: string;
|
|
@@ -1682,15 +1739,8 @@ export interface EncompassRequestLog {
|
|
|
1682
1739
|
losId?: string | null;
|
|
1683
1740
|
/** @format uuid */
|
|
1684
1741
|
accountId: string;
|
|
1685
|
-
operationType:
|
|
1686
|
-
|
|
1687
|
-
| "EConsentUpdate"
|
|
1688
|
-
| "DocumentSync"
|
|
1689
|
-
| "MilestoneUpdate"
|
|
1690
|
-
| "DocumentAttachment"
|
|
1691
|
-
| "General"
|
|
1692
|
-
| "FieldReader";
|
|
1693
|
-
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1742
|
+
operationType: EncompassRequestLogOperationTypeEnum;
|
|
1743
|
+
outcome: EncompassRequestLogOutcomeEnum;
|
|
1694
1744
|
message: string;
|
|
1695
1745
|
endpoint?: string | null;
|
|
1696
1746
|
httpMethod?: string | null;
|
|
@@ -1748,7 +1798,7 @@ export interface FileSearchCriteria {
|
|
|
1748
1798
|
export interface FileWithBytes {
|
|
1749
1799
|
name: string;
|
|
1750
1800
|
/** @format byte */
|
|
1751
|
-
data:
|
|
1801
|
+
data: Blob;
|
|
1752
1802
|
fileName: string;
|
|
1753
1803
|
mimeType?: string | null;
|
|
1754
1804
|
extension?: string | null;
|
|
@@ -1927,20 +1977,7 @@ export interface FusionFieldDisplay {
|
|
|
1927
1977
|
}
|
|
1928
1978
|
|
|
1929
1979
|
export interface FusionReportFilter {
|
|
1930
|
-
filterType:
|
|
1931
|
-
| "DateGreaterThanOrEqualTo"
|
|
1932
|
-
| "DateGreaterThan"
|
|
1933
|
-
| "DateLessThan"
|
|
1934
|
-
| "DateLessThanOrEqualTo"
|
|
1935
|
-
| "DateEquals"
|
|
1936
|
-
| "DateDoesntEqual"
|
|
1937
|
-
| "DateNonEmpty"
|
|
1938
|
-
| "DateEmpty"
|
|
1939
|
-
| "StringContains"
|
|
1940
|
-
| "StringEquals"
|
|
1941
|
-
| "StringNotEmpty"
|
|
1942
|
-
| "StringNotEquals"
|
|
1943
|
-
| "StringNotContains";
|
|
1980
|
+
filterType: FusionReportFilterFilterTypeEnum;
|
|
1944
1981
|
targetField: string;
|
|
1945
1982
|
targetValue: string;
|
|
1946
1983
|
}
|
|
@@ -2068,40 +2105,7 @@ export interface GuidPatchOperation {
|
|
|
2068
2105
|
}
|
|
2069
2106
|
|
|
2070
2107
|
export interface IPAddress {
|
|
2071
|
-
addressFamily:
|
|
2072
|
-
| "Unspecified"
|
|
2073
|
-
| "Unix"
|
|
2074
|
-
| "InterNetwork"
|
|
2075
|
-
| "ImpLink"
|
|
2076
|
-
| "Pup"
|
|
2077
|
-
| "Chaos"
|
|
2078
|
-
| "NS"
|
|
2079
|
-
| "Ipx"
|
|
2080
|
-
| "Iso"
|
|
2081
|
-
| "Osi"
|
|
2082
|
-
| "Ecma"
|
|
2083
|
-
| "DataKit"
|
|
2084
|
-
| "Ccitt"
|
|
2085
|
-
| "Sna"
|
|
2086
|
-
| "DecNet"
|
|
2087
|
-
| "DataLink"
|
|
2088
|
-
| "Lat"
|
|
2089
|
-
| "HyperChannel"
|
|
2090
|
-
| "AppleTalk"
|
|
2091
|
-
| "NetBios"
|
|
2092
|
-
| "VoiceView"
|
|
2093
|
-
| "FireFox"
|
|
2094
|
-
| "Banyan"
|
|
2095
|
-
| "Atm"
|
|
2096
|
-
| "InterNetworkV6"
|
|
2097
|
-
| "Cluster"
|
|
2098
|
-
| "Ieee12844"
|
|
2099
|
-
| "Irda"
|
|
2100
|
-
| "NetworkDesigners"
|
|
2101
|
-
| "Max"
|
|
2102
|
-
| "Packet"
|
|
2103
|
-
| "ControllerAreaNetwork"
|
|
2104
|
-
| "Unknown";
|
|
2108
|
+
addressFamily: IpAddressAddressFamilyEnum;
|
|
2105
2109
|
/** @format int64 */
|
|
2106
2110
|
scopeId: number;
|
|
2107
2111
|
isIPv6Multicast: boolean;
|
|
@@ -2368,6 +2372,7 @@ export interface Loan {
|
|
|
2368
2372
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2369
2373
|
userLoans: UserLoan[];
|
|
2370
2374
|
contacts: LoanContact[];
|
|
2375
|
+
signingMethod: LoanSigningMethodEnum;
|
|
2371
2376
|
}
|
|
2372
2377
|
|
|
2373
2378
|
export interface LoanApplication {
|
|
@@ -2425,7 +2430,7 @@ export interface LoanBorrower {
|
|
|
2425
2430
|
citizenship?: LoanCitizenship | null;
|
|
2426
2431
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2427
2432
|
languagePreference?: LoanLanguagePreference | null;
|
|
2428
|
-
applicationStatus:
|
|
2433
|
+
applicationStatus: LoanBorrowerApplicationStatusEnum;
|
|
2429
2434
|
/** @format int32 */
|
|
2430
2435
|
numberOfDependents?: number | null;
|
|
2431
2436
|
isPrimaryBorrower: boolean;
|
|
@@ -3350,19 +3355,7 @@ export interface LoanContact {
|
|
|
3350
3355
|
email?: string | null;
|
|
3351
3356
|
phone?: string | null;
|
|
3352
3357
|
companyName?: string | null;
|
|
3353
|
-
role:
|
|
3354
|
-
| "Borrower"
|
|
3355
|
-
| "CoBorrower"
|
|
3356
|
-
| "NonBorrower"
|
|
3357
|
-
| "LoanOfficer"
|
|
3358
|
-
| "LoanProcessor"
|
|
3359
|
-
| "LoanOfficerAssistant"
|
|
3360
|
-
| "SupportingLoanOfficer"
|
|
3361
|
-
| "BuyerAgent"
|
|
3362
|
-
| "SellerAgent"
|
|
3363
|
-
| "TitleInsuranceAgent"
|
|
3364
|
-
| "EscrowAgent"
|
|
3365
|
-
| "SettlementAgent";
|
|
3358
|
+
role: LoanContactRoleEnum;
|
|
3366
3359
|
}
|
|
3367
3360
|
|
|
3368
3361
|
export interface LoanContactList {
|
|
@@ -3483,6 +3476,7 @@ export interface LoanIdentifier {
|
|
|
3483
3476
|
/** @format uuid */
|
|
3484
3477
|
id: string;
|
|
3485
3478
|
losLoanID: string;
|
|
3479
|
+
number?: string | null;
|
|
3486
3480
|
}
|
|
3487
3481
|
|
|
3488
3482
|
export interface LoanImport {
|
|
@@ -3498,19 +3492,14 @@ export interface LoanImport {
|
|
|
3498
3492
|
/** @format int32 */
|
|
3499
3493
|
importedCount: number;
|
|
3500
3494
|
statusMessage?: string | null;
|
|
3501
|
-
status:
|
|
3502
|
-
|
|
3503
|
-
| "InProgress"
|
|
3504
|
-
| "Completed"
|
|
3505
|
-
| "Failed"
|
|
3506
|
-
| "Cancelled";
|
|
3507
|
-
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3495
|
+
status: LoanImportStatusEnum;
|
|
3496
|
+
importMode: LoanImportImportModeEnum;
|
|
3508
3497
|
/** @format date-time */
|
|
3509
3498
|
createdAt?: string | null;
|
|
3510
3499
|
}
|
|
3511
3500
|
|
|
3512
3501
|
export interface LoanImportLog {
|
|
3513
|
-
level:
|
|
3502
|
+
level: LoanImportLogLevelEnum;
|
|
3514
3503
|
message: string;
|
|
3515
3504
|
/** @format date-time */
|
|
3516
3505
|
createdAt: string;
|
|
@@ -3571,22 +3560,8 @@ export interface LoanListPaginated {
|
|
|
3571
3560
|
export interface LoanLog {
|
|
3572
3561
|
/** @format uuid */
|
|
3573
3562
|
id: string;
|
|
3574
|
-
level:
|
|
3575
|
-
type:
|
|
3576
|
-
| "Loan"
|
|
3577
|
-
| "Queue"
|
|
3578
|
-
| "POSFlagChanged"
|
|
3579
|
-
| "Verification"
|
|
3580
|
-
| "DocumentUploaded"
|
|
3581
|
-
| "LoanCreated"
|
|
3582
|
-
| "WorkflowSubmitted"
|
|
3583
|
-
| "UserInvitationSent"
|
|
3584
|
-
| "CoBorrowerAdded"
|
|
3585
|
-
| "TaskCompleted"
|
|
3586
|
-
| "LoanStatusChanged"
|
|
3587
|
-
| "EConsent"
|
|
3588
|
-
| "SensitiveDataPurge"
|
|
3589
|
-
| "ClosingDateUpdated";
|
|
3563
|
+
level: LoanLogLevelEnum;
|
|
3564
|
+
type: LoanLogTypeEnum;
|
|
3590
3565
|
message: string;
|
|
3591
3566
|
/** @format date-time */
|
|
3592
3567
|
createdAt: string;
|
|
@@ -3595,22 +3570,8 @@ export interface LoanLog {
|
|
|
3595
3570
|
export interface LoanLogDetail {
|
|
3596
3571
|
/** @format uuid */
|
|
3597
3572
|
id: string;
|
|
3598
|
-
level:
|
|
3599
|
-
type:
|
|
3600
|
-
| "Loan"
|
|
3601
|
-
| "Queue"
|
|
3602
|
-
| "POSFlagChanged"
|
|
3603
|
-
| "Verification"
|
|
3604
|
-
| "DocumentUploaded"
|
|
3605
|
-
| "LoanCreated"
|
|
3606
|
-
| "WorkflowSubmitted"
|
|
3607
|
-
| "UserInvitationSent"
|
|
3608
|
-
| "CoBorrowerAdded"
|
|
3609
|
-
| "TaskCompleted"
|
|
3610
|
-
| "LoanStatusChanged"
|
|
3611
|
-
| "EConsent"
|
|
3612
|
-
| "SensitiveDataPurge"
|
|
3613
|
-
| "ClosingDateUpdated";
|
|
3573
|
+
level: LoanLogDetailLevelEnum;
|
|
3574
|
+
type: LoanLogDetailTypeEnum;
|
|
3614
3575
|
message: string;
|
|
3615
3576
|
/** @format date-time */
|
|
3616
3577
|
createdAt: string;
|
|
@@ -3886,6 +3847,17 @@ export interface LoanSettings {
|
|
|
3886
3847
|
excludeFromAutoTaskReminders: boolean;
|
|
3887
3848
|
}
|
|
3888
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
|
+
|
|
3889
3861
|
export interface LoanUser {
|
|
3890
3862
|
/** @format uuid */
|
|
3891
3863
|
id: string;
|
|
@@ -3894,24 +3866,20 @@ export interface LoanUser {
|
|
|
3894
3866
|
email: string;
|
|
3895
3867
|
phone?: string | null;
|
|
3896
3868
|
role: string;
|
|
3897
|
-
loanRole:
|
|
3898
|
-
| "Borrower"
|
|
3899
|
-
| "CoBorrower"
|
|
3900
|
-
| "NonBorrower"
|
|
3901
|
-
| "LoanOfficer"
|
|
3902
|
-
| "LoanProcessor"
|
|
3903
|
-
| "LoanOfficerAssistant"
|
|
3904
|
-
| "SupportingLoanOfficer"
|
|
3905
|
-
| "BuyerAgent"
|
|
3906
|
-
| "SellerAgent"
|
|
3907
|
-
| "TitleInsuranceAgent"
|
|
3908
|
-
| "EscrowAgent"
|
|
3909
|
-
| "SettlementAgent";
|
|
3869
|
+
loanRole: LoanUserLoanRoleEnum;
|
|
3910
3870
|
isUser: boolean;
|
|
3911
3871
|
/** @format date-time */
|
|
3912
3872
|
createdAt: string;
|
|
3913
3873
|
}
|
|
3914
3874
|
|
|
3875
|
+
export interface LosCredentials {
|
|
3876
|
+
/** @format uuid */
|
|
3877
|
+
id: string;
|
|
3878
|
+
/** @format uuid */
|
|
3879
|
+
accountID: string;
|
|
3880
|
+
instanceID: string;
|
|
3881
|
+
}
|
|
3882
|
+
|
|
3915
3883
|
export interface LosLoanCreationRequest {
|
|
3916
3884
|
loanOfficerUserName?: string | null;
|
|
3917
3885
|
loanTemplate?: string | null;
|
|
@@ -3924,6 +3892,15 @@ export interface LosLoanCreationRequest {
|
|
|
3924
3892
|
existingLoanID?: string | null;
|
|
3925
3893
|
}
|
|
3926
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
|
+
|
|
3927
3904
|
export interface MdmUser {
|
|
3928
3905
|
user_email?: string | null;
|
|
3929
3906
|
user_id?: string | null;
|
|
@@ -4569,7 +4546,7 @@ export interface SSOTokenRequest {
|
|
|
4569
4546
|
}
|
|
4570
4547
|
|
|
4571
4548
|
export interface SamlMetadataRequest {
|
|
4572
|
-
ssoIntegration:
|
|
4549
|
+
ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
|
|
4573
4550
|
}
|
|
4574
4551
|
|
|
4575
4552
|
export interface SendForgotPasswordRequest {
|
|
@@ -4608,7 +4585,7 @@ export interface SiteConfiguration {
|
|
|
4608
4585
|
deletedAt?: string | null;
|
|
4609
4586
|
/** @format uuid */
|
|
4610
4587
|
id: string;
|
|
4611
|
-
type:
|
|
4588
|
+
type: SiteConfigurationTypeEnum;
|
|
4612
4589
|
/** @format uuid */
|
|
4613
4590
|
entityID: string;
|
|
4614
4591
|
/** @format int32 */
|
|
@@ -4803,7 +4780,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4803
4780
|
deletedAt?: string | null;
|
|
4804
4781
|
/** @format uuid */
|
|
4805
4782
|
id: string;
|
|
4806
|
-
type:
|
|
4783
|
+
type: SiteConfigurationByUrlTypeEnum;
|
|
4807
4784
|
/** @format uuid */
|
|
4808
4785
|
entityID: string;
|
|
4809
4786
|
/** @format int32 */
|
|
@@ -5016,7 +4993,7 @@ export interface SiteConfigurationForm {
|
|
|
5016
4993
|
export interface SiteConfigurationReduced {
|
|
5017
4994
|
/** @format uuid */
|
|
5018
4995
|
id: string;
|
|
5019
|
-
type:
|
|
4996
|
+
type: SiteConfigurationReducedTypeEnum;
|
|
5020
4997
|
url?: string | null;
|
|
5021
4998
|
name: string;
|
|
5022
4999
|
/** @format int64 */
|
|
@@ -5034,7 +5011,7 @@ export interface SiteConfigurationRequest {
|
|
|
5034
5011
|
entityID: string;
|
|
5035
5012
|
/** @format int32 */
|
|
5036
5013
|
entityType: number;
|
|
5037
|
-
type:
|
|
5014
|
+
type: SiteConfigurationRequestTypeEnum;
|
|
5038
5015
|
url: string;
|
|
5039
5016
|
name: string;
|
|
5040
5017
|
introduction?: string | null;
|
|
@@ -5211,7 +5188,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5211
5188
|
export interface SiteConfigurationSummary {
|
|
5212
5189
|
/** @format uuid */
|
|
5213
5190
|
id: string;
|
|
5214
|
-
type:
|
|
5191
|
+
type: SiteConfigurationSummaryTypeEnum;
|
|
5215
5192
|
url?: string | null;
|
|
5216
5193
|
name: string;
|
|
5217
5194
|
/** @format int64 */
|
|
@@ -5839,19 +5816,7 @@ export interface UserDevice {
|
|
|
5839
5816
|
export interface UserDraft {
|
|
5840
5817
|
/** @format uuid */
|
|
5841
5818
|
draftID: string;
|
|
5842
|
-
role:
|
|
5843
|
-
| "Borrower"
|
|
5844
|
-
| "CoBorrower"
|
|
5845
|
-
| "NonBorrower"
|
|
5846
|
-
| "LoanOfficer"
|
|
5847
|
-
| "LoanProcessor"
|
|
5848
|
-
| "LoanOfficerAssistant"
|
|
5849
|
-
| "SupportingLoanOfficer"
|
|
5850
|
-
| "BuyerAgent"
|
|
5851
|
-
| "SellerAgent"
|
|
5852
|
-
| "TitleInsuranceAgent"
|
|
5853
|
-
| "EscrowAgent"
|
|
5854
|
-
| "SettlementAgent";
|
|
5819
|
+
role: UserDraftRoleEnum;
|
|
5855
5820
|
user: User;
|
|
5856
5821
|
}
|
|
5857
5822
|
|
|
@@ -5878,7 +5843,7 @@ export interface UserGroupAccessScope {
|
|
|
5878
5843
|
id: string;
|
|
5879
5844
|
/** @format uuid */
|
|
5880
5845
|
groupId: string;
|
|
5881
|
-
scopeType:
|
|
5846
|
+
scopeType: UserGroupAccessScopeScopeTypeEnum;
|
|
5882
5847
|
/** @format uuid */
|
|
5883
5848
|
userId?: string | null;
|
|
5884
5849
|
/** @format uuid */
|
|
@@ -5914,19 +5879,7 @@ export interface UserLoan {
|
|
|
5914
5879
|
deletedAt?: string | null;
|
|
5915
5880
|
loanID: string;
|
|
5916
5881
|
user: User;
|
|
5917
|
-
role:
|
|
5918
|
-
| "Borrower"
|
|
5919
|
-
| "CoBorrower"
|
|
5920
|
-
| "NonBorrower"
|
|
5921
|
-
| "LoanOfficer"
|
|
5922
|
-
| "LoanProcessor"
|
|
5923
|
-
| "LoanOfficerAssistant"
|
|
5924
|
-
| "SupportingLoanOfficer"
|
|
5925
|
-
| "BuyerAgent"
|
|
5926
|
-
| "SellerAgent"
|
|
5927
|
-
| "TitleInsuranceAgent"
|
|
5928
|
-
| "EscrowAgent"
|
|
5929
|
-
| "SettlementAgent";
|
|
5882
|
+
role: UserLoanRoleEnum;
|
|
5930
5883
|
/** @format int32 */
|
|
5931
5884
|
borrowerPair?: number | null;
|
|
5932
5885
|
/** @format int32 */
|
|
@@ -5939,10 +5892,10 @@ export interface UserLoanConsent {
|
|
|
5939
5892
|
id: string;
|
|
5940
5893
|
/** @format uuid */
|
|
5941
5894
|
userLoanID: string;
|
|
5942
|
-
type:
|
|
5895
|
+
type: UserLoanConsentTypeEnum;
|
|
5943
5896
|
providedConsent: boolean;
|
|
5944
5897
|
ipAddress?: string | null;
|
|
5945
|
-
losSyncStatus:
|
|
5898
|
+
losSyncStatus: UserLoanConsentLosSyncStatusEnum;
|
|
5946
5899
|
/** @format date-time */
|
|
5947
5900
|
createdAt: string;
|
|
5948
5901
|
}
|
|
@@ -5958,7 +5911,6 @@ export interface UserLoanTask {
|
|
|
5958
5911
|
value?: string | null;
|
|
5959
5912
|
documents: LoanDocument[];
|
|
5960
5913
|
loan: LoanIdentifier;
|
|
5961
|
-
/** @deprecated */
|
|
5962
5914
|
loanID: string;
|
|
5963
5915
|
/** @format date-time */
|
|
5964
5916
|
completedDate?: string | null;
|
|
@@ -5971,6 +5923,13 @@ export interface UserLoanTask {
|
|
|
5971
5923
|
commentsCount: number;
|
|
5972
5924
|
}
|
|
5973
5925
|
|
|
5926
|
+
export interface UserLoanTaskPaginated {
|
|
5927
|
+
rows: UserLoanTask[];
|
|
5928
|
+
pagination: Pagination;
|
|
5929
|
+
/** @format int64 */
|
|
5930
|
+
count: number;
|
|
5931
|
+
}
|
|
5932
|
+
|
|
5974
5933
|
export interface UserLoanTaskRequest {
|
|
5975
5934
|
value?: string | null;
|
|
5976
5935
|
/**
|
|
@@ -6087,16 +6046,7 @@ export interface UserSummary {
|
|
|
6087
6046
|
id: string;
|
|
6088
6047
|
name?: string | null;
|
|
6089
6048
|
email?: string | null;
|
|
6090
|
-
role:
|
|
6091
|
-
| "Borrower"
|
|
6092
|
-
| "LoanOfficer"
|
|
6093
|
-
| "Admin"
|
|
6094
|
-
| "SuperAdmin"
|
|
6095
|
-
| "Realtor"
|
|
6096
|
-
| "SettlementAgent"
|
|
6097
|
-
| "LoanProcessor"
|
|
6098
|
-
| "LoanOfficerAssistant"
|
|
6099
|
-
| "SystemAdmin";
|
|
6049
|
+
role: UserSummaryRoleEnum;
|
|
6100
6050
|
}
|
|
6101
6051
|
|
|
6102
6052
|
export interface VerifyPasswordRequest {
|
|
@@ -6132,6 +6082,361 @@ export interface Workflow {
|
|
|
6132
6082
|
icon: string;
|
|
6133
6083
|
}
|
|
6134
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
|
+
|
|
6135
6440
|
import type {
|
|
6136
6441
|
AxiosInstance,
|
|
6137
6442
|
AxiosRequestConfig,
|
|
@@ -6310,7 +6615,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
6310
6615
|
|
|
6311
6616
|
/**
|
|
6312
6617
|
* @title The Big POS API
|
|
6313
|
-
* @version v2.38.
|
|
6618
|
+
* @version v2.38.1
|
|
6314
6619
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6315
6620
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6316
6621
|
*/
|
|
@@ -6592,6 +6897,25 @@ export class Api<
|
|
|
6592
6897
|
...params,
|
|
6593
6898
|
}),
|
|
6594
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
|
+
|
|
6595
6919
|
/**
|
|
6596
6920
|
* No description
|
|
6597
6921
|
*
|
|
@@ -7172,6 +7496,47 @@ export class Api<
|
|
|
7172
7496
|
...params,
|
|
7173
7497
|
}),
|
|
7174
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
|
+
|
|
7175
7540
|
/**
|
|
7176
7541
|
* No description
|
|
7177
7542
|
*
|
|
@@ -8662,7 +9027,7 @@ export class Api<
|
|
|
8662
9027
|
method: "POST",
|
|
8663
9028
|
body: data,
|
|
8664
9029
|
secure: true,
|
|
8665
|
-
type: ContentType.
|
|
9030
|
+
type: ContentType.Json,
|
|
8666
9031
|
format: "json",
|
|
8667
9032
|
...params,
|
|
8668
9033
|
}),
|
|
@@ -8935,7 +9300,7 @@ export class Api<
|
|
|
8935
9300
|
method: "POST",
|
|
8936
9301
|
body: data,
|
|
8937
9302
|
secure: true,
|
|
8938
|
-
type: ContentType.
|
|
9303
|
+
type: ContentType.Json,
|
|
8939
9304
|
format: "json",
|
|
8940
9305
|
...params,
|
|
8941
9306
|
}),
|
|
@@ -9174,7 +9539,7 @@ export class Api<
|
|
|
9174
9539
|
method: "POST",
|
|
9175
9540
|
body: data,
|
|
9176
9541
|
secure: true,
|
|
9177
|
-
type: ContentType.
|
|
9542
|
+
type: ContentType.Json,
|
|
9178
9543
|
format: "json",
|
|
9179
9544
|
...params,
|
|
9180
9545
|
}),
|
|
@@ -9643,7 +10008,7 @@ export class Api<
|
|
|
9643
10008
|
* @summary Download By ID
|
|
9644
10009
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
9645
10010
|
* @secure
|
|
9646
|
-
* @response `200` `
|
|
10011
|
+
* @response `200` `Blob` Success
|
|
9647
10012
|
* @response `404` `ProblemDetails` Not Found
|
|
9648
10013
|
*/
|
|
9649
10014
|
downloadLoanDocument: (
|
|
@@ -9651,7 +10016,7 @@ export class Api<
|
|
|
9651
10016
|
documentId: string,
|
|
9652
10017
|
params: RequestParams = {},
|
|
9653
10018
|
) =>
|
|
9654
|
-
this.request<
|
|
10019
|
+
this.request<Blob, ProblemDetails>({
|
|
9655
10020
|
path: `/api/loans/${loanId}/documents/${documentId}/download`,
|
|
9656
10021
|
method: "GET",
|
|
9657
10022
|
secure: true,
|
|
@@ -10746,7 +11111,7 @@ export class Api<
|
|
|
10746
11111
|
method: "POST",
|
|
10747
11112
|
body: data,
|
|
10748
11113
|
secure: true,
|
|
10749
|
-
type: ContentType.
|
|
11114
|
+
type: ContentType.Json,
|
|
10750
11115
|
format: "json",
|
|
10751
11116
|
...params,
|
|
10752
11117
|
}),
|
|
@@ -10883,9 +11248,42 @@ export class Api<
|
|
|
10883
11248
|
}),
|
|
10884
11249
|
|
|
10885
11250
|
/**
|
|
10886
|
-
*
|
|
11251
|
+
* @description Search tasks across all loans
|
|
10887
11252
|
*
|
|
10888
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
|
|
10889
11287
|
* @name GetLoanTasks
|
|
10890
11288
|
* @summary Get All
|
|
10891
11289
|
* @request GET:/api/loans/{loanID}/tasks
|
|
@@ -10905,7 +11303,7 @@ export class Api<
|
|
|
10905
11303
|
/**
|
|
10906
11304
|
* No description
|
|
10907
11305
|
*
|
|
10908
|
-
* @tags
|
|
11306
|
+
* @tags LoanTasksForSingleLoan
|
|
10909
11307
|
* @name GetLoanTask
|
|
10910
11308
|
* @summary Get by ID
|
|
10911
11309
|
* @request GET:/api/loans/{loanID}/tasks/{id}
|
|
@@ -10925,7 +11323,7 @@ export class Api<
|
|
|
10925
11323
|
/**
|
|
10926
11324
|
* @description Get the difference between the current loan tasks and the tasks generated by business rules
|
|
10927
11325
|
*
|
|
10928
|
-
* @tags
|
|
11326
|
+
* @tags LoanTasksForSingleLoan
|
|
10929
11327
|
* @name GetLoanTaskDifference
|
|
10930
11328
|
* @summary Get Difference
|
|
10931
11329
|
* @request GET:/api/loans/{loanID}/tasks/diff
|
|
@@ -10945,7 +11343,7 @@ export class Api<
|
|
|
10945
11343
|
/**
|
|
10946
11344
|
* No description
|
|
10947
11345
|
*
|
|
10948
|
-
* @tags
|
|
11346
|
+
* @tags LoanTasksForSingleLoan
|
|
10949
11347
|
* @name CreateLoanTask
|
|
10950
11348
|
* @summary Create
|
|
10951
11349
|
* @request POST:/api/loans/{loanID}/tasks/{taskID}
|
|
@@ -10972,7 +11370,7 @@ export class Api<
|
|
|
10972
11370
|
/**
|
|
10973
11371
|
* No description
|
|
10974
11372
|
*
|
|
10975
|
-
* @tags
|
|
11373
|
+
* @tags LoanTasksForSingleLoan
|
|
10976
11374
|
* @name ImportLoanTask
|
|
10977
11375
|
* @summary Import
|
|
10978
11376
|
* @request POST:/api/loans/{loanID}/tasks/import
|
|
@@ -10998,7 +11396,7 @@ export class Api<
|
|
|
10998
11396
|
/**
|
|
10999
11397
|
* No description
|
|
11000
11398
|
*
|
|
11001
|
-
* @tags
|
|
11399
|
+
* @tags LoanTasksForSingleLoan
|
|
11002
11400
|
* @name ReplaceLoanTask
|
|
11003
11401
|
* @summary Replace
|
|
11004
11402
|
* @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -11025,7 +11423,7 @@ export class Api<
|
|
|
11025
11423
|
/**
|
|
11026
11424
|
* No description
|
|
11027
11425
|
*
|
|
11028
|
-
* @tags
|
|
11426
|
+
* @tags LoanTasksForSingleLoan
|
|
11029
11427
|
* @name DeleteLoanTask
|
|
11030
11428
|
* @summary Delete
|
|
11031
11429
|
* @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -11739,16 +12137,7 @@ export class Api<
|
|
|
11739
12137
|
query?: {
|
|
11740
12138
|
showAll?: boolean;
|
|
11741
12139
|
/** @default "Realtor" */
|
|
11742
|
-
role?:
|
|
11743
|
-
| "Borrower"
|
|
11744
|
-
| "LoanOfficer"
|
|
11745
|
-
| "Admin"
|
|
11746
|
-
| "SuperAdmin"
|
|
11747
|
-
| "Realtor"
|
|
11748
|
-
| "SettlementAgent"
|
|
11749
|
-
| "LoanProcessor"
|
|
11750
|
-
| "LoanOfficerAssistant"
|
|
11751
|
-
| "SystemAdmin";
|
|
12140
|
+
role?: GetPartnersParamsRoleEnum;
|
|
11752
12141
|
/** @format int32 */
|
|
11753
12142
|
pageSize?: number;
|
|
11754
12143
|
/** @format int32 */
|
|
@@ -12084,7 +12473,7 @@ export class Api<
|
|
|
12084
12473
|
* @response `404` `ProblemDetails` Not Found
|
|
12085
12474
|
*/
|
|
12086
12475
|
getSamlMetadata: (
|
|
12087
|
-
sSoIntegration:
|
|
12476
|
+
sSoIntegration: GetSamlMetadataParamsEnum,
|
|
12088
12477
|
ssoIntegration: string,
|
|
12089
12478
|
params: RequestParams = {},
|
|
12090
12479
|
) =>
|
|
@@ -12106,7 +12495,7 @@ export class Api<
|
|
|
12106
12495
|
* @response `200` `File` Success
|
|
12107
12496
|
*/
|
|
12108
12497
|
createOrReplaceSamlMetadata: (
|
|
12109
|
-
sSoIntegration:
|
|
12498
|
+
sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
|
|
12110
12499
|
ssoIntegration: string,
|
|
12111
12500
|
params: RequestParams = {},
|
|
12112
12501
|
) =>
|
|
@@ -12484,6 +12873,129 @@ export class Api<
|
|
|
12484
12873
|
...params,
|
|
12485
12874
|
}),
|
|
12486
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
|
+
|
|
12487
12999
|
/**
|
|
12488
13000
|
* No description
|
|
12489
13001
|
*
|