@matech/thebigpos-sdk 3.15.0 → 3.16.0-dev-6073
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/README.md +39 -0
- package/dist/index.d.ts +572 -14
- package/dist/index.js +184 -2
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +16 -6
- package/scripts/apply-json-patch-content-type.js +189 -36
- package/src/index.ts +1119 -15
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
1
2
|
export type VersionStatusType = "Draft" | "Published";
|
|
2
3
|
export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
3
4
|
export type TaskType = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
|
|
@@ -25,6 +26,7 @@ export type LoanRoleTaskSource = "Rule" | "Manual";
|
|
|
25
26
|
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
26
27
|
export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
|
|
27
28
|
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
|
|
29
|
+
export type LoanRealEstatePropertyType = "SingleFamily" | "Condominium" | "Townhouse" | "Cooperative" | "TwoToFourUnitProperty" | "MultifamilyMoreThanFourUnits" | "ManufacturedMobileHome" | "CommercialNonResidential" | "HomeAndBusinessCombined" | "MixedUseResidential" | "Farm" | "Land";
|
|
28
30
|
export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
|
|
29
31
|
export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
|
|
30
32
|
export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
|
|
@@ -42,7 +44,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
|
|
|
42
44
|
export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
|
|
43
45
|
export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
|
|
44
46
|
export type LoanMaritalStatus = "Married" | "Separated" | "Single";
|
|
45
|
-
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
|
|
47
|
+
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
|
|
46
48
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
47
49
|
export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
|
|
48
50
|
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
|
|
@@ -86,6 +88,15 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
|
86
88
|
export type CompanyDocumentSourceType = "File" | "FreeText";
|
|
87
89
|
export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
88
90
|
export type ClassificationSource = "Textract" | "Llm" | "Manual";
|
|
91
|
+
export type CanvasWidgetType = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
92
|
+
export type CanvasWidgetScope = "Loan" | "User" | "Any";
|
|
93
|
+
export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
|
|
94
|
+
export type CanvasLabelPosition = "Left" | "Above";
|
|
95
|
+
export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
|
|
96
|
+
export type CanvasFieldSource = "Standard" | "Custom";
|
|
97
|
+
export type CanvasFieldFormat = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
98
|
+
export type CanvasFieldDataType = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
99
|
+
export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
89
100
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
90
101
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
91
102
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -104,6 +115,7 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
|
|
|
104
115
|
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
105
116
|
export type AiAuditEventType = "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" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
|
|
106
117
|
export type 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";
|
|
118
|
+
export type CanvasWidgetConfig = BaseCanvasWidgetConfig & (BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanProgress", LoanProgressWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MonthlyPayment", MonthlyPaymentWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Amortization", AmortizationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"PrimaryBorrower", PrimaryBorrowerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"SectionDivider", SectionDividerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>);
|
|
107
119
|
export interface ASOSettings {
|
|
108
120
|
enabled: boolean;
|
|
109
121
|
softPull: boolean;
|
|
@@ -422,7 +434,7 @@ export interface AiAuditLog {
|
|
|
422
434
|
guardrailCategory?: string | null;
|
|
423
435
|
rawRequest?: string | null;
|
|
424
436
|
rawResponse?: string | null;
|
|
425
|
-
details
|
|
437
|
+
details?: any | null;
|
|
426
438
|
/** @format date-time */
|
|
427
439
|
createdAt: string;
|
|
428
440
|
}
|
|
@@ -894,6 +906,9 @@ export interface AmortizationSchedule {
|
|
|
894
906
|
/** @format double */
|
|
895
907
|
pmi: number;
|
|
896
908
|
}
|
|
909
|
+
export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
910
|
+
type: AmortizationWidgetConfigTypeEnum;
|
|
911
|
+
};
|
|
897
912
|
export interface ApplicationRowData {
|
|
898
913
|
borrowerEmail?: string | null;
|
|
899
914
|
borrowerFirstName?: string | null;
|
|
@@ -966,7 +981,7 @@ export interface AuditLogEntry {
|
|
|
966
981
|
rootEntityType?: string | null;
|
|
967
982
|
/** @format uuid */
|
|
968
983
|
rootEntityId?: string | null;
|
|
969
|
-
changes
|
|
984
|
+
changes?: any | null;
|
|
970
985
|
/** @format date-time */
|
|
971
986
|
createdAt: string;
|
|
972
987
|
}
|
|
@@ -1000,6 +1015,18 @@ export interface AutomatedService {
|
|
|
1000
1015
|
skipped: string[];
|
|
1001
1016
|
rateLimited: string[];
|
|
1002
1017
|
}
|
|
1018
|
+
export interface BorrowerApplication {
|
|
1019
|
+
/** @format uuid */
|
|
1020
|
+
loanId: string;
|
|
1021
|
+
/** @format uuid */
|
|
1022
|
+
borrowerId: string;
|
|
1023
|
+
/** @format uuid */
|
|
1024
|
+
coBorrowerId?: string | null;
|
|
1025
|
+
applicationStatus: BorrowerApplicationApplicationStatusEnum;
|
|
1026
|
+
answers: Record<string, any>;
|
|
1027
|
+
additionalFields: Record<string, string>;
|
|
1028
|
+
cursor?: LoanApplicationSession | null;
|
|
1029
|
+
}
|
|
1003
1030
|
export interface BorrowerCount {
|
|
1004
1031
|
/** @format uuid */
|
|
1005
1032
|
userId: string;
|
|
@@ -1144,6 +1171,173 @@ export interface BusinessRuleRequest {
|
|
|
1144
1171
|
filter: BusinessRuleCondition[];
|
|
1145
1172
|
applyToAllBorrowerPairs: boolean;
|
|
1146
1173
|
}
|
|
1174
|
+
export interface CanvasAuthor {
|
|
1175
|
+
/** @format uuid */
|
|
1176
|
+
id: string;
|
|
1177
|
+
firstName: string;
|
|
1178
|
+
lastName: string;
|
|
1179
|
+
email: string;
|
|
1180
|
+
}
|
|
1181
|
+
export interface CanvasBoard {
|
|
1182
|
+
name?: string | null;
|
|
1183
|
+
roles: UserRole[];
|
|
1184
|
+
widgetIds: string[];
|
|
1185
|
+
widgets: Record<string, CanvasWidget>;
|
|
1186
|
+
}
|
|
1187
|
+
export interface CanvasBoardView {
|
|
1188
|
+
widgetIds: string[];
|
|
1189
|
+
widgets: Record<string, CanvasWidgetView>;
|
|
1190
|
+
}
|
|
1191
|
+
export interface CanvasDocument {
|
|
1192
|
+
/** @format int32 */
|
|
1193
|
+
schemaVersion: number;
|
|
1194
|
+
boards?: CanvasBoard[] | null;
|
|
1195
|
+
tabs?: CanvasTab[] | null;
|
|
1196
|
+
}
|
|
1197
|
+
export interface CanvasFieldCatalog {
|
|
1198
|
+
fields: CanvasFieldDescriptor[];
|
|
1199
|
+
}
|
|
1200
|
+
export interface CanvasFieldDescriptor {
|
|
1201
|
+
source: CanvasFieldDescriptorSourceEnum;
|
|
1202
|
+
key: string;
|
|
1203
|
+
label: string;
|
|
1204
|
+
category: string;
|
|
1205
|
+
categoryKey: string;
|
|
1206
|
+
dataType: CanvasFieldDescriptorDataTypeEnum;
|
|
1207
|
+
format: CanvasFieldDescriptorFormatEnum;
|
|
1208
|
+
encompassFieldId?: string | null;
|
|
1209
|
+
readableRoles: UserRole[];
|
|
1210
|
+
isActive: boolean;
|
|
1211
|
+
rolesWithoutPermissionRows: UserRole[];
|
|
1212
|
+
options: string[];
|
|
1213
|
+
}
|
|
1214
|
+
export interface CanvasFieldRef {
|
|
1215
|
+
source: CanvasFieldRefSourceEnum;
|
|
1216
|
+
key: string;
|
|
1217
|
+
}
|
|
1218
|
+
export interface CanvasFieldValue {
|
|
1219
|
+
dataType: CanvasFieldValueDataTypeEnum;
|
|
1220
|
+
value?: any | null;
|
|
1221
|
+
}
|
|
1222
|
+
export interface CanvasFieldValues {
|
|
1223
|
+
standard: Record<string, CanvasFieldValue>;
|
|
1224
|
+
custom: Record<string, CanvasFieldValue>;
|
|
1225
|
+
}
|
|
1226
|
+
export interface CanvasFieldValuesRequest {
|
|
1227
|
+
standardKeys: string[];
|
|
1228
|
+
customFieldIds: string[];
|
|
1229
|
+
}
|
|
1230
|
+
export interface CanvasFieldView {
|
|
1231
|
+
label: string;
|
|
1232
|
+
dataType: CanvasFieldViewDataTypeEnum;
|
|
1233
|
+
format: CanvasFieldViewFormatEnum;
|
|
1234
|
+
options: string[];
|
|
1235
|
+
}
|
|
1236
|
+
export interface CanvasInformationItem {
|
|
1237
|
+
kind: CanvasInformationItemKindEnum;
|
|
1238
|
+
field?: CanvasFieldRef | null;
|
|
1239
|
+
text?: string | null;
|
|
1240
|
+
label?: string | null;
|
|
1241
|
+
format?: CanvasFieldFormat | null;
|
|
1242
|
+
emphasis: boolean;
|
|
1243
|
+
hideWhenEmpty: boolean;
|
|
1244
|
+
roles: UserRole[];
|
|
1245
|
+
/** @format int32 */
|
|
1246
|
+
column: number;
|
|
1247
|
+
}
|
|
1248
|
+
export interface CanvasSourceSite {
|
|
1249
|
+
/** @format uuid */
|
|
1250
|
+
siteConfigurationID: string;
|
|
1251
|
+
name: string;
|
|
1252
|
+
type: CanvasSourceSiteTypeEnum;
|
|
1253
|
+
}
|
|
1254
|
+
export interface CanvasSurfaceState {
|
|
1255
|
+
surface: CanvasSurfaceStateSurfaceEnum;
|
|
1256
|
+
own?: CanvasDocument | null;
|
|
1257
|
+
/** @format int32 */
|
|
1258
|
+
ownVersion?: number | null;
|
|
1259
|
+
isOwnUnreadable: boolean;
|
|
1260
|
+
/** @format date-time */
|
|
1261
|
+
ownUpdatedAt?: string | null;
|
|
1262
|
+
/** @format uuid */
|
|
1263
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
1264
|
+
/** @format int32 */
|
|
1265
|
+
forkedFromVersion?: number | null;
|
|
1266
|
+
inherited?: CanvasDocument | null;
|
|
1267
|
+
/** @format int32 */
|
|
1268
|
+
inheritedVersion?: number | null;
|
|
1269
|
+
inheritedFrom?: CanvasSourceSite | null;
|
|
1270
|
+
isBehindInherited: boolean;
|
|
1271
|
+
effectiveBoards?: CanvasBoard[] | null;
|
|
1272
|
+
effectiveTabs?: ResolvedCanvasTab[] | null;
|
|
1273
|
+
}
|
|
1274
|
+
export interface CanvasTab {
|
|
1275
|
+
key: string;
|
|
1276
|
+
/** @format int32 */
|
|
1277
|
+
version: number;
|
|
1278
|
+
title: string;
|
|
1279
|
+
roles: UserRole[];
|
|
1280
|
+
copiedFrom?: CanvasTabOrigin | null;
|
|
1281
|
+
board: CanvasBoard;
|
|
1282
|
+
}
|
|
1283
|
+
export interface CanvasTabOrigin {
|
|
1284
|
+
/** @format uuid */
|
|
1285
|
+
siteConfigurationID: string;
|
|
1286
|
+
tabKey: string;
|
|
1287
|
+
/** @format int32 */
|
|
1288
|
+
version: number;
|
|
1289
|
+
}
|
|
1290
|
+
export interface CanvasTabView {
|
|
1291
|
+
key: string;
|
|
1292
|
+
title: string;
|
|
1293
|
+
board: CanvasBoardView;
|
|
1294
|
+
}
|
|
1295
|
+
export interface CanvasVersion {
|
|
1296
|
+
/** @format int32 */
|
|
1297
|
+
version: number;
|
|
1298
|
+
/** @format date-time */
|
|
1299
|
+
createdAt: string;
|
|
1300
|
+
createdBy?: CanvasAuthor | null;
|
|
1301
|
+
}
|
|
1302
|
+
export interface CanvasView {
|
|
1303
|
+
surface: CanvasViewSurfaceEnum;
|
|
1304
|
+
isConfigured: boolean;
|
|
1305
|
+
board?: CanvasBoardView | null;
|
|
1306
|
+
tabs?: CanvasTabView[] | null;
|
|
1307
|
+
standardFields: Record<string, CanvasFieldView>;
|
|
1308
|
+
customFields: Record<string, CanvasFieldView>;
|
|
1309
|
+
}
|
|
1310
|
+
export interface CanvasWidget {
|
|
1311
|
+
type: CanvasWidgetTypeEnum;
|
|
1312
|
+
/** @format int32 */
|
|
1313
|
+
configVersion: number;
|
|
1314
|
+
title?: string | null;
|
|
1315
|
+
/** @format int32 */
|
|
1316
|
+
width: number;
|
|
1317
|
+
roles: UserRole[];
|
|
1318
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1319
|
+
}
|
|
1320
|
+
export interface CanvasWidgetTypeDescriptor {
|
|
1321
|
+
type: CanvasWidgetTypeDescriptorTypeEnum;
|
|
1322
|
+
scope: CanvasWidgetTypeDescriptorScopeEnum;
|
|
1323
|
+
surfaces: CanvasSurface[];
|
|
1324
|
+
audiences: CanvasAudience[];
|
|
1325
|
+
allowedRoles: UserRole[];
|
|
1326
|
+
allowedWidths: number[];
|
|
1327
|
+
/** @format int32 */
|
|
1328
|
+
maxPerBoard: number;
|
|
1329
|
+
/** @format int32 */
|
|
1330
|
+
configVersion: number;
|
|
1331
|
+
}
|
|
1332
|
+
export interface CanvasWidgetView {
|
|
1333
|
+
type: CanvasWidgetViewTypeEnum;
|
|
1334
|
+
/** @format int32 */
|
|
1335
|
+
configVersion: number;
|
|
1336
|
+
title?: string | null;
|
|
1337
|
+
/** @format int32 */
|
|
1338
|
+
width: number;
|
|
1339
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1340
|
+
}
|
|
1147
1341
|
export interface ChangePasswordRequest {
|
|
1148
1342
|
oldPassword: string;
|
|
1149
1343
|
newPassword: string;
|
|
@@ -1174,6 +1368,13 @@ export interface ClosedLoansReportRequest {
|
|
|
1174
1368
|
/** @format date */
|
|
1175
1369
|
endDate: string;
|
|
1176
1370
|
}
|
|
1371
|
+
export type ClosingSoonWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1372
|
+
/** @format int32 */
|
|
1373
|
+
withinDays: number;
|
|
1374
|
+
/** @format int32 */
|
|
1375
|
+
maxItems: number;
|
|
1376
|
+
type: ClosingSoonWidgetConfigTypeEnum;
|
|
1377
|
+
};
|
|
1177
1378
|
export interface CommentUserInformation {
|
|
1178
1379
|
entityId: string;
|
|
1179
1380
|
entityType: string;
|
|
@@ -1769,6 +1970,12 @@ export interface DocumentTemplateVersionUpdateRequest {
|
|
|
1769
1970
|
isActive: boolean;
|
|
1770
1971
|
htmlBody: string;
|
|
1771
1972
|
}
|
|
1973
|
+
export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1974
|
+
/** @format int32 */
|
|
1975
|
+
maxItems: number;
|
|
1976
|
+
onlyOutstanding: boolean;
|
|
1977
|
+
type: DocumentsWidgetConfigTypeEnum;
|
|
1978
|
+
};
|
|
1772
1979
|
export interface Draft {
|
|
1773
1980
|
/** @format date-time */
|
|
1774
1981
|
createdAt: string;
|
|
@@ -1818,7 +2025,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1818
2025
|
}
|
|
1819
2026
|
export interface DraftRequest {
|
|
1820
2027
|
applicationPayload: any;
|
|
1821
|
-
customData
|
|
2028
|
+
customData?: any | null;
|
|
1822
2029
|
isCoBorrower: boolean;
|
|
1823
2030
|
}
|
|
1824
2031
|
export interface EconsentPendingSummary {
|
|
@@ -2043,7 +2250,7 @@ export interface EncompassRequestLog {
|
|
|
2043
2250
|
httpStatusCode?: number | null;
|
|
2044
2251
|
/** @format int64 */
|
|
2045
2252
|
durationMs?: number | null;
|
|
2046
|
-
context
|
|
2253
|
+
context?: any | null;
|
|
2047
2254
|
/** @format date-time */
|
|
2048
2255
|
createdAt: string;
|
|
2049
2256
|
}
|
|
@@ -2067,6 +2274,9 @@ export interface EncompassWebhookSubscription {
|
|
|
2067
2274
|
export interface Error {
|
|
2068
2275
|
message: string;
|
|
2069
2276
|
}
|
|
2277
|
+
export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2278
|
+
type: EsignStatusWidgetConfigTypeEnum;
|
|
2279
|
+
};
|
|
2070
2280
|
export interface FailureBucket {
|
|
2071
2281
|
/** @format date-time */
|
|
2072
2282
|
startUtc: string;
|
|
@@ -2172,7 +2382,7 @@ export interface FormSubmission {
|
|
|
2172
2382
|
subjectPropertyAddressCounty?: string | null;
|
|
2173
2383
|
subjectPropertyAddressState?: string | null;
|
|
2174
2384
|
subjectPropertyAddressZip?: string | null;
|
|
2175
|
-
data
|
|
2385
|
+
data?: any | null;
|
|
2176
2386
|
/** @format uuid */
|
|
2177
2387
|
listingID?: string | null;
|
|
2178
2388
|
listing?: Listing | null;
|
|
@@ -2214,7 +2424,7 @@ export interface FormSubmissionRequest {
|
|
|
2214
2424
|
subjectPropertyAddressCounty?: string | null;
|
|
2215
2425
|
subjectPropertyAddressState?: string | null;
|
|
2216
2426
|
subjectPropertyAddressZip?: string | null;
|
|
2217
|
-
data
|
|
2427
|
+
data?: any | null;
|
|
2218
2428
|
/** @format uuid */
|
|
2219
2429
|
listingID?: string | null;
|
|
2220
2430
|
}
|
|
@@ -2346,7 +2556,7 @@ export interface GetWorkflowRequest {
|
|
|
2346
2556
|
export interface GuidPatchOperation {
|
|
2347
2557
|
op: string;
|
|
2348
2558
|
path: string;
|
|
2349
|
-
value
|
|
2559
|
+
value?: any | null;
|
|
2350
2560
|
from?: string | null;
|
|
2351
2561
|
}
|
|
2352
2562
|
export interface HttpError {
|
|
@@ -2419,6 +2629,7 @@ export interface InProgressLoan {
|
|
|
2419
2629
|
siteConfigurationId?: string | null;
|
|
2420
2630
|
/** @format date-time */
|
|
2421
2631
|
updatedAt?: string | null;
|
|
2632
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2422
2633
|
}
|
|
2423
2634
|
export interface IncompleteApplicationSummary {
|
|
2424
2635
|
/** @format int32 */
|
|
@@ -2452,6 +2663,7 @@ export interface IncompleteLoanBorrower {
|
|
|
2452
2663
|
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
2453
2664
|
/** @format date-time */
|
|
2454
2665
|
deletedAt?: string | null;
|
|
2666
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2455
2667
|
}
|
|
2456
2668
|
export interface IncompleteLoanDraft {
|
|
2457
2669
|
/** @format uuid */
|
|
@@ -2481,6 +2693,15 @@ export interface IncompleteLoanSiteConfiguration {
|
|
|
2481
2693
|
id: string;
|
|
2482
2694
|
name: string;
|
|
2483
2695
|
}
|
|
2696
|
+
export type InformationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2697
|
+
/** @format int32 */
|
|
2698
|
+
columns: number;
|
|
2699
|
+
labelPosition: InformationWidgetConfigLabelPositionEnum;
|
|
2700
|
+
hideWhenEmpty: boolean;
|
|
2701
|
+
emptyText?: string | null;
|
|
2702
|
+
items: CanvasInformationItem[];
|
|
2703
|
+
type: InformationWidgetConfigTypeEnum;
|
|
2704
|
+
};
|
|
2484
2705
|
export interface IntegrationSettings {
|
|
2485
2706
|
encompass?: EncompassIntegrationSettings | null;
|
|
2486
2707
|
}
|
|
@@ -2515,6 +2736,16 @@ export interface Invite {
|
|
|
2515
2736
|
}
|
|
2516
2737
|
/** Array of operations to perform */
|
|
2517
2738
|
export type JsonPatchDocument = Operation[];
|
|
2739
|
+
export type KeyDatesWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2740
|
+
dates: string[];
|
|
2741
|
+
type: KeyDatesWidgetConfigTypeEnum;
|
|
2742
|
+
};
|
|
2743
|
+
export type KpiWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2744
|
+
field: CanvasFieldRef;
|
|
2745
|
+
label?: string | null;
|
|
2746
|
+
format?: CanvasFieldFormat | null;
|
|
2747
|
+
type: KpiWidgetConfigTypeEnum;
|
|
2748
|
+
};
|
|
2518
2749
|
export interface LOSIntegration {
|
|
2519
2750
|
instanceID: string;
|
|
2520
2751
|
}
|
|
@@ -2746,6 +2977,9 @@ export interface LoanApplicationSessionRequest {
|
|
|
2746
2977
|
currentQuestionId?: string | null;
|
|
2747
2978
|
questionHistory: string[];
|
|
2748
2979
|
}
|
|
2980
|
+
export interface LoanApplicationSessionRoute {
|
|
2981
|
+
routeName: string;
|
|
2982
|
+
}
|
|
2749
2983
|
export interface LoanBorrower {
|
|
2750
2984
|
/** @format uuid */
|
|
2751
2985
|
id: string;
|
|
@@ -2766,6 +3000,8 @@ export interface LoanBorrower {
|
|
|
2766
3000
|
numberOfDependents?: number | null;
|
|
2767
3001
|
/** @format int32 */
|
|
2768
3002
|
creditDecisionScore?: number | null;
|
|
3003
|
+
/** @format int32 */
|
|
3004
|
+
estimatedCreditScore?: number | null;
|
|
2769
3005
|
isPrimaryBorrower: boolean;
|
|
2770
3006
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
2771
3007
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
@@ -3116,6 +3352,12 @@ export interface LoanBorrowerEmploymentPrevious {
|
|
|
3116
3352
|
/** @format double */
|
|
3117
3353
|
grossIncome?: number | null;
|
|
3118
3354
|
isSelfEmployed?: boolean | null;
|
|
3355
|
+
/** @format double */
|
|
3356
|
+
bonus?: number | null;
|
|
3357
|
+
/** @format double */
|
|
3358
|
+
overtime?: number | null;
|
|
3359
|
+
/** @format double */
|
|
3360
|
+
commission?: number | null;
|
|
3119
3361
|
address?: AddressV3 | null;
|
|
3120
3362
|
}
|
|
3121
3363
|
export interface LoanBorrowerEmploymentPreviousRequest {
|
|
@@ -3129,6 +3371,12 @@ export interface LoanBorrowerEmploymentPreviousRequest {
|
|
|
3129
3371
|
/** @format double */
|
|
3130
3372
|
grossIncome?: number | null;
|
|
3131
3373
|
isSelfEmployed?: boolean | null;
|
|
3374
|
+
/** @format double */
|
|
3375
|
+
bonus?: number | null;
|
|
3376
|
+
/** @format double */
|
|
3377
|
+
overtime?: number | null;
|
|
3378
|
+
/** @format double */
|
|
3379
|
+
commission?: number | null;
|
|
3132
3380
|
address?: AddressRequest | null;
|
|
3133
3381
|
}
|
|
3134
3382
|
export interface LoanBorrowerGift {
|
|
@@ -3318,6 +3566,7 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
3318
3566
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3319
3567
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3320
3568
|
intendedUsageOtherDescription?: string | null;
|
|
3569
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
3321
3570
|
/** @format double */
|
|
3322
3571
|
marketValue?: number | null;
|
|
3323
3572
|
/** @format double */
|
|
@@ -3375,6 +3624,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
|
|
|
3375
3624
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3376
3625
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3377
3626
|
intendedUsageOtherDescription?: string | null;
|
|
3627
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
3378
3628
|
/** @format double */
|
|
3379
3629
|
marketValue?: number | null;
|
|
3380
3630
|
/** @format double */
|
|
@@ -3409,6 +3659,8 @@ export interface LoanBorrowerRequest {
|
|
|
3409
3659
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
3410
3660
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
3411
3661
|
dependentAges?: number[] | null;
|
|
3662
|
+
/** @format int32 */
|
|
3663
|
+
estimatedCreditScore?: number | null;
|
|
3412
3664
|
demographics?: LoanBorrowerDemographicsRequest | null;
|
|
3413
3665
|
declarations?: LoanBorrowerDeclarationsRequest | null;
|
|
3414
3666
|
militaryService?: LoanBorrowerMilitaryServiceRequest | null;
|
|
@@ -4011,6 +4263,9 @@ export interface LoanOutstandingItems {
|
|
|
4011
4263
|
export interface LoanPatchRequestGuidPatchDocument {
|
|
4012
4264
|
operations: GuidPatchOperation[];
|
|
4013
4265
|
}
|
|
4266
|
+
export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4267
|
+
type: LoanProgressWidgetConfigTypeEnum;
|
|
4268
|
+
};
|
|
4014
4269
|
export interface LoanProperty {
|
|
4015
4270
|
/** @format uuid */
|
|
4016
4271
|
id?: string | null;
|
|
@@ -4139,7 +4394,7 @@ export interface LoanQueueWithData {
|
|
|
4139
4394
|
user: UserPublic;
|
|
4140
4395
|
loanOfficer: LoanOfficerPublic;
|
|
4141
4396
|
siteConfiguration: SiteConfigurationReduced;
|
|
4142
|
-
data
|
|
4397
|
+
data?: any | null;
|
|
4143
4398
|
}
|
|
4144
4399
|
export interface LoanRecommendation {
|
|
4145
4400
|
/** @format uuid */
|
|
@@ -4148,7 +4403,7 @@ export interface LoanRecommendation {
|
|
|
4148
4403
|
displayName: string;
|
|
4149
4404
|
extractedValue: string;
|
|
4150
4405
|
mintable: boolean;
|
|
4151
|
-
currentLoanValue
|
|
4406
|
+
currentLoanValue?: any | null;
|
|
4152
4407
|
/** @format uuid */
|
|
4153
4408
|
sourceDocumentId: string;
|
|
4154
4409
|
sourceDocumentName?: string | null;
|
|
@@ -4314,6 +4569,9 @@ export interface LoanTaskStatusSummary {
|
|
|
4314
4569
|
/** @format int32 */
|
|
4315
4570
|
count: number;
|
|
4316
4571
|
}
|
|
4572
|
+
export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4573
|
+
type: LoanTeamWidgetConfigTypeEnum;
|
|
4574
|
+
};
|
|
4317
4575
|
export interface LoanUser {
|
|
4318
4576
|
/** @format uuid */
|
|
4319
4577
|
id: string;
|
|
@@ -4677,7 +4935,7 @@ export interface ModuleParameterValue {
|
|
|
4677
4935
|
parameterID: string;
|
|
4678
4936
|
parameterName: string;
|
|
4679
4937
|
parameterType: string;
|
|
4680
|
-
value
|
|
4938
|
+
value?: any | null;
|
|
4681
4939
|
isInherited: boolean;
|
|
4682
4940
|
}
|
|
4683
4941
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4711,6 +4969,16 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
4711
4969
|
/** @format int32 */
|
|
4712
4970
|
term: number;
|
|
4713
4971
|
}
|
|
4972
|
+
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4973
|
+
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
4974
|
+
};
|
|
4975
|
+
export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4976
|
+
/** @format int32 */
|
|
4977
|
+
dueWithinDays: number;
|
|
4978
|
+
/** @format int32 */
|
|
4979
|
+
maxItems: number;
|
|
4980
|
+
type: MyTasksWidgetConfigTypeEnum;
|
|
4981
|
+
};
|
|
4714
4982
|
export interface NoContentResult {
|
|
4715
4983
|
/** @format int32 */
|
|
4716
4984
|
statusCode: number;
|
|
@@ -4848,6 +5116,11 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4848
5116
|
textBody?: string | null;
|
|
4849
5117
|
pushNotificationBody?: string | null;
|
|
4850
5118
|
}
|
|
5119
|
+
export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5120
|
+
/** @format int32 */
|
|
5121
|
+
maxItems: number;
|
|
5122
|
+
type: OpenTasksWidgetConfigTypeEnum;
|
|
5123
|
+
};
|
|
4851
5124
|
export interface Operation {
|
|
4852
5125
|
op?: string;
|
|
4853
5126
|
value?: string | number | boolean | null | object;
|
|
@@ -4983,6 +5256,13 @@ export interface PreliminaryCondition {
|
|
|
4983
5256
|
rerequestedDate?: string | null;
|
|
4984
5257
|
rerequestedBy?: CommentUserInformation | null;
|
|
4985
5258
|
}
|
|
5259
|
+
export interface PreviewSiteConfigurationCanvasRequest {
|
|
5260
|
+
document: CanvasDocument;
|
|
5261
|
+
role?: UserRole | null;
|
|
5262
|
+
}
|
|
5263
|
+
export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5264
|
+
type: PrimaryBorrowerWidgetConfigTypeEnum;
|
|
5265
|
+
};
|
|
4986
5266
|
export interface ProblemDetails {
|
|
4987
5267
|
type?: string | null;
|
|
4988
5268
|
title?: string | null;
|
|
@@ -4992,6 +5272,11 @@ export interface ProblemDetails {
|
|
|
4992
5272
|
instance?: string | null;
|
|
4993
5273
|
[key: string]: any;
|
|
4994
5274
|
}
|
|
5275
|
+
export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5276
|
+
/** @format int32 */
|
|
5277
|
+
maxItems: number;
|
|
5278
|
+
type: RecentLoansWidgetConfigTypeEnum;
|
|
5279
|
+
};
|
|
4995
5280
|
export interface RefinanceCalculator {
|
|
4996
5281
|
currentLoan: RefinanceLoan;
|
|
4997
5282
|
refinanceLoan: RefinanceLoan;
|
|
@@ -5099,6 +5384,15 @@ export interface ResetPasswordRequest {
|
|
|
5099
5384
|
token: string;
|
|
5100
5385
|
password: string;
|
|
5101
5386
|
}
|
|
5387
|
+
export interface ResolvedCanvasTab {
|
|
5388
|
+
tab: CanvasTab;
|
|
5389
|
+
source: CanvasSourceSite;
|
|
5390
|
+
isInherited: boolean;
|
|
5391
|
+
}
|
|
5392
|
+
export interface RestoreSiteConfigurationCanvasVersionRequest {
|
|
5393
|
+
/** @format int32 */
|
|
5394
|
+
expectedVersion: number;
|
|
5395
|
+
}
|
|
5102
5396
|
export interface RunLOCalculation {
|
|
5103
5397
|
loanID: string;
|
|
5104
5398
|
loanAmount?: string | null;
|
|
@@ -5175,9 +5469,22 @@ export interface SSOTokenRequest {
|
|
|
5175
5469
|
email: string;
|
|
5176
5470
|
redirectUri?: string | null;
|
|
5177
5471
|
}
|
|
5472
|
+
export interface SaveSiteConfigurationCanvasRequest {
|
|
5473
|
+
document: CanvasDocument;
|
|
5474
|
+
/** @format int32 */
|
|
5475
|
+
expectedVersion?: number | null;
|
|
5476
|
+
/** @format uuid */
|
|
5477
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
5478
|
+
/** @format int32 */
|
|
5479
|
+
forkedFromVersion?: number | null;
|
|
5480
|
+
}
|
|
5178
5481
|
export interface SearchCriteria {
|
|
5179
5482
|
searchText?: string | null;
|
|
5180
5483
|
}
|
|
5484
|
+
export type SectionDividerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5485
|
+
label?: string | null;
|
|
5486
|
+
type: SectionDividerWidgetConfigTypeEnum;
|
|
5487
|
+
};
|
|
5181
5488
|
export interface SendESignatureReminderRequest {
|
|
5182
5489
|
/** @format uuid */
|
|
5183
5490
|
userId: string;
|
|
@@ -5606,6 +5913,11 @@ export interface SiteConfigurationByUrl {
|
|
|
5606
5913
|
losSettings?: LOSSettings | null;
|
|
5607
5914
|
workflows: Workflow[];
|
|
5608
5915
|
}
|
|
5916
|
+
export interface SiteConfigurationCanvases {
|
|
5917
|
+
/** @format uuid */
|
|
5918
|
+
siteConfigurationID: string;
|
|
5919
|
+
surfaces: CanvasSurfaceState[];
|
|
5920
|
+
}
|
|
5609
5921
|
export interface SiteConfigurationForm {
|
|
5610
5922
|
/** @format date-time */
|
|
5611
5923
|
createdAt: string;
|
|
@@ -6081,6 +6393,10 @@ export interface TemplateTokenRoot {
|
|
|
6081
6393
|
displayName: string;
|
|
6082
6394
|
fields: TemplateToken[];
|
|
6083
6395
|
}
|
|
6396
|
+
export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
6397
|
+
text: string;
|
|
6398
|
+
type: TextBlockWidgetConfigTypeEnum;
|
|
6399
|
+
};
|
|
6084
6400
|
export interface Theme {
|
|
6085
6401
|
logoURL: string;
|
|
6086
6402
|
primaryColor: string;
|
|
@@ -6176,6 +6492,8 @@ export interface UnprocessableEntity {
|
|
|
6176
6492
|
export interface UnprocessableEntityError {
|
|
6177
6493
|
error: string;
|
|
6178
6494
|
property: string;
|
|
6495
|
+
code?: string | null;
|
|
6496
|
+
params?: Record<string, any> | null;
|
|
6179
6497
|
}
|
|
6180
6498
|
export interface UnregisteredBorrower {
|
|
6181
6499
|
/** @format uuid */
|
|
@@ -6312,6 +6630,9 @@ export interface UpdateLoanRoleTaskRequest {
|
|
|
6312
6630
|
/** @format date */
|
|
6313
6631
|
dueDate?: string | null;
|
|
6314
6632
|
}
|
|
6633
|
+
export interface UpdateLoanSigningMethodRequest {
|
|
6634
|
+
signingMethod?: SigningMethod | null;
|
|
6635
|
+
}
|
|
6315
6636
|
export interface UpdateMeRequest {
|
|
6316
6637
|
phone?: string | null;
|
|
6317
6638
|
firstName: string;
|
|
@@ -6835,6 +7156,12 @@ export interface Workflow {
|
|
|
6835
7156
|
tileSubtitle: string;
|
|
6836
7157
|
icon: string;
|
|
6837
7158
|
}
|
|
7159
|
+
interface BaseCanvasWidgetConfig {
|
|
7160
|
+
type: string;
|
|
7161
|
+
}
|
|
7162
|
+
type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
|
|
7163
|
+
type: Key;
|
|
7164
|
+
} & Type;
|
|
6838
7165
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6839
7166
|
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" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
|
|
6840
7167
|
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
|
|
@@ -6843,9 +7170,27 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
|
|
|
6843
7170
|
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6844
7171
|
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
6845
7172
|
export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
|
|
7173
|
+
export type AmortizationWidgetConfigTypeEnum = "Amortization";
|
|
6846
7174
|
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
7175
|
+
export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
|
|
6847
7176
|
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6848
7177
|
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7178
|
+
export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
|
|
7179
|
+
export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7180
|
+
export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7181
|
+
export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
|
|
7182
|
+
export type CanvasFieldValueDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7183
|
+
export type CanvasFieldViewDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7184
|
+
export type CanvasFieldViewFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7185
|
+
export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
|
|
7186
|
+
export type CanvasSourceSiteTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
7187
|
+
export type CanvasSurfaceStateSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7188
|
+
export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7189
|
+
export type CanvasWidgetTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7190
|
+
export type CanvasWidgetTypeDescriptorTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7191
|
+
export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
|
|
7192
|
+
export type CanvasWidgetViewTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7193
|
+
export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
|
|
6849
7194
|
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
6850
7195
|
export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
6851
7196
|
export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
|
|
@@ -6872,6 +7217,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
|
|
|
6872
7217
|
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6873
7218
|
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
6874
7219
|
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
7220
|
+
export type DocumentsWidgetConfigTypeEnum = "Documents";
|
|
6875
7221
|
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6876
7222
|
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6877
7223
|
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6881,10 +7227,15 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
|
|
|
6881
7227
|
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6882
7228
|
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6883
7229
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
7230
|
+
export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
|
|
6884
7231
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6885
7232
|
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";
|
|
6886
7233
|
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
6887
7234
|
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
7235
|
+
export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
|
|
7236
|
+
export type InformationWidgetConfigTypeEnum = "Information";
|
|
7237
|
+
export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
|
|
7238
|
+
export type KpiWidgetConfigTypeEnum = "Kpi";
|
|
6888
7239
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6889
7240
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6890
7241
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6899,14 +7250,16 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
|
|
|
6899
7250
|
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6900
7251
|
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6901
7252
|
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6902
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
|
|
7253
|
+
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
|
|
6903
7254
|
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6904
|
-
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
|
|
7255
|
+
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
|
|
7256
|
+
export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
|
|
6905
7257
|
export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6906
7258
|
export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6907
7259
|
export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
|
|
6908
7260
|
export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
|
|
6909
7261
|
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
7262
|
+
export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
|
|
6910
7263
|
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6911
7264
|
export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
|
|
6912
7265
|
export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6920,8 +7273,14 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
|
|
|
6920
7273
|
export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
6921
7274
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
6922
7275
|
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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
|
|
7276
|
+
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7277
|
+
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
7278
|
+
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
6923
7279
|
export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
6924
7280
|
export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7281
|
+
export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
|
|
7282
|
+
export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
|
|
7283
|
+
export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
|
|
6925
7284
|
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6926
7285
|
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6927
7286
|
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
@@ -6932,6 +7291,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
|
6932
7291
|
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
6933
7292
|
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
6934
7293
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
7294
|
+
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
6935
7295
|
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6936
7296
|
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6937
7297
|
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
@@ -6943,9 +7303,21 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
|
|
|
6943
7303
|
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6944
7304
|
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
6945
7305
|
export type UserTableSettingsTableKeyEnum = "Pipeline";
|
|
7306
|
+
export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7307
|
+
export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6946
7308
|
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6947
7309
|
/** @default "Realtor" */
|
|
6948
7310
|
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
7311
|
+
export type SaveSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7312
|
+
export type SaveSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7313
|
+
export type DeleteSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7314
|
+
export type DeleteSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7315
|
+
export type PreviewSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7316
|
+
export type PreviewSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7317
|
+
export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7318
|
+
export type GetSiteConfigurationCanvasVersionsParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7319
|
+
export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7320
|
+
export type RestoreSiteConfigurationCanvasVersionParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6949
7321
|
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6950
7322
|
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6951
7323
|
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
@@ -6993,7 +7365,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6993
7365
|
}
|
|
6994
7366
|
/**
|
|
6995
7367
|
* @title The Big POS API
|
|
6996
|
-
* @version v3.
|
|
7368
|
+
* @version v3.16.0
|
|
6997
7369
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6998
7370
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6999
7371
|
*/
|
|
@@ -8290,6 +8662,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8290
8662
|
/** @default true */
|
|
8291
8663
|
revokeSessions?: boolean;
|
|
8292
8664
|
}, params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any, {}>>;
|
|
8665
|
+
/**
|
|
8666
|
+
* No description
|
|
8667
|
+
*
|
|
8668
|
+
* @tags BorrowerApplication
|
|
8669
|
+
* @name GetBorrowerApplication
|
|
8670
|
+
* @summary Get a borrower's application as flat answers
|
|
8671
|
+
* @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
|
|
8672
|
+
* @secure
|
|
8673
|
+
* @response `200` `BorrowerApplication` OK
|
|
8674
|
+
* @response `400` `any` Bad Request
|
|
8675
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8676
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8677
|
+
*/
|
|
8678
|
+
getBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplication, any, {}>>;
|
|
8293
8679
|
/**
|
|
8294
8680
|
* No description
|
|
8295
8681
|
*
|
|
@@ -8503,6 +8889,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8503
8889
|
* @response `200` `BusinessRule` OK
|
|
8504
8890
|
*/
|
|
8505
8891
|
restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any, {}>>;
|
|
8892
|
+
/**
|
|
8893
|
+
* No description
|
|
8894
|
+
*
|
|
8895
|
+
* @tags Canvases
|
|
8896
|
+
* @name GetCanvas
|
|
8897
|
+
* @summary Get a site's canvas for one surface, as the signed-in user sees it
|
|
8898
|
+
* @request GET:/api/canvases/{surface}
|
|
8899
|
+
* @secure
|
|
8900
|
+
* @response `200` `CanvasView` OK
|
|
8901
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8902
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8903
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
8904
|
+
*/
|
|
8905
|
+
getCanvas: (surface: GetCanvasParamsEnum, query: {
|
|
8906
|
+
/** @format uuid */
|
|
8907
|
+
siteConfigurationId: string;
|
|
8908
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
8909
|
+
/**
|
|
8910
|
+
* @description A standard field's key and every categoryKey never change: saved layouts refer to fields by key, and a client can translate labels and categories by these keys.
|
|
8911
|
+
*
|
|
8912
|
+
* @tags CanvasFields
|
|
8913
|
+
* @name GetCanvasFields
|
|
8914
|
+
* @summary Get the fields a canvas can show
|
|
8915
|
+
* @request GET:/api/canvas/fields
|
|
8916
|
+
* @secure
|
|
8917
|
+
* @response `200` `CanvasFieldCatalog` OK
|
|
8918
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8919
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8920
|
+
*/
|
|
8921
|
+
getCanvasFields: (params?: RequestParams) => Promise<AxiosResponse<CanvasFieldCatalog, any, {}>>;
|
|
8922
|
+
/**
|
|
8923
|
+
* No description
|
|
8924
|
+
*
|
|
8925
|
+
* @tags CanvasWidgetTypes
|
|
8926
|
+
* @name GetCanvasWidgetTypes
|
|
8927
|
+
* @summary Get canvas widget types
|
|
8928
|
+
* @request GET:/api/canvas/widget-types
|
|
8929
|
+
* @secure
|
|
8930
|
+
* @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
|
|
8931
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8932
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8933
|
+
*/
|
|
8934
|
+
getCanvasWidgetTypes: (params?: RequestParams) => Promise<AxiosResponse<CanvasWidgetTypeDescriptor[], any, {}>>;
|
|
8506
8935
|
/**
|
|
8507
8936
|
* @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
|
|
8508
8937
|
*
|
|
@@ -10324,6 +10753,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10324
10753
|
* @response `423` `UnprocessableEntity` Locked
|
|
10325
10754
|
*/
|
|
10326
10755
|
runLoanCalculator: (loanId: string, data: RunLOCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<RunLOCalculation, any, {}>>;
|
|
10756
|
+
/**
|
|
10757
|
+
* No description
|
|
10758
|
+
*
|
|
10759
|
+
* @tags LoanCanvasFieldValues
|
|
10760
|
+
* @name GetLoanCanvasFieldValues
|
|
10761
|
+
* @summary Get a loan's values for canvas fields
|
|
10762
|
+
* @request POST:/api/loans/{loanId}/canvas/field-values
|
|
10763
|
+
* @secure
|
|
10764
|
+
* @response `200` `CanvasFieldValues` OK
|
|
10765
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10766
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10767
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10768
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
10769
|
+
*/
|
|
10770
|
+
getLoanCanvasFieldValues: (loanId: string, data: CanvasFieldValuesRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasFieldValues, any, {}>>;
|
|
10327
10771
|
/**
|
|
10328
10772
|
* No description
|
|
10329
10773
|
*
|
|
@@ -11356,6 +11800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11356
11800
|
* @response `404` `ProblemDetails` Not Found
|
|
11357
11801
|
* @response `409` `ProblemDetails` Conflict
|
|
11358
11802
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11803
|
+
* @response `423` `ProblemDetails` Locked
|
|
11359
11804
|
*/
|
|
11360
11805
|
completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11361
11806
|
/**
|
|
@@ -11464,6 +11909,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11464
11909
|
* @response `404` `ProblemDetails` Not Found
|
|
11465
11910
|
*/
|
|
11466
11911
|
triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}>>;
|
|
11912
|
+
/**
|
|
11913
|
+
* No description
|
|
11914
|
+
*
|
|
11915
|
+
* @tags LoanSigningMethod
|
|
11916
|
+
* @name UpdateLoanSigningMethod
|
|
11917
|
+
* @summary Switch the loan's signing method
|
|
11918
|
+
* @request PUT:/api/loans/{loanId}/signing-method
|
|
11919
|
+
* @secure
|
|
11920
|
+
* @response `204` `void` No Content
|
|
11921
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11922
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11923
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
11924
|
+
*/
|
|
11925
|
+
updateLoanSigningMethod: (loanId: string, data: UpdateLoanSigningMethodRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11467
11926
|
/**
|
|
11468
11927
|
* No description
|
|
11469
11928
|
*
|
|
@@ -12290,6 +12749,104 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12290
12749
|
replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
|
|
12291
12750
|
applyToChildren?: boolean;
|
|
12292
12751
|
}, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
|
|
12752
|
+
/**
|
|
12753
|
+
* No description
|
|
12754
|
+
*
|
|
12755
|
+
* @tags SiteConfigurationCanvases
|
|
12756
|
+
* @name GetSiteConfigurationCanvases
|
|
12757
|
+
* @summary Get a site's canvases: own, inherited and effective per surface
|
|
12758
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases
|
|
12759
|
+
* @secure
|
|
12760
|
+
* @response `200` `SiteConfigurationCanvases` OK
|
|
12761
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12762
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12763
|
+
*/
|
|
12764
|
+
getSiteConfigurationCanvases: (siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationCanvases, any, {}>>;
|
|
12765
|
+
/**
|
|
12766
|
+
* @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
|
|
12767
|
+
*
|
|
12768
|
+
* @tags SiteConfigurationCanvases
|
|
12769
|
+
* @name SaveSiteConfigurationCanvas
|
|
12770
|
+
* @summary Save a site's canvas for one surface
|
|
12771
|
+
* @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12772
|
+
* @secure
|
|
12773
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12774
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12775
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12776
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12777
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12778
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12779
|
+
* @response `423` `ProblemDetails` Locked
|
|
12780
|
+
*/
|
|
12781
|
+
saveSiteConfigurationCanvas: (siteConfigurationId: string, surface: SaveSiteConfigurationCanvasParamsEnum, data: SaveSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12782
|
+
/**
|
|
12783
|
+
* No description
|
|
12784
|
+
*
|
|
12785
|
+
* @tags SiteConfigurationCanvases
|
|
12786
|
+
* @name DeleteSiteConfigurationCanvas
|
|
12787
|
+
* @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
|
|
12788
|
+
* @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12789
|
+
* @secure
|
|
12790
|
+
* @response `204` `void` No Content
|
|
12791
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12792
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12793
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12794
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12795
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12796
|
+
*/
|
|
12797
|
+
deleteSiteConfigurationCanvas: (siteConfigurationId: string, surface: DeleteSiteConfigurationCanvasParamsEnum, query: {
|
|
12798
|
+
/**
|
|
12799
|
+
* The canvas Version the caller last read. A delete over a newer save is refused as stale.
|
|
12800
|
+
* @format int32
|
|
12801
|
+
*/
|
|
12802
|
+
expectedVersion: number;
|
|
12803
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
12804
|
+
/**
|
|
12805
|
+
* No description
|
|
12806
|
+
*
|
|
12807
|
+
* @tags SiteConfigurationCanvases
|
|
12808
|
+
* @name PreviewSiteConfigurationCanvas
|
|
12809
|
+
* @summary Preview an unsaved canvas for one surface as a role would see it
|
|
12810
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
|
|
12811
|
+
* @secure
|
|
12812
|
+
* @response `200` `CanvasView` OK
|
|
12813
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12814
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12815
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12816
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12817
|
+
*/
|
|
12818
|
+
previewSiteConfigurationCanvas: (siteConfigurationId: string, surface: PreviewSiteConfigurationCanvasParamsEnum, data: PreviewSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
12819
|
+
/**
|
|
12820
|
+
* No description
|
|
12821
|
+
*
|
|
12822
|
+
* @tags SiteConfigurationCanvases
|
|
12823
|
+
* @name GetSiteConfigurationCanvasVersions
|
|
12824
|
+
* @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
|
|
12825
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
|
|
12826
|
+
* @secure
|
|
12827
|
+
* @response `200` `(CanvasVersion)[]` OK
|
|
12828
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12829
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12830
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12831
|
+
*/
|
|
12832
|
+
getSiteConfigurationCanvasVersions: (siteConfigurationId: string, surface: GetSiteConfigurationCanvasVersionsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<CanvasVersion[], any, {}>>;
|
|
12833
|
+
/**
|
|
12834
|
+
* No description
|
|
12835
|
+
*
|
|
12836
|
+
* @tags SiteConfigurationCanvases
|
|
12837
|
+
* @name RestoreSiteConfigurationCanvasVersion
|
|
12838
|
+
* @summary Restore a saved version of a site's canvas as a new version
|
|
12839
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
|
|
12840
|
+
* @secure
|
|
12841
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12842
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12843
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12844
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12845
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12846
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12847
|
+
* @response `423` `ProblemDetails` Locked
|
|
12848
|
+
*/
|
|
12849
|
+
restoreSiteConfigurationCanvasVersion: (siteConfigurationId: string, surface: RestoreSiteConfigurationCanvasVersionParamsEnum, version: number, data: RestoreSiteConfigurationCanvasVersionRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12293
12850
|
/**
|
|
12294
12851
|
* No description
|
|
12295
12852
|
*
|
|
@@ -13632,3 +14189,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13632
14189
|
logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13633
14190
|
};
|
|
13634
14191
|
}
|
|
14192
|
+
export {};
|