@matech/thebigpos-sdk 2.49.0-rc0 → 2.49.3-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 +0 -10
- package/dist/index.d.ts +452 -254
- package/dist/index.js +381 -220
- package/dist/index.js.map +1 -1
- package/package.json +2 -5
- package/scripts/apply-json-patch-content-type.js +36 -129
- package/src/index.ts +1361 -1172
- package/tsconfig.json +27 -27
- package/.claude/settings.local.json +0 -52
package/dist/index.d.ts
CHANGED
|
@@ -5,15 +5,20 @@ export type SiteTileLocation = "HomePage" | "Dashboard";
|
|
|
5
5
|
export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6
6
|
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
7
7
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
8
|
+
export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
9
|
+
export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
|
|
8
10
|
export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
|
|
9
11
|
export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
12
|
+
export type LosCredentialHealthStatus = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
|
|
10
13
|
export type LogLevel = "None" | "Info" | "Warning" | "Error";
|
|
11
14
|
export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
|
|
12
15
|
export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
|
|
13
16
|
export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
|
|
14
17
|
export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
|
|
15
18
|
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
16
|
-
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
|
|
19
|
+
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
|
|
20
|
+
export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
|
|
21
|
+
export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
|
|
17
22
|
export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
|
|
18
23
|
export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
|
|
19
24
|
export type LoanPurpose = "Purchase" | "Refinance";
|
|
@@ -37,18 +42,18 @@ export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "
|
|
|
37
42
|
export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
|
|
38
43
|
export type LoanHousingType = "NoExpense" | "Own" | "Rent";
|
|
39
44
|
export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
|
|
40
|
-
export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
|
|
45
|
+
export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone" | "FaceToFace" | "Hybrid" | "Internet";
|
|
41
46
|
export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
|
|
42
47
|
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
|
|
43
|
-
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
|
|
48
|
+
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
|
|
44
49
|
export type LoanGenderType = "Male" | "Female";
|
|
45
|
-
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";
|
|
50
|
+
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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
|
|
46
51
|
export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
|
|
47
52
|
export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
|
|
48
53
|
export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
|
|
49
54
|
export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese" | "Korean" | "Vietnamese" | "Other";
|
|
50
55
|
export type LoanAmortizationType = "Fixed" | "Arm" | "Balloon" | "Other";
|
|
51
|
-
export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
|
|
56
|
+
export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other" | "StockOptions";
|
|
52
57
|
export type LoanAccessScopeType = "User" | "Branch";
|
|
53
58
|
export type LinkTarget = "Self" | "Blank";
|
|
54
59
|
export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
|
|
@@ -74,7 +79,7 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
|
74
79
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
75
80
|
export type BorrowerApplicationStatus = "Draft" | "Complete";
|
|
76
81
|
export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
77
|
-
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
82
|
+
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
78
83
|
export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
|
|
79
84
|
export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
80
85
|
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
@@ -136,35 +141,16 @@ export interface AccountBilling {
|
|
|
136
141
|
contractedRate: number;
|
|
137
142
|
}
|
|
138
143
|
export interface AccountBillingRequest {
|
|
139
|
-
billingType:
|
|
144
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
140
145
|
/** @format double */
|
|
141
146
|
contractedRate: number;
|
|
142
147
|
}
|
|
143
|
-
export interface AccountDeactivated {
|
|
144
|
-
accountDeactivated: boolean;
|
|
145
|
-
email: string;
|
|
146
|
-
}
|
|
147
148
|
export interface AccountFailureCount {
|
|
148
149
|
/** @format uuid */
|
|
149
150
|
accountId: string;
|
|
150
151
|
/** @format int32 */
|
|
151
152
|
count: number;
|
|
152
153
|
}
|
|
153
|
-
export interface AccountReactivationCompleteRequest {
|
|
154
|
-
/** @format uuid */
|
|
155
|
-
token: string;
|
|
156
|
-
/** @minLength 8 */
|
|
157
|
-
newPassword: string;
|
|
158
|
-
}
|
|
159
|
-
export interface AccountReactivationRequest {
|
|
160
|
-
/**
|
|
161
|
-
* @format email
|
|
162
|
-
* @minLength 1
|
|
163
|
-
*/
|
|
164
|
-
email: string;
|
|
165
|
-
/** @format uuid */
|
|
166
|
-
siteConfigurationId: string;
|
|
167
|
-
}
|
|
168
154
|
export interface AccountSettings {
|
|
169
155
|
isSmsEnabled: boolean;
|
|
170
156
|
isLoanEditEnabled: boolean;
|
|
@@ -184,7 +170,7 @@ export interface Action {
|
|
|
184
170
|
comments?: string | null;
|
|
185
171
|
/** @format uuid */
|
|
186
172
|
siteConfigurationID: string;
|
|
187
|
-
applicationSettings?: any
|
|
173
|
+
applicationSettings?: any;
|
|
188
174
|
surveysToken?: string | null;
|
|
189
175
|
}
|
|
190
176
|
export interface Address {
|
|
@@ -407,7 +393,7 @@ export interface AiAuditLog {
|
|
|
407
393
|
conversationId?: string | null;
|
|
408
394
|
/** @format uuid */
|
|
409
395
|
messageId?: string | null;
|
|
410
|
-
eventType:
|
|
396
|
+
eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
|
|
411
397
|
modelId?: string | null;
|
|
412
398
|
/** @format int32 */
|
|
413
399
|
inputTokens?: number | null;
|
|
@@ -420,7 +406,7 @@ export interface AiAuditLog {
|
|
|
420
406
|
guardrailCategory?: string | null;
|
|
421
407
|
rawRequest?: string | null;
|
|
422
408
|
rawResponse?: string | null;
|
|
423
|
-
details?: any
|
|
409
|
+
details?: any;
|
|
424
410
|
/** @format date-time */
|
|
425
411
|
createdAt: string;
|
|
426
412
|
}
|
|
@@ -482,7 +468,7 @@ export interface AiChatMessagePaginated {
|
|
|
482
468
|
count: number;
|
|
483
469
|
}
|
|
484
470
|
export interface AiChatMetadata {
|
|
485
|
-
intent:
|
|
471
|
+
intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
486
472
|
fieldsAccessed: string[];
|
|
487
473
|
/** @format int64 */
|
|
488
474
|
queryTimeMs: number;
|
|
@@ -508,7 +494,7 @@ export interface AiChatRequest {
|
|
|
508
494
|
promptId?: string | null;
|
|
509
495
|
}
|
|
510
496
|
export interface AiChatStructuredData {
|
|
511
|
-
type:
|
|
497
|
+
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
512
498
|
displayHint?: AiDisplayHint | null;
|
|
513
499
|
detectedDocumentType?: string | null;
|
|
514
500
|
columns: string[];
|
|
@@ -594,7 +580,7 @@ export interface AiGuardrail {
|
|
|
594
580
|
/** @format uuid */
|
|
595
581
|
id: string;
|
|
596
582
|
name: string;
|
|
597
|
-
category:
|
|
583
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
598
584
|
description?: string | null;
|
|
599
585
|
keywords: string[];
|
|
600
586
|
responseTemplate: string;
|
|
@@ -722,8 +708,8 @@ export interface AiUrlSource {
|
|
|
722
708
|
name: string;
|
|
723
709
|
url: string;
|
|
724
710
|
description?: string | null;
|
|
725
|
-
category:
|
|
726
|
-
scope:
|
|
711
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
712
|
+
scope: "FullDomain" | "SpecificPath";
|
|
727
713
|
isActive: boolean;
|
|
728
714
|
isDefault: boolean;
|
|
729
715
|
hasAccountOverride: boolean;
|
|
@@ -830,14 +816,14 @@ export interface AuditLogEntry {
|
|
|
830
816
|
/** @format uuid */
|
|
831
817
|
id: string;
|
|
832
818
|
entityType: string;
|
|
833
|
-
changeType:
|
|
819
|
+
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
834
820
|
/** @format uuid */
|
|
835
821
|
entityId: string;
|
|
836
822
|
performedBy?: AuditLogUser | null;
|
|
837
823
|
rootEntityType?: string | null;
|
|
838
824
|
/** @format uuid */
|
|
839
825
|
rootEntityId?: string | null;
|
|
840
|
-
changes?: any
|
|
826
|
+
changes?: any;
|
|
841
827
|
/** @format date-time */
|
|
842
828
|
createdAt: string;
|
|
843
829
|
}
|
|
@@ -877,7 +863,7 @@ export interface BorrowerCount {
|
|
|
877
863
|
firstName: string;
|
|
878
864
|
lastName: string;
|
|
879
865
|
email: string;
|
|
880
|
-
role:
|
|
866
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
881
867
|
/** @format int32 */
|
|
882
868
|
count: number;
|
|
883
869
|
}
|
|
@@ -887,7 +873,7 @@ export interface BorrowerIdentity {
|
|
|
887
873
|
firstName: string;
|
|
888
874
|
lastName: string;
|
|
889
875
|
email: string;
|
|
890
|
-
role:
|
|
876
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
891
877
|
}
|
|
892
878
|
export interface BorrowersNotUsingPosSummary {
|
|
893
879
|
/** @format int32 */
|
|
@@ -1055,12 +1041,13 @@ export interface CompanyDocument {
|
|
|
1055
1041
|
folderId: string;
|
|
1056
1042
|
folderName: string;
|
|
1057
1043
|
name: string;
|
|
1058
|
-
sourceType:
|
|
1044
|
+
sourceType: "File" | "FreeText";
|
|
1059
1045
|
contentType?: string | null;
|
|
1060
1046
|
/** @format int64 */
|
|
1061
1047
|
fileSizeBytes: number;
|
|
1062
1048
|
inlineContent?: string | null;
|
|
1063
|
-
|
|
1049
|
+
previewImage?: string | null;
|
|
1050
|
+
indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
1064
1051
|
indexError?: string | null;
|
|
1065
1052
|
/** @format date-time */
|
|
1066
1053
|
indexedAt?: string | null;
|
|
@@ -1090,6 +1077,9 @@ export interface CompanyDocumentPaginated {
|
|
|
1090
1077
|
/** @format int64 */
|
|
1091
1078
|
count: number;
|
|
1092
1079
|
}
|
|
1080
|
+
export interface CompanyDocumentPreviewsRequest {
|
|
1081
|
+
documentIds: string[];
|
|
1082
|
+
}
|
|
1093
1083
|
export interface CompanyDocumentSearchCriteria {
|
|
1094
1084
|
searchText?: string | null;
|
|
1095
1085
|
/** @format uuid */
|
|
@@ -1171,7 +1161,7 @@ export interface CorporateSearchCriteria {
|
|
|
1171
1161
|
isActive?: boolean | null;
|
|
1172
1162
|
}
|
|
1173
1163
|
export interface CreateAccessScopeRequest {
|
|
1174
|
-
scopeType:
|
|
1164
|
+
scopeType: "User" | "Branch";
|
|
1175
1165
|
/** @format uuid */
|
|
1176
1166
|
userId?: string | null;
|
|
1177
1167
|
/** @format uuid */
|
|
@@ -1189,7 +1179,7 @@ export interface CreateAccountRequest {
|
|
|
1189
1179
|
/** @format int64 */
|
|
1190
1180
|
nlmsid: number;
|
|
1191
1181
|
settings: AccountSettingsRequest;
|
|
1192
|
-
environment:
|
|
1182
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1193
1183
|
losIntegration: LOSIntegration;
|
|
1194
1184
|
billingSettings: AccountBillingRequest;
|
|
1195
1185
|
}
|
|
@@ -1203,7 +1193,7 @@ export interface CreateAiCanonicalFieldRequest {
|
|
|
1203
1193
|
}
|
|
1204
1194
|
export interface CreateAiGuardrailRequest {
|
|
1205
1195
|
name: string;
|
|
1206
|
-
category:
|
|
1196
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
1207
1197
|
description?: string | null;
|
|
1208
1198
|
keywords: string[];
|
|
1209
1199
|
responseTemplate: string;
|
|
@@ -1234,8 +1224,8 @@ export interface CreateAiUrlSourceRequest {
|
|
|
1234
1224
|
name: string;
|
|
1235
1225
|
url: string;
|
|
1236
1226
|
description?: string | null;
|
|
1237
|
-
category:
|
|
1238
|
-
scope:
|
|
1227
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
1228
|
+
scope: "FullDomain" | "SpecificPath";
|
|
1239
1229
|
}
|
|
1240
1230
|
export interface CreateBranchRequest {
|
|
1241
1231
|
name: string;
|
|
@@ -1268,8 +1258,8 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
1268
1258
|
name: string;
|
|
1269
1259
|
defaultValue?: string | null;
|
|
1270
1260
|
regexPattern?: string | null;
|
|
1271
|
-
dataType:
|
|
1272
|
-
entityType:
|
|
1261
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1262
|
+
entityType: "Loan";
|
|
1273
1263
|
options?: CustomFieldOptionRequest[] | null;
|
|
1274
1264
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
1275
1265
|
}
|
|
@@ -1287,7 +1277,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1287
1277
|
export interface CreateGroupMemberRequest {
|
|
1288
1278
|
/** @format uuid */
|
|
1289
1279
|
userId: string;
|
|
1290
|
-
loanRole:
|
|
1280
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1291
1281
|
}
|
|
1292
1282
|
export interface CreateInviteRequest {
|
|
1293
1283
|
firstName: string;
|
|
@@ -1295,7 +1285,7 @@ export interface CreateInviteRequest {
|
|
|
1295
1285
|
emailAddress: string;
|
|
1296
1286
|
phoneNumber?: string | null;
|
|
1297
1287
|
/** @deprecated */
|
|
1298
|
-
relationship:
|
|
1288
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1299
1289
|
loanID: string;
|
|
1300
1290
|
route?: string | null;
|
|
1301
1291
|
/** @format uuid */
|
|
@@ -1315,7 +1305,7 @@ export interface CreateLoanImportRequest {
|
|
|
1315
1305
|
endDate: string;
|
|
1316
1306
|
/** @format date-time */
|
|
1317
1307
|
startDate: string;
|
|
1318
|
-
importMode:
|
|
1308
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1319
1309
|
}
|
|
1320
1310
|
export interface CreateSession {
|
|
1321
1311
|
sessionId: string;
|
|
@@ -1333,7 +1323,7 @@ export interface CreateUserDeviceRequest {
|
|
|
1333
1323
|
token: string;
|
|
1334
1324
|
}
|
|
1335
1325
|
export interface CreateUserDraft {
|
|
1336
|
-
loanRole:
|
|
1326
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1337
1327
|
}
|
|
1338
1328
|
export interface CreateUserGroupRequest {
|
|
1339
1329
|
name: string;
|
|
@@ -1394,8 +1384,8 @@ export interface CustomFieldDefinition {
|
|
|
1394
1384
|
name: string;
|
|
1395
1385
|
defaultValue?: string | null;
|
|
1396
1386
|
regexPattern?: string | null;
|
|
1397
|
-
dataType:
|
|
1398
|
-
entityType:
|
|
1387
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1388
|
+
entityType: "Loan";
|
|
1399
1389
|
options: CustomFieldOption[];
|
|
1400
1390
|
permissions: CustomFieldPermission[];
|
|
1401
1391
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1409,7 +1399,7 @@ export interface CustomFieldEntry {
|
|
|
1409
1399
|
displayOrder: number;
|
|
1410
1400
|
name: string;
|
|
1411
1401
|
value: string;
|
|
1412
|
-
dataType:
|
|
1402
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1413
1403
|
}
|
|
1414
1404
|
export interface CustomFieldOption {
|
|
1415
1405
|
/** @format uuid */
|
|
@@ -1426,12 +1416,12 @@ export interface CustomFieldOptionRequest {
|
|
|
1426
1416
|
export interface CustomFieldPermission {
|
|
1427
1417
|
/** @format uuid */
|
|
1428
1418
|
id: string;
|
|
1429
|
-
role:
|
|
1430
|
-
accessLevel:
|
|
1419
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1420
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1431
1421
|
}
|
|
1432
1422
|
export interface CustomFieldPermissionRequest {
|
|
1433
|
-
role:
|
|
1434
|
-
accessLevel:
|
|
1423
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1424
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1435
1425
|
}
|
|
1436
1426
|
export interface CustomFieldValue {
|
|
1437
1427
|
/** @format uuid */
|
|
@@ -1442,7 +1432,7 @@ export interface CustomFieldValue {
|
|
|
1442
1432
|
customFieldDefinitionID: string;
|
|
1443
1433
|
value: string;
|
|
1444
1434
|
definitionName: string;
|
|
1445
|
-
dataType:
|
|
1435
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1446
1436
|
}
|
|
1447
1437
|
export interface DetailedUser {
|
|
1448
1438
|
/** @format date-time */
|
|
@@ -1672,7 +1662,7 @@ export interface Draft {
|
|
|
1672
1662
|
siteConfiguration: SiteConfigurationReduced;
|
|
1673
1663
|
/** @format uuid */
|
|
1674
1664
|
loanID?: string | null;
|
|
1675
|
-
type:
|
|
1665
|
+
type: "NewLoan" | "EditLoan";
|
|
1676
1666
|
isCoBorrower: boolean;
|
|
1677
1667
|
}
|
|
1678
1668
|
export interface DraftContent {
|
|
@@ -1690,7 +1680,7 @@ export interface DraftContent {
|
|
|
1690
1680
|
siteConfiguration: SiteConfigurationReduced;
|
|
1691
1681
|
/** @format uuid */
|
|
1692
1682
|
loanID?: string | null;
|
|
1693
|
-
type:
|
|
1683
|
+
type: "NewLoan" | "EditLoan";
|
|
1694
1684
|
isCoBorrower: boolean;
|
|
1695
1685
|
applicationPayload: any;
|
|
1696
1686
|
}
|
|
@@ -1706,7 +1696,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1706
1696
|
}
|
|
1707
1697
|
export interface DraftRequest {
|
|
1708
1698
|
applicationPayload: any;
|
|
1709
|
-
customData?: any
|
|
1699
|
+
customData?: any;
|
|
1710
1700
|
isCoBorrower: boolean;
|
|
1711
1701
|
}
|
|
1712
1702
|
export interface EconsentPendingSummary {
|
|
@@ -1776,9 +1766,9 @@ export interface EncompassCredentialsDetail {
|
|
|
1776
1766
|
clearStateIfUnlicensed: boolean;
|
|
1777
1767
|
/** @deprecated */
|
|
1778
1768
|
baseUrl?: string | null;
|
|
1779
|
-
encompassEnvironment:
|
|
1769
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1780
1770
|
consumerConnectWidgetHost?: string | null;
|
|
1781
|
-
signingMethod:
|
|
1771
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1782
1772
|
subscriptionId?: string | null;
|
|
1783
1773
|
environment?: string | null;
|
|
1784
1774
|
/** @format uuid */
|
|
@@ -1794,9 +1784,9 @@ export interface EncompassCredentialsRequest {
|
|
|
1794
1784
|
clearStateIfUnlicensed: boolean;
|
|
1795
1785
|
/** @deprecated */
|
|
1796
1786
|
baseUrl?: string | null;
|
|
1797
|
-
encompassEnvironment:
|
|
1787
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1798
1788
|
consumerConnectWidgetHost?: string | null;
|
|
1799
|
-
signingMethod:
|
|
1789
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1800
1790
|
subscriptionId?: string | null;
|
|
1801
1791
|
environment?: string | null;
|
|
1802
1792
|
clientID?: string | null;
|
|
@@ -1906,8 +1896,8 @@ export interface EncompassRequestLog {
|
|
|
1906
1896
|
losId?: string | null;
|
|
1907
1897
|
/** @format uuid */
|
|
1908
1898
|
accountId: string;
|
|
1909
|
-
operationType:
|
|
1910
|
-
outcome:
|
|
1899
|
+
operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
1900
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1911
1901
|
message: string;
|
|
1912
1902
|
endpoint?: string | null;
|
|
1913
1903
|
httpMethod?: string | null;
|
|
@@ -1915,7 +1905,7 @@ export interface EncompassRequestLog {
|
|
|
1915
1905
|
httpStatusCode?: number | null;
|
|
1916
1906
|
/** @format int64 */
|
|
1917
1907
|
durationMs?: number | null;
|
|
1918
|
-
context?: any
|
|
1908
|
+
context?: any;
|
|
1919
1909
|
/** @format date-time */
|
|
1920
1910
|
createdAt: string;
|
|
1921
1911
|
}
|
|
@@ -1960,7 +1950,7 @@ export interface FileSearchCriteria {
|
|
|
1960
1950
|
export interface FileWithBytes {
|
|
1961
1951
|
name: string;
|
|
1962
1952
|
/** @format byte */
|
|
1963
|
-
data:
|
|
1953
|
+
data: string;
|
|
1964
1954
|
fileName: string;
|
|
1965
1955
|
mimeType?: string | null;
|
|
1966
1956
|
extension?: string | null;
|
|
@@ -2036,7 +2026,7 @@ export interface FormSubmission {
|
|
|
2036
2026
|
subjectPropertyAddressCounty?: string | null;
|
|
2037
2027
|
subjectPropertyAddressState?: string | null;
|
|
2038
2028
|
subjectPropertyAddressZip?: string | null;
|
|
2039
|
-
data?: any
|
|
2029
|
+
data?: any;
|
|
2040
2030
|
/** @format uuid */
|
|
2041
2031
|
listingID?: string | null;
|
|
2042
2032
|
listing?: Listing | null;
|
|
@@ -2071,7 +2061,7 @@ export interface FormSubmissionRequest {
|
|
|
2071
2061
|
subjectPropertyAddressCounty?: string | null;
|
|
2072
2062
|
subjectPropertyAddressState?: string | null;
|
|
2073
2063
|
subjectPropertyAddressZip?: string | null;
|
|
2074
|
-
data?: any
|
|
2064
|
+
data?: any;
|
|
2075
2065
|
/** @format uuid */
|
|
2076
2066
|
listingID?: string | null;
|
|
2077
2067
|
}
|
|
@@ -2120,7 +2110,7 @@ export interface FusionFieldDisplay {
|
|
|
2120
2110
|
fieldValue: string;
|
|
2121
2111
|
}
|
|
2122
2112
|
export interface FusionReportFilter {
|
|
2123
|
-
filterType:
|
|
2113
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
2124
2114
|
targetField: string;
|
|
2125
2115
|
targetValue: string;
|
|
2126
2116
|
}
|
|
@@ -2140,7 +2130,7 @@ export interface GenerateSystemPrompt {
|
|
|
2140
2130
|
}
|
|
2141
2131
|
export interface GenerateSystemPromptRequest {
|
|
2142
2132
|
description: string;
|
|
2143
|
-
category:
|
|
2133
|
+
category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
2144
2134
|
}
|
|
2145
2135
|
export interface GetApplications {
|
|
2146
2136
|
applications: ApplicationRowData[];
|
|
@@ -2224,11 +2214,11 @@ export interface GetWorkflowRequest {
|
|
|
2224
2214
|
export interface GuidPatchOperation {
|
|
2225
2215
|
op: string;
|
|
2226
2216
|
path: string;
|
|
2227
|
-
value?: any
|
|
2217
|
+
value?: any;
|
|
2228
2218
|
from?: string | null;
|
|
2229
2219
|
}
|
|
2230
2220
|
export interface IPAddress {
|
|
2231
|
-
addressFamily:
|
|
2221
|
+
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";
|
|
2232
2222
|
/** @format int64 */
|
|
2233
2223
|
scopeId: number;
|
|
2234
2224
|
isIPv6Multicast: boolean;
|
|
@@ -2477,7 +2467,7 @@ export interface Loan {
|
|
|
2477
2467
|
contacts: LoanContact[];
|
|
2478
2468
|
customFields: CustomFieldEntry[];
|
|
2479
2469
|
milestones: LoanMilestone[];
|
|
2480
|
-
signingMethod:
|
|
2470
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
2481
2471
|
}
|
|
2482
2472
|
export interface LoanApplication {
|
|
2483
2473
|
/** @format uuid */
|
|
@@ -2515,7 +2505,7 @@ export interface LoanApplicationRequest {
|
|
|
2515
2505
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2516
2506
|
/** @format uuid */
|
|
2517
2507
|
draftId?: string | null;
|
|
2518
|
-
additionalFields?: Record<string, any
|
|
2508
|
+
additionalFields?: Record<string, any>;
|
|
2519
2509
|
/** @format uuid */
|
|
2520
2510
|
existingLoanId?: string | null;
|
|
2521
2511
|
}
|
|
@@ -2534,7 +2524,7 @@ export interface LoanBorrower {
|
|
|
2534
2524
|
citizenship?: LoanCitizenship | null;
|
|
2535
2525
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2536
2526
|
languagePreference?: LoanLanguagePreference | null;
|
|
2537
|
-
applicationStatus:
|
|
2527
|
+
applicationStatus: "Draft" | "Complete";
|
|
2538
2528
|
/** @format int32 */
|
|
2539
2529
|
numberOfDependents?: number | null;
|
|
2540
2530
|
/** @format int32 */
|
|
@@ -2908,10 +2898,16 @@ export interface LoanBorrowerGiftRequest {
|
|
|
2908
2898
|
isDeposited?: boolean | null;
|
|
2909
2899
|
source?: LoanGiftSource | null;
|
|
2910
2900
|
assetType?: LoanGiftAssetType | null;
|
|
2901
|
+
grantorDonorName?: string | null;
|
|
2902
|
+
/** @format double */
|
|
2903
|
+
amountAppliedToDownPayment?: number | null;
|
|
2904
|
+
/** @format double */
|
|
2905
|
+
amountAppliedToClosingCosts?: number | null;
|
|
2911
2906
|
}
|
|
2912
2907
|
export interface LoanBorrowerHomeOwnership {
|
|
2913
2908
|
/** @format uuid */
|
|
2914
2909
|
id?: string | null;
|
|
2910
|
+
isCompleted?: boolean | null;
|
|
2915
2911
|
/** @format date */
|
|
2916
2912
|
dateCompleted?: string | null;
|
|
2917
2913
|
type?: LoanHomeOwnershipType | null;
|
|
@@ -2923,14 +2919,17 @@ export interface LoanBorrowerHomeOwnershipProvider {
|
|
|
2923
2919
|
id?: string | null;
|
|
2924
2920
|
name?: string | null;
|
|
2925
2921
|
phoneNumber?: string | null;
|
|
2922
|
+
hudAgencyId?: string | null;
|
|
2926
2923
|
address?: AddressV3 | null;
|
|
2927
2924
|
}
|
|
2928
2925
|
export interface LoanBorrowerHomeOwnershipProviderRequest {
|
|
2929
2926
|
name?: string | null;
|
|
2930
2927
|
phoneNumber?: string | null;
|
|
2928
|
+
hudAgencyId?: string | null;
|
|
2931
2929
|
address?: AddressRequest | null;
|
|
2932
2930
|
}
|
|
2933
2931
|
export interface LoanBorrowerHomeOwnershipRequest {
|
|
2932
|
+
isCompleted?: boolean | null;
|
|
2934
2933
|
/** @format date */
|
|
2935
2934
|
dateCompleted?: string | null;
|
|
2936
2935
|
type?: LoanHomeOwnershipType | null;
|
|
@@ -3063,7 +3062,9 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
3063
3062
|
/** @format uuid */
|
|
3064
3063
|
id?: string | null;
|
|
3065
3064
|
status?: LoanRealEstateStatus | null;
|
|
3066
|
-
occupancy?:
|
|
3065
|
+
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3066
|
+
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3067
|
+
intendedUsageOtherDescription?: string | null;
|
|
3067
3068
|
/** @format double */
|
|
3068
3069
|
marketValue?: number | null;
|
|
3069
3070
|
/** @format double */
|
|
@@ -3118,7 +3119,9 @@ export interface LoanBorrowerRealEstateAssetMortgageRequest {
|
|
|
3118
3119
|
}
|
|
3119
3120
|
export interface LoanBorrowerRealEstateAssetRequest {
|
|
3120
3121
|
status?: LoanRealEstateStatus | null;
|
|
3121
|
-
occupancy?:
|
|
3122
|
+
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3123
|
+
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3124
|
+
intendedUsageOtherDescription?: string | null;
|
|
3122
3125
|
/** @format double */
|
|
3123
3126
|
marketValue?: number | null;
|
|
3124
3127
|
/** @format double */
|
|
@@ -3260,7 +3263,7 @@ export interface LoanConsentRequest {
|
|
|
3260
3263
|
borrowerEConsent?: boolean | null;
|
|
3261
3264
|
borrowerCreditAuth?: boolean | null;
|
|
3262
3265
|
borrowerTCPAOptIn?: boolean | null;
|
|
3263
|
-
additionalFields?: Record<string, string
|
|
3266
|
+
additionalFields?: Record<string, string>;
|
|
3264
3267
|
}
|
|
3265
3268
|
export interface LoanContact {
|
|
3266
3269
|
/** @format date-time */
|
|
@@ -3278,7 +3281,7 @@ export interface LoanContact {
|
|
|
3278
3281
|
email?: string | null;
|
|
3279
3282
|
phone?: string | null;
|
|
3280
3283
|
companyName?: string | null;
|
|
3281
|
-
role:
|
|
3284
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3282
3285
|
}
|
|
3283
3286
|
export interface LoanContactList {
|
|
3284
3287
|
email: string;
|
|
@@ -3300,7 +3303,7 @@ export interface LoanCostDetails {
|
|
|
3300
3303
|
totalFinancing?: number | null;
|
|
3301
3304
|
}
|
|
3302
3305
|
export interface LoanCustomFieldsRequest {
|
|
3303
|
-
additionalFields?: Record<string, string
|
|
3306
|
+
additionalFields?: Record<string, string>;
|
|
3304
3307
|
}
|
|
3305
3308
|
export interface LoanDocument {
|
|
3306
3309
|
/** @format date-time */
|
|
@@ -3357,14 +3360,14 @@ export interface LoanDocumentFolderPermission {
|
|
|
3357
3360
|
id: string;
|
|
3358
3361
|
/** @format uuid */
|
|
3359
3362
|
loanDocumentFolderID: string;
|
|
3360
|
-
role:
|
|
3361
|
-
level:
|
|
3362
|
-
readScope:
|
|
3363
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3364
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3365
|
+
readScope: "Own" | "All";
|
|
3363
3366
|
}
|
|
3364
3367
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3365
|
-
role:
|
|
3366
|
-
level:
|
|
3367
|
-
readScope:
|
|
3368
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3369
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3370
|
+
readScope: "Own" | "All";
|
|
3368
3371
|
}
|
|
3369
3372
|
export interface LoanDocumentFolderSearchCriteria {
|
|
3370
3373
|
searchText?: string | null;
|
|
@@ -3524,13 +3527,13 @@ export interface LoanImport {
|
|
|
3524
3527
|
/** @format int32 */
|
|
3525
3528
|
importedCount: number;
|
|
3526
3529
|
statusMessage?: string | null;
|
|
3527
|
-
status:
|
|
3528
|
-
importMode:
|
|
3530
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
3531
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3529
3532
|
/** @format date-time */
|
|
3530
3533
|
createdAt?: string | null;
|
|
3531
3534
|
}
|
|
3532
3535
|
export interface LoanImportLog {
|
|
3533
|
-
level:
|
|
3536
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3534
3537
|
message: string;
|
|
3535
3538
|
/** @format date-time */
|
|
3536
3539
|
createdAt: string;
|
|
@@ -3585,8 +3588,8 @@ export interface LoanListPaginated {
|
|
|
3585
3588
|
export interface LoanLog {
|
|
3586
3589
|
/** @format uuid */
|
|
3587
3590
|
id: string;
|
|
3588
|
-
level:
|
|
3589
|
-
type:
|
|
3591
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3592
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
3590
3593
|
message: string;
|
|
3591
3594
|
/** @format date-time */
|
|
3592
3595
|
createdAt: string;
|
|
@@ -3594,8 +3597,8 @@ export interface LoanLog {
|
|
|
3594
3597
|
export interface LoanLogDetail {
|
|
3595
3598
|
/** @format uuid */
|
|
3596
3599
|
id: string;
|
|
3597
|
-
level:
|
|
3598
|
-
type:
|
|
3600
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3601
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
3599
3602
|
message: string;
|
|
3600
3603
|
/** @format date-time */
|
|
3601
3604
|
createdAt: string;
|
|
@@ -3857,7 +3860,7 @@ export interface LoanQueueWithData {
|
|
|
3857
3860
|
user: UserPublic;
|
|
3858
3861
|
loanOfficer: LoanOfficerPublic;
|
|
3859
3862
|
siteConfiguration: SiteConfigurationReduced;
|
|
3860
|
-
data?: any
|
|
3863
|
+
data?: any;
|
|
3861
3864
|
}
|
|
3862
3865
|
export interface LoanRecord {
|
|
3863
3866
|
loanGuid: string;
|
|
@@ -3888,7 +3891,7 @@ export interface LoanTaskSearchRequest {
|
|
|
3888
3891
|
loanStatus?: LoanTaskActivityFilter | null;
|
|
3889
3892
|
}
|
|
3890
3893
|
export interface LoanTaskStatusSummary {
|
|
3891
|
-
status:
|
|
3894
|
+
status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
3892
3895
|
/** @format int32 */
|
|
3893
3896
|
count: number;
|
|
3894
3897
|
}
|
|
@@ -3900,11 +3903,19 @@ export interface LoanUser {
|
|
|
3900
3903
|
email: string;
|
|
3901
3904
|
phone?: string | null;
|
|
3902
3905
|
role: string;
|
|
3903
|
-
loanRole:
|
|
3906
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3904
3907
|
isUser: boolean;
|
|
3905
3908
|
/** @format date-time */
|
|
3906
3909
|
createdAt: string;
|
|
3907
3910
|
}
|
|
3911
|
+
export interface LosCredentialHealth {
|
|
3912
|
+
/** @format uuid */
|
|
3913
|
+
accountId: string;
|
|
3914
|
+
status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
|
|
3915
|
+
/** @format date-time */
|
|
3916
|
+
checkedAtUtc: string;
|
|
3917
|
+
message: string;
|
|
3918
|
+
}
|
|
3908
3919
|
export interface LosCredentials {
|
|
3909
3920
|
/** @format uuid */
|
|
3910
3921
|
id: string;
|
|
@@ -3912,6 +3923,71 @@ export interface LosCredentials {
|
|
|
3912
3923
|
accountID: string;
|
|
3913
3924
|
instanceID: string;
|
|
3914
3925
|
}
|
|
3926
|
+
export interface LosIntegration {
|
|
3927
|
+
/** @format uuid */
|
|
3928
|
+
accountId: string;
|
|
3929
|
+
accountName?: string | null;
|
|
3930
|
+
instanceID: string;
|
|
3931
|
+
encompassEnvironment: "Production" | "UAT";
|
|
3932
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
3933
|
+
consumerConnectWidgetHost?: string | null;
|
|
3934
|
+
defaultLoanOfficerUserName?: string | null;
|
|
3935
|
+
loanTemplate?: string | null;
|
|
3936
|
+
loanAssignmentRole?: string | null;
|
|
3937
|
+
clearStateIfUnlicensed: boolean;
|
|
3938
|
+
subscriptionId?: string | null;
|
|
3939
|
+
environment?: string | null;
|
|
3940
|
+
hasSigningKey: boolean;
|
|
3941
|
+
health?: LosCredentialHealth | null;
|
|
3942
|
+
webhooks?: LosWebhookInventory | null;
|
|
3943
|
+
}
|
|
3944
|
+
export interface LosIntegrationCredentials {
|
|
3945
|
+
/** @format uuid */
|
|
3946
|
+
id: string;
|
|
3947
|
+
/** @format uuid */
|
|
3948
|
+
accountID: string;
|
|
3949
|
+
instanceID: string;
|
|
3950
|
+
encompassEnvironment: "Production" | "UAT";
|
|
3951
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
3952
|
+
consumerConnectWidgetHost?: string | null;
|
|
3953
|
+
defaultLoanOfficerUserName?: string | null;
|
|
3954
|
+
loanTemplate?: string | null;
|
|
3955
|
+
loanAssignmentRole?: string | null;
|
|
3956
|
+
clearStateIfUnlicensed: boolean;
|
|
3957
|
+
subscriptionId?: string | null;
|
|
3958
|
+
environment?: string | null;
|
|
3959
|
+
clientID?: string | null;
|
|
3960
|
+
clientSecret?: string | null;
|
|
3961
|
+
signingKeyId?: string | null;
|
|
3962
|
+
signingKey?: string | null;
|
|
3963
|
+
secretsDecrypted: boolean;
|
|
3964
|
+
}
|
|
3965
|
+
export interface LosIntegrationPaginated {
|
|
3966
|
+
rows: LosIntegration[];
|
|
3967
|
+
pagination: Pagination;
|
|
3968
|
+
/** @format int64 */
|
|
3969
|
+
count: number;
|
|
3970
|
+
}
|
|
3971
|
+
export interface LosIntegrationsBatchRequest {
|
|
3972
|
+
accountIds: string[];
|
|
3973
|
+
}
|
|
3974
|
+
export interface LosIntegrationsSearchCriteria {
|
|
3975
|
+
searchText?: string | null;
|
|
3976
|
+
}
|
|
3977
|
+
export interface LosIntegrationsSummary {
|
|
3978
|
+
/** @format int32 */
|
|
3979
|
+
totalIntegrations: number;
|
|
3980
|
+
/** @format int32 */
|
|
3981
|
+
healthyCount: number;
|
|
3982
|
+
/** @format int32 */
|
|
3983
|
+
failingCount: number;
|
|
3984
|
+
/** @format int32 */
|
|
3985
|
+
unknownCount: number;
|
|
3986
|
+
/** @format int32 */
|
|
3987
|
+
accountsMissingExpectedWebhook: number;
|
|
3988
|
+
/** @format int32 */
|
|
3989
|
+
webhookUnknownCount: number;
|
|
3990
|
+
}
|
|
3915
3991
|
export interface LosLoanCreationRequest {
|
|
3916
3992
|
loanOfficerUserName?: string | null;
|
|
3917
3993
|
loanTemplate?: string | null;
|
|
@@ -3934,7 +4010,7 @@ export interface LosOperationTracking {
|
|
|
3934
4010
|
operationType: string;
|
|
3935
4011
|
correlationKey: string;
|
|
3936
4012
|
lastTriggerSource?: string | null;
|
|
3937
|
-
status:
|
|
4013
|
+
status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
3938
4014
|
/** @format date-time */
|
|
3939
4015
|
createdAt: string;
|
|
3940
4016
|
/** @format date-time */
|
|
@@ -4020,7 +4096,7 @@ export interface LosSyncStep {
|
|
|
4020
4096
|
/** @format int32 */
|
|
4021
4097
|
order: number;
|
|
4022
4098
|
name: string;
|
|
4023
|
-
severity:
|
|
4099
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
4024
4100
|
message: string;
|
|
4025
4101
|
/** @format date-time */
|
|
4026
4102
|
atUtc: string;
|
|
@@ -4033,8 +4109,29 @@ export interface LosWebhook {
|
|
|
4033
4109
|
events: string[];
|
|
4034
4110
|
enableSubscription: boolean;
|
|
4035
4111
|
}
|
|
4112
|
+
export interface LosWebhookEntry {
|
|
4113
|
+
path: string;
|
|
4114
|
+
endpoint: string;
|
|
4115
|
+
resource: string;
|
|
4116
|
+
events: string[];
|
|
4117
|
+
/** @format uuid */
|
|
4118
|
+
subscriptionId?: string | null;
|
|
4119
|
+
enableSubscription?: boolean | null;
|
|
4120
|
+
status: "Registered" | "Disabled" | "Missing" | "Extra";
|
|
4121
|
+
}
|
|
4122
|
+
export interface LosWebhookInventory {
|
|
4123
|
+
/** @format uuid */
|
|
4124
|
+
accountId: string;
|
|
4125
|
+
overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
4126
|
+
entries: LosWebhookEntry[];
|
|
4127
|
+
/** @format int32 */
|
|
4128
|
+
missingCount: number;
|
|
4129
|
+
/** @format date-time */
|
|
4130
|
+
checkedAtUtc: string;
|
|
4131
|
+
message: string;
|
|
4132
|
+
}
|
|
4036
4133
|
export interface ManualDocumentClassificationRequest {
|
|
4037
|
-
documentType:
|
|
4134
|
+
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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
|
|
4038
4135
|
}
|
|
4039
4136
|
export interface MdmUser {
|
|
4040
4137
|
user_email?: string | null;
|
|
@@ -4117,7 +4214,7 @@ export interface ModuleParameterValue {
|
|
|
4117
4214
|
parameterID: string;
|
|
4118
4215
|
parameterName: string;
|
|
4119
4216
|
parameterType: string;
|
|
4120
|
-
value?: any
|
|
4217
|
+
value?: any;
|
|
4121
4218
|
isInherited: boolean;
|
|
4122
4219
|
}
|
|
4123
4220
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4290,7 +4387,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4290
4387
|
}
|
|
4291
4388
|
export interface Operation {
|
|
4292
4389
|
op?: string;
|
|
4293
|
-
value?:
|
|
4390
|
+
value?: string | number | boolean | null | object;
|
|
4294
4391
|
path?: string;
|
|
4295
4392
|
}
|
|
4296
4393
|
export interface OverridePasswordRequest {
|
|
@@ -4624,7 +4721,7 @@ export interface SiteConfiguration {
|
|
|
4624
4721
|
deletedAt?: string | null;
|
|
4625
4722
|
/** @format uuid */
|
|
4626
4723
|
id: string;
|
|
4627
|
-
type:
|
|
4724
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4628
4725
|
/** @format uuid */
|
|
4629
4726
|
entityID: string;
|
|
4630
4727
|
/** @format int32 */
|
|
@@ -4818,7 +4915,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4818
4915
|
deletedAt?: string | null;
|
|
4819
4916
|
/** @format uuid */
|
|
4820
4917
|
id: string;
|
|
4821
|
-
type:
|
|
4918
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4822
4919
|
/** @format uuid */
|
|
4823
4920
|
entityID: string;
|
|
4824
4921
|
/** @format int32 */
|
|
@@ -5029,7 +5126,7 @@ export interface SiteConfigurationForm {
|
|
|
5029
5126
|
export interface SiteConfigurationReduced {
|
|
5030
5127
|
/** @format uuid */
|
|
5031
5128
|
id: string;
|
|
5032
|
-
type:
|
|
5129
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5033
5130
|
url?: string | null;
|
|
5034
5131
|
name: string;
|
|
5035
5132
|
/** @format int64 */
|
|
@@ -5046,7 +5143,7 @@ export interface SiteConfigurationRequest {
|
|
|
5046
5143
|
entityID: string;
|
|
5047
5144
|
/** @format int32 */
|
|
5048
5145
|
entityType: number;
|
|
5049
|
-
type:
|
|
5146
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5050
5147
|
url: string;
|
|
5051
5148
|
name: string;
|
|
5052
5149
|
introduction?: string | null;
|
|
@@ -5222,7 +5319,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5222
5319
|
export interface SiteConfigurationSummary {
|
|
5223
5320
|
/** @format uuid */
|
|
5224
5321
|
id: string;
|
|
5225
|
-
type:
|
|
5322
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5226
5323
|
url?: string | null;
|
|
5227
5324
|
name: string;
|
|
5228
5325
|
/** @format int64 */
|
|
@@ -5258,7 +5355,7 @@ export interface SiteTile {
|
|
|
5258
5355
|
title: string;
|
|
5259
5356
|
description: string;
|
|
5260
5357
|
linkUrl: string;
|
|
5261
|
-
linkTarget:
|
|
5358
|
+
linkTarget: "Self" | "Blank";
|
|
5262
5359
|
siteTypes: SiteConfigurationType[];
|
|
5263
5360
|
locationAudiences: SiteTileLocationAudience[];
|
|
5264
5361
|
/** @format int32 */
|
|
@@ -5270,11 +5367,11 @@ export interface SiteTile {
|
|
|
5270
5367
|
updatedAt?: string | null;
|
|
5271
5368
|
}
|
|
5272
5369
|
export interface SiteTileLocationAudience {
|
|
5273
|
-
location:
|
|
5370
|
+
location: "HomePage" | "Dashboard";
|
|
5274
5371
|
audience: UserRole[];
|
|
5275
5372
|
}
|
|
5276
5373
|
export interface SiteTileLocationAudienceRequest {
|
|
5277
|
-
location:
|
|
5374
|
+
location: "HomePage" | "Dashboard";
|
|
5278
5375
|
audience: UserRole[];
|
|
5279
5376
|
}
|
|
5280
5377
|
export interface SiteTilePaginated {
|
|
@@ -5290,7 +5387,7 @@ export interface SiteTileRequest {
|
|
|
5290
5387
|
title: string;
|
|
5291
5388
|
description: string;
|
|
5292
5389
|
linkUrl: string;
|
|
5293
|
-
linkTarget:
|
|
5390
|
+
linkTarget: "Self" | "Blank";
|
|
5294
5391
|
siteTypes: SiteConfigurationType[];
|
|
5295
5392
|
locationAudiences: SiteTileLocationAudienceRequest[];
|
|
5296
5393
|
/** @format int32 */
|
|
@@ -5311,7 +5408,7 @@ export interface SiteTileView {
|
|
|
5311
5408
|
title: string;
|
|
5312
5409
|
description: string;
|
|
5313
5410
|
linkUrl: string;
|
|
5314
|
-
linkTarget:
|
|
5411
|
+
linkTarget: "Self" | "Blank";
|
|
5315
5412
|
/** @format int32 */
|
|
5316
5413
|
weight: number;
|
|
5317
5414
|
}
|
|
@@ -5542,7 +5639,7 @@ export interface UnregisteredBorrower {
|
|
|
5542
5639
|
lastName?: string | null;
|
|
5543
5640
|
fullName?: string | null;
|
|
5544
5641
|
email?: string | null;
|
|
5545
|
-
role:
|
|
5642
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5546
5643
|
}
|
|
5547
5644
|
export interface UpdateAccountRequest {
|
|
5548
5645
|
name: string;
|
|
@@ -5566,7 +5663,7 @@ export interface UpdateAiCanonicalFieldRequest {
|
|
|
5566
5663
|
}
|
|
5567
5664
|
export interface UpdateAiGuardrailRequest {
|
|
5568
5665
|
name: string;
|
|
5569
|
-
category:
|
|
5666
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5570
5667
|
description?: string | null;
|
|
5571
5668
|
keywords: string[];
|
|
5572
5669
|
responseTemplate: string;
|
|
@@ -5600,8 +5697,8 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5600
5697
|
name: string;
|
|
5601
5698
|
url: string;
|
|
5602
5699
|
description?: string | null;
|
|
5603
|
-
category:
|
|
5604
|
-
scope:
|
|
5700
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5701
|
+
scope: "FullDomain" | "SpecificPath";
|
|
5605
5702
|
}
|
|
5606
5703
|
export interface UpdateCompanyDocumentFolderRequest {
|
|
5607
5704
|
name: string;
|
|
@@ -5887,6 +5984,10 @@ export interface UserBase {
|
|
|
5887
5984
|
lastName: string;
|
|
5888
5985
|
email: string;
|
|
5889
5986
|
}
|
|
5987
|
+
export interface UserDeactivated {
|
|
5988
|
+
accountDeactivated: boolean;
|
|
5989
|
+
email: string;
|
|
5990
|
+
}
|
|
5890
5991
|
export interface UserDevice {
|
|
5891
5992
|
/** @format uuid */
|
|
5892
5993
|
id: string;
|
|
@@ -5901,7 +6002,7 @@ export interface UserDevice {
|
|
|
5901
6002
|
export interface UserDraft {
|
|
5902
6003
|
/** @format uuid */
|
|
5903
6004
|
draftID: string;
|
|
5904
|
-
role:
|
|
6005
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5905
6006
|
user: User;
|
|
5906
6007
|
}
|
|
5907
6008
|
export interface UserDraftPaginated {
|
|
@@ -5925,7 +6026,7 @@ export interface UserGroupAccessScope {
|
|
|
5925
6026
|
id: string;
|
|
5926
6027
|
/** @format uuid */
|
|
5927
6028
|
groupId: string;
|
|
5928
|
-
scopeType:
|
|
6029
|
+
scopeType: "User" | "Branch";
|
|
5929
6030
|
/** @format uuid */
|
|
5930
6031
|
userId?: string | null;
|
|
5931
6032
|
/** @format uuid */
|
|
@@ -5948,7 +6049,7 @@ export interface UserGroupMemberUserSummary {
|
|
|
5948
6049
|
id: string;
|
|
5949
6050
|
name?: string | null;
|
|
5950
6051
|
email?: string | null;
|
|
5951
|
-
role:
|
|
6052
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5952
6053
|
}
|
|
5953
6054
|
export interface UserGroupPaginated {
|
|
5954
6055
|
rows: UserGroup[];
|
|
@@ -5965,7 +6066,7 @@ export interface UserLoan {
|
|
|
5965
6066
|
deletedAt?: string | null;
|
|
5966
6067
|
loanID: string;
|
|
5967
6068
|
user: User;
|
|
5968
|
-
role:
|
|
6069
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5969
6070
|
/** @format int32 */
|
|
5970
6071
|
borrowerPair?: number | null;
|
|
5971
6072
|
/** @format int32 */
|
|
@@ -5977,11 +6078,11 @@ export interface UserLoanConsent {
|
|
|
5977
6078
|
id: string;
|
|
5978
6079
|
/** @format uuid */
|
|
5979
6080
|
userLoanID: string;
|
|
5980
|
-
type:
|
|
6081
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5981
6082
|
providedConsent: boolean;
|
|
5982
6083
|
source?: ConsentSource | null;
|
|
5983
6084
|
ipAddress?: string | null;
|
|
5984
|
-
losSyncStatus:
|
|
6085
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
5985
6086
|
/** @format date-time */
|
|
5986
6087
|
createdAt: string;
|
|
5987
6088
|
/** @format date-time */
|
|
@@ -6057,6 +6158,21 @@ export interface UserPublic {
|
|
|
6057
6158
|
phone?: string | null;
|
|
6058
6159
|
title?: string | null;
|
|
6059
6160
|
}
|
|
6161
|
+
export interface UserReactivationCompleteRequest {
|
|
6162
|
+
/** @format uuid */
|
|
6163
|
+
token: string;
|
|
6164
|
+
/** @minLength 8 */
|
|
6165
|
+
newPassword: string;
|
|
6166
|
+
}
|
|
6167
|
+
export interface UserReactivationRequest {
|
|
6168
|
+
/**
|
|
6169
|
+
* @format email
|
|
6170
|
+
* @minLength 1
|
|
6171
|
+
*/
|
|
6172
|
+
email: string;
|
|
6173
|
+
/** @format uuid */
|
|
6174
|
+
siteConfigurationId: string;
|
|
6175
|
+
}
|
|
6060
6176
|
export interface UserRelation {
|
|
6061
6177
|
/** @format uuid */
|
|
6062
6178
|
userId1: string;
|
|
@@ -6140,98 +6256,6 @@ export interface Workflow {
|
|
|
6140
6256
|
tileSubtitle: string;
|
|
6141
6257
|
icon: string;
|
|
6142
6258
|
}
|
|
6143
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6144
|
-
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" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
|
|
6145
|
-
export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
6146
|
-
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
6147
|
-
export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6148
|
-
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6149
|
-
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
6150
|
-
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
6151
|
-
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6152
|
-
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6153
|
-
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
6154
|
-
export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
6155
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
6156
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
6157
|
-
export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6158
|
-
export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6159
|
-
export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
6160
|
-
export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6161
|
-
export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
|
|
6162
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6163
|
-
/** @deprecated */
|
|
6164
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
6165
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6166
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6167
|
-
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6168
|
-
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
6169
|
-
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6170
|
-
export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6171
|
-
export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
6172
|
-
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6173
|
-
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
6174
|
-
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6175
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6176
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6177
|
-
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
6178
|
-
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6179
|
-
export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
|
|
6180
|
-
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6181
|
-
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6182
|
-
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6183
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
6184
|
-
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6185
|
-
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";
|
|
6186
|
-
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6187
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6188
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6189
|
-
export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6190
|
-
export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
6191
|
-
export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
|
|
6192
|
-
export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6193
|
-
export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
6194
|
-
export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
|
|
6195
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
6196
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6197
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6198
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6199
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
6200
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6201
|
-
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
6202
|
-
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
6203
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6204
|
-
export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
6205
|
-
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
6206
|
-
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";
|
|
6207
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6208
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6209
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6210
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6211
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6212
|
-
export type SiteTileLinkTargetEnum = "Self" | "Blank";
|
|
6213
|
-
export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
6214
|
-
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
6215
|
-
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
6216
|
-
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
6217
|
-
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6218
|
-
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6219
|
-
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6220
|
-
export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
6221
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6222
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6223
|
-
export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6224
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6225
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6226
|
-
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
6227
|
-
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6228
|
-
/** @default "Realtor" */
|
|
6229
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6230
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6231
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6232
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6233
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6234
|
-
export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
|
|
6235
6259
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
6236
6260
|
export type QueryParamsType = Record<string | number, any>;
|
|
6237
6261
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -6254,7 +6278,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
6254
6278
|
secure?: boolean;
|
|
6255
6279
|
format?: ResponseType;
|
|
6256
6280
|
}
|
|
6257
|
-
export
|
|
6281
|
+
export declare enum ContentType {
|
|
6282
|
+
JsonPatch = "application/json-patch+json",
|
|
6283
|
+
Json = "application/json",
|
|
6284
|
+
JsonApi = "application/vnd.api+json",
|
|
6285
|
+
FormData = "multipart/form-data",
|
|
6286
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
6287
|
+
Text = "text/plain"
|
|
6288
|
+
}
|
|
6258
6289
|
export declare class HttpClient<SecurityDataType = unknown> {
|
|
6259
6290
|
instance: AxiosInstance;
|
|
6260
6291
|
private securityData;
|
|
@@ -6270,7 +6301,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6270
6301
|
}
|
|
6271
6302
|
/**
|
|
6272
6303
|
* @title The Big POS API
|
|
6273
|
-
* @version v2.49.
|
|
6304
|
+
* @version v2.49.3
|
|
6274
6305
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6275
6306
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6276
6307
|
*/
|
|
@@ -6344,29 +6375,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6344
6375
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6345
6376
|
*/
|
|
6346
6377
|
updateSiteConfigurationForAccount: (data: SiteConfiguration, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
|
|
6347
|
-
/**
|
|
6348
|
-
* No description
|
|
6349
|
-
*
|
|
6350
|
-
* @tags AccountReactivation
|
|
6351
|
-
* @name RequestAccountReactivation
|
|
6352
|
-
* @summary Request account reactivation
|
|
6353
|
-
* @request POST:/api/account/reactivation/request
|
|
6354
|
-
* @secure
|
|
6355
|
-
* @response `204` `void` No Content
|
|
6356
|
-
*/
|
|
6357
|
-
requestAccountReactivation: (data: AccountReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6358
|
-
/**
|
|
6359
|
-
* No description
|
|
6360
|
-
*
|
|
6361
|
-
* @tags AccountReactivation
|
|
6362
|
-
* @name CompleteAccountReactivation
|
|
6363
|
-
* @summary Complete account reactivation with new password
|
|
6364
|
-
* @request POST:/api/account/reactivation/complete
|
|
6365
|
-
* @secure
|
|
6366
|
-
* @response `204` `void` No Content
|
|
6367
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6368
|
-
*/
|
|
6369
|
-
completeAccountReactivation: (data: AccountReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6370
6378
|
/**
|
|
6371
6379
|
* No description
|
|
6372
6380
|
*
|
|
@@ -7359,10 +7367,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7359
7367
|
* @summary Get Token
|
|
7360
7368
|
* @request POST:/api/token
|
|
7361
7369
|
* @secure
|
|
7362
|
-
* @response `200` `
|
|
7370
|
+
* @response `200` `UserDeactivated` OK
|
|
7363
7371
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
7364
7372
|
*/
|
|
7365
|
-
getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
7373
|
+
getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
|
|
7366
7374
|
/**
|
|
7367
7375
|
* No description
|
|
7368
7376
|
*
|
|
@@ -7371,10 +7379,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7371
7379
|
* @summary Get Token From Challenge Code
|
|
7372
7380
|
* @request POST:/api/token/code
|
|
7373
7381
|
* @secure
|
|
7374
|
-
* @response `200` `
|
|
7382
|
+
* @response `200` `UserDeactivated` OK
|
|
7375
7383
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
7376
7384
|
*/
|
|
7377
|
-
getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
7385
|
+
getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
|
|
7378
7386
|
/**
|
|
7379
7387
|
* No description
|
|
7380
7388
|
*
|
|
@@ -7729,7 +7737,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7729
7737
|
* @response `200` `CompanyDocument` OK
|
|
7730
7738
|
* @response `404` `ProblemDetails` Not Found
|
|
7731
7739
|
*/
|
|
7732
|
-
getCompanyDocument: (id: string,
|
|
7740
|
+
getCompanyDocument: (id: string, query?: {
|
|
7741
|
+
/** @default false */
|
|
7742
|
+
preview?: boolean;
|
|
7743
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7733
7744
|
/**
|
|
7734
7745
|
* No description
|
|
7735
7746
|
*
|
|
@@ -7756,6 +7767,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7756
7767
|
* @response `404` `ProblemDetails` Not Found
|
|
7757
7768
|
*/
|
|
7758
7769
|
deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7770
|
+
/**
|
|
7771
|
+
* No description
|
|
7772
|
+
*
|
|
7773
|
+
* @tags CompanyDocuments
|
|
7774
|
+
* @name GetCompanyDocumentPreviews
|
|
7775
|
+
* @summary Get company document previews in batch
|
|
7776
|
+
* @request POST:/api/company-documents/previews
|
|
7777
|
+
* @secure
|
|
7778
|
+
* @response `200` `Record<string,string>` OK
|
|
7779
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7780
|
+
*/
|
|
7781
|
+
getCompanyDocumentPreviews: (data: CompanyDocumentPreviewsRequest, params?: RequestParams) => Promise<AxiosResponse<Record<string, string>, any, {}>>;
|
|
7759
7782
|
/**
|
|
7760
7783
|
* No description
|
|
7761
7784
|
*
|
|
@@ -8004,7 +8027,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8004
8027
|
* @response `200` `(CustomFieldDefinition)[]` OK
|
|
8005
8028
|
*/
|
|
8006
8029
|
getCustomFieldDefinitions: (query?: {
|
|
8007
|
-
entityType?:
|
|
8030
|
+
entityType?: "Loan";
|
|
8008
8031
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
|
|
8009
8032
|
/**
|
|
8010
8033
|
* No description
|
|
@@ -8471,6 +8494,155 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8471
8494
|
* @response `500` `EncompassError` Internal Server Error
|
|
8472
8495
|
*/
|
|
8473
8496
|
createEncompassSession: (data: CreateSessionRequest, params?: RequestParams) => Promise<AxiosResponse<CreateSession, any, {}>>;
|
|
8497
|
+
/**
|
|
8498
|
+
* No description
|
|
8499
|
+
*
|
|
8500
|
+
* @tags EncompassIntegrations
|
|
8501
|
+
* @name SearchEncompassIntegrations
|
|
8502
|
+
* @summary Search registered Encompass integrations across accounts (SuperAdmin)
|
|
8503
|
+
* @request POST:/api/monitoring/encompass-integrations/search
|
|
8504
|
+
* @secure
|
|
8505
|
+
* @response `200` `LosIntegrationPaginated` OK
|
|
8506
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8507
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8508
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8509
|
+
*/
|
|
8510
|
+
searchEncompassIntegrations: (data: LosIntegrationsSearchCriteria, query?: {
|
|
8511
|
+
/** @format int32 */
|
|
8512
|
+
pageSize?: number;
|
|
8513
|
+
/** @format int32 */
|
|
8514
|
+
pageNumber?: number;
|
|
8515
|
+
sortBy?: string;
|
|
8516
|
+
sortDirection?: string;
|
|
8517
|
+
/** @format uuid */
|
|
8518
|
+
accountId?: string;
|
|
8519
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationPaginated, any, {}>>;
|
|
8520
|
+
/**
|
|
8521
|
+
* No description
|
|
8522
|
+
*
|
|
8523
|
+
* @tags EncompassIntegrations
|
|
8524
|
+
* @name GetEncompassIntegrationsSummary
|
|
8525
|
+
* @summary Summarize registered Encompass integration health across accounts (SuperAdmin)
|
|
8526
|
+
* @request POST:/api/monitoring/encompass-integrations/summary
|
|
8527
|
+
* @secure
|
|
8528
|
+
* @response `200` `LosIntegrationsSummary` OK
|
|
8529
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8530
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8531
|
+
*/
|
|
8532
|
+
getEncompassIntegrationsSummary: (data: LosIntegrationsSearchCriteria, query?: {
|
|
8533
|
+
/** @format uuid */
|
|
8534
|
+
accountId?: string;
|
|
8535
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationsSummary, any, {}>>;
|
|
8536
|
+
/**
|
|
8537
|
+
* No description
|
|
8538
|
+
*
|
|
8539
|
+
* @tags EncompassIntegrations
|
|
8540
|
+
* @name GetEncompassIntegrationsHealth
|
|
8541
|
+
* @summary Get Encompass login health for a set of accounts (SuperAdmin)
|
|
8542
|
+
* @request POST:/api/monitoring/encompass-integrations/health
|
|
8543
|
+
* @secure
|
|
8544
|
+
* @response `200` `(LosCredentialHealth)[]` OK
|
|
8545
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8546
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8547
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8548
|
+
*/
|
|
8549
|
+
getEncompassIntegrationsHealth: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth[], any, {}>>;
|
|
8550
|
+
/**
|
|
8551
|
+
* No description
|
|
8552
|
+
*
|
|
8553
|
+
* @tags EncompassIntegrations
|
|
8554
|
+
* @name RecheckEncompassIntegrationHealth
|
|
8555
|
+
* @summary Force a fresh Encompass login health check for one account (SuperAdmin)
|
|
8556
|
+
* @request POST:/api/monitoring/encompass-integrations/{accountId}/health/recheck
|
|
8557
|
+
* @secure
|
|
8558
|
+
* @response `200` `LosCredentialHealth` OK
|
|
8559
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8560
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8561
|
+
*/
|
|
8562
|
+
recheckEncompassIntegrationHealth: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth, any, {}>>;
|
|
8563
|
+
/**
|
|
8564
|
+
* No description
|
|
8565
|
+
*
|
|
8566
|
+
* @tags EncompassIntegrations
|
|
8567
|
+
* @name GetEncompassIntegrationsWebhooks
|
|
8568
|
+
* @summary Get registered-versus-expected Encompass webhooks for a set of accounts (SuperAdmin)
|
|
8569
|
+
* @request POST:/api/monitoring/encompass-integrations/webhooks
|
|
8570
|
+
* @secure
|
|
8571
|
+
* @response `200` `(LosWebhookInventory)[]` OK
|
|
8572
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8573
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8574
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8575
|
+
*/
|
|
8576
|
+
getEncompassIntegrationsWebhooks: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory[], any, {}>>;
|
|
8577
|
+
/**
|
|
8578
|
+
* No description
|
|
8579
|
+
*
|
|
8580
|
+
* @tags EncompassIntegrations
|
|
8581
|
+
* @name RecheckEncompassIntegrationWebhooks
|
|
8582
|
+
* @summary Force a fresh Encompass webhook inventory read for one account (SuperAdmin)
|
|
8583
|
+
* @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/recheck
|
|
8584
|
+
* @secure
|
|
8585
|
+
* @response `200` `LosWebhookInventory` OK
|
|
8586
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8587
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8588
|
+
*/
|
|
8589
|
+
recheckEncompassIntegrationWebhooks: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory, any, {}>>;
|
|
8590
|
+
/**
|
|
8591
|
+
* No description
|
|
8592
|
+
*
|
|
8593
|
+
* @tags EncompassIntegrations
|
|
8594
|
+
* @name GetEncompassIntegrationCredentials
|
|
8595
|
+
* @summary Get Encompass credentials including secrets for a specific account (SuperAdmin)
|
|
8596
|
+
* @request GET:/api/monitoring/encompass-integrations/{accountId}/credentials
|
|
8597
|
+
* @secure
|
|
8598
|
+
* @response `200` `LosIntegrationCredentials` OK
|
|
8599
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8600
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8601
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8602
|
+
*/
|
|
8603
|
+
getEncompassIntegrationCredentials: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationCredentials, any, {}>>;
|
|
8604
|
+
/**
|
|
8605
|
+
* No description
|
|
8606
|
+
*
|
|
8607
|
+
* @tags EncompassIntegrations
|
|
8608
|
+
* @name UpdateEncompassIntegrationCredentials
|
|
8609
|
+
* @summary Update Encompass credentials for a specific account (SuperAdmin)
|
|
8610
|
+
* @request PUT:/api/monitoring/encompass-integrations/{accountId}/credentials
|
|
8611
|
+
* @secure
|
|
8612
|
+
* @response `200` `EncompassCredentialsDetail` OK
|
|
8613
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8614
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8615
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8616
|
+
*/
|
|
8617
|
+
updateEncompassIntegrationCredentials: (accountId: string, data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any, {}>>;
|
|
8618
|
+
/**
|
|
8619
|
+
* No description
|
|
8620
|
+
*
|
|
8621
|
+
* @tags EncompassIntegrations
|
|
8622
|
+
* @name RegisterEncompassIntegrationWebhook
|
|
8623
|
+
* @summary Register an expected Encompass webhook for a specific account (SuperAdmin)
|
|
8624
|
+
* @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks
|
|
8625
|
+
* @secure
|
|
8626
|
+
* @response `201` `LosWebhook` Created
|
|
8627
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8628
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8629
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8630
|
+
*/
|
|
8631
|
+
registerEncompassIntegrationWebhook: (accountId: string, data: CreateWebhookRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhook, any, {}>>;
|
|
8632
|
+
/**
|
|
8633
|
+
* No description
|
|
8634
|
+
*
|
|
8635
|
+
* @tags EncompassIntegrations
|
|
8636
|
+
* @name DeleteEncompassIntegrationWebhook
|
|
8637
|
+
* @summary Delete an Encompass webhook for a specific account (SuperAdmin)
|
|
8638
|
+
* @request DELETE:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookId}
|
|
8639
|
+
* @secure
|
|
8640
|
+
* @response `204` `void` No Content
|
|
8641
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
8642
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8643
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8644
|
+
*/
|
|
8645
|
+
deleteEncompassIntegrationWebhook: (accountId: string, webhookId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
8474
8646
|
/**
|
|
8475
8647
|
* No description
|
|
8476
8648
|
*
|
|
@@ -9526,10 +9698,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9526
9698
|
* @summary Download By ID
|
|
9527
9699
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
9528
9700
|
* @secure
|
|
9529
|
-
* @response `200` `
|
|
9701
|
+
* @response `200` `string` OK
|
|
9530
9702
|
* @response `404` `ProblemDetails` Not Found
|
|
9531
9703
|
*/
|
|
9532
|
-
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<
|
|
9704
|
+
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
9533
9705
|
/**
|
|
9534
9706
|
* No description
|
|
9535
9707
|
*
|
|
@@ -10794,7 +10966,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10794
10966
|
getPartners: (query?: {
|
|
10795
10967
|
showAll?: boolean;
|
|
10796
10968
|
/** @default "Realtor" */
|
|
10797
|
-
role?:
|
|
10969
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
10798
10970
|
/** @format int32 */
|
|
10799
10971
|
pageSize?: number;
|
|
10800
10972
|
/** @format int32 */
|
|
@@ -10972,7 +11144,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10972
11144
|
* @response `200` `File` OK
|
|
10973
11145
|
* @response `404` `ProblemDetails` Not Found
|
|
10974
11146
|
*/
|
|
10975
|
-
getSamlMetadata: (sSoIntegration:
|
|
11147
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10976
11148
|
/**
|
|
10977
11149
|
* No description
|
|
10978
11150
|
*
|
|
@@ -10983,7 +11155,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10983
11155
|
* @secure
|
|
10984
11156
|
* @response `200` `File` OK
|
|
10985
11157
|
*/
|
|
10986
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
11158
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10987
11159
|
/**
|
|
10988
11160
|
* No description
|
|
10989
11161
|
*
|
|
@@ -11076,7 +11248,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11076
11248
|
getSiteTilesBySiteConfiguration: (query?: {
|
|
11077
11249
|
/** @format uuid */
|
|
11078
11250
|
siteConfigurationId?: string;
|
|
11079
|
-
location?:
|
|
11251
|
+
location?: "HomePage" | "Dashboard";
|
|
11080
11252
|
}, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
|
|
11081
11253
|
/**
|
|
11082
11254
|
* No description
|
|
@@ -11774,6 +11946,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11774
11946
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11775
11947
|
*/
|
|
11776
11948
|
verifyUserInvite: (token: string, params?: RequestParams) => Promise<AxiosResponse<Invite, any, {}>>;
|
|
11949
|
+
/**
|
|
11950
|
+
* No description
|
|
11951
|
+
*
|
|
11952
|
+
* @tags UserReactivation
|
|
11953
|
+
* @name RequestUserReactivation
|
|
11954
|
+
* @summary Request user reactivation
|
|
11955
|
+
* @request POST:/api/users/reactivation/request
|
|
11956
|
+
* @secure
|
|
11957
|
+
* @response `204` `void` No Content
|
|
11958
|
+
*/
|
|
11959
|
+
requestUserReactivation: (data: UserReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11960
|
+
/**
|
|
11961
|
+
* No description
|
|
11962
|
+
*
|
|
11963
|
+
* @tags UserReactivation
|
|
11964
|
+
* @name CompleteUserReactivation
|
|
11965
|
+
* @summary Complete user reactivation with new password
|
|
11966
|
+
* @request POST:/api/users/reactivation/complete
|
|
11967
|
+
* @secure
|
|
11968
|
+
* @response `204` `void` No Content
|
|
11969
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
11970
|
+
*/
|
|
11971
|
+
completeUserReactivation: (data: UserReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11777
11972
|
/**
|
|
11778
11973
|
* No description
|
|
11779
11974
|
*
|
|
@@ -11845,6 +12040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11845
12040
|
* @request POST:/api/users
|
|
11846
12041
|
* @secure
|
|
11847
12042
|
* @response `200` `DetailedUser` OK
|
|
12043
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11848
12044
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11849
12045
|
*/
|
|
11850
12046
|
createUser: (data: CreateUserRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
|
|
@@ -12021,6 +12217,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12021
12217
|
* @request PUT:/api/users/me
|
|
12022
12218
|
* @secure
|
|
12023
12219
|
* @response `200` `DetailedUser` OK
|
|
12220
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12221
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12024
12222
|
*/
|
|
12025
12223
|
replaceMe: (data: UpdateMeRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
|
|
12026
12224
|
/**
|