@matech/thebigpos-sdk 2.45.0-rc5 → 2.45.0-rc7
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/dist/index.d.ts +210 -262
- package/dist/index.js +201 -228
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +937 -1227
- package/tsconfig.json +27 -27
package/dist/index.d.ts
CHANGED
|
@@ -31,14 +31,14 @@ export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
|
|
|
31
31
|
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
32
32
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
33
33
|
export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
|
|
34
|
-
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
|
|
34
|
+
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
|
|
35
35
|
export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
36
36
|
export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
|
|
37
37
|
export type LoanHousingType = "NoExpense" | "Own" | "Rent";
|
|
38
38
|
export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
|
|
39
39
|
export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
|
|
40
40
|
export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
|
|
41
|
-
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
|
|
41
|
+
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
|
|
42
42
|
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
|
|
43
43
|
export type LoanGenderType = "Male" | "Female";
|
|
44
44
|
export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
|
|
@@ -132,7 +132,7 @@ export interface AccountBilling {
|
|
|
132
132
|
contractedRate: number;
|
|
133
133
|
}
|
|
134
134
|
export interface AccountBillingRequest {
|
|
135
|
-
billingType:
|
|
135
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
136
136
|
/** @format double */
|
|
137
137
|
contractedRate: number;
|
|
138
138
|
}
|
|
@@ -167,7 +167,6 @@ export interface AccountSettingsRequest {
|
|
|
167
167
|
isSmsEnabled: boolean;
|
|
168
168
|
smsNumber?: string | null;
|
|
169
169
|
isEarlyAdopter: boolean;
|
|
170
|
-
isAIEnabled: boolean;
|
|
171
170
|
}
|
|
172
171
|
export interface Action {
|
|
173
172
|
/** @format uuid */
|
|
@@ -176,7 +175,7 @@ export interface Action {
|
|
|
176
175
|
comments?: string | null;
|
|
177
176
|
/** @format uuid */
|
|
178
177
|
siteConfigurationID: string;
|
|
179
|
-
applicationSettings?: any
|
|
178
|
+
applicationSettings?: any;
|
|
180
179
|
surveysToken?: string | null;
|
|
181
180
|
}
|
|
182
181
|
export interface Address {
|
|
@@ -397,7 +396,7 @@ export interface AiAuditLog {
|
|
|
397
396
|
conversationId?: string | null;
|
|
398
397
|
/** @format uuid */
|
|
399
398
|
messageId?: string | null;
|
|
400
|
-
eventType:
|
|
399
|
+
eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
|
|
401
400
|
modelId?: string | null;
|
|
402
401
|
/** @format int32 */
|
|
403
402
|
inputTokens?: number | null;
|
|
@@ -410,7 +409,7 @@ export interface AiAuditLog {
|
|
|
410
409
|
guardrailCategory?: string | null;
|
|
411
410
|
rawRequest?: string | null;
|
|
412
411
|
rawResponse?: string | null;
|
|
413
|
-
details?: any
|
|
412
|
+
details?: any;
|
|
414
413
|
/** @format date-time */
|
|
415
414
|
createdAt: string;
|
|
416
415
|
}
|
|
@@ -472,7 +471,7 @@ export interface AiChatMessagePaginated {
|
|
|
472
471
|
count: number;
|
|
473
472
|
}
|
|
474
473
|
export interface AiChatMetadata {
|
|
475
|
-
intent:
|
|
474
|
+
intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
476
475
|
fieldsAccessed: string[];
|
|
477
476
|
/** @format int64 */
|
|
478
477
|
queryTimeMs: number;
|
|
@@ -498,7 +497,7 @@ export interface AiChatRequest {
|
|
|
498
497
|
promptId?: string | null;
|
|
499
498
|
}
|
|
500
499
|
export interface AiChatStructuredData {
|
|
501
|
-
type:
|
|
500
|
+
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
502
501
|
displayHint?: AiDisplayHint | null;
|
|
503
502
|
detectedDocumentType?: string | null;
|
|
504
503
|
columns: string[];
|
|
@@ -514,12 +513,12 @@ export interface AiConfigChangeLog {
|
|
|
514
513
|
accountId?: string | null;
|
|
515
514
|
/** @format uuid */
|
|
516
515
|
actorUserId: string;
|
|
517
|
-
entityType:
|
|
516
|
+
entityType: "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
|
|
518
517
|
/** @format uuid */
|
|
519
518
|
entityId?: string | null;
|
|
520
|
-
action:
|
|
521
|
-
before?: any
|
|
522
|
-
after?: any
|
|
519
|
+
action: "Created" | "Updated" | "Deleted" | "Toggled";
|
|
520
|
+
before?: any;
|
|
521
|
+
after?: any;
|
|
523
522
|
/** @format date-time */
|
|
524
523
|
createdAt: string;
|
|
525
524
|
}
|
|
@@ -593,7 +592,7 @@ export interface AiGuardrail {
|
|
|
593
592
|
/** @format uuid */
|
|
594
593
|
id: string;
|
|
595
594
|
name: string;
|
|
596
|
-
category:
|
|
595
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
597
596
|
description?: string | null;
|
|
598
597
|
keywords: string[];
|
|
599
598
|
responseTemplate: string;
|
|
@@ -699,8 +698,8 @@ export interface AiUrlSource {
|
|
|
699
698
|
name: string;
|
|
700
699
|
url: string;
|
|
701
700
|
description?: string | null;
|
|
702
|
-
category:
|
|
703
|
-
scope:
|
|
701
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
702
|
+
scope: "FullDomain" | "SpecificPath";
|
|
704
703
|
isActive: boolean;
|
|
705
704
|
isDefault: boolean;
|
|
706
705
|
hasAccountOverride: boolean;
|
|
@@ -799,10 +798,6 @@ export interface ApplicationRowData {
|
|
|
799
798
|
escrowAgent?: EncompassContact | null;
|
|
800
799
|
titleInsuranceAgent?: EncompassContact | null;
|
|
801
800
|
}
|
|
802
|
-
export interface Attachment {
|
|
803
|
-
fileName: string;
|
|
804
|
-
base64Data: string;
|
|
805
|
-
}
|
|
806
801
|
export interface AuditEntityType {
|
|
807
802
|
entityType: string;
|
|
808
803
|
rootEntityType?: string | null;
|
|
@@ -811,14 +806,14 @@ export interface AuditLogEntry {
|
|
|
811
806
|
/** @format uuid */
|
|
812
807
|
id: string;
|
|
813
808
|
entityType: string;
|
|
814
|
-
changeType:
|
|
809
|
+
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
815
810
|
/** @format uuid */
|
|
816
811
|
entityId: string;
|
|
817
812
|
performedBy?: AuditLogUser | null;
|
|
818
813
|
rootEntityType?: string | null;
|
|
819
814
|
/** @format uuid */
|
|
820
815
|
rootEntityId?: string | null;
|
|
821
|
-
changes?: any
|
|
816
|
+
changes?: any;
|
|
822
817
|
/** @format date-time */
|
|
823
818
|
createdAt: string;
|
|
824
819
|
}
|
|
@@ -858,7 +853,7 @@ export interface BorrowerCount {
|
|
|
858
853
|
firstName: string;
|
|
859
854
|
lastName: string;
|
|
860
855
|
email: string;
|
|
861
|
-
role:
|
|
856
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
862
857
|
/** @format int32 */
|
|
863
858
|
count: number;
|
|
864
859
|
}
|
|
@@ -868,7 +863,7 @@ export interface BorrowerIdentity {
|
|
|
868
863
|
firstName: string;
|
|
869
864
|
lastName: string;
|
|
870
865
|
email: string;
|
|
871
|
-
role:
|
|
866
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
872
867
|
}
|
|
873
868
|
export interface BorrowersNotUsingPosSummary {
|
|
874
869
|
/** @format int32 */
|
|
@@ -1102,7 +1097,7 @@ export interface CorporateSearchCriteria {
|
|
|
1102
1097
|
isActive?: boolean | null;
|
|
1103
1098
|
}
|
|
1104
1099
|
export interface CreateAccessScopeRequest {
|
|
1105
|
-
scopeType:
|
|
1100
|
+
scopeType: "User" | "Branch";
|
|
1106
1101
|
/** @format uuid */
|
|
1107
1102
|
userId?: string | null;
|
|
1108
1103
|
/** @format uuid */
|
|
@@ -1120,7 +1115,7 @@ export interface CreateAccountRequest {
|
|
|
1120
1115
|
/** @format int64 */
|
|
1121
1116
|
nlmsid: number;
|
|
1122
1117
|
settings: AccountSettingsRequest;
|
|
1123
|
-
environment:
|
|
1118
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1124
1119
|
losIntegration: LOSIntegration;
|
|
1125
1120
|
billingSettings: AccountBillingRequest;
|
|
1126
1121
|
}
|
|
@@ -1134,7 +1129,7 @@ export interface CreateAiCanonicalFieldRequest {
|
|
|
1134
1129
|
}
|
|
1135
1130
|
export interface CreateAiGuardrailRequest {
|
|
1136
1131
|
name: string;
|
|
1137
|
-
category:
|
|
1132
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
1138
1133
|
description?: string | null;
|
|
1139
1134
|
keywords: string[];
|
|
1140
1135
|
responseTemplate: string;
|
|
@@ -1160,8 +1155,8 @@ export interface CreateAiUrlSourceRequest {
|
|
|
1160
1155
|
name: string;
|
|
1161
1156
|
url: string;
|
|
1162
1157
|
description?: string | null;
|
|
1163
|
-
category:
|
|
1164
|
-
scope:
|
|
1158
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
1159
|
+
scope: "FullDomain" | "SpecificPath";
|
|
1165
1160
|
}
|
|
1166
1161
|
export interface CreateBranchRequest {
|
|
1167
1162
|
name: string;
|
|
@@ -1184,8 +1179,8 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
1184
1179
|
name: string;
|
|
1185
1180
|
defaultValue?: string | null;
|
|
1186
1181
|
regexPattern?: string | null;
|
|
1187
|
-
dataType:
|
|
1188
|
-
entityType:
|
|
1182
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1183
|
+
entityType: "Loan";
|
|
1189
1184
|
options?: CustomFieldOptionRequest[] | null;
|
|
1190
1185
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
1191
1186
|
}
|
|
@@ -1200,7 +1195,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1200
1195
|
export interface CreateGroupMemberRequest {
|
|
1201
1196
|
/** @format uuid */
|
|
1202
1197
|
userId: string;
|
|
1203
|
-
loanRole:
|
|
1198
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1204
1199
|
}
|
|
1205
1200
|
export interface CreateInviteRequest {
|
|
1206
1201
|
firstName: string;
|
|
@@ -1208,7 +1203,7 @@ export interface CreateInviteRequest {
|
|
|
1208
1203
|
emailAddress: string;
|
|
1209
1204
|
phoneNumber?: string | null;
|
|
1210
1205
|
/** @deprecated */
|
|
1211
|
-
relationship:
|
|
1206
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1212
1207
|
loanID: string;
|
|
1213
1208
|
route?: string | null;
|
|
1214
1209
|
/** @format uuid */
|
|
@@ -1228,7 +1223,7 @@ export interface CreateLoanImportRequest {
|
|
|
1228
1223
|
endDate: string;
|
|
1229
1224
|
/** @format date-time */
|
|
1230
1225
|
startDate: string;
|
|
1231
|
-
importMode:
|
|
1226
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1232
1227
|
}
|
|
1233
1228
|
export interface CreateSession {
|
|
1234
1229
|
sessionId: string;
|
|
@@ -1246,7 +1241,7 @@ export interface CreateUserDeviceRequest {
|
|
|
1246
1241
|
token: string;
|
|
1247
1242
|
}
|
|
1248
1243
|
export interface CreateUserDraft {
|
|
1249
|
-
loanRole:
|
|
1244
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1250
1245
|
}
|
|
1251
1246
|
export interface CreateUserGroupRequest {
|
|
1252
1247
|
name: string;
|
|
@@ -1307,8 +1302,8 @@ export interface CustomFieldDefinition {
|
|
|
1307
1302
|
name: string;
|
|
1308
1303
|
defaultValue?: string | null;
|
|
1309
1304
|
regexPattern?: string | null;
|
|
1310
|
-
dataType:
|
|
1311
|
-
entityType:
|
|
1305
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1306
|
+
entityType: "Loan";
|
|
1312
1307
|
options: CustomFieldOption[];
|
|
1313
1308
|
permissions: CustomFieldPermission[];
|
|
1314
1309
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1322,7 +1317,7 @@ export interface CustomFieldEntry {
|
|
|
1322
1317
|
displayOrder: number;
|
|
1323
1318
|
name: string;
|
|
1324
1319
|
value: string;
|
|
1325
|
-
dataType:
|
|
1320
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1326
1321
|
}
|
|
1327
1322
|
export interface CustomFieldOption {
|
|
1328
1323
|
/** @format uuid */
|
|
@@ -1339,12 +1334,12 @@ export interface CustomFieldOptionRequest {
|
|
|
1339
1334
|
export interface CustomFieldPermission {
|
|
1340
1335
|
/** @format uuid */
|
|
1341
1336
|
id: string;
|
|
1342
|
-
role:
|
|
1343
|
-
accessLevel:
|
|
1337
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1338
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1344
1339
|
}
|
|
1345
1340
|
export interface CustomFieldPermissionRequest {
|
|
1346
|
-
role:
|
|
1347
|
-
accessLevel:
|
|
1341
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1342
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1348
1343
|
}
|
|
1349
1344
|
export interface CustomFieldValue {
|
|
1350
1345
|
/** @format uuid */
|
|
@@ -1355,7 +1350,7 @@ export interface CustomFieldValue {
|
|
|
1355
1350
|
customFieldDefinitionID: string;
|
|
1356
1351
|
value: string;
|
|
1357
1352
|
definitionName: string;
|
|
1358
|
-
dataType:
|
|
1353
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1359
1354
|
}
|
|
1360
1355
|
export interface DetailedUser {
|
|
1361
1356
|
/** @format date-time */
|
|
@@ -1593,7 +1588,7 @@ export interface Draft {
|
|
|
1593
1588
|
siteConfiguration: SiteConfigurationReduced;
|
|
1594
1589
|
/** @format uuid */
|
|
1595
1590
|
loanID?: string | null;
|
|
1596
|
-
type:
|
|
1591
|
+
type: "NewLoan" | "EditLoan";
|
|
1597
1592
|
isCoBorrower: boolean;
|
|
1598
1593
|
}
|
|
1599
1594
|
export interface DraftContent {
|
|
@@ -1611,7 +1606,7 @@ export interface DraftContent {
|
|
|
1611
1606
|
siteConfiguration: SiteConfigurationReduced;
|
|
1612
1607
|
/** @format uuid */
|
|
1613
1608
|
loanID?: string | null;
|
|
1614
|
-
type:
|
|
1609
|
+
type: "NewLoan" | "EditLoan";
|
|
1615
1610
|
isCoBorrower: boolean;
|
|
1616
1611
|
applicationPayload: any;
|
|
1617
1612
|
}
|
|
@@ -1627,7 +1622,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1627
1622
|
}
|
|
1628
1623
|
export interface DraftRequest {
|
|
1629
1624
|
applicationPayload: any;
|
|
1630
|
-
customData?: any
|
|
1625
|
+
customData?: any;
|
|
1631
1626
|
isCoBorrower: boolean;
|
|
1632
1627
|
}
|
|
1633
1628
|
export interface EconsentPendingSummary {
|
|
@@ -1701,9 +1696,9 @@ export interface EncompassCredentialsDetail {
|
|
|
1701
1696
|
clearStateIfUnlicensed: boolean;
|
|
1702
1697
|
/** @deprecated */
|
|
1703
1698
|
baseUrl?: string | null;
|
|
1704
|
-
encompassEnvironment:
|
|
1699
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1705
1700
|
consumerConnectWidgetHost?: string | null;
|
|
1706
|
-
signingMethod:
|
|
1701
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1707
1702
|
subscriptionId?: string | null;
|
|
1708
1703
|
environment?: string | null;
|
|
1709
1704
|
}
|
|
@@ -1719,9 +1714,9 @@ export interface EncompassCredentialsRequest {
|
|
|
1719
1714
|
clearStateIfUnlicensed: boolean;
|
|
1720
1715
|
/** @deprecated */
|
|
1721
1716
|
baseUrl?: string | null;
|
|
1722
|
-
encompassEnvironment:
|
|
1717
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1723
1718
|
consumerConnectWidgetHost?: string | null;
|
|
1724
|
-
signingMethod:
|
|
1719
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1725
1720
|
subscriptionId?: string | null;
|
|
1726
1721
|
environment?: string | null;
|
|
1727
1722
|
clientID?: string | null;
|
|
@@ -1830,8 +1825,8 @@ export interface EncompassRequestLog {
|
|
|
1830
1825
|
losId?: string | null;
|
|
1831
1826
|
/** @format uuid */
|
|
1832
1827
|
accountId: string;
|
|
1833
|
-
operationType:
|
|
1834
|
-
outcome:
|
|
1828
|
+
operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
1829
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1835
1830
|
message: string;
|
|
1836
1831
|
endpoint?: string | null;
|
|
1837
1832
|
httpMethod?: string | null;
|
|
@@ -1839,7 +1834,7 @@ export interface EncompassRequestLog {
|
|
|
1839
1834
|
httpStatusCode?: number | null;
|
|
1840
1835
|
/** @format int64 */
|
|
1841
1836
|
durationMs?: number | null;
|
|
1842
|
-
context?: any
|
|
1837
|
+
context?: any;
|
|
1843
1838
|
/** @format date-time */
|
|
1844
1839
|
createdAt: string;
|
|
1845
1840
|
}
|
|
@@ -1878,7 +1873,7 @@ export interface FileSearchCriteria {
|
|
|
1878
1873
|
export interface FileWithBytes {
|
|
1879
1874
|
name: string;
|
|
1880
1875
|
/** @format byte */
|
|
1881
|
-
data:
|
|
1876
|
+
data: string;
|
|
1882
1877
|
fileName: string;
|
|
1883
1878
|
mimeType?: string | null;
|
|
1884
1879
|
extension?: string | null;
|
|
@@ -1954,7 +1949,7 @@ export interface FormSubmission {
|
|
|
1954
1949
|
subjectPropertyAddressCounty?: string | null;
|
|
1955
1950
|
subjectPropertyAddressState?: string | null;
|
|
1956
1951
|
subjectPropertyAddressZip?: string | null;
|
|
1957
|
-
data?: any
|
|
1952
|
+
data?: any;
|
|
1958
1953
|
/** @format uuid */
|
|
1959
1954
|
listingID?: string | null;
|
|
1960
1955
|
listing?: Listing | null;
|
|
@@ -1989,7 +1984,7 @@ export interface FormSubmissionRequest {
|
|
|
1989
1984
|
subjectPropertyAddressCounty?: string | null;
|
|
1990
1985
|
subjectPropertyAddressState?: string | null;
|
|
1991
1986
|
subjectPropertyAddressZip?: string | null;
|
|
1992
|
-
data?: any
|
|
1987
|
+
data?: any;
|
|
1993
1988
|
/** @format uuid */
|
|
1994
1989
|
listingID?: string | null;
|
|
1995
1990
|
}
|
|
@@ -2038,13 +2033,11 @@ export interface FusionFieldDisplay {
|
|
|
2038
2033
|
fieldValue: string;
|
|
2039
2034
|
}
|
|
2040
2035
|
export interface FusionReportFilter {
|
|
2041
|
-
filterType:
|
|
2036
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
2042
2037
|
targetField: string;
|
|
2043
2038
|
targetValue: string;
|
|
2044
2039
|
}
|
|
2045
2040
|
export interface GenerateDocumentRequest {
|
|
2046
|
-
/** @deprecated */
|
|
2047
|
-
loanID?: string | null;
|
|
2048
2041
|
/** @format uuid */
|
|
2049
2042
|
templateID: string;
|
|
2050
2043
|
/**
|
|
@@ -2060,7 +2053,7 @@ export interface GenerateSystemPrompt {
|
|
|
2060
2053
|
}
|
|
2061
2054
|
export interface GenerateSystemPromptRequest {
|
|
2062
2055
|
description: string;
|
|
2063
|
-
category:
|
|
2056
|
+
category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
2064
2057
|
}
|
|
2065
2058
|
export interface GetApplications {
|
|
2066
2059
|
applications: ApplicationRowData[];
|
|
@@ -2144,11 +2137,11 @@ export interface GetWorkflowRequest {
|
|
|
2144
2137
|
export interface GuidPatchOperation {
|
|
2145
2138
|
op: string;
|
|
2146
2139
|
path: string;
|
|
2147
|
-
value?: any
|
|
2140
|
+
value?: any;
|
|
2148
2141
|
from?: string | null;
|
|
2149
2142
|
}
|
|
2150
2143
|
export interface IPAddress {
|
|
2151
|
-
addressFamily:
|
|
2144
|
+
addressFamily: "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";
|
|
2152
2145
|
/** @format int64 */
|
|
2153
2146
|
scopeId: number;
|
|
2154
2147
|
isIPv6Multicast: boolean;
|
|
@@ -2389,13 +2382,15 @@ export interface Loan {
|
|
|
2389
2382
|
financial?: LoanFinancial | null;
|
|
2390
2383
|
financialTerms?: LoanFinancialTerms | null;
|
|
2391
2384
|
monthlyPayment?: LoanMonthlyPayment | null;
|
|
2385
|
+
costDetails?: LoanCostDetails | null;
|
|
2386
|
+
metrics?: LoanMetrics | null;
|
|
2392
2387
|
borrowers: LoanBorrower[];
|
|
2393
2388
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2394
2389
|
userLoans: UserLoan[];
|
|
2395
2390
|
contacts: LoanContact[];
|
|
2396
2391
|
customFields: CustomFieldEntry[];
|
|
2397
2392
|
milestones: LoanMilestone[];
|
|
2398
|
-
signingMethod:
|
|
2393
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
2399
2394
|
}
|
|
2400
2395
|
export interface LoanApplication {
|
|
2401
2396
|
/** @format uuid */
|
|
@@ -2427,11 +2422,13 @@ export interface LoanApplicationRequest {
|
|
|
2427
2422
|
companyName?: string | null;
|
|
2428
2423
|
property?: LoanPropertyRequest | null;
|
|
2429
2424
|
financial?: LoanFinancialRequest | null;
|
|
2425
|
+
financialTerms?: LoanFinancialTermsRequest | null;
|
|
2426
|
+
monthlyPayment?: LoanMonthlyPaymentRequest | null;
|
|
2430
2427
|
borrowers: LoanBorrowerRequest[];
|
|
2431
2428
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2432
2429
|
/** @format uuid */
|
|
2433
2430
|
draftId?: string | null;
|
|
2434
|
-
additionalFields?: Record<string, any
|
|
2431
|
+
additionalFields?: Record<string, any>;
|
|
2435
2432
|
/** @format uuid */
|
|
2436
2433
|
existingLoanId?: string | null;
|
|
2437
2434
|
}
|
|
@@ -2450,9 +2447,11 @@ export interface LoanBorrower {
|
|
|
2450
2447
|
citizenship?: LoanCitizenship | null;
|
|
2451
2448
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2452
2449
|
languagePreference?: LoanLanguagePreference | null;
|
|
2453
|
-
applicationStatus:
|
|
2450
|
+
applicationStatus: "Draft" | "Complete";
|
|
2454
2451
|
/** @format int32 */
|
|
2455
2452
|
numberOfDependents?: number | null;
|
|
2453
|
+
/** @format int32 */
|
|
2454
|
+
creditDecisionScore?: number | null;
|
|
2456
2455
|
isPrimaryBorrower: boolean;
|
|
2457
2456
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
2458
2457
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
@@ -2810,6 +2809,11 @@ export interface LoanBorrowerGift {
|
|
|
2810
2809
|
isDeposited?: boolean | null;
|
|
2811
2810
|
source?: LoanGiftSource | null;
|
|
2812
2811
|
assetType?: LoanGiftAssetType | null;
|
|
2812
|
+
grantorDonorName?: string | null;
|
|
2813
|
+
/** @format double */
|
|
2814
|
+
amountAppliedToDownPayment?: number | null;
|
|
2815
|
+
/** @format double */
|
|
2816
|
+
amountAppliedToClosingCosts?: number | null;
|
|
2813
2817
|
}
|
|
2814
2818
|
export interface LoanBorrowerGiftRequest {
|
|
2815
2819
|
/** @format double */
|
|
@@ -2986,7 +2990,15 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
2986
2990
|
/** @format double */
|
|
2987
2991
|
monthlyRentalIncome?: number | null;
|
|
2988
2992
|
/** @format double */
|
|
2993
|
+
rentalIncomeNetAmount?: number | null;
|
|
2994
|
+
/** @format double */
|
|
2989
2995
|
maintenanceExpense?: number | null;
|
|
2996
|
+
/** @format double */
|
|
2997
|
+
percentageOfRental?: number | null;
|
|
2998
|
+
/** @format double */
|
|
2999
|
+
participationPercentage?: number | null;
|
|
3000
|
+
/** @format date */
|
|
3001
|
+
acquiredDate?: string | null;
|
|
2990
3002
|
dispositionStatus?: string | null;
|
|
2991
3003
|
address?: AddressV3 | null;
|
|
2992
3004
|
mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
|
|
@@ -3161,7 +3173,7 @@ export interface LoanConsentRequest {
|
|
|
3161
3173
|
borrowerEConsent?: boolean | null;
|
|
3162
3174
|
borrowerCreditAuth?: boolean | null;
|
|
3163
3175
|
borrowerTCPAOptIn?: boolean | null;
|
|
3164
|
-
additionalFields?: Record<string, string
|
|
3176
|
+
additionalFields?: Record<string, string>;
|
|
3165
3177
|
}
|
|
3166
3178
|
export interface LoanContact {
|
|
3167
3179
|
/** @format date-time */
|
|
@@ -3179,13 +3191,29 @@ export interface LoanContact {
|
|
|
3179
3191
|
email?: string | null;
|
|
3180
3192
|
phone?: string | null;
|
|
3181
3193
|
companyName?: string | null;
|
|
3182
|
-
role:
|
|
3194
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3183
3195
|
}
|
|
3184
3196
|
export interface LoanContactList {
|
|
3185
3197
|
email: string;
|
|
3186
3198
|
}
|
|
3199
|
+
export interface LoanCostDetails {
|
|
3200
|
+
/** @format uuid */
|
|
3201
|
+
id?: string | null;
|
|
3202
|
+
/** @format double */
|
|
3203
|
+
closingCosts?: number | null;
|
|
3204
|
+
/** @format double */
|
|
3205
|
+
prepaidCharges?: number | null;
|
|
3206
|
+
/** @format double */
|
|
3207
|
+
discount?: number | null;
|
|
3208
|
+
/** @format double */
|
|
3209
|
+
lenderCredit?: number | null;
|
|
3210
|
+
/** @format double */
|
|
3211
|
+
totalCost?: number | null;
|
|
3212
|
+
/** @format double */
|
|
3213
|
+
totalFinancing?: number | null;
|
|
3214
|
+
}
|
|
3187
3215
|
export interface LoanCustomFieldsRequest {
|
|
3188
|
-
additionalFields?: Record<string, string
|
|
3216
|
+
additionalFields?: Record<string, string>;
|
|
3189
3217
|
}
|
|
3190
3218
|
export interface LoanDocument {
|
|
3191
3219
|
/** @format date-time */
|
|
@@ -3235,12 +3263,12 @@ export interface LoanDocumentFolderPermission {
|
|
|
3235
3263
|
id: string;
|
|
3236
3264
|
/** @format uuid */
|
|
3237
3265
|
loanDocumentFolderID: string;
|
|
3238
|
-
role:
|
|
3239
|
-
level:
|
|
3266
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3267
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3240
3268
|
}
|
|
3241
3269
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3242
|
-
role:
|
|
3243
|
-
level:
|
|
3270
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3271
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3244
3272
|
}
|
|
3245
3273
|
export interface LoanDocumentFolderUsage {
|
|
3246
3274
|
/** @format uuid */
|
|
@@ -3336,6 +3364,24 @@ export interface LoanFinancialTerms {
|
|
|
3336
3364
|
baseLoanAmount?: number | null;
|
|
3337
3365
|
/** @format double */
|
|
3338
3366
|
totalLoanAmount?: number | null;
|
|
3367
|
+
/** @format double */
|
|
3368
|
+
mortgageInsuranceFactor?: number | null;
|
|
3369
|
+
isEscrowWaived?: boolean | null;
|
|
3370
|
+
}
|
|
3371
|
+
export interface LoanFinancialTermsRequest {
|
|
3372
|
+
/** @format int32 */
|
|
3373
|
+
loanTermMonths?: number | null;
|
|
3374
|
+
amortizationType?: LoanAmortizationType | null;
|
|
3375
|
+
/** @format double */
|
|
3376
|
+
apr?: number | null;
|
|
3377
|
+
/** @format double */
|
|
3378
|
+
interestRate?: number | null;
|
|
3379
|
+
/** @format double */
|
|
3380
|
+
downPayment?: number | null;
|
|
3381
|
+
/** @format double */
|
|
3382
|
+
baseLoanAmount?: number | null;
|
|
3383
|
+
/** @format double */
|
|
3384
|
+
totalLoanAmount?: number | null;
|
|
3339
3385
|
}
|
|
3340
3386
|
export interface LoanIdentifier {
|
|
3341
3387
|
/** @format uuid */
|
|
@@ -3356,13 +3402,13 @@ export interface LoanImport {
|
|
|
3356
3402
|
/** @format int32 */
|
|
3357
3403
|
importedCount: number;
|
|
3358
3404
|
statusMessage?: string | null;
|
|
3359
|
-
status:
|
|
3360
|
-
importMode:
|
|
3405
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
3406
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3361
3407
|
/** @format date-time */
|
|
3362
3408
|
createdAt?: string | null;
|
|
3363
3409
|
}
|
|
3364
3410
|
export interface LoanImportLog {
|
|
3365
|
-
level:
|
|
3411
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3366
3412
|
message: string;
|
|
3367
3413
|
/** @format date-time */
|
|
3368
3414
|
createdAt: string;
|
|
@@ -3417,8 +3463,8 @@ export interface LoanListPaginated {
|
|
|
3417
3463
|
export interface LoanLog {
|
|
3418
3464
|
/** @format uuid */
|
|
3419
3465
|
id: string;
|
|
3420
|
-
level:
|
|
3421
|
-
type:
|
|
3466
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3467
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
3422
3468
|
message: string;
|
|
3423
3469
|
/** @format date-time */
|
|
3424
3470
|
createdAt: string;
|
|
@@ -3426,8 +3472,8 @@ export interface LoanLog {
|
|
|
3426
3472
|
export interface LoanLogDetail {
|
|
3427
3473
|
/** @format uuid */
|
|
3428
3474
|
id: string;
|
|
3429
|
-
level:
|
|
3430
|
-
type:
|
|
3475
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3476
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
3431
3477
|
message: string;
|
|
3432
3478
|
/** @format date-time */
|
|
3433
3479
|
createdAt: string;
|
|
@@ -3444,6 +3490,18 @@ export interface LoanLogSearchCriteria {
|
|
|
3444
3490
|
types?: LoanLogType[] | null;
|
|
3445
3491
|
levels?: LogLevel[] | null;
|
|
3446
3492
|
}
|
|
3493
|
+
export interface LoanMetrics {
|
|
3494
|
+
/** @format uuid */
|
|
3495
|
+
id?: string | null;
|
|
3496
|
+
/** @format double */
|
|
3497
|
+
ltv?: number | null;
|
|
3498
|
+
/** @format double */
|
|
3499
|
+
cltv?: number | null;
|
|
3500
|
+
/** @format double */
|
|
3501
|
+
frontDti?: number | null;
|
|
3502
|
+
/** @format double */
|
|
3503
|
+
backDti?: number | null;
|
|
3504
|
+
}
|
|
3447
3505
|
export interface LoanMilestone {
|
|
3448
3506
|
/** @format uuid */
|
|
3449
3507
|
id: string;
|
|
@@ -3470,6 +3528,22 @@ export interface LoanMonthlyPayment {
|
|
|
3470
3528
|
/** @format double */
|
|
3471
3529
|
other?: number | null;
|
|
3472
3530
|
}
|
|
3531
|
+
export interface LoanMonthlyPaymentRequest {
|
|
3532
|
+
/** @format double */
|
|
3533
|
+
principalAndInterest?: number | null;
|
|
3534
|
+
/** @format double */
|
|
3535
|
+
taxes?: number | null;
|
|
3536
|
+
/** @format double */
|
|
3537
|
+
insurance?: number | null;
|
|
3538
|
+
/** @format double */
|
|
3539
|
+
mortgageInsurance?: number | null;
|
|
3540
|
+
/** @format double */
|
|
3541
|
+
floodInsurance?: number | null;
|
|
3542
|
+
/** @format double */
|
|
3543
|
+
hoa?: number | null;
|
|
3544
|
+
/** @format double */
|
|
3545
|
+
other?: number | null;
|
|
3546
|
+
}
|
|
3473
3547
|
export interface LoanNonOwningBorrower {
|
|
3474
3548
|
/** @format uuid */
|
|
3475
3549
|
id?: string | null;
|
|
@@ -3661,7 +3735,7 @@ export interface LoanQueueWithData {
|
|
|
3661
3735
|
user: UserPublic;
|
|
3662
3736
|
loanOfficer: LoanOfficerPublic;
|
|
3663
3737
|
siteConfiguration: SiteConfigurationReduced;
|
|
3664
|
-
data?: any
|
|
3738
|
+
data?: any;
|
|
3665
3739
|
}
|
|
3666
3740
|
export interface LoanRecord {
|
|
3667
3741
|
loanGuid: string;
|
|
@@ -3692,7 +3766,7 @@ export interface LoanTaskSearchRequest {
|
|
|
3692
3766
|
loanStatus?: LoanTaskActivityFilter | null;
|
|
3693
3767
|
}
|
|
3694
3768
|
export interface LoanTaskStatusSummary {
|
|
3695
|
-
status:
|
|
3769
|
+
status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
3696
3770
|
/** @format int32 */
|
|
3697
3771
|
count: number;
|
|
3698
3772
|
}
|
|
@@ -3704,7 +3778,7 @@ export interface LoanUser {
|
|
|
3704
3778
|
email: string;
|
|
3705
3779
|
phone?: string | null;
|
|
3706
3780
|
role: string;
|
|
3707
|
-
loanRole:
|
|
3781
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3708
3782
|
isUser: boolean;
|
|
3709
3783
|
/** @format date-time */
|
|
3710
3784
|
createdAt: string;
|
|
@@ -3737,7 +3811,7 @@ export interface LosOperationTracking {
|
|
|
3737
3811
|
operationType: string;
|
|
3738
3812
|
correlationKey: string;
|
|
3739
3813
|
lastTriggerSource?: string | null;
|
|
3740
|
-
status:
|
|
3814
|
+
status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
3741
3815
|
/** @format date-time */
|
|
3742
3816
|
createdAt: string;
|
|
3743
3817
|
/** @format date-time */
|
|
@@ -3798,7 +3872,7 @@ export interface LosSyncStep {
|
|
|
3798
3872
|
/** @format int32 */
|
|
3799
3873
|
order: number;
|
|
3800
3874
|
name: string;
|
|
3801
|
-
severity:
|
|
3875
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
3802
3876
|
message: string;
|
|
3803
3877
|
/** @format date-time */
|
|
3804
3878
|
atUtc: string;
|
|
@@ -3812,7 +3886,7 @@ export interface LosWebhook {
|
|
|
3812
3886
|
enableSubscription: boolean;
|
|
3813
3887
|
}
|
|
3814
3888
|
export interface ManualDocumentClassificationRequest {
|
|
3815
|
-
documentType:
|
|
3889
|
+
documentType: "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
|
|
3816
3890
|
}
|
|
3817
3891
|
export interface MdmUser {
|
|
3818
3892
|
user_email?: string | null;
|
|
@@ -3891,7 +3965,7 @@ export interface ModuleParameterValue {
|
|
|
3891
3965
|
parameterID: string;
|
|
3892
3966
|
parameterName: string;
|
|
3893
3967
|
parameterType: string;
|
|
3894
|
-
value?: any
|
|
3968
|
+
value?: any;
|
|
3895
3969
|
isInherited: boolean;
|
|
3896
3970
|
}
|
|
3897
3971
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4064,7 +4138,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4064
4138
|
}
|
|
4065
4139
|
export interface Operation {
|
|
4066
4140
|
op?: string;
|
|
4067
|
-
value?:
|
|
4141
|
+
value?: string | number | boolean | null | object;
|
|
4068
4142
|
path?: string;
|
|
4069
4143
|
}
|
|
4070
4144
|
export interface OverridePasswordRequest {
|
|
@@ -4367,15 +4441,11 @@ export interface SendLoanTaskReminderRequest {
|
|
|
4367
4441
|
templateId: string;
|
|
4368
4442
|
userIds?: string[] | null;
|
|
4369
4443
|
}
|
|
4370
|
-
export interface
|
|
4371
|
-
|
|
4372
|
-
|
|
4373
|
-
|
|
4374
|
-
|
|
4375
|
-
siteConfigurationId?: string | null;
|
|
4376
|
-
email?: string | null;
|
|
4377
|
-
phone?: string | null;
|
|
4378
|
-
attachments: Attachment[];
|
|
4444
|
+
export interface SendOutstandingTaskReminderRequest {
|
|
4445
|
+
userIds?: string[] | null;
|
|
4446
|
+
}
|
|
4447
|
+
export interface SetAiEnabledRequest {
|
|
4448
|
+
isEnabled: boolean;
|
|
4379
4449
|
}
|
|
4380
4450
|
export interface SetCustomFieldValueRequest {
|
|
4381
4451
|
/** @format uuid */
|
|
@@ -4394,7 +4464,7 @@ export interface SiteConfiguration {
|
|
|
4394
4464
|
deletedAt?: string | null;
|
|
4395
4465
|
/** @format uuid */
|
|
4396
4466
|
id: string;
|
|
4397
|
-
type:
|
|
4467
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4398
4468
|
/** @format uuid */
|
|
4399
4469
|
entityID: string;
|
|
4400
4470
|
/** @format int32 */
|
|
@@ -4587,7 +4657,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4587
4657
|
deletedAt?: string | null;
|
|
4588
4658
|
/** @format uuid */
|
|
4589
4659
|
id: string;
|
|
4590
|
-
type:
|
|
4660
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4591
4661
|
/** @format uuid */
|
|
4592
4662
|
entityID: string;
|
|
4593
4663
|
/** @format int32 */
|
|
@@ -4797,7 +4867,7 @@ export interface SiteConfigurationForm {
|
|
|
4797
4867
|
export interface SiteConfigurationReduced {
|
|
4798
4868
|
/** @format uuid */
|
|
4799
4869
|
id: string;
|
|
4800
|
-
type:
|
|
4870
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4801
4871
|
url?: string | null;
|
|
4802
4872
|
name: string;
|
|
4803
4873
|
/** @format int64 */
|
|
@@ -4814,7 +4884,7 @@ export interface SiteConfigurationRequest {
|
|
|
4814
4884
|
entityID: string;
|
|
4815
4885
|
/** @format int32 */
|
|
4816
4886
|
entityType: number;
|
|
4817
|
-
type:
|
|
4887
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4818
4888
|
url: string;
|
|
4819
4889
|
name: string;
|
|
4820
4890
|
introduction?: string | null;
|
|
@@ -4989,7 +5059,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4989
5059
|
export interface SiteConfigurationSummary {
|
|
4990
5060
|
/** @format uuid */
|
|
4991
5061
|
id: string;
|
|
4992
|
-
type:
|
|
5062
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4993
5063
|
url?: string | null;
|
|
4994
5064
|
name: string;
|
|
4995
5065
|
/** @format int64 */
|
|
@@ -5140,15 +5210,6 @@ export interface TaxRatesRequest {
|
|
|
5140
5210
|
/** @format double */
|
|
5141
5211
|
marginalIncomeTaxRate: number;
|
|
5142
5212
|
}
|
|
5143
|
-
export interface TestSendNotificationForLoanRequest {
|
|
5144
|
-
loanData: Record<string, string>;
|
|
5145
|
-
/** @format uuid */
|
|
5146
|
-
siteConfigurationId: string;
|
|
5147
|
-
toAddress?: string | null;
|
|
5148
|
-
toPhoneNumber?: string | null;
|
|
5149
|
-
templateKey?: string | null;
|
|
5150
|
-
attachments: Attachment[];
|
|
5151
|
-
}
|
|
5152
5213
|
export interface Theme {
|
|
5153
5214
|
logoURL: string;
|
|
5154
5215
|
primaryColor: string;
|
|
@@ -5252,7 +5313,7 @@ export interface UnregisteredBorrower {
|
|
|
5252
5313
|
lastName?: string | null;
|
|
5253
5314
|
fullName?: string | null;
|
|
5254
5315
|
email?: string | null;
|
|
5255
|
-
role:
|
|
5316
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5256
5317
|
}
|
|
5257
5318
|
export interface UpdateAccountRequest {
|
|
5258
5319
|
name: string;
|
|
@@ -5276,7 +5337,7 @@ export interface UpdateAiCanonicalFieldRequest {
|
|
|
5276
5337
|
}
|
|
5277
5338
|
export interface UpdateAiGuardrailRequest {
|
|
5278
5339
|
name: string;
|
|
5279
|
-
category:
|
|
5340
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5280
5341
|
description?: string | null;
|
|
5281
5342
|
keywords: string[];
|
|
5282
5343
|
responseTemplate: string;
|
|
@@ -5301,8 +5362,8 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5301
5362
|
name: string;
|
|
5302
5363
|
url: string;
|
|
5303
5364
|
description?: string | null;
|
|
5304
|
-
category:
|
|
5305
|
-
scope:
|
|
5365
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5366
|
+
scope: "FullDomain" | "SpecificPath";
|
|
5306
5367
|
}
|
|
5307
5368
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5308
5369
|
isRequired: boolean;
|
|
@@ -5589,7 +5650,7 @@ export interface UserDevice {
|
|
|
5589
5650
|
export interface UserDraft {
|
|
5590
5651
|
/** @format uuid */
|
|
5591
5652
|
draftID: string;
|
|
5592
|
-
role:
|
|
5653
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5593
5654
|
user: User;
|
|
5594
5655
|
}
|
|
5595
5656
|
export interface UserDraftPaginated {
|
|
@@ -5613,7 +5674,7 @@ export interface UserGroupAccessScope {
|
|
|
5613
5674
|
id: string;
|
|
5614
5675
|
/** @format uuid */
|
|
5615
5676
|
groupId: string;
|
|
5616
|
-
scopeType:
|
|
5677
|
+
scopeType: "User" | "Branch";
|
|
5617
5678
|
/** @format uuid */
|
|
5618
5679
|
userId?: string | null;
|
|
5619
5680
|
/** @format uuid */
|
|
@@ -5646,7 +5707,7 @@ export interface UserLoan {
|
|
|
5646
5707
|
deletedAt?: string | null;
|
|
5647
5708
|
loanID: string;
|
|
5648
5709
|
user: User;
|
|
5649
|
-
role:
|
|
5710
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5650
5711
|
/** @format int32 */
|
|
5651
5712
|
borrowerPair?: number | null;
|
|
5652
5713
|
/** @format int32 */
|
|
@@ -5658,11 +5719,11 @@ export interface UserLoanConsent {
|
|
|
5658
5719
|
id: string;
|
|
5659
5720
|
/** @format uuid */
|
|
5660
5721
|
userLoanID: string;
|
|
5661
|
-
type:
|
|
5722
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5662
5723
|
providedConsent: boolean;
|
|
5663
5724
|
source?: ConsentSource | null;
|
|
5664
5725
|
ipAddress?: string | null;
|
|
5665
|
-
losSyncStatus:
|
|
5726
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
5666
5727
|
/** @format date-time */
|
|
5667
5728
|
createdAt: string;
|
|
5668
5729
|
/** @format date-time */
|
|
@@ -5792,7 +5853,7 @@ export interface UserSummary {
|
|
|
5792
5853
|
id: string;
|
|
5793
5854
|
name?: string | null;
|
|
5794
5855
|
email?: string | null;
|
|
5795
|
-
role:
|
|
5856
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5796
5857
|
}
|
|
5797
5858
|
export interface VerifyPasswordRequest {
|
|
5798
5859
|
email: string;
|
|
@@ -5819,90 +5880,6 @@ export interface Workflow {
|
|
|
5819
5880
|
tileSubtitle: string;
|
|
5820
5881
|
icon: string;
|
|
5821
5882
|
}
|
|
5822
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5823
|
-
export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
|
|
5824
|
-
export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
5825
|
-
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
5826
|
-
export type AiConfigChangeLogEntityTypeEnum = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
|
|
5827
|
-
export type AiConfigChangeLogActionEnum = "Created" | "Updated" | "Deleted" | "Toggled";
|
|
5828
|
-
export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5829
|
-
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5830
|
-
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
5831
|
-
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
5832
|
-
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5833
|
-
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5834
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5835
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5836
|
-
export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5837
|
-
export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5838
|
-
export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
5839
|
-
export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5840
|
-
export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
|
|
5841
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5842
|
-
/** @deprecated */
|
|
5843
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5844
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5845
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5846
|
-
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5847
|
-
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
5848
|
-
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5849
|
-
export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5850
|
-
export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5851
|
-
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5852
|
-
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5853
|
-
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5854
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5855
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5856
|
-
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
5857
|
-
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5858
|
-
export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
|
|
5859
|
-
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5860
|
-
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
5861
|
-
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
5862
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5863
|
-
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
5864
|
-
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";
|
|
5865
|
-
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5866
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
5867
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5868
|
-
export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5869
|
-
export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5870
|
-
export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5871
|
-
export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5872
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5873
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5874
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5875
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5876
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
5877
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5878
|
-
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
5879
|
-
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
5880
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5881
|
-
export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
5882
|
-
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
5883
|
-
export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
|
|
5884
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5885
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5886
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5887
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5888
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5889
|
-
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5890
|
-
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5891
|
-
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5892
|
-
export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
5893
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5894
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5895
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5896
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5897
|
-
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
5898
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5899
|
-
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
5900
|
-
/** @default "Realtor" */
|
|
5901
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5902
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5903
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5904
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5905
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5906
5883
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5907
5884
|
export type QueryParamsType = Record<string | number, any>;
|
|
5908
5885
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5925,7 +5902,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
5925
5902
|
secure?: boolean;
|
|
5926
5903
|
format?: ResponseType;
|
|
5927
5904
|
}
|
|
5928
|
-
export
|
|
5905
|
+
export declare enum ContentType {
|
|
5906
|
+
JsonPatch = "application/json-patch+json",
|
|
5907
|
+
Json = "application/json",
|
|
5908
|
+
JsonApi = "application/vnd.api+json",
|
|
5909
|
+
FormData = "multipart/form-data",
|
|
5910
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
5911
|
+
Text = "text/plain"
|
|
5912
|
+
}
|
|
5929
5913
|
export declare class HttpClient<SecurityDataType = unknown> {
|
|
5930
5914
|
instance: AxiosInstance;
|
|
5931
5915
|
private securityData;
|
|
@@ -6772,6 +6756,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6772
6756
|
sortBy?: string;
|
|
6773
6757
|
sortDirection?: string;
|
|
6774
6758
|
}, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
|
|
6759
|
+
/**
|
|
6760
|
+
* No description
|
|
6761
|
+
*
|
|
6762
|
+
* @tags AiSuperAdmin
|
|
6763
|
+
* @name SetAccountAiEnabled
|
|
6764
|
+
* @summary Enable or disable AI for an account (SuperAdmin only)
|
|
6765
|
+
* @request PUT:/api/ai/superadmin/accounts/{accountId}/ai-enabled
|
|
6766
|
+
* @secure
|
|
6767
|
+
* @response `204` `void` No Content
|
|
6768
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6769
|
+
*/
|
|
6770
|
+
setAccountAiEnabled: (accountId: string, data: SetAiEnabledRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6775
6771
|
/**
|
|
6776
6772
|
* No description
|
|
6777
6773
|
*
|
|
@@ -7458,7 +7454,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7458
7454
|
* @response `200` `(CustomFieldDefinition)[]` OK
|
|
7459
7455
|
*/
|
|
7460
7456
|
getCustomFieldDefinitions: (query?: {
|
|
7461
|
-
entityType?:
|
|
7457
|
+
entityType?: "Loan";
|
|
7462
7458
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
|
|
7463
7459
|
/**
|
|
7464
7460
|
* No description
|
|
@@ -8406,18 +8402,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8406
8402
|
* @response `200` `string` OK
|
|
8407
8403
|
*/
|
|
8408
8404
|
getLoanEmbeddedSigningLink: (envelopeId: string, userName: string, email: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
8409
|
-
/**
|
|
8410
|
-
* No description
|
|
8411
|
-
*
|
|
8412
|
-
* @tags LegacyLoan
|
|
8413
|
-
* @name CreateLegacyLoanDocument
|
|
8414
|
-
* @summary Create Document
|
|
8415
|
-
* @request POST:/api/los/loan/generatedocument
|
|
8416
|
-
* @deprecated
|
|
8417
|
-
* @secure
|
|
8418
|
-
* @response `200` `DocumentDataRequest` OK
|
|
8419
|
-
*/
|
|
8420
|
-
createLegacyLoanDocument: (data: GenerateDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<DocumentDataRequest, any, {}>>;
|
|
8421
8405
|
/**
|
|
8422
8406
|
* No description
|
|
8423
8407
|
*
|
|
@@ -8965,10 +8949,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8965
8949
|
* @summary Download By ID
|
|
8966
8950
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
8967
8951
|
* @secure
|
|
8968
|
-
* @response `200` `
|
|
8952
|
+
* @response `200` `string` OK
|
|
8969
8953
|
* @response `404` `ProblemDetails` Not Found
|
|
8970
8954
|
*/
|
|
8971
|
-
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<
|
|
8955
|
+
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
8972
8956
|
/**
|
|
8973
8957
|
* No description
|
|
8974
8958
|
*
|
|
@@ -9670,18 +9654,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9670
9654
|
/** @format uuid */
|
|
9671
9655
|
folderID?: string;
|
|
9672
9656
|
}, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
|
|
9673
|
-
/**
|
|
9674
|
-
* No description
|
|
9675
|
-
*
|
|
9676
|
-
* @tags LoanTaskDocuments
|
|
9677
|
-
* @name CreateLoanTaskDocumentBucket
|
|
9678
|
-
* @summary Create Bucket
|
|
9679
|
-
* @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
|
|
9680
|
-
* @secure
|
|
9681
|
-
* @response `204` `UserLoanTask` No Content
|
|
9682
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
9683
|
-
*/
|
|
9684
|
-
createLoanTaskDocumentBucket: (loanId: string, loanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
|
|
9685
9657
|
/**
|
|
9686
9658
|
* No description
|
|
9687
9659
|
*
|
|
@@ -9691,9 +9663,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9691
9663
|
* @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
|
|
9692
9664
|
* @secure
|
|
9693
9665
|
* @response `204` `void` No Content
|
|
9666
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
9694
9667
|
* @response `404` `ProblemDetails` Not Found
|
|
9668
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
9695
9669
|
*/
|
|
9696
|
-
sendOutstandingLoanTaskNotification: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
9670
|
+
sendOutstandingLoanTaskNotification: (loanId: string, data: SendOutstandingTaskReminderRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
9697
9671
|
/**
|
|
9698
9672
|
* No description
|
|
9699
9673
|
*
|
|
@@ -10030,32 +10004,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10030
10004
|
* @response `422` `ProblemDetails` Unprocessable Content
|
|
10031
10005
|
*/
|
|
10032
10006
|
calculateMortgageRefinance: (data: RefinanceCalculatorRequest, params?: RequestParams) => Promise<AxiosResponse<RefinanceCalculator, any, {}>>;
|
|
10033
|
-
/**
|
|
10034
|
-
* No description
|
|
10035
|
-
*
|
|
10036
|
-
* @tags Notifications
|
|
10037
|
-
* @name SendNotificationForLoan
|
|
10038
|
-
* @summary Send Notification for Loan
|
|
10039
|
-
* @request POST:/api/notifications
|
|
10040
|
-
* @deprecated
|
|
10041
|
-
* @secure
|
|
10042
|
-
* @response `200` `void` OK
|
|
10043
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
10044
|
-
*/
|
|
10045
|
-
sendNotificationForLoan: (data: SendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10046
|
-
/**
|
|
10047
|
-
* No description
|
|
10048
|
-
*
|
|
10049
|
-
* @tags Notifications
|
|
10050
|
-
* @name SendTestNotificationForLoan
|
|
10051
|
-
* @summary Send Test Notification for Loan
|
|
10052
|
-
* @request POST:/api/notifications/test
|
|
10053
|
-
* @deprecated
|
|
10054
|
-
* @secure
|
|
10055
|
-
* @response `200` `void` OK
|
|
10056
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
10057
|
-
*/
|
|
10058
|
-
sendTestNotificationForLoan: (data: TestSendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10059
10007
|
/**
|
|
10060
10008
|
* No description
|
|
10061
10009
|
*
|
|
@@ -10212,7 +10160,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10212
10160
|
getPartners: (query?: {
|
|
10213
10161
|
showAll?: boolean;
|
|
10214
10162
|
/** @default "Realtor" */
|
|
10215
|
-
role?:
|
|
10163
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
10216
10164
|
/** @format int32 */
|
|
10217
10165
|
pageSize?: number;
|
|
10218
10166
|
/** @format int32 */
|
|
@@ -10390,7 +10338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10390
10338
|
* @response `200` `File` OK
|
|
10391
10339
|
* @response `404` `ProblemDetails` Not Found
|
|
10392
10340
|
*/
|
|
10393
|
-
getSamlMetadata: (sSoIntegration:
|
|
10341
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10394
10342
|
/**
|
|
10395
10343
|
* No description
|
|
10396
10344
|
*
|
|
@@ -10401,7 +10349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10401
10349
|
* @secure
|
|
10402
10350
|
* @response `200` `File` OK
|
|
10403
10351
|
*/
|
|
10404
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
10352
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10405
10353
|
/**
|
|
10406
10354
|
* No description
|
|
10407
10355
|
*
|