@matech/thebigpos-sdk 3.14.0 → 3.15.0-dev-6028
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 +641 -1
- package/dist/index.js +216 -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 +1233 -27
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";
|
|
@@ -67,6 +68,7 @@ export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "Cer
|
|
|
67
68
|
export type LoanAccessScopeType = "User" | "Branch";
|
|
68
69
|
export type LinkTarget = "Self" | "Blank";
|
|
69
70
|
export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
|
|
71
|
+
export type IncompleteLoanSource = "V3" | "LegacyDraft";
|
|
70
72
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
71
73
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
72
74
|
export type EncompassWebhookType = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
@@ -77,6 +79,7 @@ export type DraftType = "NewLoan" | "EditLoan";
|
|
|
77
79
|
export type DocumentVisibilityScope = "Own" | "All";
|
|
78
80
|
export type CustomFieldEntityType = "Loan";
|
|
79
81
|
export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
82
|
+
export type CustomFieldAnswerWarningReason = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
|
|
80
83
|
export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
81
84
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
82
85
|
export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
|
|
@@ -84,6 +87,15 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
|
84
87
|
export type CompanyDocumentSourceType = "File" | "FreeText";
|
|
85
88
|
export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
86
89
|
export type ClassificationSource = "Textract" | "Llm" | "Manual";
|
|
90
|
+
export type CanvasWidgetType = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
91
|
+
export type CanvasWidgetScope = "Loan" | "User" | "Any";
|
|
92
|
+
export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
|
|
93
|
+
export type CanvasLabelPosition = "Left" | "Above";
|
|
94
|
+
export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
|
|
95
|
+
export type CanvasFieldSource = "Standard" | "Custom";
|
|
96
|
+
export type CanvasFieldFormat = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
97
|
+
export type CanvasFieldDataType = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
98
|
+
export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
87
99
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
88
100
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
89
101
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -102,6 +114,7 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
|
|
|
102
114
|
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
103
115
|
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";
|
|
104
116
|
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";
|
|
117
|
+
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>);
|
|
105
118
|
export interface ASOSettings {
|
|
106
119
|
enabled: boolean;
|
|
107
120
|
softPull: boolean;
|
|
@@ -128,6 +141,16 @@ export interface ASOSettings {
|
|
|
128
141
|
mimgic: boolean;
|
|
129
142
|
miArch: boolean;
|
|
130
143
|
}
|
|
144
|
+
export interface AcceptBorrowerInviteRequest {
|
|
145
|
+
/** @format uuid */
|
|
146
|
+
inviteCode: string;
|
|
147
|
+
}
|
|
148
|
+
export interface AcceptedBorrowerInvite {
|
|
149
|
+
/** @format uuid */
|
|
150
|
+
loanId: string;
|
|
151
|
+
/** @format uuid */
|
|
152
|
+
borrowerId: string;
|
|
153
|
+
}
|
|
131
154
|
export interface Account {
|
|
132
155
|
/** @format uuid */
|
|
133
156
|
id: string;
|
|
@@ -882,6 +905,9 @@ export interface AmortizationSchedule {
|
|
|
882
905
|
/** @format double */
|
|
883
906
|
pmi: number;
|
|
884
907
|
}
|
|
908
|
+
export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
909
|
+
type: AmortizationWidgetConfigTypeEnum;
|
|
910
|
+
};
|
|
885
911
|
export interface ApplicationRowData {
|
|
886
912
|
borrowerEmail?: string | null;
|
|
887
913
|
borrowerFirstName?: string | null;
|
|
@@ -1132,6 +1158,173 @@ export interface BusinessRuleRequest {
|
|
|
1132
1158
|
filter: BusinessRuleCondition[];
|
|
1133
1159
|
applyToAllBorrowerPairs: boolean;
|
|
1134
1160
|
}
|
|
1161
|
+
export interface CanvasAuthor {
|
|
1162
|
+
/** @format uuid */
|
|
1163
|
+
id: string;
|
|
1164
|
+
firstName: string;
|
|
1165
|
+
lastName: string;
|
|
1166
|
+
email: string;
|
|
1167
|
+
}
|
|
1168
|
+
export interface CanvasBoard {
|
|
1169
|
+
name?: string | null;
|
|
1170
|
+
roles: UserRole[];
|
|
1171
|
+
widgetIds: string[];
|
|
1172
|
+
widgets: Record<string, CanvasWidget>;
|
|
1173
|
+
}
|
|
1174
|
+
export interface CanvasBoardView {
|
|
1175
|
+
widgetIds: string[];
|
|
1176
|
+
widgets: Record<string, CanvasWidgetView>;
|
|
1177
|
+
}
|
|
1178
|
+
export interface CanvasDocument {
|
|
1179
|
+
/** @format int32 */
|
|
1180
|
+
schemaVersion: number;
|
|
1181
|
+
boards?: CanvasBoard[] | null;
|
|
1182
|
+
tabs?: CanvasTab[] | null;
|
|
1183
|
+
}
|
|
1184
|
+
export interface CanvasFieldCatalog {
|
|
1185
|
+
fields: CanvasFieldDescriptor[];
|
|
1186
|
+
}
|
|
1187
|
+
export interface CanvasFieldDescriptor {
|
|
1188
|
+
source: CanvasFieldDescriptorSourceEnum;
|
|
1189
|
+
key: string;
|
|
1190
|
+
label: string;
|
|
1191
|
+
category: string;
|
|
1192
|
+
categoryKey: string;
|
|
1193
|
+
dataType: CanvasFieldDescriptorDataTypeEnum;
|
|
1194
|
+
format: CanvasFieldDescriptorFormatEnum;
|
|
1195
|
+
encompassFieldId?: string | null;
|
|
1196
|
+
readableRoles: UserRole[];
|
|
1197
|
+
isActive: boolean;
|
|
1198
|
+
rolesWithoutPermissionRows: UserRole[];
|
|
1199
|
+
options: string[];
|
|
1200
|
+
}
|
|
1201
|
+
export interface CanvasFieldRef {
|
|
1202
|
+
source: CanvasFieldRefSourceEnum;
|
|
1203
|
+
key: string;
|
|
1204
|
+
}
|
|
1205
|
+
export interface CanvasFieldValue {
|
|
1206
|
+
dataType: CanvasFieldValueDataTypeEnum;
|
|
1207
|
+
value?: any | null;
|
|
1208
|
+
}
|
|
1209
|
+
export interface CanvasFieldValues {
|
|
1210
|
+
standard: Record<string, CanvasFieldValue>;
|
|
1211
|
+
custom: Record<string, CanvasFieldValue>;
|
|
1212
|
+
}
|
|
1213
|
+
export interface CanvasFieldValuesRequest {
|
|
1214
|
+
standardKeys: string[];
|
|
1215
|
+
customFieldIds: string[];
|
|
1216
|
+
}
|
|
1217
|
+
export interface CanvasFieldView {
|
|
1218
|
+
label: string;
|
|
1219
|
+
dataType: CanvasFieldViewDataTypeEnum;
|
|
1220
|
+
format: CanvasFieldViewFormatEnum;
|
|
1221
|
+
options: string[];
|
|
1222
|
+
}
|
|
1223
|
+
export interface CanvasInformationItem {
|
|
1224
|
+
kind: CanvasInformationItemKindEnum;
|
|
1225
|
+
field?: CanvasFieldRef | null;
|
|
1226
|
+
text?: string | null;
|
|
1227
|
+
label?: string | null;
|
|
1228
|
+
format?: CanvasFieldFormat | null;
|
|
1229
|
+
emphasis: boolean;
|
|
1230
|
+
hideWhenEmpty: boolean;
|
|
1231
|
+
roles: UserRole[];
|
|
1232
|
+
/** @format int32 */
|
|
1233
|
+
column: number;
|
|
1234
|
+
}
|
|
1235
|
+
export interface CanvasSourceSite {
|
|
1236
|
+
/** @format uuid */
|
|
1237
|
+
siteConfigurationID: string;
|
|
1238
|
+
name: string;
|
|
1239
|
+
type: CanvasSourceSiteTypeEnum;
|
|
1240
|
+
}
|
|
1241
|
+
export interface CanvasSurfaceState {
|
|
1242
|
+
surface: CanvasSurfaceStateSurfaceEnum;
|
|
1243
|
+
own?: CanvasDocument | null;
|
|
1244
|
+
/** @format int32 */
|
|
1245
|
+
ownVersion?: number | null;
|
|
1246
|
+
isOwnUnreadable: boolean;
|
|
1247
|
+
/** @format date-time */
|
|
1248
|
+
ownUpdatedAt?: string | null;
|
|
1249
|
+
/** @format uuid */
|
|
1250
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
1251
|
+
/** @format int32 */
|
|
1252
|
+
forkedFromVersion?: number | null;
|
|
1253
|
+
inherited?: CanvasDocument | null;
|
|
1254
|
+
/** @format int32 */
|
|
1255
|
+
inheritedVersion?: number | null;
|
|
1256
|
+
inheritedFrom?: CanvasSourceSite | null;
|
|
1257
|
+
isBehindInherited: boolean;
|
|
1258
|
+
effectiveBoards?: CanvasBoard[] | null;
|
|
1259
|
+
effectiveTabs?: ResolvedCanvasTab[] | null;
|
|
1260
|
+
}
|
|
1261
|
+
export interface CanvasTab {
|
|
1262
|
+
key: string;
|
|
1263
|
+
/** @format int32 */
|
|
1264
|
+
version: number;
|
|
1265
|
+
title: string;
|
|
1266
|
+
roles: UserRole[];
|
|
1267
|
+
copiedFrom?: CanvasTabOrigin | null;
|
|
1268
|
+
board: CanvasBoard;
|
|
1269
|
+
}
|
|
1270
|
+
export interface CanvasTabOrigin {
|
|
1271
|
+
/** @format uuid */
|
|
1272
|
+
siteConfigurationID: string;
|
|
1273
|
+
tabKey: string;
|
|
1274
|
+
/** @format int32 */
|
|
1275
|
+
version: number;
|
|
1276
|
+
}
|
|
1277
|
+
export interface CanvasTabView {
|
|
1278
|
+
key: string;
|
|
1279
|
+
title: string;
|
|
1280
|
+
board: CanvasBoardView;
|
|
1281
|
+
}
|
|
1282
|
+
export interface CanvasVersion {
|
|
1283
|
+
/** @format int32 */
|
|
1284
|
+
version: number;
|
|
1285
|
+
/** @format date-time */
|
|
1286
|
+
createdAt: string;
|
|
1287
|
+
createdBy?: CanvasAuthor | null;
|
|
1288
|
+
}
|
|
1289
|
+
export interface CanvasView {
|
|
1290
|
+
surface: CanvasViewSurfaceEnum;
|
|
1291
|
+
isConfigured: boolean;
|
|
1292
|
+
board?: CanvasBoardView | null;
|
|
1293
|
+
tabs?: CanvasTabView[] | null;
|
|
1294
|
+
standardFields: Record<string, CanvasFieldView>;
|
|
1295
|
+
customFields: Record<string, CanvasFieldView>;
|
|
1296
|
+
}
|
|
1297
|
+
export interface CanvasWidget {
|
|
1298
|
+
type: CanvasWidgetTypeEnum;
|
|
1299
|
+
/** @format int32 */
|
|
1300
|
+
configVersion: number;
|
|
1301
|
+
title?: string | null;
|
|
1302
|
+
/** @format int32 */
|
|
1303
|
+
width: number;
|
|
1304
|
+
roles: UserRole[];
|
|
1305
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1306
|
+
}
|
|
1307
|
+
export interface CanvasWidgetTypeDescriptor {
|
|
1308
|
+
type: CanvasWidgetTypeDescriptorTypeEnum;
|
|
1309
|
+
scope: CanvasWidgetTypeDescriptorScopeEnum;
|
|
1310
|
+
surfaces: CanvasSurface[];
|
|
1311
|
+
audiences: CanvasAudience[];
|
|
1312
|
+
allowedRoles: UserRole[];
|
|
1313
|
+
allowedWidths: number[];
|
|
1314
|
+
/** @format int32 */
|
|
1315
|
+
maxPerBoard: number;
|
|
1316
|
+
/** @format int32 */
|
|
1317
|
+
configVersion: number;
|
|
1318
|
+
}
|
|
1319
|
+
export interface CanvasWidgetView {
|
|
1320
|
+
type: CanvasWidgetViewTypeEnum;
|
|
1321
|
+
/** @format int32 */
|
|
1322
|
+
configVersion: number;
|
|
1323
|
+
title?: string | null;
|
|
1324
|
+
/** @format int32 */
|
|
1325
|
+
width: number;
|
|
1326
|
+
config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
|
|
1327
|
+
}
|
|
1135
1328
|
export interface ChangePasswordRequest {
|
|
1136
1329
|
oldPassword: string;
|
|
1137
1330
|
newPassword: string;
|
|
@@ -1162,6 +1355,13 @@ export interface ClosedLoansReportRequest {
|
|
|
1162
1355
|
/** @format date */
|
|
1163
1356
|
endDate: string;
|
|
1164
1357
|
}
|
|
1358
|
+
export type ClosingSoonWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1359
|
+
/** @format int32 */
|
|
1360
|
+
withinDays: number;
|
|
1361
|
+
/** @format int32 */
|
|
1362
|
+
maxItems: number;
|
|
1363
|
+
type: ClosingSoonWidgetConfigTypeEnum;
|
|
1364
|
+
};
|
|
1165
1365
|
export interface CommentUserInformation {
|
|
1166
1366
|
entityId: string;
|
|
1167
1367
|
entityType: string;
|
|
@@ -1527,6 +1727,10 @@ export interface CreditAuthPendingSummary {
|
|
|
1527
1727
|
total: number;
|
|
1528
1728
|
borrowers: BorrowerIdentity[];
|
|
1529
1729
|
}
|
|
1730
|
+
export interface CustomFieldAnswerWarning {
|
|
1731
|
+
key: string;
|
|
1732
|
+
reason: CustomFieldAnswerWarningReasonEnum;
|
|
1733
|
+
}
|
|
1530
1734
|
export interface CustomFieldDefinition {
|
|
1531
1735
|
/** @format date-time */
|
|
1532
1736
|
createdAt: string;
|
|
@@ -1753,6 +1957,12 @@ export interface DocumentTemplateVersionUpdateRequest {
|
|
|
1753
1957
|
isActive: boolean;
|
|
1754
1958
|
htmlBody: string;
|
|
1755
1959
|
}
|
|
1960
|
+
export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
1961
|
+
/** @format int32 */
|
|
1962
|
+
maxItems: number;
|
|
1963
|
+
onlyOutstanding: boolean;
|
|
1964
|
+
type: DocumentsWidgetConfigTypeEnum;
|
|
1965
|
+
};
|
|
1756
1966
|
export interface Draft {
|
|
1757
1967
|
/** @format date-time */
|
|
1758
1968
|
createdAt: string;
|
|
@@ -2051,6 +2261,9 @@ export interface EncompassWebhookSubscription {
|
|
|
2051
2261
|
export interface Error {
|
|
2052
2262
|
message: string;
|
|
2053
2263
|
}
|
|
2264
|
+
export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2265
|
+
type: EsignStatusWidgetConfigTypeEnum;
|
|
2266
|
+
};
|
|
2054
2267
|
export interface FailureBucket {
|
|
2055
2268
|
/** @format date-time */
|
|
2056
2269
|
startUtc: string;
|
|
@@ -2403,12 +2616,79 @@ export interface InProgressLoan {
|
|
|
2403
2616
|
siteConfigurationId?: string | null;
|
|
2404
2617
|
/** @format date-time */
|
|
2405
2618
|
updatedAt?: string | null;
|
|
2619
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2406
2620
|
}
|
|
2407
2621
|
export interface IncompleteApplicationSummary {
|
|
2408
2622
|
/** @format int32 */
|
|
2409
2623
|
total: number;
|
|
2410
2624
|
borrowers: BorrowerIdentity[];
|
|
2411
2625
|
}
|
|
2626
|
+
export interface IncompleteLoan {
|
|
2627
|
+
source: IncompleteLoanSourceEnum;
|
|
2628
|
+
/** @format uuid */
|
|
2629
|
+
loanId?: string | null;
|
|
2630
|
+
/** @format uuid */
|
|
2631
|
+
borrowerId?: string | null;
|
|
2632
|
+
/** @format uuid */
|
|
2633
|
+
draftId?: string | null;
|
|
2634
|
+
/** @format date-time */
|
|
2635
|
+
createdAt: string;
|
|
2636
|
+
/** @format date-time */
|
|
2637
|
+
updatedAt?: string | null;
|
|
2638
|
+
loanOfficer?: UserSummary | null;
|
|
2639
|
+
siteConfiguration?: IncompleteLoanSiteConfiguration | null;
|
|
2640
|
+
draft?: IncompleteLoanDraft | null;
|
|
2641
|
+
borrowers: IncompleteLoanBorrower[];
|
|
2642
|
+
}
|
|
2643
|
+
export interface IncompleteLoanBorrower {
|
|
2644
|
+
/** @format uuid */
|
|
2645
|
+
id: string;
|
|
2646
|
+
firstName?: string | null;
|
|
2647
|
+
lastName?: string | null;
|
|
2648
|
+
email?: string | null;
|
|
2649
|
+
isPrimaryBorrower: boolean;
|
|
2650
|
+
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
2651
|
+
/** @format date-time */
|
|
2652
|
+
deletedAt?: string | null;
|
|
2653
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
2654
|
+
}
|
|
2655
|
+
export interface IncompleteLoanDraft {
|
|
2656
|
+
/** @format uuid */
|
|
2657
|
+
loanID?: string | null;
|
|
2658
|
+
/** @format date-time */
|
|
2659
|
+
deletedAt?: string | null;
|
|
2660
|
+
routeName?: string | null;
|
|
2661
|
+
user: UserBase;
|
|
2662
|
+
}
|
|
2663
|
+
export interface IncompleteLoanPaginated {
|
|
2664
|
+
rows: IncompleteLoan[];
|
|
2665
|
+
pagination: Pagination;
|
|
2666
|
+
/** @format int64 */
|
|
2667
|
+
count: number;
|
|
2668
|
+
}
|
|
2669
|
+
export interface IncompleteLoanSearchCriteria {
|
|
2670
|
+
searchText?: string | null;
|
|
2671
|
+
/** @format uuid */
|
|
2672
|
+
loanOfficerId?: string | null;
|
|
2673
|
+
/** @format uuid */
|
|
2674
|
+
siteConfigurationId?: string | null;
|
|
2675
|
+
isUnassigned?: boolean | null;
|
|
2676
|
+
includeRemovedApplications?: boolean | null;
|
|
2677
|
+
}
|
|
2678
|
+
export interface IncompleteLoanSiteConfiguration {
|
|
2679
|
+
/** @format uuid */
|
|
2680
|
+
id: string;
|
|
2681
|
+
name: string;
|
|
2682
|
+
}
|
|
2683
|
+
export type InformationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2684
|
+
/** @format int32 */
|
|
2685
|
+
columns: number;
|
|
2686
|
+
labelPosition: InformationWidgetConfigLabelPositionEnum;
|
|
2687
|
+
hideWhenEmpty: boolean;
|
|
2688
|
+
emptyText?: string | null;
|
|
2689
|
+
items: CanvasInformationItem[];
|
|
2690
|
+
type: InformationWidgetConfigTypeEnum;
|
|
2691
|
+
};
|
|
2412
2692
|
export interface IntegrationSettings {
|
|
2413
2693
|
encompass?: EncompassIntegrationSettings | null;
|
|
2414
2694
|
}
|
|
@@ -2439,9 +2719,20 @@ export interface Invite {
|
|
|
2439
2719
|
status: string;
|
|
2440
2720
|
loan: LoanIdentifier;
|
|
2441
2721
|
url: string;
|
|
2722
|
+
linksBorrowerApplication?: boolean | null;
|
|
2442
2723
|
}
|
|
2443
2724
|
/** Array of operations to perform */
|
|
2444
2725
|
export type JsonPatchDocument = Operation[];
|
|
2726
|
+
export type KeyDatesWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2727
|
+
dates: string[];
|
|
2728
|
+
type: KeyDatesWidgetConfigTypeEnum;
|
|
2729
|
+
};
|
|
2730
|
+
export type KpiWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
2731
|
+
field: CanvasFieldRef;
|
|
2732
|
+
label?: string | null;
|
|
2733
|
+
format?: CanvasFieldFormat | null;
|
|
2734
|
+
type: KpiWidgetConfigTypeEnum;
|
|
2735
|
+
};
|
|
2445
2736
|
export interface LOSIntegration {
|
|
2446
2737
|
instanceID: string;
|
|
2447
2738
|
}
|
|
@@ -2634,6 +2925,7 @@ export interface LoanApplication {
|
|
|
2634
2925
|
refinance?: LoanRefinance | null;
|
|
2635
2926
|
borrowers: LoanBorrower[];
|
|
2636
2927
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2928
|
+
customFieldWarnings?: CustomFieldAnswerWarning[] | null;
|
|
2637
2929
|
}
|
|
2638
2930
|
export interface LoanApplicationRequest {
|
|
2639
2931
|
/** @format uuid */
|
|
@@ -2672,6 +2964,9 @@ export interface LoanApplicationSessionRequest {
|
|
|
2672
2964
|
currentQuestionId?: string | null;
|
|
2673
2965
|
questionHistory: string[];
|
|
2674
2966
|
}
|
|
2967
|
+
export interface LoanApplicationSessionRoute {
|
|
2968
|
+
routeName: string;
|
|
2969
|
+
}
|
|
2675
2970
|
export interface LoanBorrower {
|
|
2676
2971
|
/** @format uuid */
|
|
2677
2972
|
id: string;
|
|
@@ -3937,6 +4232,9 @@ export interface LoanOutstandingItems {
|
|
|
3937
4232
|
export interface LoanPatchRequestGuidPatchDocument {
|
|
3938
4233
|
operations: GuidPatchOperation[];
|
|
3939
4234
|
}
|
|
4235
|
+
export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4236
|
+
type: LoanProgressWidgetConfigTypeEnum;
|
|
4237
|
+
};
|
|
3940
4238
|
export interface LoanProperty {
|
|
3941
4239
|
/** @format uuid */
|
|
3942
4240
|
id?: string | null;
|
|
@@ -4240,6 +4538,9 @@ export interface LoanTaskStatusSummary {
|
|
|
4240
4538
|
/** @format int32 */
|
|
4241
4539
|
count: number;
|
|
4242
4540
|
}
|
|
4541
|
+
export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4542
|
+
type: LoanTeamWidgetConfigTypeEnum;
|
|
4543
|
+
};
|
|
4243
4544
|
export interface LoanUser {
|
|
4244
4545
|
/** @format uuid */
|
|
4245
4546
|
id: string;
|
|
@@ -4637,6 +4938,16 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
4637
4938
|
/** @format int32 */
|
|
4638
4939
|
term: number;
|
|
4639
4940
|
}
|
|
4941
|
+
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4942
|
+
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
4943
|
+
};
|
|
4944
|
+
export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4945
|
+
/** @format int32 */
|
|
4946
|
+
dueWithinDays: number;
|
|
4947
|
+
/** @format int32 */
|
|
4948
|
+
maxItems: number;
|
|
4949
|
+
type: MyTasksWidgetConfigTypeEnum;
|
|
4950
|
+
};
|
|
4640
4951
|
export interface NoContentResult {
|
|
4641
4952
|
/** @format int32 */
|
|
4642
4953
|
statusCode: number;
|
|
@@ -4774,6 +5085,11 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4774
5085
|
textBody?: string | null;
|
|
4775
5086
|
pushNotificationBody?: string | null;
|
|
4776
5087
|
}
|
|
5088
|
+
export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5089
|
+
/** @format int32 */
|
|
5090
|
+
maxItems: number;
|
|
5091
|
+
type: OpenTasksWidgetConfigTypeEnum;
|
|
5092
|
+
};
|
|
4777
5093
|
export interface Operation {
|
|
4778
5094
|
op?: string;
|
|
4779
5095
|
value?: string | number | boolean | null | object;
|
|
@@ -4789,6 +5105,7 @@ export interface OutboundFailureBucket {
|
|
|
4789
5105
|
}
|
|
4790
5106
|
export interface OverridePasswordRequest {
|
|
4791
5107
|
password: string;
|
|
5108
|
+
passwordConfirmation?: string | null;
|
|
4792
5109
|
}
|
|
4793
5110
|
export interface Pagination {
|
|
4794
5111
|
/** @format int32 */
|
|
@@ -4908,6 +5225,13 @@ export interface PreliminaryCondition {
|
|
|
4908
5225
|
rerequestedDate?: string | null;
|
|
4909
5226
|
rerequestedBy?: CommentUserInformation | null;
|
|
4910
5227
|
}
|
|
5228
|
+
export interface PreviewSiteConfigurationCanvasRequest {
|
|
5229
|
+
document: CanvasDocument;
|
|
5230
|
+
role?: UserRole | null;
|
|
5231
|
+
}
|
|
5232
|
+
export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5233
|
+
type: PrimaryBorrowerWidgetConfigTypeEnum;
|
|
5234
|
+
};
|
|
4911
5235
|
export interface ProblemDetails {
|
|
4912
5236
|
type?: string | null;
|
|
4913
5237
|
title?: string | null;
|
|
@@ -4917,6 +5241,11 @@ export interface ProblemDetails {
|
|
|
4917
5241
|
instance?: string | null;
|
|
4918
5242
|
[key: string]: any;
|
|
4919
5243
|
}
|
|
5244
|
+
export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5245
|
+
/** @format int32 */
|
|
5246
|
+
maxItems: number;
|
|
5247
|
+
type: RecentLoansWidgetConfigTypeEnum;
|
|
5248
|
+
};
|
|
4920
5249
|
export interface RefinanceCalculator {
|
|
4921
5250
|
currentLoan: RefinanceLoan;
|
|
4922
5251
|
refinanceLoan: RefinanceLoan;
|
|
@@ -5024,6 +5353,15 @@ export interface ResetPasswordRequest {
|
|
|
5024
5353
|
token: string;
|
|
5025
5354
|
password: string;
|
|
5026
5355
|
}
|
|
5356
|
+
export interface ResolvedCanvasTab {
|
|
5357
|
+
tab: CanvasTab;
|
|
5358
|
+
source: CanvasSourceSite;
|
|
5359
|
+
isInherited: boolean;
|
|
5360
|
+
}
|
|
5361
|
+
export interface RestoreSiteConfigurationCanvasVersionRequest {
|
|
5362
|
+
/** @format int32 */
|
|
5363
|
+
expectedVersion: number;
|
|
5364
|
+
}
|
|
5027
5365
|
export interface RunLOCalculation {
|
|
5028
5366
|
loanID: string;
|
|
5029
5367
|
loanAmount?: string | null;
|
|
@@ -5100,9 +5438,22 @@ export interface SSOTokenRequest {
|
|
|
5100
5438
|
email: string;
|
|
5101
5439
|
redirectUri?: string | null;
|
|
5102
5440
|
}
|
|
5441
|
+
export interface SaveSiteConfigurationCanvasRequest {
|
|
5442
|
+
document: CanvasDocument;
|
|
5443
|
+
/** @format int32 */
|
|
5444
|
+
expectedVersion?: number | null;
|
|
5445
|
+
/** @format uuid */
|
|
5446
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
5447
|
+
/** @format int32 */
|
|
5448
|
+
forkedFromVersion?: number | null;
|
|
5449
|
+
}
|
|
5103
5450
|
export interface SearchCriteria {
|
|
5104
5451
|
searchText?: string | null;
|
|
5105
5452
|
}
|
|
5453
|
+
export type SectionDividerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
5454
|
+
label?: string | null;
|
|
5455
|
+
type: SectionDividerWidgetConfigTypeEnum;
|
|
5456
|
+
};
|
|
5106
5457
|
export interface SendESignatureReminderRequest {
|
|
5107
5458
|
/** @format uuid */
|
|
5108
5459
|
userId: string;
|
|
@@ -5531,6 +5882,11 @@ export interface SiteConfigurationByUrl {
|
|
|
5531
5882
|
losSettings?: LOSSettings | null;
|
|
5532
5883
|
workflows: Workflow[];
|
|
5533
5884
|
}
|
|
5885
|
+
export interface SiteConfigurationCanvases {
|
|
5886
|
+
/** @format uuid */
|
|
5887
|
+
siteConfigurationID: string;
|
|
5888
|
+
surfaces: CanvasSurfaceState[];
|
|
5889
|
+
}
|
|
5534
5890
|
export interface SiteConfigurationForm {
|
|
5535
5891
|
/** @format date-time */
|
|
5536
5892
|
createdAt: string;
|
|
@@ -6006,6 +6362,10 @@ export interface TemplateTokenRoot {
|
|
|
6006
6362
|
displayName: string;
|
|
6007
6363
|
fields: TemplateToken[];
|
|
6008
6364
|
}
|
|
6365
|
+
export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
6366
|
+
text: string;
|
|
6367
|
+
type: TextBlockWidgetConfigTypeEnum;
|
|
6368
|
+
};
|
|
6009
6369
|
export interface Theme {
|
|
6010
6370
|
logoURL: string;
|
|
6011
6371
|
primaryColor: string;
|
|
@@ -6101,6 +6461,8 @@ export interface UnprocessableEntity {
|
|
|
6101
6461
|
export interface UnprocessableEntityError {
|
|
6102
6462
|
error: string;
|
|
6103
6463
|
property: string;
|
|
6464
|
+
code?: string | null;
|
|
6465
|
+
params?: Record<string, any> | null;
|
|
6104
6466
|
}
|
|
6105
6467
|
export interface UnregisteredBorrower {
|
|
6106
6468
|
/** @format uuid */
|
|
@@ -6760,6 +7122,12 @@ export interface Workflow {
|
|
|
6760
7122
|
tileSubtitle: string;
|
|
6761
7123
|
icon: string;
|
|
6762
7124
|
}
|
|
7125
|
+
interface BaseCanvasWidgetConfig {
|
|
7126
|
+
type: string;
|
|
7127
|
+
}
|
|
7128
|
+
type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
|
|
7129
|
+
type: Key;
|
|
7130
|
+
} & Type;
|
|
6763
7131
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6764
7132
|
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";
|
|
6765
7133
|
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
|
|
@@ -6768,9 +7136,26 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
|
|
|
6768
7136
|
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6769
7137
|
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
6770
7138
|
export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
|
|
7139
|
+
export type AmortizationWidgetConfigTypeEnum = "Amortization";
|
|
6771
7140
|
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
|
|
6772
7141
|
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6773
7142
|
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7143
|
+
export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
|
|
7144
|
+
export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7145
|
+
export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7146
|
+
export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
|
|
7147
|
+
export type CanvasFieldValueDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7148
|
+
export type CanvasFieldViewDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7149
|
+
export type CanvasFieldViewFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
7150
|
+
export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
|
|
7151
|
+
export type CanvasSourceSiteTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
7152
|
+
export type CanvasSurfaceStateSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7153
|
+
export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7154
|
+
export type CanvasWidgetTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7155
|
+
export type CanvasWidgetTypeDescriptorTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7156
|
+
export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
|
|
7157
|
+
export type CanvasWidgetViewTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
|
|
7158
|
+
export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
|
|
6774
7159
|
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
6775
7160
|
export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
6776
7161
|
export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
|
|
@@ -6788,6 +7173,7 @@ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "
|
|
|
6788
7173
|
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6789
7174
|
export type CreateLoanRoleTaskRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6790
7175
|
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7176
|
+
export type CustomFieldAnswerWarningReasonEnum = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
|
|
6791
7177
|
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6792
7178
|
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
6793
7179
|
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
@@ -6796,6 +7182,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
|
|
|
6796
7182
|
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6797
7183
|
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
6798
7184
|
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
7185
|
+
export type DocumentsWidgetConfigTypeEnum = "Documents";
|
|
6799
7186
|
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
6800
7187
|
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
6801
7188
|
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6805,8 +7192,15 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
|
|
|
6805
7192
|
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6806
7193
|
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6807
7194
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
7195
|
+
export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
|
|
6808
7196
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6809
7197
|
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";
|
|
7198
|
+
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
7199
|
+
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
7200
|
+
export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
|
|
7201
|
+
export type InformationWidgetConfigTypeEnum = "Information";
|
|
7202
|
+
export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
|
|
7203
|
+
export type KpiWidgetConfigTypeEnum = "Kpi";
|
|
6810
7204
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6811
7205
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6812
7206
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6824,11 +7218,13 @@ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
|
6824
7218
|
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
|
|
6825
7219
|
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6826
7220
|
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
|
|
7221
|
+
export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
|
|
6827
7222
|
export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6828
7223
|
export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6829
7224
|
export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
|
|
6830
7225
|
export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
|
|
6831
7226
|
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
7227
|
+
export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
|
|
6832
7228
|
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6833
7229
|
export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
|
|
6834
7230
|
export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
|
|
@@ -6842,8 +7238,14 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
|
|
|
6842
7238
|
export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
6843
7239
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
6844
7240
|
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";
|
|
7241
|
+
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7242
|
+
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
7243
|
+
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
6845
7244
|
export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
6846
7245
|
export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7246
|
+
export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
|
|
7247
|
+
export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
|
|
7248
|
+
export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
|
|
6847
7249
|
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6848
7250
|
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6849
7251
|
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
@@ -6854,6 +7256,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
|
6854
7256
|
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
6855
7257
|
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
6856
7258
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
7259
|
+
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
6857
7260
|
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6858
7261
|
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6859
7262
|
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
@@ -6865,9 +7268,21 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
|
|
|
6865
7268
|
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6866
7269
|
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
6867
7270
|
export type UserTableSettingsTableKeyEnum = "Pipeline";
|
|
7271
|
+
export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7272
|
+
export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6868
7273
|
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6869
7274
|
/** @default "Realtor" */
|
|
6870
7275
|
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
7276
|
+
export type SaveSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7277
|
+
export type SaveSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7278
|
+
export type DeleteSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7279
|
+
export type DeleteSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7280
|
+
export type PreviewSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7281
|
+
export type PreviewSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7282
|
+
export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7283
|
+
export type GetSiteConfigurationCanvasVersionsParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7284
|
+
export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
7285
|
+
export type RestoreSiteConfigurationCanvasVersionParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
6871
7286
|
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6872
7287
|
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6873
7288
|
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
@@ -6915,7 +7330,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6915
7330
|
}
|
|
6916
7331
|
/**
|
|
6917
7332
|
* @title The Big POS API
|
|
6918
|
-
* @version v3.
|
|
7333
|
+
* @version v3.15.0
|
|
6919
7334
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6920
7335
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6921
7336
|
*/
|
|
@@ -8425,6 +8840,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8425
8840
|
* @response `200` `BusinessRule` OK
|
|
8426
8841
|
*/
|
|
8427
8842
|
restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any, {}>>;
|
|
8843
|
+
/**
|
|
8844
|
+
* No description
|
|
8845
|
+
*
|
|
8846
|
+
* @tags Canvases
|
|
8847
|
+
* @name GetCanvas
|
|
8848
|
+
* @summary Get a site's canvas for one surface, as the signed-in user sees it
|
|
8849
|
+
* @request GET:/api/canvases/{surface}
|
|
8850
|
+
* @secure
|
|
8851
|
+
* @response `200` `CanvasView` OK
|
|
8852
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8853
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8854
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
8855
|
+
*/
|
|
8856
|
+
getCanvas: (surface: GetCanvasParamsEnum, query: {
|
|
8857
|
+
/** @format uuid */
|
|
8858
|
+
siteConfigurationId: string;
|
|
8859
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
8860
|
+
/**
|
|
8861
|
+
* @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.
|
|
8862
|
+
*
|
|
8863
|
+
* @tags CanvasFields
|
|
8864
|
+
* @name GetCanvasFields
|
|
8865
|
+
* @summary Get the fields a canvas can show
|
|
8866
|
+
* @request GET:/api/canvas/fields
|
|
8867
|
+
* @secure
|
|
8868
|
+
* @response `200` `CanvasFieldCatalog` OK
|
|
8869
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8870
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8871
|
+
*/
|
|
8872
|
+
getCanvasFields: (params?: RequestParams) => Promise<AxiosResponse<CanvasFieldCatalog, any, {}>>;
|
|
8873
|
+
/**
|
|
8874
|
+
* No description
|
|
8875
|
+
*
|
|
8876
|
+
* @tags CanvasWidgetTypes
|
|
8877
|
+
* @name GetCanvasWidgetTypes
|
|
8878
|
+
* @summary Get canvas widget types
|
|
8879
|
+
* @request GET:/api/canvas/widget-types
|
|
8880
|
+
* @secure
|
|
8881
|
+
* @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
|
|
8882
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
8883
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8884
|
+
*/
|
|
8885
|
+
getCanvasWidgetTypes: (params?: RequestParams) => Promise<AxiosResponse<CanvasWidgetTypeDescriptor[], any, {}>>;
|
|
8428
8886
|
/**
|
|
8429
8887
|
* @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
|
|
8430
8888
|
*
|
|
@@ -9794,6 +10252,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9794
10252
|
* @response `200` `FormVersion` OK
|
|
9795
10253
|
*/
|
|
9796
10254
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
10255
|
+
/**
|
|
10256
|
+
* No description
|
|
10257
|
+
*
|
|
10258
|
+
* @tags IncompleteLoans
|
|
10259
|
+
* @name SearchIncompleteLoans
|
|
10260
|
+
* @summary Search incomplete loans
|
|
10261
|
+
* @request POST:/api/loans/incomplete/search
|
|
10262
|
+
* @secure
|
|
10263
|
+
* @response `200` `IncompleteLoanPaginated` OK
|
|
10264
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10265
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10266
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10267
|
+
*/
|
|
10268
|
+
searchIncompleteLoans: (data: IncompleteLoanSearchCriteria, query?: {
|
|
10269
|
+
/** @format int32 */
|
|
10270
|
+
pageSize?: number;
|
|
10271
|
+
/** @format int32 */
|
|
10272
|
+
pageNumber?: number;
|
|
10273
|
+
sortBy?: string;
|
|
10274
|
+
sortDirection?: string;
|
|
10275
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncompleteLoanPaginated, any, {}>>;
|
|
9797
10276
|
/**
|
|
9798
10277
|
* No description
|
|
9799
10278
|
*
|
|
@@ -10171,6 +10650,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10171
10650
|
* @response `200` `File` OK
|
|
10172
10651
|
*/
|
|
10173
10652
|
getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10653
|
+
/**
|
|
10654
|
+
* No description
|
|
10655
|
+
*
|
|
10656
|
+
* @tags LoanApplicationRemoval
|
|
10657
|
+
* @name RemoveLoanApplication
|
|
10658
|
+
* @summary Remove a loan application nobody has submitted
|
|
10659
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
10660
|
+
* @secure
|
|
10661
|
+
* @response `204` `void` No Content
|
|
10662
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10663
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10664
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10665
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10666
|
+
*/
|
|
10667
|
+
removeLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10668
|
+
/**
|
|
10669
|
+
* No description
|
|
10670
|
+
*
|
|
10671
|
+
* @tags LoanApplicationRemoval
|
|
10672
|
+
* @name RestoreLoanApplication
|
|
10673
|
+
* @summary Restore a removed loan application
|
|
10674
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
10675
|
+
* @secure
|
|
10676
|
+
* @response `204` `void` No Content
|
|
10677
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10678
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10679
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10680
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10681
|
+
*/
|
|
10682
|
+
restoreLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10174
10683
|
/**
|
|
10175
10684
|
* No description
|
|
10176
10685
|
*
|
|
@@ -10195,6 +10704,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10195
10704
|
* @response `423` `UnprocessableEntity` Locked
|
|
10196
10705
|
*/
|
|
10197
10706
|
runLoanCalculator: (loanId: string, data: RunLOCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<RunLOCalculation, any, {}>>;
|
|
10707
|
+
/**
|
|
10708
|
+
* No description
|
|
10709
|
+
*
|
|
10710
|
+
* @tags LoanCanvasFieldValues
|
|
10711
|
+
* @name GetLoanCanvasFieldValues
|
|
10712
|
+
* @summary Get a loan's values for canvas fields
|
|
10713
|
+
* @request POST:/api/loans/{loanId}/canvas/field-values
|
|
10714
|
+
* @secure
|
|
10715
|
+
* @response `200` `CanvasFieldValues` OK
|
|
10716
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10717
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10718
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10719
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
10720
|
+
*/
|
|
10721
|
+
getLoanCanvasFieldValues: (loanId: string, data: CanvasFieldValuesRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasFieldValues, any, {}>>;
|
|
10198
10722
|
/**
|
|
10199
10723
|
* No description
|
|
10200
10724
|
*
|
|
@@ -11211,6 +11735,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11211
11735
|
* @response `404` `ProblemDetails` Not Found
|
|
11212
11736
|
* @response `409` `any` Conflict
|
|
11213
11737
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11738
|
+
* @response `423` `ProblemDetails` Locked
|
|
11214
11739
|
*/
|
|
11215
11740
|
updateLoan: (loanId: string, data: LoanPatchRequestGuidPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
|
|
11216
11741
|
/**
|
|
@@ -11293,6 +11818,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11293
11818
|
* @secure
|
|
11294
11819
|
* @response `202` `void` Accepted
|
|
11295
11820
|
* @response `404` `ProblemDetails` Not Found
|
|
11821
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11296
11822
|
*/
|
|
11297
11823
|
syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11298
11824
|
/**
|
|
@@ -12159,6 +12685,104 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12159
12685
|
replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
|
|
12160
12686
|
applyToChildren?: boolean;
|
|
12161
12687
|
}, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
|
|
12688
|
+
/**
|
|
12689
|
+
* No description
|
|
12690
|
+
*
|
|
12691
|
+
* @tags SiteConfigurationCanvases
|
|
12692
|
+
* @name GetSiteConfigurationCanvases
|
|
12693
|
+
* @summary Get a site's canvases: own, inherited and effective per surface
|
|
12694
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases
|
|
12695
|
+
* @secure
|
|
12696
|
+
* @response `200` `SiteConfigurationCanvases` OK
|
|
12697
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12698
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12699
|
+
*/
|
|
12700
|
+
getSiteConfigurationCanvases: (siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationCanvases, any, {}>>;
|
|
12701
|
+
/**
|
|
12702
|
+
* @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
|
|
12703
|
+
*
|
|
12704
|
+
* @tags SiteConfigurationCanvases
|
|
12705
|
+
* @name SaveSiteConfigurationCanvas
|
|
12706
|
+
* @summary Save a site's canvas for one surface
|
|
12707
|
+
* @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12708
|
+
* @secure
|
|
12709
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12710
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12711
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12712
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12713
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12714
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12715
|
+
* @response `423` `ProblemDetails` Locked
|
|
12716
|
+
*/
|
|
12717
|
+
saveSiteConfigurationCanvas: (siteConfigurationId: string, surface: SaveSiteConfigurationCanvasParamsEnum, data: SaveSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12718
|
+
/**
|
|
12719
|
+
* No description
|
|
12720
|
+
*
|
|
12721
|
+
* @tags SiteConfigurationCanvases
|
|
12722
|
+
* @name DeleteSiteConfigurationCanvas
|
|
12723
|
+
* @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
|
|
12724
|
+
* @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
12725
|
+
* @secure
|
|
12726
|
+
* @response `204` `void` No Content
|
|
12727
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12728
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12729
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12730
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12731
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12732
|
+
*/
|
|
12733
|
+
deleteSiteConfigurationCanvas: (siteConfigurationId: string, surface: DeleteSiteConfigurationCanvasParamsEnum, query: {
|
|
12734
|
+
/**
|
|
12735
|
+
* The canvas Version the caller last read. A delete over a newer save is refused as stale.
|
|
12736
|
+
* @format int32
|
|
12737
|
+
*/
|
|
12738
|
+
expectedVersion: number;
|
|
12739
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
12740
|
+
/**
|
|
12741
|
+
* No description
|
|
12742
|
+
*
|
|
12743
|
+
* @tags SiteConfigurationCanvases
|
|
12744
|
+
* @name PreviewSiteConfigurationCanvas
|
|
12745
|
+
* @summary Preview an unsaved canvas for one surface as a role would see it
|
|
12746
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
|
|
12747
|
+
* @secure
|
|
12748
|
+
* @response `200` `CanvasView` OK
|
|
12749
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12750
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12751
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12752
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12753
|
+
*/
|
|
12754
|
+
previewSiteConfigurationCanvas: (siteConfigurationId: string, surface: PreviewSiteConfigurationCanvasParamsEnum, data: PreviewSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
|
|
12755
|
+
/**
|
|
12756
|
+
* No description
|
|
12757
|
+
*
|
|
12758
|
+
* @tags SiteConfigurationCanvases
|
|
12759
|
+
* @name GetSiteConfigurationCanvasVersions
|
|
12760
|
+
* @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
|
|
12761
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
|
|
12762
|
+
* @secure
|
|
12763
|
+
* @response `200` `(CanvasVersion)[]` OK
|
|
12764
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12765
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12766
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12767
|
+
*/
|
|
12768
|
+
getSiteConfigurationCanvasVersions: (siteConfigurationId: string, surface: GetSiteConfigurationCanvasVersionsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<CanvasVersion[], any, {}>>;
|
|
12769
|
+
/**
|
|
12770
|
+
* No description
|
|
12771
|
+
*
|
|
12772
|
+
* @tags SiteConfigurationCanvases
|
|
12773
|
+
* @name RestoreSiteConfigurationCanvasVersion
|
|
12774
|
+
* @summary Restore a saved version of a site's canvas as a new version
|
|
12775
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
|
|
12776
|
+
* @secure
|
|
12777
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
12778
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12779
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12780
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12781
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12782
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12783
|
+
* @response `423` `ProblemDetails` Locked
|
|
12784
|
+
*/
|
|
12785
|
+
restoreSiteConfigurationCanvasVersion: (siteConfigurationId: string, surface: RestoreSiteConfigurationCanvasVersionParamsEnum, version: number, data: RestoreSiteConfigurationCanvasVersionRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
|
|
12162
12786
|
/**
|
|
12163
12787
|
* No description
|
|
12164
12788
|
*
|
|
@@ -13005,6 +13629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13005
13629
|
* @response `204` `void` No Content
|
|
13006
13630
|
* @response `404` `Error` Not Found
|
|
13007
13631
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13632
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
13008
13633
|
*/
|
|
13009
13634
|
allowImpersonationWithGuid: (allowToken: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13010
13635
|
/**
|
|
@@ -13056,6 +13681,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13056
13681
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13057
13682
|
*/
|
|
13058
13683
|
extendImpersonation: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13684
|
+
/**
|
|
13685
|
+
* No description
|
|
13686
|
+
*
|
|
13687
|
+
* @tags UserInviteAcceptance
|
|
13688
|
+
* @name AcceptBorrowerInvite
|
|
13689
|
+
* @summary Accept a borrower invite with the signed-in account
|
|
13690
|
+
* @request POST:/api/users/invites/accept
|
|
13691
|
+
* @secure
|
|
13692
|
+
* @response `200` `AcceptedBorrowerInvite` OK
|
|
13693
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
13694
|
+
* @response `404` `ProblemDetails` Not Found
|
|
13695
|
+
* @response `409` `ProblemDetails` Conflict
|
|
13696
|
+
*/
|
|
13697
|
+
acceptBorrowerInvite: (data: AcceptBorrowerInviteRequest, params?: RequestParams) => Promise<AxiosResponse<AcceptedBorrowerInvite, any, {}>>;
|
|
13059
13698
|
/**
|
|
13060
13699
|
* No description
|
|
13061
13700
|
*
|
|
@@ -13486,3 +14125,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13486
14125
|
logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13487
14126
|
};
|
|
13488
14127
|
}
|
|
14128
|
+
export {};
|