@matech/thebigpos-sdk 2.40.4-rc1 → 2.40.6-rc0
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 +148 -86
- package/dist/index.js +20 -19
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +584 -374
- package/tsconfig.json +27 -27
package/dist/index.d.ts
CHANGED
|
@@ -53,12 +53,12 @@ export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
|
53
53
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
54
54
|
export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
|
|
55
55
|
export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
56
|
-
export type EncompassEnvironment = "Production" | "UAT";
|
|
57
56
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
58
57
|
export type CustomFieldEntityType = "Loan";
|
|
59
58
|
export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
60
59
|
export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
61
60
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
61
|
+
export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
|
|
62
62
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
63
63
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
64
64
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -116,7 +116,7 @@ export interface AccountBilling {
|
|
|
116
116
|
contractedRate: number;
|
|
117
117
|
}
|
|
118
118
|
export interface AccountBillingRequest {
|
|
119
|
-
billingType:
|
|
119
|
+
billingType: AccountBillingRequestBillingTypeEnum;
|
|
120
120
|
/**
|
|
121
121
|
* @format double
|
|
122
122
|
* @min 0
|
|
@@ -455,7 +455,7 @@ export interface AuditLogEntry {
|
|
|
455
455
|
/** @format uuid */
|
|
456
456
|
id: string;
|
|
457
457
|
entityType: string;
|
|
458
|
-
changeType:
|
|
458
|
+
changeType: AuditLogEntryChangeTypeEnum;
|
|
459
459
|
/** @format uuid */
|
|
460
460
|
entityId: string;
|
|
461
461
|
performedBy?: AuditLogUser | null;
|
|
@@ -739,7 +739,7 @@ export interface CorporateSearchCriteria {
|
|
|
739
739
|
isActive?: boolean | null;
|
|
740
740
|
}
|
|
741
741
|
export interface CreateAccessScopeRequest {
|
|
742
|
-
scopeType:
|
|
742
|
+
scopeType: CreateAccessScopeRequestScopeTypeEnum;
|
|
743
743
|
/** @format uuid */
|
|
744
744
|
userId?: string | null;
|
|
745
745
|
/** @format uuid */
|
|
@@ -762,7 +762,7 @@ export interface CreateAccountRequest {
|
|
|
762
762
|
*/
|
|
763
763
|
nlmsid: number;
|
|
764
764
|
settings: AccountSettingsRequest;
|
|
765
|
-
environment:
|
|
765
|
+
environment: CreateAccountRequestEnvironmentEnum;
|
|
766
766
|
losIntegration: LOSIntegration;
|
|
767
767
|
billingSettings: AccountBillingRequest;
|
|
768
768
|
}
|
|
@@ -798,8 +798,8 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
798
798
|
name: string;
|
|
799
799
|
defaultValue?: string | null;
|
|
800
800
|
regexPattern?: string | null;
|
|
801
|
-
dataType:
|
|
802
|
-
entityType:
|
|
801
|
+
dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
|
|
802
|
+
entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
|
|
803
803
|
options?: CustomFieldOptionRequest[] | null;
|
|
804
804
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
805
805
|
}
|
|
@@ -819,7 +819,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
819
819
|
export interface CreateGroupMemberRequest {
|
|
820
820
|
/** @format uuid */
|
|
821
821
|
userId: string;
|
|
822
|
-
loanRole:
|
|
822
|
+
loanRole: CreateGroupMemberRequestLoanRoleEnum;
|
|
823
823
|
}
|
|
824
824
|
export interface CreateInviteRequest {
|
|
825
825
|
/** @minLength 1 */
|
|
@@ -830,7 +830,7 @@ export interface CreateInviteRequest {
|
|
|
830
830
|
emailAddress: string;
|
|
831
831
|
phoneNumber?: string | null;
|
|
832
832
|
/** @deprecated */
|
|
833
|
-
relationship:
|
|
833
|
+
relationship: CreateInviteRequestRelationshipEnum;
|
|
834
834
|
loanID: string;
|
|
835
835
|
route?: string | null;
|
|
836
836
|
/** @format uuid */
|
|
@@ -860,7 +860,7 @@ export interface CreateLoanImportRequest {
|
|
|
860
860
|
* @minLength 1
|
|
861
861
|
*/
|
|
862
862
|
startDate: string;
|
|
863
|
-
importMode:
|
|
863
|
+
importMode: CreateLoanImportRequestImportModeEnum;
|
|
864
864
|
}
|
|
865
865
|
export interface CreateSession {
|
|
866
866
|
sessionId: string;
|
|
@@ -878,7 +878,7 @@ export interface CreateUserDeviceRequest {
|
|
|
878
878
|
token: string;
|
|
879
879
|
}
|
|
880
880
|
export interface CreateUserDraft {
|
|
881
|
-
loanRole:
|
|
881
|
+
loanRole: CreateUserDraftLoanRoleEnum;
|
|
882
882
|
}
|
|
883
883
|
export interface CreateUserGroupRequest {
|
|
884
884
|
/**
|
|
@@ -959,8 +959,8 @@ export interface CustomFieldDefinition {
|
|
|
959
959
|
name: string;
|
|
960
960
|
defaultValue?: string | null;
|
|
961
961
|
regexPattern?: string | null;
|
|
962
|
-
dataType:
|
|
963
|
-
entityType:
|
|
962
|
+
dataType: CustomFieldDefinitionDataTypeEnum;
|
|
963
|
+
entityType: CustomFieldDefinitionEntityTypeEnum;
|
|
964
964
|
options: CustomFieldOption[];
|
|
965
965
|
permissions: CustomFieldPermission[];
|
|
966
966
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -974,7 +974,7 @@ export interface CustomFieldEntry {
|
|
|
974
974
|
displayOrder: number;
|
|
975
975
|
name: string;
|
|
976
976
|
value: string;
|
|
977
|
-
dataType:
|
|
977
|
+
dataType: CustomFieldEntryDataTypeEnum;
|
|
978
978
|
}
|
|
979
979
|
export interface CustomFieldOption {
|
|
980
980
|
/** @format uuid */
|
|
@@ -991,12 +991,12 @@ export interface CustomFieldOptionRequest {
|
|
|
991
991
|
export interface CustomFieldPermission {
|
|
992
992
|
/** @format uuid */
|
|
993
993
|
id: string;
|
|
994
|
-
role:
|
|
995
|
-
accessLevel:
|
|
994
|
+
role: CustomFieldPermissionRoleEnum;
|
|
995
|
+
accessLevel: CustomFieldPermissionAccessLevelEnum;
|
|
996
996
|
}
|
|
997
997
|
export interface CustomFieldPermissionRequest {
|
|
998
|
-
role:
|
|
999
|
-
accessLevel:
|
|
998
|
+
role: CustomFieldPermissionRequestRoleEnum;
|
|
999
|
+
accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
|
|
1000
1000
|
}
|
|
1001
1001
|
export interface CustomFieldValue {
|
|
1002
1002
|
/** @format uuid */
|
|
@@ -1007,7 +1007,7 @@ export interface CustomFieldValue {
|
|
|
1007
1007
|
customFieldDefinitionID: string;
|
|
1008
1008
|
value: string;
|
|
1009
1009
|
definitionName: string;
|
|
1010
|
-
dataType:
|
|
1010
|
+
dataType: CustomFieldValueDataTypeEnum;
|
|
1011
1011
|
}
|
|
1012
1012
|
export interface DetailedUser {
|
|
1013
1013
|
/** @format date-time */
|
|
@@ -1248,7 +1248,7 @@ export interface Draft {
|
|
|
1248
1248
|
siteConfiguration: SiteConfigurationReduced;
|
|
1249
1249
|
/** @format uuid */
|
|
1250
1250
|
loanID?: string | null;
|
|
1251
|
-
type:
|
|
1251
|
+
type: DraftTypeEnum;
|
|
1252
1252
|
isCoBorrower: boolean;
|
|
1253
1253
|
}
|
|
1254
1254
|
export interface DraftContent {
|
|
@@ -1266,7 +1266,7 @@ export interface DraftContent {
|
|
|
1266
1266
|
siteConfiguration: SiteConfigurationReduced;
|
|
1267
1267
|
/** @format uuid */
|
|
1268
1268
|
loanID?: string | null;
|
|
1269
|
-
type:
|
|
1269
|
+
type: DraftContentTypeEnum;
|
|
1270
1270
|
isCoBorrower: boolean;
|
|
1271
1271
|
applicationPayload: any;
|
|
1272
1272
|
}
|
|
@@ -1350,9 +1350,7 @@ export interface EncompassCredentialsDetail {
|
|
|
1350
1350
|
defaultLoanOfficerUserName?: string | null;
|
|
1351
1351
|
clearStateIfUnlicensed: boolean;
|
|
1352
1352
|
baseUrl?: string | null;
|
|
1353
|
-
|
|
1354
|
-
consumerConnectWidgetHost?: string | null;
|
|
1355
|
-
signingMethod: "ConsumerConnect" | "POSF";
|
|
1353
|
+
signingMethod: EncompassCredentialsDetailSigningMethodEnum;
|
|
1356
1354
|
subscriptionId?: string | null;
|
|
1357
1355
|
environment?: string | null;
|
|
1358
1356
|
}
|
|
@@ -1367,9 +1365,7 @@ export interface EncompassCredentialsRequest {
|
|
|
1367
1365
|
defaultLoanOfficerUserName?: string | null;
|
|
1368
1366
|
clearStateIfUnlicensed: boolean;
|
|
1369
1367
|
baseUrl?: string | null;
|
|
1370
|
-
|
|
1371
|
-
consumerConnectWidgetHost?: string | null;
|
|
1372
|
-
signingMethod: "ConsumerConnect" | "POSF";
|
|
1368
|
+
signingMethod: EncompassCredentialsRequestSigningMethodEnum;
|
|
1373
1369
|
subscriptionId?: string | null;
|
|
1374
1370
|
environment?: string | null;
|
|
1375
1371
|
clientID?: string | null;
|
|
@@ -1403,9 +1399,6 @@ export interface EncompassFieldListItem {
|
|
|
1403
1399
|
fieldType: string;
|
|
1404
1400
|
inUse: boolean;
|
|
1405
1401
|
}
|
|
1406
|
-
export interface EncompassIntegrationSettings {
|
|
1407
|
-
consumerConnectWidgetHost?: string | null;
|
|
1408
|
-
}
|
|
1409
1402
|
export interface EncompassLogSearchCriteria {
|
|
1410
1403
|
searchText?: string | null;
|
|
1411
1404
|
operationTypes?: EncompassLogOperationType[] | null;
|
|
@@ -1478,8 +1471,8 @@ export interface EncompassRequestLog {
|
|
|
1478
1471
|
losId?: string | null;
|
|
1479
1472
|
/** @format uuid */
|
|
1480
1473
|
accountId: string;
|
|
1481
|
-
operationType:
|
|
1482
|
-
outcome:
|
|
1474
|
+
operationType: EncompassRequestLogOperationTypeEnum;
|
|
1475
|
+
outcome: EncompassRequestLogOutcomeEnum;
|
|
1483
1476
|
message: string;
|
|
1484
1477
|
endpoint?: string | null;
|
|
1485
1478
|
httpMethod?: string | null;
|
|
@@ -1692,7 +1685,7 @@ export interface FusionFieldDisplay {
|
|
|
1692
1685
|
fieldValue: string;
|
|
1693
1686
|
}
|
|
1694
1687
|
export interface FusionReportFilter {
|
|
1695
|
-
filterType:
|
|
1688
|
+
filterType: FusionReportFilterFilterTypeEnum;
|
|
1696
1689
|
targetField: string;
|
|
1697
1690
|
targetValue: string;
|
|
1698
1691
|
}
|
|
@@ -1806,7 +1799,7 @@ export interface GuidPatchOperation {
|
|
|
1806
1799
|
from?: string | null;
|
|
1807
1800
|
}
|
|
1808
1801
|
export interface IPAddress {
|
|
1809
|
-
addressFamily:
|
|
1802
|
+
addressFamily: IpAddressAddressFamilyEnum;
|
|
1810
1803
|
/** @format int64 */
|
|
1811
1804
|
scopeId: number;
|
|
1812
1805
|
isIPv6Multicast: boolean;
|
|
@@ -1863,9 +1856,6 @@ export interface ImportUserLoanTaskRequest {
|
|
|
1863
1856
|
*/
|
|
1864
1857
|
userID: string;
|
|
1865
1858
|
}
|
|
1866
|
-
export interface IntegrationSettings {
|
|
1867
|
-
encompass?: EncompassIntegrationSettings | null;
|
|
1868
|
-
}
|
|
1869
1859
|
export interface Invite {
|
|
1870
1860
|
/** @format uuid */
|
|
1871
1861
|
id: string;
|
|
@@ -2063,7 +2053,7 @@ export interface Loan {
|
|
|
2063
2053
|
userLoans: UserLoan[];
|
|
2064
2054
|
contacts: LoanContact[];
|
|
2065
2055
|
customFields: CustomFieldEntry[];
|
|
2066
|
-
signingMethod:
|
|
2056
|
+
signingMethod: LoanSigningMethodEnum;
|
|
2067
2057
|
}
|
|
2068
2058
|
export interface LoanApplication {
|
|
2069
2059
|
/** @format uuid */
|
|
@@ -2119,7 +2109,7 @@ export interface LoanBorrower {
|
|
|
2119
2109
|
citizenship?: LoanCitizenship | null;
|
|
2120
2110
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2121
2111
|
languagePreference?: LoanLanguagePreference | null;
|
|
2122
|
-
applicationStatus:
|
|
2112
|
+
applicationStatus: LoanBorrowerApplicationStatusEnum;
|
|
2123
2113
|
/** @format int32 */
|
|
2124
2114
|
numberOfDependents?: number | null;
|
|
2125
2115
|
isPrimaryBorrower: boolean;
|
|
@@ -2247,6 +2237,7 @@ export interface LoanBorrowerConsent {
|
|
|
2247
2237
|
id?: string | null;
|
|
2248
2238
|
type?: ConsentType | null;
|
|
2249
2239
|
providedConsent?: boolean | null;
|
|
2240
|
+
source?: ConsentSource | null;
|
|
2250
2241
|
ipAddress?: string | null;
|
|
2251
2242
|
}
|
|
2252
2243
|
export interface LoanBorrowerConsentRequest {
|
|
@@ -2976,7 +2967,7 @@ export interface LoanContact {
|
|
|
2976
2967
|
email?: string | null;
|
|
2977
2968
|
phone?: string | null;
|
|
2978
2969
|
companyName?: string | null;
|
|
2979
|
-
role:
|
|
2970
|
+
role: LoanContactRoleEnum;
|
|
2980
2971
|
}
|
|
2981
2972
|
export interface LoanContactList {
|
|
2982
2973
|
email: string;
|
|
@@ -3025,12 +3016,12 @@ export interface LoanDocumentFolderPermission {
|
|
|
3025
3016
|
id: string;
|
|
3026
3017
|
/** @format uuid */
|
|
3027
3018
|
loanDocumentFolderID: string;
|
|
3028
|
-
role:
|
|
3029
|
-
level:
|
|
3019
|
+
role: LoanDocumentFolderPermissionRoleEnum;
|
|
3020
|
+
level: LoanDocumentFolderPermissionLevelEnum;
|
|
3030
3021
|
}
|
|
3031
3022
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3032
|
-
role:
|
|
3033
|
-
level:
|
|
3023
|
+
role: LoanDocumentFolderPermissionRequestRoleEnum;
|
|
3024
|
+
level: LoanDocumentFolderPermissionRequestLevelEnum;
|
|
3034
3025
|
}
|
|
3035
3026
|
export interface LoanDocumentFolderUsage {
|
|
3036
3027
|
/** @format uuid */
|
|
@@ -3138,13 +3129,13 @@ export interface LoanImport {
|
|
|
3138
3129
|
/** @format int32 */
|
|
3139
3130
|
importedCount: number;
|
|
3140
3131
|
statusMessage?: string | null;
|
|
3141
|
-
status:
|
|
3142
|
-
importMode:
|
|
3132
|
+
status: LoanImportStatusEnum;
|
|
3133
|
+
importMode: LoanImportImportModeEnum;
|
|
3143
3134
|
/** @format date-time */
|
|
3144
3135
|
createdAt?: string | null;
|
|
3145
3136
|
}
|
|
3146
3137
|
export interface LoanImportLog {
|
|
3147
|
-
level:
|
|
3138
|
+
level: LoanImportLogLevelEnum;
|
|
3148
3139
|
message: string;
|
|
3149
3140
|
/** @format date-time */
|
|
3150
3141
|
createdAt: string;
|
|
@@ -3199,8 +3190,8 @@ export interface LoanListPaginated {
|
|
|
3199
3190
|
export interface LoanLog {
|
|
3200
3191
|
/** @format uuid */
|
|
3201
3192
|
id: string;
|
|
3202
|
-
level:
|
|
3203
|
-
type:
|
|
3193
|
+
level: LoanLogLevelEnum;
|
|
3194
|
+
type: LoanLogTypeEnum;
|
|
3204
3195
|
message: string;
|
|
3205
3196
|
/** @format date-time */
|
|
3206
3197
|
createdAt: string;
|
|
@@ -3208,8 +3199,8 @@ export interface LoanLog {
|
|
|
3208
3199
|
export interface LoanLogDetail {
|
|
3209
3200
|
/** @format uuid */
|
|
3210
3201
|
id: string;
|
|
3211
|
-
level:
|
|
3212
|
-
type:
|
|
3202
|
+
level: LoanLogDetailLevelEnum;
|
|
3203
|
+
type: LoanLogDetailTypeEnum;
|
|
3213
3204
|
message: string;
|
|
3214
3205
|
/** @format date-time */
|
|
3215
3206
|
createdAt: string;
|
|
@@ -3279,6 +3270,10 @@ export interface LoanOfficerSearchCriteria {
|
|
|
3279
3270
|
/** @format uuid */
|
|
3280
3271
|
brand?: string | null;
|
|
3281
3272
|
}
|
|
3273
|
+
export interface LoanOutstandingItems {
|
|
3274
|
+
/** @format int32 */
|
|
3275
|
+
pendingSignaturePackages: number;
|
|
3276
|
+
}
|
|
3282
3277
|
export interface LoanPatchRequestGuidPatchDocument {
|
|
3283
3278
|
operations: GuidPatchOperation[];
|
|
3284
3279
|
}
|
|
@@ -3475,7 +3470,7 @@ export interface LoanTaskSearchRequest {
|
|
|
3475
3470
|
loanStatus?: LoanTaskActivityFilter | null;
|
|
3476
3471
|
}
|
|
3477
3472
|
export interface LoanTaskStatusSummary {
|
|
3478
|
-
status:
|
|
3473
|
+
status: LoanTaskStatusSummaryStatusEnum;
|
|
3479
3474
|
/** @format int32 */
|
|
3480
3475
|
count: number;
|
|
3481
3476
|
}
|
|
@@ -3487,7 +3482,7 @@ export interface LoanUser {
|
|
|
3487
3482
|
email: string;
|
|
3488
3483
|
phone?: string | null;
|
|
3489
3484
|
role: string;
|
|
3490
|
-
loanRole:
|
|
3485
|
+
loanRole: LoanUserLoanRoleEnum;
|
|
3491
3486
|
isUser: boolean;
|
|
3492
3487
|
/** @format date-time */
|
|
3493
3488
|
createdAt: string;
|
|
@@ -3520,7 +3515,7 @@ export interface LosOperationTracking {
|
|
|
3520
3515
|
operationType: string;
|
|
3521
3516
|
correlationKey: string;
|
|
3522
3517
|
lastTriggerSource?: string | null;
|
|
3523
|
-
status:
|
|
3518
|
+
status: LosOperationTrackingStatusEnum;
|
|
3524
3519
|
/** @format date-time */
|
|
3525
3520
|
createdAt: string;
|
|
3526
3521
|
/** @format date-time */
|
|
@@ -3581,7 +3576,7 @@ export interface LosSyncStep {
|
|
|
3581
3576
|
/** @format int32 */
|
|
3582
3577
|
order: number;
|
|
3583
3578
|
name: string;
|
|
3584
|
-
severity:
|
|
3579
|
+
severity: LosSyncStepSeverityEnum;
|
|
3585
3580
|
message: string;
|
|
3586
3581
|
/** @format date-time */
|
|
3587
3582
|
atUtc: string;
|
|
@@ -3892,7 +3887,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
3892
3887
|
}
|
|
3893
3888
|
export interface Operation {
|
|
3894
3889
|
op?: string;
|
|
3895
|
-
value?:
|
|
3890
|
+
value?: object | null;
|
|
3896
3891
|
path?: string;
|
|
3897
3892
|
}
|
|
3898
3893
|
export interface OverridePasswordRequest {
|
|
@@ -4228,7 +4223,7 @@ export interface SSOTokenRequest {
|
|
|
4228
4223
|
redirectUri: string;
|
|
4229
4224
|
}
|
|
4230
4225
|
export interface SamlMetadataRequest {
|
|
4231
|
-
ssoIntegration:
|
|
4226
|
+
ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
|
|
4232
4227
|
}
|
|
4233
4228
|
export interface SendForgotPasswordRequest {
|
|
4234
4229
|
/**
|
|
@@ -4279,7 +4274,7 @@ export interface SiteConfiguration {
|
|
|
4279
4274
|
deletedAt?: string | null;
|
|
4280
4275
|
/** @format uuid */
|
|
4281
4276
|
id: string;
|
|
4282
|
-
type:
|
|
4277
|
+
type: SiteConfigurationTypeEnum;
|
|
4283
4278
|
/** @format uuid */
|
|
4284
4279
|
entityID: string;
|
|
4285
4280
|
/** @format int32 */
|
|
@@ -4473,7 +4468,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4473
4468
|
deletedAt?: string | null;
|
|
4474
4469
|
/** @format uuid */
|
|
4475
4470
|
id: string;
|
|
4476
|
-
type:
|
|
4471
|
+
type: SiteConfigurationByUrlTypeEnum;
|
|
4477
4472
|
/** @format uuid */
|
|
4478
4473
|
entityID: string;
|
|
4479
4474
|
/** @format int32 */
|
|
@@ -4684,7 +4679,7 @@ export interface SiteConfigurationForm {
|
|
|
4684
4679
|
export interface SiteConfigurationReduced {
|
|
4685
4680
|
/** @format uuid */
|
|
4686
4681
|
id: string;
|
|
4687
|
-
type:
|
|
4682
|
+
type: SiteConfigurationReducedTypeEnum;
|
|
4688
4683
|
url?: string | null;
|
|
4689
4684
|
name: string;
|
|
4690
4685
|
/** @format int64 */
|
|
@@ -4701,7 +4696,7 @@ export interface SiteConfigurationRequest {
|
|
|
4701
4696
|
entityID: string;
|
|
4702
4697
|
/** @format int32 */
|
|
4703
4698
|
entityType: number;
|
|
4704
|
-
type:
|
|
4699
|
+
type: SiteConfigurationRequestTypeEnum;
|
|
4705
4700
|
url: string;
|
|
4706
4701
|
name: string;
|
|
4707
4702
|
introduction?: string | null;
|
|
@@ -4876,7 +4871,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4876
4871
|
export interface SiteConfigurationSummary {
|
|
4877
4872
|
/** @format uuid */
|
|
4878
4873
|
id: string;
|
|
4879
|
-
type:
|
|
4874
|
+
type: SiteConfigurationSummaryTypeEnum;
|
|
4880
4875
|
url?: string | null;
|
|
4881
4876
|
name: string;
|
|
4882
4877
|
/** @format int64 */
|
|
@@ -5492,7 +5487,7 @@ export interface UserDevice {
|
|
|
5492
5487
|
export interface UserDraft {
|
|
5493
5488
|
/** @format uuid */
|
|
5494
5489
|
draftID: string;
|
|
5495
|
-
role:
|
|
5490
|
+
role: UserDraftRoleEnum;
|
|
5496
5491
|
user: User;
|
|
5497
5492
|
}
|
|
5498
5493
|
export interface UserDraftPaginated {
|
|
@@ -5516,7 +5511,7 @@ export interface UserGroupAccessScope {
|
|
|
5516
5511
|
id: string;
|
|
5517
5512
|
/** @format uuid */
|
|
5518
5513
|
groupId: string;
|
|
5519
|
-
scopeType:
|
|
5514
|
+
scopeType: UserGroupAccessScopeScopeTypeEnum;
|
|
5520
5515
|
/** @format uuid */
|
|
5521
5516
|
userId?: string | null;
|
|
5522
5517
|
/** @format uuid */
|
|
@@ -5549,7 +5544,7 @@ export interface UserLoan {
|
|
|
5549
5544
|
deletedAt?: string | null;
|
|
5550
5545
|
loanID: string;
|
|
5551
5546
|
user: User;
|
|
5552
|
-
role:
|
|
5547
|
+
role: UserLoanRoleEnum;
|
|
5553
5548
|
/** @format int32 */
|
|
5554
5549
|
borrowerPair?: number | null;
|
|
5555
5550
|
/** @format int32 */
|
|
@@ -5561,10 +5556,11 @@ export interface UserLoanConsent {
|
|
|
5561
5556
|
id: string;
|
|
5562
5557
|
/** @format uuid */
|
|
5563
5558
|
userLoanID: string;
|
|
5564
|
-
type:
|
|
5559
|
+
type: UserLoanConsentTypeEnum;
|
|
5565
5560
|
providedConsent: boolean;
|
|
5561
|
+
source?: ConsentSource | null;
|
|
5566
5562
|
ipAddress?: string | null;
|
|
5567
|
-
losSyncStatus:
|
|
5563
|
+
losSyncStatus: UserLoanConsentLosSyncStatusEnum;
|
|
5568
5564
|
/** @format date-time */
|
|
5569
5565
|
createdAt: string;
|
|
5570
5566
|
/** @format date-time */
|
|
@@ -5705,7 +5701,7 @@ export interface UserSummary {
|
|
|
5705
5701
|
id: string;
|
|
5706
5702
|
name?: string | null;
|
|
5707
5703
|
email?: string | null;
|
|
5708
|
-
role:
|
|
5704
|
+
role: UserSummaryRoleEnum;
|
|
5709
5705
|
}
|
|
5710
5706
|
export interface VerifyPasswordRequest {
|
|
5711
5707
|
/**
|
|
@@ -5738,6 +5734,70 @@ export interface Workflow {
|
|
|
5738
5734
|
tileSubtitle: string;
|
|
5739
5735
|
icon: string;
|
|
5740
5736
|
}
|
|
5737
|
+
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5738
|
+
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
5739
|
+
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5740
|
+
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5741
|
+
export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5742
|
+
export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
|
|
5743
|
+
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5744
|
+
/** @deprecated */
|
|
5745
|
+
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5746
|
+
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5747
|
+
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5748
|
+
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5749
|
+
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
5750
|
+
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5751
|
+
export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5752
|
+
export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5753
|
+
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5754
|
+
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5755
|
+
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5756
|
+
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5757
|
+
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5758
|
+
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5759
|
+
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5760
|
+
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
5761
|
+
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
5762
|
+
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5763
|
+
export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
|
|
5764
|
+
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5765
|
+
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
5766
|
+
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5767
|
+
export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5768
|
+
export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5769
|
+
export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5770
|
+
export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5771
|
+
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5772
|
+
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5773
|
+
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5774
|
+
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5775
|
+
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
|
|
5776
|
+
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5777
|
+
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
|
|
5778
|
+
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
5779
|
+
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5780
|
+
export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
5781
|
+
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
5782
|
+
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5783
|
+
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5784
|
+
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5785
|
+
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5786
|
+
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5787
|
+
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5788
|
+
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5789
|
+
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5790
|
+
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5791
|
+
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5792
|
+
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
5793
|
+
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5794
|
+
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
5795
|
+
/** @default "Realtor" */
|
|
5796
|
+
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5797
|
+
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5798
|
+
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5799
|
+
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5800
|
+
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5741
5801
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5742
5802
|
export type QueryParamsType = Record<string | number, any>;
|
|
5743
5803
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5761,7 +5821,6 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
5761
5821
|
format?: ResponseType;
|
|
5762
5822
|
}
|
|
5763
5823
|
export declare enum ContentType {
|
|
5764
|
-
JsonPatch = "application/json-patch+json",
|
|
5765
5824
|
Json = "application/json",
|
|
5766
5825
|
JsonApi = "application/vnd.api+json",
|
|
5767
5826
|
FormData = "multipart/form-data",
|
|
@@ -5783,7 +5842,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5783
5842
|
}
|
|
5784
5843
|
/**
|
|
5785
5844
|
* @title The Big POS API
|
|
5786
|
-
* @version v2.40.
|
|
5845
|
+
* @version v2.40.5
|
|
5787
5846
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5788
5847
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5789
5848
|
*/
|
|
@@ -6468,7 +6527,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6468
6527
|
* @response `200` `(CustomFieldDefinition)[]` Success
|
|
6469
6528
|
*/
|
|
6470
6529
|
getCustomFieldDefinitions: (query?: {
|
|
6471
|
-
entityType?:
|
|
6530
|
+
entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
|
|
6472
6531
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
|
|
6473
6532
|
/**
|
|
6474
6533
|
* No description
|
|
@@ -6857,7 +6916,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6857
6916
|
* @response `500` `EncompassError` Server Error
|
|
6858
6917
|
*/
|
|
6859
6918
|
getUserPackages: (query?: {
|
|
6860
|
-
/** @default "all" */
|
|
6861
6919
|
status?: string;
|
|
6862
6920
|
/**
|
|
6863
6921
|
* @format int32
|
|
@@ -6871,6 +6929,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6871
6929
|
pageSize?: number;
|
|
6872
6930
|
/** @format uuid */
|
|
6873
6931
|
loanId?: string;
|
|
6932
|
+
sortBy?: string;
|
|
6933
|
+
sortDirection?: string;
|
|
6874
6934
|
}, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
|
|
6875
6935
|
/**
|
|
6876
6936
|
* No description
|
|
@@ -7236,17 +7296,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7236
7296
|
* @response `200` `FormVersion` Success
|
|
7237
7297
|
*/
|
|
7238
7298
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
7239
|
-
/**
|
|
7240
|
-
* No description
|
|
7241
|
-
*
|
|
7242
|
-
* @tags IntegrationSettings
|
|
7243
|
-
* @name GetIntegrationSettings
|
|
7244
|
-
* @summary Get Integration Settings
|
|
7245
|
-
* @request GET:/api/integrations/settings
|
|
7246
|
-
* @secure
|
|
7247
|
-
* @response `200` `IntegrationSettings` Success
|
|
7248
|
-
*/
|
|
7249
|
-
getIntegrationSettings: (params?: RequestParams) => Promise<AxiosResponse<IntegrationSettings, any, {}>>;
|
|
7250
7299
|
/**
|
|
7251
7300
|
* No description
|
|
7252
7301
|
*
|
|
@@ -8521,6 +8570,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8521
8570
|
* @response `404` `ProblemDetails` Not Found
|
|
8522
8571
|
*/
|
|
8523
8572
|
syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
8573
|
+
/**
|
|
8574
|
+
* No description
|
|
8575
|
+
*
|
|
8576
|
+
* @tags Loans
|
|
8577
|
+
* @name GetLoanOutstandingItems
|
|
8578
|
+
* @summary Get outstanding items
|
|
8579
|
+
* @request GET:/api/loans/{loanId}/outstanding-items
|
|
8580
|
+
* @secure
|
|
8581
|
+
* @response `200` `LoanOutstandingItems` Success
|
|
8582
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8583
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8584
|
+
*/
|
|
8585
|
+
getLoanOutstandingItems: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanOutstandingItems, any, {}>>;
|
|
8524
8586
|
/**
|
|
8525
8587
|
* No description
|
|
8526
8588
|
*
|
|
@@ -9161,7 +9223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9161
9223
|
getPartners: (query?: {
|
|
9162
9224
|
showAll?: boolean;
|
|
9163
9225
|
/** @default "Realtor" */
|
|
9164
|
-
role?:
|
|
9226
|
+
role?: GetPartnersParamsRoleEnum;
|
|
9165
9227
|
/** @format int32 */
|
|
9166
9228
|
pageSize?: number;
|
|
9167
9229
|
/** @format int32 */
|
|
@@ -9339,7 +9401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9339
9401
|
* @response `200` `File` Success
|
|
9340
9402
|
* @response `404` `ProblemDetails` Not Found
|
|
9341
9403
|
*/
|
|
9342
|
-
getSamlMetadata: (sSoIntegration:
|
|
9404
|
+
getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
9343
9405
|
/**
|
|
9344
9406
|
* No description
|
|
9345
9407
|
*
|
|
@@ -9350,7 +9412,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9350
9412
|
* @secure
|
|
9351
9413
|
* @response `200` `File` Success
|
|
9352
9414
|
*/
|
|
9353
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
9415
|
+
createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
9354
9416
|
/**
|
|
9355
9417
|
* No description
|
|
9356
9418
|
*
|