@matech/thebigpos-sdk 3.15.0 → 3.16.0-dev-6117
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 +624 -14
- package/dist/index.js +215 -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 +1228 -20
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,10 +88,20 @@ 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";
|
|
92
103
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
104
|
+
export type BorrowerApplicationWarningCode = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
|
|
93
105
|
export type BorrowerApplicationStatus = "Draft" | "Complete";
|
|
94
106
|
export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
95
107
|
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
@@ -104,6 +116,7 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
|
|
|
104
116
|
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
105
117
|
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
118
|
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";
|
|
119
|
+
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
120
|
export interface ASOSettings {
|
|
108
121
|
enabled: boolean;
|
|
109
122
|
softPull: boolean;
|
|
@@ -176,6 +189,7 @@ export interface AccountFailureCount {
|
|
|
176
189
|
export interface AccountSettings {
|
|
177
190
|
isSmsEnabled: boolean;
|
|
178
191
|
isLoanEditEnabled: boolean;
|
|
192
|
+
isApplicationEditEnabled?: boolean | null;
|
|
179
193
|
smsNumber?: string | null;
|
|
180
194
|
ssoHostOverride?: string | null;
|
|
181
195
|
isEarlyAdopter: boolean;
|
|
@@ -184,6 +198,7 @@ export interface AccountSettingsRequest {
|
|
|
184
198
|
isSmsEnabled: boolean;
|
|
185
199
|
smsNumber?: string | null;
|
|
186
200
|
isEarlyAdopter: boolean;
|
|
201
|
+
isApplicationEditEnabled?: boolean | null;
|
|
187
202
|
}
|
|
188
203
|
export interface Address {
|
|
189
204
|
/** @format uuid */
|
|
@@ -422,7 +437,7 @@ export interface AiAuditLog {
|
|
|
422
437
|
guardrailCategory?: string | null;
|
|
423
438
|
rawRequest?: string | null;
|
|
424
439
|
rawResponse?: string | null;
|
|
425
|
-
details
|
|
440
|
+
details?: any | null;
|
|
426
441
|
/** @format date-time */
|
|
427
442
|
createdAt: string;
|
|
428
443
|
}
|
|
@@ -894,6 +909,9 @@ export interface AmortizationSchedule {
|
|
|
894
909
|
/** @format double */
|
|
895
910
|
pmi: number;
|
|
896
911
|
}
|
|
912
|
+
export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
913
|
+
type: AmortizationWidgetConfigTypeEnum;
|
|
914
|
+
};
|
|
897
915
|
export interface ApplicationRowData {
|
|
898
916
|
borrowerEmail?: string | null;
|
|
899
917
|
borrowerFirstName?: string | null;
|
|
@@ -966,7 +984,7 @@ export interface AuditLogEntry {
|
|
|
966
984
|
rootEntityType?: string | null;
|
|
967
985
|
/** @format uuid */
|
|
968
986
|
rootEntityId?: string | null;
|
|
969
|
-
changes
|
|
987
|
+
changes?: any | null;
|
|
970
988
|
/** @format date-time */
|
|
971
989
|
createdAt: string;
|
|
972
990
|
}
|
|
@@ -1000,6 +1018,32 @@ export interface AutomatedService {
|
|
|
1000
1018
|
skipped: string[];
|
|
1001
1019
|
rateLimited: string[];
|
|
1002
1020
|
}
|
|
1021
|
+
export interface BorrowerApplication {
|
|
1022
|
+
/** @format uuid */
|
|
1023
|
+
loanId: string;
|
|
1024
|
+
/** @format uuid */
|
|
1025
|
+
borrowerId: string;
|
|
1026
|
+
/** @format uuid */
|
|
1027
|
+
coBorrowerId?: string | null;
|
|
1028
|
+
applicationStatus: BorrowerApplicationApplicationStatusEnum;
|
|
1029
|
+
answers: Record<string, any>;
|
|
1030
|
+
additionalFields: Record<string, string>;
|
|
1031
|
+
cursor?: LoanApplicationSession | null;
|
|
1032
|
+
}
|
|
1033
|
+
export interface BorrowerApplicationUpdate {
|
|
1034
|
+
warnings: BorrowerApplicationWarning[];
|
|
1035
|
+
application: BorrowerApplication;
|
|
1036
|
+
}
|
|
1037
|
+
export interface BorrowerApplicationUpdateRequest {
|
|
1038
|
+
answers: Record<string, any>;
|
|
1039
|
+
additionalFields?: Record<string, any> | null;
|
|
1040
|
+
cursor?: LoanApplicationSessionRequest | null;
|
|
1041
|
+
}
|
|
1042
|
+
export interface BorrowerApplicationWarning {
|
|
1043
|
+
key: string;
|
|
1044
|
+
code: BorrowerApplicationWarningCodeEnum;
|
|
1045
|
+
message: string;
|
|
1046
|
+
}
|
|
1003
1047
|
export interface BorrowerCount {
|
|
1004
1048
|
/** @format uuid */
|
|
1005
1049
|
userId: string;
|
|
@@ -1144,6 +1188,173 @@ export interface BusinessRuleRequest {
|
|
|
1144
1188
|
filter: BusinessRuleCondition[];
|
|
1145
1189
|
applyToAllBorrowerPairs: boolean;
|
|
1146
1190
|
}
|
|
1191
|
+
export interface CanvasAuthor {
|
|
1192
|
+
/** @format uuid */
|
|
1193
|
+
id: string;
|
|
1194
|
+
firstName: string;
|
|
1195
|
+
lastName: string;
|
|
1196
|
+
email: string;
|
|
1197
|
+
}
|
|
1198
|
+
export interface CanvasBoard {
|
|
1199
|
+
name?: string | null;
|
|
1200
|
+
roles: UserRole[];
|
|
1201
|
+
widgetIds: string[];
|
|
1202
|
+
widgets: Record<string, CanvasWidget>;
|
|
1203
|
+
}
|
|
1204
|
+
export interface CanvasBoardView {
|
|
1205
|
+
widgetIds: string[];
|
|
1206
|
+
widgets: Record<string, CanvasWidgetView>;
|
|
1207
|
+
}
|
|
1208
|
+
export interface CanvasDocument {
|
|
1209
|
+
/** @format int32 */
|
|
1210
|
+
schemaVersion: number;
|
|
1211
|
+
boards?: CanvasBoard[] | null;
|
|
1212
|
+
tabs?: CanvasTab[] | null;
|
|
1213
|
+
}
|
|
1214
|
+
export interface CanvasFieldCatalog {
|
|
1215
|
+
fields: CanvasFieldDescriptor[];
|
|
1216
|
+
}
|
|
1217
|
+
export interface CanvasFieldDescriptor {
|
|
1218
|
+
source: CanvasFieldDescriptorSourceEnum;
|
|
1219
|
+
key: string;
|
|
1220
|
+
label: string;
|
|
1221
|
+
category: string;
|
|
1222
|
+
categoryKey: string;
|
|
1223
|
+
dataType: CanvasFieldDescriptorDataTypeEnum;
|
|
1224
|
+
format: CanvasFieldDescriptorFormatEnum;
|
|
1225
|
+
encompassFieldId?: string | null;
|
|
1226
|
+
readableRoles: UserRole[];
|
|
1227
|
+
isActive: boolean;
|
|
1228
|
+
rolesWithoutPermissionRows: UserRole[];
|
|
1229
|
+
options: string[];
|
|
1230
|
+
}
|
|
1231
|
+
export interface CanvasFieldRef {
|
|
1232
|
+
source: CanvasFieldRefSourceEnum;
|
|
1233
|
+
key: string;
|
|
1234
|
+
}
|
|
1235
|
+
export interface CanvasFieldValue {
|
|
1236
|
+
dataType: CanvasFieldValueDataTypeEnum;
|
|
1237
|
+
value?: any | null;
|
|
1238
|
+
}
|
|
1239
|
+
export interface CanvasFieldValues {
|
|
1240
|
+
standard: Record<string, CanvasFieldValue>;
|
|
1241
|
+
custom: Record<string, CanvasFieldValue>;
|
|
1242
|
+
}
|
|
1243
|
+
export interface CanvasFieldValuesRequest {
|
|
1244
|
+
standardKeys: string[];
|
|
1245
|
+
customFieldIds: string[];
|
|
1246
|
+
}
|
|
1247
|
+
export interface CanvasFieldView {
|
|
1248
|
+
label: string;
|
|
1249
|
+
dataType: CanvasFieldViewDataTypeEnum;
|
|
1250
|
+
format: CanvasFieldViewFormatEnum;
|
|
1251
|
+
options: string[];
|
|
1252
|
+
}
|
|
1253
|
+
export interface CanvasInformationItem {
|
|
1254
|
+
kind: CanvasInformationItemKindEnum;
|
|
1255
|
+
field?: CanvasFieldRef | null;
|
|
1256
|
+
text?: string | null;
|
|
1257
|
+
label?: string | null;
|
|
1258
|
+
format?: CanvasFieldFormat | null;
|
|
1259
|
+
emphasis: boolean;
|
|
1260
|
+
hideWhenEmpty: boolean;
|
|
1261
|
+
roles: UserRole[];
|
|
1262
|
+
/** @format int32 */
|
|
1263
|
+
column: number;
|
|
1264
|
+
}
|
|
1265
|
+
export interface CanvasSourceSite {
|
|
1266
|
+
/** @format uuid */
|
|
1267
|
+
siteConfigurationID: string;
|
|
1268
|
+
name: string;
|
|
1269
|
+
type: CanvasSourceSiteTypeEnum;
|
|
1270
|
+
}
|
|
1271
|
+
export interface CanvasSurfaceState {
|
|
1272
|
+
surface: CanvasSurfaceStateSurfaceEnum;
|
|
1273
|
+
own?: CanvasDocument | null;
|
|
1274
|
+
/** @format int32 */
|
|
1275
|
+
ownVersion?: number | null;
|
|
1276
|
+
isOwnUnreadable: boolean;
|
|
1277
|
+
/** @format date-time */
|
|
1278
|
+
ownUpdatedAt?: string | null;
|
|
1279
|
+
/** @format uuid */
|
|
1280
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
1281
|
+
/** @format int32 */
|
|
1282
|
+
forkedFromVersion?: number | null;
|
|
1283
|
+
inherited?: CanvasDocument | null;
|
|
1284
|
+
/** @format int32 */
|
|
1285
|
+
inheritedVersion?: number | null;
|
|
1286
|
+
inheritedFrom?: CanvasSourceSite | null;
|
|
1287
|
+
isBehindInherited: boolean;
|
|
1288
|
+
effectiveBoards?: CanvasBoard[] | null;
|
|
1289
|
+
effectiveTabs?: ResolvedCanvasTab[] | null;
|
|
1290
|
+
}
|
|
1291
|
+
export interface CanvasTab {
|
|
1292
|
+
key: string;
|
|
1293
|
+
/** @format int32 */
|
|
1294
|
+
version: number;
|
|
1295
|
+
title: string;
|
|
1296
|
+
roles: UserRole[];
|
|
1297
|
+
copiedFrom?: CanvasTabOrigin | null;
|
|
1298
|
+
board: CanvasBoard;
|
|
1299
|
+
}
|
|
1300
|
+
export interface CanvasTabOrigin {
|
|
1301
|
+
/** @format uuid */
|
|
1302
|
+
siteConfigurationID: string;
|
|
1303
|
+
tabKey: string;
|
|
1304
|
+
/** @format int32 */
|
|
1305
|
+
version: number;
|
|
1306
|
+
}
|
|
1307
|
+
export interface CanvasTabView {
|
|
1308
|
+
key: string;
|
|
1309
|
+
title: string;
|
|
1310
|
+
board: CanvasBoardView;
|
|
1311
|
+
}
|
|
1312
|
+
export interface CanvasVersion {
|
|
1313
|
+
/** @format int32 */
|
|
1314
|
+
version: number;
|
|
1315
|
+
/** @format date-time */
|
|
1316
|
+
createdAt: string;
|
|
1317
|
+
createdBy?: CanvasAuthor | null;
|
|
1318
|
+
}
|
|
1319
|
+
export interface CanvasView {
|
|
1320
|
+
surface: CanvasViewSurfaceEnum;
|
|
1321
|
+
isConfigured: boolean;
|
|
1322
|
+
board?: CanvasBoardView | null;
|
|
1323
|
+
tabs?: CanvasTabView[] | null;
|
|
1324
|
+
standardFields: Record<string, CanvasFieldView>;
|
|
1325
|
+
customFields: Record<string, CanvasFieldView>;
|
|
1326
|
+
}
|
|
1327
|
+
export interface CanvasWidget {
|
|
1328
|
+
type: CanvasWidgetTypeEnum;
|
|
1329
|
+
/** @format int32 */
|
|
1330
|
+
configVersion: number;
|
|
1331
|
+
title?: string | null;
|
|
1332
|
+
/** @format int32 */
|
|
1333
|
+
width: number;
|
|
1334
|
+
roles: UserRole[];
|
|
1335
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1336
|
+
}
|
|
1337
|
+
export interface CanvasWidgetTypeDescriptor {
|
|
1338
|
+
type: CanvasWidgetTypeDescriptorTypeEnum;
|
|
1339
|
+
scope: CanvasWidgetTypeDescriptorScopeEnum;
|
|
1340
|
+
surfaces: CanvasSurface[];
|
|
1341
|
+
audiences: CanvasAudience[];
|
|
1342
|
+
allowedRoles: UserRole[];
|
|
1343
|
+
allowedWidths: number[];
|
|
1344
|
+
/** @format int32 */
|
|
1345
|
+
maxPerBoard: number;
|
|
1346
|
+
/** @format int32 */
|
|
1347
|
+
configVersion: number;
|
|
1348
|
+
}
|
|
1349
|
+
export interface CanvasWidgetView {
|
|
1350
|
+
type: CanvasWidgetViewTypeEnum;
|
|
1351
|
+
/** @format int32 */
|
|
1352
|
+
configVersion: number;
|
|
1353
|
+
title?: string | null;
|
|
1354
|
+
/** @format int32 */
|
|
1355
|
+
width: number;
|
|
1356
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1357
|
+
}
|
|
1147
1358
|
export interface ChangePasswordRequest {
|
|
1148
1359
|
oldPassword: string;
|
|
1149
1360
|
newPassword: string;
|
|
@@ -1174,6 +1385,13 @@ export interface ClosedLoansReportRequest {
|
|
|
1174
1385
|
/** @format date */
|
|
1175
1386
|
endDate: string;
|
|
1176
1387
|
}
|
|
1388
|
+
export type ClosingSoonWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1389
|
+
/** @format int32 */
|
|
1390
|
+
withinDays: number;
|
|
1391
|
+
/** @format int32 */
|
|
1392
|
+
maxItems: number;
|
|
1393
|
+
type: ClosingSoonWidgetConfigTypeEnum;
|
|
1394
|
+
};
|
|
1177
1395
|
export interface CommentUserInformation {
|
|
1178
1396
|
entityId: string;
|
|
1179
1397
|
entityType: string;
|
|
@@ -1769,6 +1987,12 @@ export interface DocumentTemplateVersionUpdateRequest {
|
|
|
1769
1987
|
isActive: boolean;
|
|
1770
1988
|
htmlBody: string;
|
|
1771
1989
|
}
|
|
1990
|
+
export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1991
|
+
/** @format int32 */
|
|
1992
|
+
maxItems: number;
|
|
1993
|
+
onlyOutstanding: boolean;
|
|
1994
|
+
type: DocumentsWidgetConfigTypeEnum;
|
|
1995
|
+
};
|
|
1772
1996
|
export interface Draft {
|
|
1773
1997
|
/** @format date-time */
|
|
1774
1998
|
createdAt: string;
|
|
@@ -1818,7 +2042,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1818
2042
|
}
|
|
1819
2043
|
export interface DraftRequest {
|
|
1820
2044
|
applicationPayload: any;
|
|
1821
|
-
customData
|
|
2045
|
+
customData?: any | null;
|
|
1822
2046
|
isCoBorrower: boolean;
|
|
1823
2047
|
}
|
|
1824
2048
|
export interface EconsentPendingSummary {
|
|
@@ -2043,7 +2267,7 @@ export interface EncompassRequestLog {
|
|
|
2043
2267
|
httpStatusCode?: number | null;
|
|
2044
2268
|
/** @format int64 */
|
|
2045
2269
|
durationMs?: number | null;
|
|
2046
|
-
context
|
|
2270
|
+
context?: any | null;
|
|
2047
2271
|
/** @format date-time */
|
|
2048
2272
|
createdAt: string;
|
|
2049
2273
|
}
|
|
@@ -2067,6 +2291,9 @@ export interface EncompassWebhookSubscription {
|
|
|
2067
2291
|
export interface Error {
|
|
2068
2292
|
message: string;
|
|
2069
2293
|
}
|
|
2294
|
+
export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2295
|
+
type: EsignStatusWidgetConfigTypeEnum;
|
|
2296
|
+
};
|
|
2070
2297
|
export interface FailureBucket {
|
|
2071
2298
|
/** @format date-time */
|
|
2072
2299
|
startUtc: string;
|
|
@@ -2172,7 +2399,7 @@ export interface FormSubmission {
|
|
|
2172
2399
|
subjectPropertyAddressCounty?: string | null;
|
|
2173
2400
|
subjectPropertyAddressState?: string | null;
|
|
2174
2401
|
subjectPropertyAddressZip?: string | null;
|
|
2175
|
-
data
|
|
2402
|
+
data?: any | null;
|
|
2176
2403
|
/** @format uuid */
|
|
2177
2404
|
listingID?: string | null;
|
|
2178
2405
|
listing?: Listing | null;
|
|
@@ -2214,7 +2441,7 @@ export interface FormSubmissionRequest {
|
|
|
2214
2441
|
subjectPropertyAddressCounty?: string | null;
|
|
2215
2442
|
subjectPropertyAddressState?: string | null;
|
|
2216
2443
|
subjectPropertyAddressZip?: string | null;
|
|
2217
|
-
data
|
|
2444
|
+
data?: any | null;
|
|
2218
2445
|
/** @format uuid */
|
|
2219
2446
|
listingID?: string | null;
|
|
2220
2447
|
}
|
|
@@ -2346,7 +2573,7 @@ export interface GetWorkflowRequest {
|
|
|
2346
2573
|
export interface GuidPatchOperation {
|
|
2347
2574
|
op: string;
|
|
2348
2575
|
path: string;
|
|
2349
|
-
value
|
|
2576
|
+
value?: any | null;
|
|
2350
2577
|
from?: string | null;
|
|
2351
2578
|
}
|
|
2352
2579
|
export interface HttpError {
|
|
@@ -2419,6 +2646,7 @@ export interface InProgressLoan {
|
|
|
2419
2646
|
siteConfigurationId?: string | null;
|
|
2420
2647
|
/** @format date-time */
|
|
2421
2648
|
updatedAt?: string | null;
|
|
2649
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2422
2650
|
}
|
|
2423
2651
|
export interface IncompleteApplicationSummary {
|
|
2424
2652
|
/** @format int32 */
|
|
@@ -2452,6 +2680,7 @@ export interface IncompleteLoanBorrower {
|
|
|
2452
2680
|
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
2453
2681
|
/** @format date-time */
|
|
2454
2682
|
deletedAt?: string | null;
|
|
2683
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2455
2684
|
}
|
|
2456
2685
|
export interface IncompleteLoanDraft {
|
|
2457
2686
|
/** @format uuid */
|
|
@@ -2481,6 +2710,15 @@ export interface IncompleteLoanSiteConfiguration {
|
|
|
2481
2710
|
id: string;
|
|
2482
2711
|
name: string;
|
|
2483
2712
|
}
|
|
2713
|
+
export type InformationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2714
|
+
/** @format int32 */
|
|
2715
|
+
columns: number;
|
|
2716
|
+
labelPosition: InformationWidgetConfigLabelPositionEnum;
|
|
2717
|
+
hideWhenEmpty: boolean;
|
|
2718
|
+
emptyText?: string | null;
|
|
2719
|
+
items: CanvasInformationItem[];
|
|
2720
|
+
type: InformationWidgetConfigTypeEnum;
|
|
2721
|
+
};
|
|
2484
2722
|
export interface IntegrationSettings {
|
|
2485
2723
|
encompass?: EncompassIntegrationSettings | null;
|
|
2486
2724
|
}
|
|
@@ -2515,6 +2753,16 @@ export interface Invite {
|
|
|
2515
2753
|
}
|
|
2516
2754
|
/** Array of operations to perform */
|
|
2517
2755
|
export type JsonPatchDocument = Operation[];
|
|
2756
|
+
export type KeyDatesWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2757
|
+
dates: string[];
|
|
2758
|
+
type: KeyDatesWidgetConfigTypeEnum;
|
|
2759
|
+
};
|
|
2760
|
+
export type KpiWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2761
|
+
field: CanvasFieldRef;
|
|
2762
|
+
label?: string | null;
|
|
2763
|
+
format?: CanvasFieldFormat | null;
|
|
2764
|
+
type: KpiWidgetConfigTypeEnum;
|
|
2765
|
+
};
|
|
2518
2766
|
export interface LOSIntegration {
|
|
2519
2767
|
instanceID: string;
|
|
2520
2768
|
}
|
|
@@ -2746,6 +2994,9 @@ export interface LoanApplicationSessionRequest {
|
|
|
2746
2994
|
currentQuestionId?: string | null;
|
|
2747
2995
|
questionHistory: string[];
|
|
2748
2996
|
}
|
|
2997
|
+
export interface LoanApplicationSessionRoute {
|
|
2998
|
+
routeName: string;
|
|
2999
|
+
}
|
|
2749
3000
|
export interface LoanBorrower {
|
|
2750
3001
|
/** @format uuid */
|
|
2751
3002
|
id: string;
|
|
@@ -2766,6 +3017,8 @@ export interface LoanBorrower {
|
|
|
2766
3017
|
numberOfDependents?: number | null;
|
|
2767
3018
|
/** @format int32 */
|
|
2768
3019
|
creditDecisionScore?: number | null;
|
|
3020
|
+
/** @format int32 */
|
|
3021
|
+
estimatedCreditScore?: number | null;
|
|
2769
3022
|
isPrimaryBorrower: boolean;
|
|
2770
3023
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
2771
3024
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
@@ -3116,6 +3369,12 @@ export interface LoanBorrowerEmploymentPrevious {
|
|
|
3116
3369
|
/** @format double */
|
|
3117
3370
|
grossIncome?: number | null;
|
|
3118
3371
|
isSelfEmployed?: boolean | null;
|
|
3372
|
+
/** @format double */
|
|
3373
|
+
bonus?: number | null;
|
|
3374
|
+
/** @format double */
|
|
3375
|
+
overtime?: number | null;
|
|
3376
|
+
/** @format double */
|
|
3377
|
+
commission?: number | null;
|
|
3119
3378
|
address?: AddressV3 | null;
|
|
3120
3379
|
}
|
|
3121
3380
|
export interface LoanBorrowerEmploymentPreviousRequest {
|
|
@@ -3129,6 +3388,12 @@ export interface LoanBorrowerEmploymentPreviousRequest {
|
|
|
3129
3388
|
/** @format double */
|
|
3130
3389
|
grossIncome?: number | null;
|
|
3131
3390
|
isSelfEmployed?: boolean | null;
|
|
3391
|
+
/** @format double */
|
|
3392
|
+
bonus?: number | null;
|
|
3393
|
+
/** @format double */
|
|
3394
|
+
overtime?: number | null;
|
|
3395
|
+
/** @format double */
|
|
3396
|
+
commission?: number | null;
|
|
3132
3397
|
address?: AddressRequest | null;
|
|
3133
3398
|
}
|
|
3134
3399
|
export interface LoanBorrowerGift {
|
|
@@ -3318,6 +3583,7 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
3318
3583
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3319
3584
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3320
3585
|
intendedUsageOtherDescription?: string | null;
|
|
3586
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
3321
3587
|
/** @format double */
|
|
3322
3588
|
marketValue?: number | null;
|
|
3323
3589
|
/** @format double */
|
|
@@ -3375,6 +3641,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
|
|
|
3375
3641
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
3376
3642
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
3377
3643
|
intendedUsageOtherDescription?: string | null;
|
|
3644
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
3378
3645
|
/** @format double */
|
|
3379
3646
|
marketValue?: number | null;
|
|
3380
3647
|
/** @format double */
|
|
@@ -3409,6 +3676,8 @@ export interface LoanBorrowerRequest {
|
|
|
3409
3676
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
3410
3677
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
3411
3678
|
dependentAges?: number[] | null;
|
|
3679
|
+
/** @format int32 */
|
|
3680
|
+
estimatedCreditScore?: number | null;
|
|
3412
3681
|
demographics?: LoanBorrowerDemographicsRequest | null;
|
|
3413
3682
|
declarations?: LoanBorrowerDeclarationsRequest | null;
|
|
3414
3683
|
militaryService?: LoanBorrowerMilitaryServiceRequest | null;
|
|
@@ -4011,6 +4280,9 @@ export interface LoanOutstandingItems {
|
|
|
4011
4280
|
export interface LoanPatchRequestGuidPatchDocument {
|
|
4012
4281
|
operations: GuidPatchOperation[];
|
|
4013
4282
|
}
|
|
4283
|
+
export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4284
|
+
type: LoanProgressWidgetConfigTypeEnum;
|
|
4285
|
+
};
|
|
4014
4286
|
export interface LoanProperty {
|
|
4015
4287
|
/** @format uuid */
|
|
4016
4288
|
id?: string | null;
|
|
@@ -4139,7 +4411,7 @@ export interface LoanQueueWithData {
|
|
|
4139
4411
|
user: UserPublic;
|
|
4140
4412
|
loanOfficer: LoanOfficerPublic;
|
|
4141
4413
|
siteConfiguration: SiteConfigurationReduced;
|
|
4142
|
-
data
|
|
4414
|
+
data?: any | null;
|
|
4143
4415
|
}
|
|
4144
4416
|
export interface LoanRecommendation {
|
|
4145
4417
|
/** @format uuid */
|
|
@@ -4148,7 +4420,7 @@ export interface LoanRecommendation {
|
|
|
4148
4420
|
displayName: string;
|
|
4149
4421
|
extractedValue: string;
|
|
4150
4422
|
mintable: boolean;
|
|
4151
|
-
currentLoanValue
|
|
4423
|
+
currentLoanValue?: any | null;
|
|
4152
4424
|
/** @format uuid */
|
|
4153
4425
|
sourceDocumentId: string;
|
|
4154
4426
|
sourceDocumentName?: string | null;
|
|
@@ -4314,6 +4586,9 @@ export interface LoanTaskStatusSummary {
|
|
|
4314
4586
|
/** @format int32 */
|
|
4315
4587
|
count: number;
|
|
4316
4588
|
}
|
|
4589
|
+
export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4590
|
+
type: LoanTeamWidgetConfigTypeEnum;
|
|
4591
|
+
};
|
|
4317
4592
|
export interface LoanUser {
|
|
4318
4593
|
/** @format uuid */
|
|
4319
4594
|
id: string;
|
|
@@ -4677,7 +4952,7 @@ export interface ModuleParameterValue {
|
|
|
4677
4952
|
parameterID: string;
|
|
4678
4953
|
parameterName: string;
|
|
4679
4954
|
parameterType: string;
|
|
4680
|
-
value
|
|
4955
|
+
value?: any | null;
|
|
4681
4956
|
isInherited: boolean;
|
|
4682
4957
|
}
|
|
4683
4958
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4711,6 +4986,16 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
4711
4986
|
/** @format int32 */
|
|
4712
4987
|
term: number;
|
|
4713
4988
|
}
|
|
4989
|
+
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4990
|
+
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
4991
|
+
};
|
|
4992
|
+
export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4993
|
+
/** @format int32 */
|
|
4994
|
+
dueWithinDays: number;
|
|
4995
|
+
/** @format int32 */
|
|
4996
|
+
maxItems: number;
|
|
4997
|
+
type: MyTasksWidgetConfigTypeEnum;
|
|
4998
|
+
};
|
|
4714
4999
|
export interface NoContentResult {
|
|
4715
5000
|
/** @format int32 */
|
|
4716
5001
|
statusCode: number;
|
|
@@ -4848,6 +5133,14 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4848
5133
|
textBody?: string | null;
|
|
4849
5134
|
pushNotificationBody?: string | null;
|
|
4850
5135
|
}
|
|
5136
|
+
export interface OpenBorrowerApplicationEditRequest {
|
|
5137
|
+
isCoBorrower: boolean;
|
|
5138
|
+
}
|
|
5139
|
+
export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5140
|
+
/** @format int32 */
|
|
5141
|
+
maxItems: number;
|
|
5142
|
+
type: OpenTasksWidgetConfigTypeEnum;
|
|
5143
|
+
};
|
|
4851
5144
|
export interface Operation {
|
|
4852
5145
|
op?: string;
|
|
4853
5146
|
value?: string | number | boolean | null | object;
|
|
@@ -4983,6 +5276,13 @@ export interface PreliminaryCondition {
|
|
|
4983
5276
|
rerequestedDate?: string | null;
|
|
4984
5277
|
rerequestedBy?: CommentUserInformation | null;
|
|
4985
5278
|
}
|
|
5279
|
+
export interface PreviewSiteConfigurationCanvasRequest {
|
|
5280
|
+
document: CanvasDocument;
|
|
5281
|
+
role?: UserRole | null;
|
|
5282
|
+
}
|
|
5283
|
+
export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5284
|
+
type: PrimaryBorrowerWidgetConfigTypeEnum;
|
|
5285
|
+
};
|
|
4986
5286
|
export interface ProblemDetails {
|
|
4987
5287
|
type?: string | null;
|
|
4988
5288
|
title?: string | null;
|
|
@@ -4992,6 +5292,11 @@ export interface ProblemDetails {
|
|
|
4992
5292
|
instance?: string | null;
|
|
4993
5293
|
[key: string]: any;
|
|
4994
5294
|
}
|
|
5295
|
+
export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5296
|
+
/** @format int32 */
|
|
5297
|
+
maxItems: number;
|
|
5298
|
+
type: RecentLoansWidgetConfigTypeEnum;
|
|
5299
|
+
};
|
|
4995
5300
|
export interface RefinanceCalculator {
|
|
4996
5301
|
currentLoan: RefinanceLoan;
|
|
4997
5302
|
refinanceLoan: RefinanceLoan;
|
|
@@ -5099,6 +5404,15 @@ export interface ResetPasswordRequest {
|
|
|
5099
5404
|
token: string;
|
|
5100
5405
|
password: string;
|
|
5101
5406
|
}
|
|
5407
|
+
export interface ResolvedCanvasTab {
|
|
5408
|
+
tab: CanvasTab;
|
|
5409
|
+
source: CanvasSourceSite;
|
|
5410
|
+
isInherited: boolean;
|
|
5411
|
+
}
|
|
5412
|
+
export interface RestoreSiteConfigurationCanvasVersionRequest {
|
|
5413
|
+
/** @format int32 */
|
|
5414
|
+
expectedVersion: number;
|
|
5415
|
+
}
|
|
5102
5416
|
export interface RunLOCalculation {
|
|
5103
5417
|
loanID: string;
|
|
5104
5418
|
loanAmount?: string | null;
|
|
@@ -5175,9 +5489,22 @@ export interface SSOTokenRequest {
|
|
|
5175
5489
|
email: string;
|
|
5176
5490
|
redirectUri?: string | null;
|
|
5177
5491
|
}
|
|
5492
|
+
export interface SaveSiteConfigurationCanvasRequest {
|
|
5493
|
+
document: CanvasDocument;
|
|
5494
|
+
/** @format int32 */
|
|
5495
|
+
expectedVersion?: number | null;
|
|
5496
|
+
/** @format uuid */
|
|
5497
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
5498
|
+
/** @format int32 */
|
|
5499
|
+
forkedFromVersion?: number | null;
|
|
5500
|
+
}
|
|
5178
5501
|
export interface SearchCriteria {
|
|
5179
5502
|
searchText?: string | null;
|
|
5180
5503
|
}
|
|
5504
|
+
export type SectionDividerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5505
|
+
label?: string | null;
|
|
5506
|
+
type: SectionDividerWidgetConfigTypeEnum;
|
|
5507
|
+
};
|
|
5181
5508
|
export interface SendESignatureReminderRequest {
|
|
5182
5509
|
/** @format uuid */
|
|
5183
5510
|
userId: string;
|
|
@@ -5606,6 +5933,11 @@ export interface SiteConfigurationByUrl {
|
|
|
5606
5933
|
losSettings?: LOSSettings | null;
|
|
5607
5934
|
workflows: Workflow[];
|
|
5608
5935
|
}
|
|
5936
|
+
export interface SiteConfigurationCanvases {
|
|
5937
|
+
/** @format uuid */
|
|
5938
|
+
siteConfigurationID: string;
|
|
5939
|
+
surfaces: CanvasSurfaceState[];
|
|
5940
|
+
}
|
|
5609
5941
|
export interface SiteConfigurationForm {
|
|
5610
5942
|
/** @format date-time */
|
|
5611
5943
|
createdAt: string;
|
|
@@ -6081,6 +6413,10 @@ export interface TemplateTokenRoot {
|
|
|
6081
6413
|
displayName: string;
|
|
6082
6414
|
fields: TemplateToken[];
|
|
6083
6415
|
}
|
|
6416
|
+
export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
6417
|
+
text: string;
|
|
6418
|
+
type: TextBlockWidgetConfigTypeEnum;
|
|
6419
|
+
};
|
|
6084
6420
|
export interface Theme {
|
|
6085
6421
|
logoURL: string;
|
|
6086
6422
|
primaryColor: string;
|
|
@@ -6176,6 +6512,8 @@ export interface UnprocessableEntity {
|
|
|
6176
6512
|
export interface UnprocessableEntityError {
|
|
6177
6513
|
error: string;
|
|
6178
6514
|
property: string;
|
|
6515
|
+
code?: string | null;
|
|
6516
|
+
params?: Record<string, any> | null;
|
|
6179
6517
|
}
|
|
6180
6518
|
export interface UnregisteredBorrower {
|
|
6181
6519
|
/** @format uuid */
|
|
@@ -6312,6 +6650,9 @@ export interface UpdateLoanRoleTaskRequest {
|
|
|
6312
6650
|
/** @format date */
|
|
6313
6651
|
dueDate?: string | null;
|
|
6314
6652
|
}
|
|
6653
|
+
export interface UpdateLoanSigningMethodRequest {
|
|
6654
|
+
signingMethod?: SigningMethod | null;
|
|
6655
|
+
}
|
|
6315
6656
|
export interface UpdateMeRequest {
|
|
6316
6657
|
phone?: string | null;
|
|
6317
6658
|
firstName: string;
|
|
@@ -6835,6 +7176,12 @@ export interface Workflow {
|
|
|
6835
7176
|
tileSubtitle: string;
|
|
6836
7177
|
icon: string;
|
|
6837
7178
|
}
|
|
7179
|
+
interface BaseCanvasWidgetConfig {
|
|
7180
|
+
type: string;
|
|
7181
|
+
}
|
|
7182
|
+
type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
|
|
7183
|
+
type: Key;
|
|
7184
|
+
} & Type;
|
|
6838
7185
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6839
7186
|
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
7187
|
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
|
|
@@ -6843,9 +7190,28 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
|
|
|
6843
7190
|
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6844
7191
|
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
6845
7192
|
export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
|
|
7193
|
+
export type AmortizationWidgetConfigTypeEnum = "Amortization";
|
|
6846
7194
|
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
7195
|
+
export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
|
|
7196
|
+
export type BorrowerApplicationWarningCodeEnum = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
|
|
6847
7197
|
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6848
7198
|
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7199
|
+
export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
|
|
7200
|
+
export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7201
|
+
export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7202
|
+
export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
|
|
7203
|
+
export type CanvasFieldValueDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7204
|
+
export type CanvasFieldViewDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7205
|
+
export type CanvasFieldViewFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7206
|
+
export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
|
|
7207
|
+
export type CanvasSourceSiteTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
7208
|
+
export type CanvasSurfaceStateSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7209
|
+
export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7210
|
+
export type CanvasWidgetTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7211
|
+
export type CanvasWidgetTypeDescriptorTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7212
|
+
export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
|
|
7213
|
+
export type CanvasWidgetViewTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7214
|
+
export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
|
|
6849
7215
|
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
6850
7216
|
export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
6851
7217
|
export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
|
|
@@ -6872,6 +7238,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
|
|
|
6872
7238
|
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6873
7239
|
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
6874
7240
|
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
7241
|
+
export type DocumentsWidgetConfigTypeEnum = "Documents";
|
|
6875
7242
|
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6876
7243
|
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6877
7244
|
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6881,10 +7248,15 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
|
|
|
6881
7248
|
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6882
7249
|
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6883
7250
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
7251
|
+
export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
|
|
6884
7252
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6885
7253
|
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
7254
|
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
6887
7255
|
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
7256
|
+
export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
|
|
7257
|
+
export type InformationWidgetConfigTypeEnum = "Information";
|
|
7258
|
+
export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
|
|
7259
|
+
export type KpiWidgetConfigTypeEnum = "Kpi";
|
|
6888
7260
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6889
7261
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6890
7262
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6899,14 +7271,16 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
|
|
|
6899
7271
|
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6900
7272
|
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6901
7273
|
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";
|
|
7274
|
+
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
7275
|
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";
|
|
7276
|
+
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";
|
|
7277
|
+
export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
|
|
6905
7278
|
export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6906
7279
|
export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6907
7280
|
export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
|
|
6908
7281
|
export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
|
|
6909
7282
|
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
7283
|
+
export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
|
|
6910
7284
|
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6911
7285
|
export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
|
|
6912
7286
|
export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6920,8 +7294,14 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
|
|
|
6920
7294
|
export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
6921
7295
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
6922
7296
|
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";
|
|
7297
|
+
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7298
|
+
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
7299
|
+
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
6923
7300
|
export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
6924
7301
|
export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7302
|
+
export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
|
|
7303
|
+
export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
|
|
7304
|
+
export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
|
|
6925
7305
|
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6926
7306
|
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6927
7307
|
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
@@ -6932,6 +7312,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
|
6932
7312
|
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
6933
7313
|
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
6934
7314
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
7315
|
+
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
6935
7316
|
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6936
7317
|
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6937
7318
|
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
@@ -6943,9 +7324,21 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
|
|
|
6943
7324
|
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6944
7325
|
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
6945
7326
|
export type UserTableSettingsTableKeyEnum = "Pipeline";
|
|
7327
|
+
export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7328
|
+
export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6946
7329
|
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6947
7330
|
/** @default "Realtor" */
|
|
6948
7331
|
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
7332
|
+
export type SaveSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7333
|
+
export type SaveSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7334
|
+
export type DeleteSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7335
|
+
export type DeleteSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7336
|
+
export type PreviewSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7337
|
+
export type PreviewSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7338
|
+
export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7339
|
+
export type GetSiteConfigurationCanvasVersionsParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7340
|
+
export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7341
|
+
export type RestoreSiteConfigurationCanvasVersionParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6949
7342
|
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6950
7343
|
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6951
7344
|
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
@@ -6993,7 +7386,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6993
7386
|
}
|
|
6994
7387
|
/**
|
|
6995
7388
|
* @title The Big POS API
|
|
6996
|
-
* @version v3.
|
|
7389
|
+
* @version v3.16.0
|
|
6997
7390
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6998
7391
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6999
7392
|
*/
|
|
@@ -8290,6 +8683,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8290
8683
|
/** @default true */
|
|
8291
8684
|
revokeSessions?: boolean;
|
|
8292
8685
|
}, params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any, {}>>;
|
|
8686
|
+
/**
|
|
8687
|
+
* No description
|
|
8688
|
+
*
|
|
8689
|
+
* @tags BorrowerApplication
|
|
8690
|
+
* @name GetBorrowerApplication
|
|
8691
|
+
* @summary Get a borrower's application as flat answers
|
|
8692
|
+
* @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
|
|
8693
|
+
* @secure
|
|
8694
|
+
* @response `200` `BorrowerApplication` OK
|
|
8695
|
+
* @response `400` `any` Bad Request
|
|
8696
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8697
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8698
|
+
*/
|
|
8699
|
+
getBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplication, any, {}>>;
|
|
8700
|
+
/**
|
|
8701
|
+
* No description
|
|
8702
|
+
*
|
|
8703
|
+
* @tags BorrowerApplication
|
|
8704
|
+
* @name UpdateBorrowerApplication
|
|
8705
|
+
* @summary Save a step of a borrower's application from flat answers
|
|
8706
|
+
* @request PATCH:/api/loans/{loanId}/borrowers/{borrowerId}/application
|
|
8707
|
+
* @secure
|
|
8708
|
+
* @response `200` `BorrowerApplicationUpdate` OK
|
|
8709
|
+
* @response `400` `any` Bad Request
|
|
8710
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8711
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8712
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
8713
|
+
*/
|
|
8714
|
+
updateBorrowerApplication: (loanId: string, borrowerId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplicationUpdate, any, {}>>;
|
|
8293
8715
|
/**
|
|
8294
8716
|
* No description
|
|
8295
8717
|
*
|
|
@@ -8503,6 +8925,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8503
8925
|
* @response `200` `BusinessRule` OK
|
|
8504
8926
|
*/
|
|
8505
8927
|
restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any, {}>>;
|
|
8928
|
+
/**
|
|
8929
|
+
* No description
|
|
8930
|
+
*
|
|
8931
|
+
* @tags Canvases
|
|
8932
|
+
* @name GetCanvas
|
|
8933
|
+
* @summary Get a site's canvas for one surface, as the signed-in user sees it
|
|
8934
|
+
* @request GET:/api/canvases/{surface}
|
|
8935
|
+
* @secure
|
|
8936
|
+
* @response `200` `CanvasView` OK
|
|
8937
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8938
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8939
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
8940
|
+
*/
|
|
8941
|
+
getCanvas: (surface: GetCanvasParamsEnum, query: {
|
|
8942
|
+
/** @format uuid */
|
|
8943
|
+
siteConfigurationId: string;
|
|
8944
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
8945
|
+
/**
|
|
8946
|
+
* @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.
|
|
8947
|
+
*
|
|
8948
|
+
* @tags CanvasFields
|
|
8949
|
+
* @name GetCanvasFields
|
|
8950
|
+
* @summary Get the fields a canvas can show
|
|
8951
|
+
* @request GET:/api/canvas/fields
|
|
8952
|
+
* @secure
|
|
8953
|
+
* @response `200` `CanvasFieldCatalog` OK
|
|
8954
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8955
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8956
|
+
*/
|
|
8957
|
+
getCanvasFields: (params?: RequestParams) => Promise<AxiosResponse<CanvasFieldCatalog, any, {}>>;
|
|
8958
|
+
/**
|
|
8959
|
+
* No description
|
|
8960
|
+
*
|
|
8961
|
+
* @tags CanvasWidgetTypes
|
|
8962
|
+
* @name GetCanvasWidgetTypes
|
|
8963
|
+
* @summary Get canvas widget types
|
|
8964
|
+
* @request GET:/api/canvas/widget-types
|
|
8965
|
+
* @secure
|
|
8966
|
+
* @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
|
|
8967
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8968
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8969
|
+
*/
|
|
8970
|
+
getCanvasWidgetTypes: (params?: RequestParams) => Promise<AxiosResponse<CanvasWidgetTypeDescriptor[], any, {}>>;
|
|
8506
8971
|
/**
|
|
8507
8972
|
* @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
|
|
8508
8973
|
*
|
|
@@ -10270,6 +10735,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10270
10735
|
* @response `200` `File` OK
|
|
10271
10736
|
*/
|
|
10272
10737
|
getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10738
|
+
/**
|
|
10739
|
+
* No description
|
|
10740
|
+
*
|
|
10741
|
+
* @tags LoanApplicationEdit
|
|
10742
|
+
* @name OpenBorrowerApplicationEdit
|
|
10743
|
+
* @summary Open a borrower's submitted application for editing
|
|
10744
|
+
* @request POST:/api/loans/{loanId}/application/edit
|
|
10745
|
+
* @secure
|
|
10746
|
+
* @response `200` `BorrowerApplication` OK
|
|
10747
|
+
* @response `400` `any` Bad Request
|
|
10748
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10749
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10750
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10751
|
+
* @response `423` `any` Locked
|
|
10752
|
+
*/
|
|
10753
|
+
openBorrowerApplicationEdit: (loanId: string, data: OpenBorrowerApplicationEditRequest, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplication, any, {}>>;
|
|
10273
10754
|
/**
|
|
10274
10755
|
* No description
|
|
10275
10756
|
*
|
|
@@ -10324,6 +10805,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10324
10805
|
* @response `423` `UnprocessableEntity` Locked
|
|
10325
10806
|
*/
|
|
10326
10807
|
runLoanCalculator: (loanId: string, data: RunLOCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<RunLOCalculation, any, {}>>;
|
|
10808
|
+
/**
|
|
10809
|
+
* No description
|
|
10810
|
+
*
|
|
10811
|
+
* @tags LoanCanvasFieldValues
|
|
10812
|
+
* @name GetLoanCanvasFieldValues
|
|
10813
|
+
* @summary Get a loan's values for canvas fields
|
|
10814
|
+
* @request POST:/api/loans/{loanId}/canvas/field-values
|
|
10815
|
+
* @secure
|
|
10816
|
+
* @response `200` `CanvasFieldValues` OK
|
|
10817
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10818
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10819
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10820
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
10821
|
+
*/
|
|
10822
|
+
getLoanCanvasFieldValues: (loanId: string, data: CanvasFieldValuesRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasFieldValues, any, {}>>;
|
|
10327
10823
|
/**
|
|
10328
10824
|
* No description
|
|
10329
10825
|
*
|
|
@@ -11356,6 +11852,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11356
11852
|
* @response `404` `ProblemDetails` Not Found
|
|
11357
11853
|
* @response `409` `ProblemDetails` Conflict
|
|
11358
11854
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11855
|
+
* @response `423` `ProblemDetails` Locked
|
|
11359
11856
|
*/
|
|
11360
11857
|
completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11361
11858
|
/**
|
|
@@ -11464,6 +11961,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11464
11961
|
* @response `404` `ProblemDetails` Not Found
|
|
11465
11962
|
*/
|
|
11466
11963
|
triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}>>;
|
|
11964
|
+
/**
|
|
11965
|
+
* No description
|
|
11966
|
+
*
|
|
11967
|
+
* @tags LoanSigningMethod
|
|
11968
|
+
* @name UpdateLoanSigningMethod
|
|
11969
|
+
* @summary Switch the loan's signing method
|
|
11970
|
+
* @request PUT:/api/loans/{loanId}/signing-method
|
|
11971
|
+
* @secure
|
|
11972
|
+
* @response `204` `void` No Content
|
|
11973
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11974
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11975
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
11976
|
+
*/
|
|
11977
|
+
updateLoanSigningMethod: (loanId: string, data: UpdateLoanSigningMethodRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11467
11978
|
/**
|
|
11468
11979
|
* No description
|
|
11469
11980
|
*
|
|
@@ -12290,6 +12801,104 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12290
12801
|
replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
|
|
12291
12802
|
applyToChildren?: boolean;
|
|
12292
12803
|
}, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
|
|
12804
|
+
/**
|
|
12805
|
+
* No description
|
|
12806
|
+
*
|
|
12807
|
+
* @tags SiteConfigurationCanvases
|
|
12808
|
+
* @name GetSiteConfigurationCanvases
|
|
12809
|
+
* @summary Get a site's canvases: own, inherited and effective per surface
|
|
12810
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases
|
|
12811
|
+
* @secure
|
|
12812
|
+
* @response `200` `SiteConfigurationCanvases` OK
|
|
12813
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12814
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12815
|
+
*/
|
|
12816
|
+
getSiteConfigurationCanvases: (siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationCanvases, any, {}>>;
|
|
12817
|
+
/**
|
|
12818
|
+
* @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
|
|
12819
|
+
*
|
|
12820
|
+
* @tags SiteConfigurationCanvases
|
|
12821
|
+
* @name SaveSiteConfigurationCanvas
|
|
12822
|
+
* @summary Save a site's canvas for one surface
|
|
12823
|
+
* @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12824
|
+
* @secure
|
|
12825
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12826
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12827
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12828
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12829
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12830
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12831
|
+
* @response `423` `ProblemDetails` Locked
|
|
12832
|
+
*/
|
|
12833
|
+
saveSiteConfigurationCanvas: (siteConfigurationId: string, surface: SaveSiteConfigurationCanvasParamsEnum, data: SaveSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12834
|
+
/**
|
|
12835
|
+
* No description
|
|
12836
|
+
*
|
|
12837
|
+
* @tags SiteConfigurationCanvases
|
|
12838
|
+
* @name DeleteSiteConfigurationCanvas
|
|
12839
|
+
* @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
|
|
12840
|
+
* @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12841
|
+
* @secure
|
|
12842
|
+
* @response `204` `void` No Content
|
|
12843
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12844
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12845
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12846
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12847
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12848
|
+
*/
|
|
12849
|
+
deleteSiteConfigurationCanvas: (siteConfigurationId: string, surface: DeleteSiteConfigurationCanvasParamsEnum, query: {
|
|
12850
|
+
/**
|
|
12851
|
+
* The canvas Version the caller last read. A delete over a newer save is refused as stale.
|
|
12852
|
+
* @format int32
|
|
12853
|
+
*/
|
|
12854
|
+
expectedVersion: number;
|
|
12855
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
12856
|
+
/**
|
|
12857
|
+
* No description
|
|
12858
|
+
*
|
|
12859
|
+
* @tags SiteConfigurationCanvases
|
|
12860
|
+
* @name PreviewSiteConfigurationCanvas
|
|
12861
|
+
* @summary Preview an unsaved canvas for one surface as a role would see it
|
|
12862
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
|
|
12863
|
+
* @secure
|
|
12864
|
+
* @response `200` `CanvasView` OK
|
|
12865
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12866
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12867
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12868
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12869
|
+
*/
|
|
12870
|
+
previewSiteConfigurationCanvas: (siteConfigurationId: string, surface: PreviewSiteConfigurationCanvasParamsEnum, data: PreviewSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
12871
|
+
/**
|
|
12872
|
+
* No description
|
|
12873
|
+
*
|
|
12874
|
+
* @tags SiteConfigurationCanvases
|
|
12875
|
+
* @name GetSiteConfigurationCanvasVersions
|
|
12876
|
+
* @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
|
|
12877
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
|
|
12878
|
+
* @secure
|
|
12879
|
+
* @response `200` `(CanvasVersion)[]` OK
|
|
12880
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12881
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12882
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12883
|
+
*/
|
|
12884
|
+
getSiteConfigurationCanvasVersions: (siteConfigurationId: string, surface: GetSiteConfigurationCanvasVersionsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<CanvasVersion[], any, {}>>;
|
|
12885
|
+
/**
|
|
12886
|
+
* No description
|
|
12887
|
+
*
|
|
12888
|
+
* @tags SiteConfigurationCanvases
|
|
12889
|
+
* @name RestoreSiteConfigurationCanvasVersion
|
|
12890
|
+
* @summary Restore a saved version of a site's canvas as a new version
|
|
12891
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
|
|
12892
|
+
* @secure
|
|
12893
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12894
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12895
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12896
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12897
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12898
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12899
|
+
* @response `423` `ProblemDetails` Locked
|
|
12900
|
+
*/
|
|
12901
|
+
restoreSiteConfigurationCanvasVersion: (siteConfigurationId: string, surface: RestoreSiteConfigurationCanvasVersionParamsEnum, version: number, data: RestoreSiteConfigurationCanvasVersionRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12293
12902
|
/**
|
|
12294
12903
|
* No description
|
|
12295
12904
|
*
|
|
@@ -13632,3 +14241,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13632
14241
|
logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13633
14242
|
};
|
|
13634
14243
|
}
|
|
14244
|
+
export {};
|