@matech/thebigpos-sdk 3.15.0 → 3.16.0

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/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
1
2
  export type VersionStatusType = "Draft" | "Published";
2
3
  export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
3
4
  export type TaskType = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
@@ -25,6 +26,7 @@ export type LoanRoleTaskSource = "Rule" | "Manual";
25
26
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
26
27
  export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
27
28
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
29
+ export type LoanRealEstatePropertyType = "SingleFamily" | "Condominium" | "Townhouse" | "Cooperative" | "TwoToFourUnitProperty" | "MultifamilyMoreThanFourUnits" | "ManufacturedMobileHome" | "CommercialNonResidential" | "HomeAndBusinessCombined" | "MixedUseResidential" | "Farm" | "Land";
28
30
  export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
29
31
  export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
30
32
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
@@ -42,7 +44,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
42
44
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
43
45
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
44
46
  export type LoanMaritalStatus = "Married" | "Separated" | "Single";
45
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
47
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
46
48
  export type LoanLienPosition = "First" | "Subordinate";
47
49
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
48
50
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
@@ -86,6 +88,15 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
86
88
  export type CompanyDocumentSourceType = "File" | "FreeText";
87
89
  export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
88
90
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
91
+ export type CanvasWidgetType = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
92
+ export type CanvasWidgetScope = "Loan" | "User" | "Any";
93
+ export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
94
+ export type CanvasLabelPosition = "Left" | "Above";
95
+ export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
96
+ export type CanvasFieldSource = "Standard" | "Custom";
97
+ export type CanvasFieldFormat = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
98
+ export type CanvasFieldDataType = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
99
+ export type CanvasAudience = "Staff" | "Borrower" | "Partner";
89
100
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
90
101
  export type BranchType = "Mortgage" | "RealEstate";
91
102
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -104,6 +115,7 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
104
115
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
105
116
  export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
106
117
  export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
118
+ export type CanvasWidgetConfig = BaseCanvasWidgetConfig & (BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanProgress", LoanProgressWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MonthlyPayment", MonthlyPaymentWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Amortization", AmortizationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"PrimaryBorrower", PrimaryBorrowerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"SectionDivider", SectionDividerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>);
107
119
  export interface ASOSettings {
108
120
  enabled: boolean;
109
121
  softPull: boolean;
@@ -422,7 +434,7 @@ export interface AiAuditLog {
422
434
  guardrailCategory?: string | null;
423
435
  rawRequest?: string | null;
424
436
  rawResponse?: string | null;
425
- details: any;
437
+ details?: any | null;
426
438
  /** @format date-time */
427
439
  createdAt: string;
428
440
  }
@@ -894,6 +906,9 @@ export interface AmortizationSchedule {
894
906
  /** @format double */
895
907
  pmi: number;
896
908
  }
909
+ export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
910
+ type: AmortizationWidgetConfigTypeEnum;
911
+ };
897
912
  export interface ApplicationRowData {
898
913
  borrowerEmail?: string | null;
899
914
  borrowerFirstName?: string | null;
@@ -966,7 +981,7 @@ export interface AuditLogEntry {
966
981
  rootEntityType?: string | null;
967
982
  /** @format uuid */
968
983
  rootEntityId?: string | null;
969
- changes: any;
984
+ changes?: any | null;
970
985
  /** @format date-time */
971
986
  createdAt: string;
972
987
  }
@@ -1144,6 +1159,173 @@ export interface BusinessRuleRequest {
1144
1159
  filter: BusinessRuleCondition[];
1145
1160
  applyToAllBorrowerPairs: boolean;
1146
1161
  }
1162
+ export interface CanvasAuthor {
1163
+ /** @format uuid */
1164
+ id: string;
1165
+ firstName: string;
1166
+ lastName: string;
1167
+ email: string;
1168
+ }
1169
+ export interface CanvasBoard {
1170
+ name?: string | null;
1171
+ roles: UserRole[];
1172
+ widgetIds: string[];
1173
+ widgets: Record<string, CanvasWidget>;
1174
+ }
1175
+ export interface CanvasBoardView {
1176
+ widgetIds: string[];
1177
+ widgets: Record<string, CanvasWidgetView>;
1178
+ }
1179
+ export interface CanvasDocument {
1180
+ /** @format int32 */
1181
+ schemaVersion: number;
1182
+ boards?: CanvasBoard[] | null;
1183
+ tabs?: CanvasTab[] | null;
1184
+ }
1185
+ export interface CanvasFieldCatalog {
1186
+ fields: CanvasFieldDescriptor[];
1187
+ }
1188
+ export interface CanvasFieldDescriptor {
1189
+ source: CanvasFieldDescriptorSourceEnum;
1190
+ key: string;
1191
+ label: string;
1192
+ category: string;
1193
+ categoryKey: string;
1194
+ dataType: CanvasFieldDescriptorDataTypeEnum;
1195
+ format: CanvasFieldDescriptorFormatEnum;
1196
+ encompassFieldId?: string | null;
1197
+ readableRoles: UserRole[];
1198
+ isActive: boolean;
1199
+ rolesWithoutPermissionRows: UserRole[];
1200
+ options: string[];
1201
+ }
1202
+ export interface CanvasFieldRef {
1203
+ source: CanvasFieldRefSourceEnum;
1204
+ key: string;
1205
+ }
1206
+ export interface CanvasFieldValue {
1207
+ dataType: CanvasFieldValueDataTypeEnum;
1208
+ value?: any | null;
1209
+ }
1210
+ export interface CanvasFieldValues {
1211
+ standard: Record<string, CanvasFieldValue>;
1212
+ custom: Record<string, CanvasFieldValue>;
1213
+ }
1214
+ export interface CanvasFieldValuesRequest {
1215
+ standardKeys: string[];
1216
+ customFieldIds: string[];
1217
+ }
1218
+ export interface CanvasFieldView {
1219
+ label: string;
1220
+ dataType: CanvasFieldViewDataTypeEnum;
1221
+ format: CanvasFieldViewFormatEnum;
1222
+ options: string[];
1223
+ }
1224
+ export interface CanvasInformationItem {
1225
+ kind: CanvasInformationItemKindEnum;
1226
+ field?: CanvasFieldRef | null;
1227
+ text?: string | null;
1228
+ label?: string | null;
1229
+ format?: CanvasFieldFormat | null;
1230
+ emphasis: boolean;
1231
+ hideWhenEmpty: boolean;
1232
+ roles: UserRole[];
1233
+ /** @format int32 */
1234
+ column: number;
1235
+ }
1236
+ export interface CanvasSourceSite {
1237
+ /** @format uuid */
1238
+ siteConfigurationID: string;
1239
+ name: string;
1240
+ type: CanvasSourceSiteTypeEnum;
1241
+ }
1242
+ export interface CanvasSurfaceState {
1243
+ surface: CanvasSurfaceStateSurfaceEnum;
1244
+ own?: CanvasDocument | null;
1245
+ /** @format int32 */
1246
+ ownVersion?: number | null;
1247
+ isOwnUnreadable: boolean;
1248
+ /** @format date-time */
1249
+ ownUpdatedAt?: string | null;
1250
+ /** @format uuid */
1251
+ forkedFromSiteConfigurationID?: string | null;
1252
+ /** @format int32 */
1253
+ forkedFromVersion?: number | null;
1254
+ inherited?: CanvasDocument | null;
1255
+ /** @format int32 */
1256
+ inheritedVersion?: number | null;
1257
+ inheritedFrom?: CanvasSourceSite | null;
1258
+ isBehindInherited: boolean;
1259
+ effectiveBoards?: CanvasBoard[] | null;
1260
+ effectiveTabs?: ResolvedCanvasTab[] | null;
1261
+ }
1262
+ export interface CanvasTab {
1263
+ key: string;
1264
+ /** @format int32 */
1265
+ version: number;
1266
+ title: string;
1267
+ roles: UserRole[];
1268
+ copiedFrom?: CanvasTabOrigin | null;
1269
+ board: CanvasBoard;
1270
+ }
1271
+ export interface CanvasTabOrigin {
1272
+ /** @format uuid */
1273
+ siteConfigurationID: string;
1274
+ tabKey: string;
1275
+ /** @format int32 */
1276
+ version: number;
1277
+ }
1278
+ export interface CanvasTabView {
1279
+ key: string;
1280
+ title: string;
1281
+ board: CanvasBoardView;
1282
+ }
1283
+ export interface CanvasVersion {
1284
+ /** @format int32 */
1285
+ version: number;
1286
+ /** @format date-time */
1287
+ createdAt: string;
1288
+ createdBy?: CanvasAuthor | null;
1289
+ }
1290
+ export interface CanvasView {
1291
+ surface: CanvasViewSurfaceEnum;
1292
+ isConfigured: boolean;
1293
+ board?: CanvasBoardView | null;
1294
+ tabs?: CanvasTabView[] | null;
1295
+ standardFields: Record<string, CanvasFieldView>;
1296
+ customFields: Record<string, CanvasFieldView>;
1297
+ }
1298
+ export interface CanvasWidget {
1299
+ type: CanvasWidgetTypeEnum;
1300
+ /** @format int32 */
1301
+ configVersion: number;
1302
+ title?: string | null;
1303
+ /** @format int32 */
1304
+ width: number;
1305
+ roles: UserRole[];
1306
+ config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
1307
+ }
1308
+ export interface CanvasWidgetTypeDescriptor {
1309
+ type: CanvasWidgetTypeDescriptorTypeEnum;
1310
+ scope: CanvasWidgetTypeDescriptorScopeEnum;
1311
+ surfaces: CanvasSurface[];
1312
+ audiences: CanvasAudience[];
1313
+ allowedRoles: UserRole[];
1314
+ allowedWidths: number[];
1315
+ /** @format int32 */
1316
+ maxPerBoard: number;
1317
+ /** @format int32 */
1318
+ configVersion: number;
1319
+ }
1320
+ export interface CanvasWidgetView {
1321
+ type: CanvasWidgetViewTypeEnum;
1322
+ /** @format int32 */
1323
+ configVersion: number;
1324
+ title?: string | null;
1325
+ /** @format int32 */
1326
+ width: number;
1327
+ config: InformationWidgetConfig | KpiWidgetConfig | KeyDatesWidgetConfig | LoanProgressWidgetConfig | MonthlyPaymentWidgetConfig | AmortizationWidgetConfig | PrimaryBorrowerWidgetConfig | OpenTasksWidgetConfig | DocumentsWidgetConfig | EsignStatusWidgetConfig | LoanTeamWidgetConfig | TextBlockWidgetConfig | SectionDividerWidgetConfig | MyTasksWidgetConfig | RecentLoansWidgetConfig | ClosingSoonWidgetConfig;
1328
+ }
1147
1329
  export interface ChangePasswordRequest {
1148
1330
  oldPassword: string;
1149
1331
  newPassword: string;
@@ -1174,6 +1356,13 @@ export interface ClosedLoansReportRequest {
1174
1356
  /** @format date */
1175
1357
  endDate: string;
1176
1358
  }
1359
+ export type ClosingSoonWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
1360
+ /** @format int32 */
1361
+ withinDays: number;
1362
+ /** @format int32 */
1363
+ maxItems: number;
1364
+ type: ClosingSoonWidgetConfigTypeEnum;
1365
+ };
1177
1366
  export interface CommentUserInformation {
1178
1367
  entityId: string;
1179
1368
  entityType: string;
@@ -1769,6 +1958,12 @@ export interface DocumentTemplateVersionUpdateRequest {
1769
1958
  isActive: boolean;
1770
1959
  htmlBody: string;
1771
1960
  }
1961
+ export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
1962
+ /** @format int32 */
1963
+ maxItems: number;
1964
+ onlyOutstanding: boolean;
1965
+ type: DocumentsWidgetConfigTypeEnum;
1966
+ };
1772
1967
  export interface Draft {
1773
1968
  /** @format date-time */
1774
1969
  createdAt: string;
@@ -1818,7 +2013,7 @@ export interface DraftLoanOfficerReassignRequest {
1818
2013
  }
1819
2014
  export interface DraftRequest {
1820
2015
  applicationPayload: any;
1821
- customData: any;
2016
+ customData?: any | null;
1822
2017
  isCoBorrower: boolean;
1823
2018
  }
1824
2019
  export interface EconsentPendingSummary {
@@ -2043,7 +2238,7 @@ export interface EncompassRequestLog {
2043
2238
  httpStatusCode?: number | null;
2044
2239
  /** @format int64 */
2045
2240
  durationMs?: number | null;
2046
- context: any;
2241
+ context?: any | null;
2047
2242
  /** @format date-time */
2048
2243
  createdAt: string;
2049
2244
  }
@@ -2067,6 +2262,9 @@ export interface EncompassWebhookSubscription {
2067
2262
  export interface Error {
2068
2263
  message: string;
2069
2264
  }
2265
+ export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
2266
+ type: EsignStatusWidgetConfigTypeEnum;
2267
+ };
2070
2268
  export interface FailureBucket {
2071
2269
  /** @format date-time */
2072
2270
  startUtc: string;
@@ -2172,7 +2370,7 @@ export interface FormSubmission {
2172
2370
  subjectPropertyAddressCounty?: string | null;
2173
2371
  subjectPropertyAddressState?: string | null;
2174
2372
  subjectPropertyAddressZip?: string | null;
2175
- data: any;
2373
+ data?: any | null;
2176
2374
  /** @format uuid */
2177
2375
  listingID?: string | null;
2178
2376
  listing?: Listing | null;
@@ -2214,7 +2412,7 @@ export interface FormSubmissionRequest {
2214
2412
  subjectPropertyAddressCounty?: string | null;
2215
2413
  subjectPropertyAddressState?: string | null;
2216
2414
  subjectPropertyAddressZip?: string | null;
2217
- data: any;
2415
+ data?: any | null;
2218
2416
  /** @format uuid */
2219
2417
  listingID?: string | null;
2220
2418
  }
@@ -2346,7 +2544,7 @@ export interface GetWorkflowRequest {
2346
2544
  export interface GuidPatchOperation {
2347
2545
  op: string;
2348
2546
  path: string;
2349
- value: any;
2547
+ value?: any | null;
2350
2548
  from?: string | null;
2351
2549
  }
2352
2550
  export interface HttpError {
@@ -2419,6 +2617,7 @@ export interface InProgressLoan {
2419
2617
  siteConfigurationId?: string | null;
2420
2618
  /** @format date-time */
2421
2619
  updatedAt?: string | null;
2620
+ applicationSession?: LoanApplicationSessionRoute | null;
2422
2621
  }
2423
2622
  export interface IncompleteApplicationSummary {
2424
2623
  /** @format int32 */
@@ -2452,6 +2651,7 @@ export interface IncompleteLoanBorrower {
2452
2651
  applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
2453
2652
  /** @format date-time */
2454
2653
  deletedAt?: string | null;
2654
+ applicationSession?: LoanApplicationSessionRoute | null;
2455
2655
  }
2456
2656
  export interface IncompleteLoanDraft {
2457
2657
  /** @format uuid */
@@ -2481,6 +2681,15 @@ export interface IncompleteLoanSiteConfiguration {
2481
2681
  id: string;
2482
2682
  name: string;
2483
2683
  }
2684
+ export type InformationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
2685
+ /** @format int32 */
2686
+ columns: number;
2687
+ labelPosition: InformationWidgetConfigLabelPositionEnum;
2688
+ hideWhenEmpty: boolean;
2689
+ emptyText?: string | null;
2690
+ items: CanvasInformationItem[];
2691
+ type: InformationWidgetConfigTypeEnum;
2692
+ };
2484
2693
  export interface IntegrationSettings {
2485
2694
  encompass?: EncompassIntegrationSettings | null;
2486
2695
  }
@@ -2515,6 +2724,16 @@ export interface Invite {
2515
2724
  }
2516
2725
  /** Array of operations to perform */
2517
2726
  export type JsonPatchDocument = Operation[];
2727
+ export type KeyDatesWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
2728
+ dates: string[];
2729
+ type: KeyDatesWidgetConfigTypeEnum;
2730
+ };
2731
+ export type KpiWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
2732
+ field: CanvasFieldRef;
2733
+ label?: string | null;
2734
+ format?: CanvasFieldFormat | null;
2735
+ type: KpiWidgetConfigTypeEnum;
2736
+ };
2518
2737
  export interface LOSIntegration {
2519
2738
  instanceID: string;
2520
2739
  }
@@ -2746,6 +2965,9 @@ export interface LoanApplicationSessionRequest {
2746
2965
  currentQuestionId?: string | null;
2747
2966
  questionHistory: string[];
2748
2967
  }
2968
+ export interface LoanApplicationSessionRoute {
2969
+ routeName: string;
2970
+ }
2749
2971
  export interface LoanBorrower {
2750
2972
  /** @format uuid */
2751
2973
  id: string;
@@ -2766,6 +2988,8 @@ export interface LoanBorrower {
2766
2988
  numberOfDependents?: number | null;
2767
2989
  /** @format int32 */
2768
2990
  creditDecisionScore?: number | null;
2991
+ /** @format int32 */
2992
+ estimatedCreditScore?: number | null;
2769
2993
  isPrimaryBorrower: boolean;
2770
2994
  isFirstTimeHomeBuyer?: boolean | null;
2771
2995
  hasJointAssetsAndLiabilities?: boolean | null;
@@ -3116,6 +3340,12 @@ export interface LoanBorrowerEmploymentPrevious {
3116
3340
  /** @format double */
3117
3341
  grossIncome?: number | null;
3118
3342
  isSelfEmployed?: boolean | null;
3343
+ /** @format double */
3344
+ bonus?: number | null;
3345
+ /** @format double */
3346
+ overtime?: number | null;
3347
+ /** @format double */
3348
+ commission?: number | null;
3119
3349
  address?: AddressV3 | null;
3120
3350
  }
3121
3351
  export interface LoanBorrowerEmploymentPreviousRequest {
@@ -3129,6 +3359,12 @@ export interface LoanBorrowerEmploymentPreviousRequest {
3129
3359
  /** @format double */
3130
3360
  grossIncome?: number | null;
3131
3361
  isSelfEmployed?: boolean | null;
3362
+ /** @format double */
3363
+ bonus?: number | null;
3364
+ /** @format double */
3365
+ overtime?: number | null;
3366
+ /** @format double */
3367
+ commission?: number | null;
3132
3368
  address?: AddressRequest | null;
3133
3369
  }
3134
3370
  export interface LoanBorrowerGift {
@@ -3318,6 +3554,7 @@ export interface LoanBorrowerRealEstateAsset {
3318
3554
  occupancy?: LoanRealEstateOccupancyType | null;
3319
3555
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
3320
3556
  intendedUsageOtherDescription?: string | null;
3557
+ propertyType?: LoanRealEstatePropertyType | null;
3321
3558
  /** @format double */
3322
3559
  marketValue?: number | null;
3323
3560
  /** @format double */
@@ -3375,6 +3612,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
3375
3612
  occupancy?: LoanRealEstateOccupancyType | null;
3376
3613
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
3377
3614
  intendedUsageOtherDescription?: string | null;
3615
+ propertyType?: LoanRealEstatePropertyType | null;
3378
3616
  /** @format double */
3379
3617
  marketValue?: number | null;
3380
3618
  /** @format double */
@@ -3409,6 +3647,8 @@ export interface LoanBorrowerRequest {
3409
3647
  isFirstTimeHomeBuyer?: boolean | null;
3410
3648
  hasJointAssetsAndLiabilities?: boolean | null;
3411
3649
  dependentAges?: number[] | null;
3650
+ /** @format int32 */
3651
+ estimatedCreditScore?: number | null;
3412
3652
  demographics?: LoanBorrowerDemographicsRequest | null;
3413
3653
  declarations?: LoanBorrowerDeclarationsRequest | null;
3414
3654
  militaryService?: LoanBorrowerMilitaryServiceRequest | null;
@@ -4011,6 +4251,9 @@ export interface LoanOutstandingItems {
4011
4251
  export interface LoanPatchRequestGuidPatchDocument {
4012
4252
  operations: GuidPatchOperation[];
4013
4253
  }
4254
+ export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4255
+ type: LoanProgressWidgetConfigTypeEnum;
4256
+ };
4014
4257
  export interface LoanProperty {
4015
4258
  /** @format uuid */
4016
4259
  id?: string | null;
@@ -4139,7 +4382,7 @@ export interface LoanQueueWithData {
4139
4382
  user: UserPublic;
4140
4383
  loanOfficer: LoanOfficerPublic;
4141
4384
  siteConfiguration: SiteConfigurationReduced;
4142
- data: any;
4385
+ data?: any | null;
4143
4386
  }
4144
4387
  export interface LoanRecommendation {
4145
4388
  /** @format uuid */
@@ -4148,7 +4391,7 @@ export interface LoanRecommendation {
4148
4391
  displayName: string;
4149
4392
  extractedValue: string;
4150
4393
  mintable: boolean;
4151
- currentLoanValue: any;
4394
+ currentLoanValue?: any | null;
4152
4395
  /** @format uuid */
4153
4396
  sourceDocumentId: string;
4154
4397
  sourceDocumentName?: string | null;
@@ -4314,6 +4557,9 @@ export interface LoanTaskStatusSummary {
4314
4557
  /** @format int32 */
4315
4558
  count: number;
4316
4559
  }
4560
+ export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4561
+ type: LoanTeamWidgetConfigTypeEnum;
4562
+ };
4317
4563
  export interface LoanUser {
4318
4564
  /** @format uuid */
4319
4565
  id: string;
@@ -4677,7 +4923,7 @@ export interface ModuleParameterValue {
4677
4923
  parameterID: string;
4678
4924
  parameterName: string;
4679
4925
  parameterType: string;
4680
- value: any;
4926
+ value?: any | null;
4681
4927
  isInherited: boolean;
4682
4928
  }
4683
4929
  export interface MonthlyPaymentCalculator {
@@ -4711,6 +4957,16 @@ export interface MonthlyPaymentCalculatorRequest {
4711
4957
  /** @format int32 */
4712
4958
  term: number;
4713
4959
  }
4960
+ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4961
+ type: MonthlyPaymentWidgetConfigTypeEnum;
4962
+ };
4963
+ export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4964
+ /** @format int32 */
4965
+ dueWithinDays: number;
4966
+ /** @format int32 */
4967
+ maxItems: number;
4968
+ type: MyTasksWidgetConfigTypeEnum;
4969
+ };
4714
4970
  export interface NoContentResult {
4715
4971
  /** @format int32 */
4716
4972
  statusCode: number;
@@ -4848,6 +5104,11 @@ export interface NotificationTemplateVersionUpdateRequest {
4848
5104
  textBody?: string | null;
4849
5105
  pushNotificationBody?: string | null;
4850
5106
  }
5107
+ export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5108
+ /** @format int32 */
5109
+ maxItems: number;
5110
+ type: OpenTasksWidgetConfigTypeEnum;
5111
+ };
4851
5112
  export interface Operation {
4852
5113
  op?: string;
4853
5114
  value?: string | number | boolean | null | object;
@@ -4983,6 +5244,13 @@ export interface PreliminaryCondition {
4983
5244
  rerequestedDate?: string | null;
4984
5245
  rerequestedBy?: CommentUserInformation | null;
4985
5246
  }
5247
+ export interface PreviewSiteConfigurationCanvasRequest {
5248
+ document: CanvasDocument;
5249
+ role?: UserRole | null;
5250
+ }
5251
+ export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5252
+ type: PrimaryBorrowerWidgetConfigTypeEnum;
5253
+ };
4986
5254
  export interface ProblemDetails {
4987
5255
  type?: string | null;
4988
5256
  title?: string | null;
@@ -4992,6 +5260,11 @@ export interface ProblemDetails {
4992
5260
  instance?: string | null;
4993
5261
  [key: string]: any;
4994
5262
  }
5263
+ export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5264
+ /** @format int32 */
5265
+ maxItems: number;
5266
+ type: RecentLoansWidgetConfigTypeEnum;
5267
+ };
4995
5268
  export interface RefinanceCalculator {
4996
5269
  currentLoan: RefinanceLoan;
4997
5270
  refinanceLoan: RefinanceLoan;
@@ -5099,6 +5372,15 @@ export interface ResetPasswordRequest {
5099
5372
  token: string;
5100
5373
  password: string;
5101
5374
  }
5375
+ export interface ResolvedCanvasTab {
5376
+ tab: CanvasTab;
5377
+ source: CanvasSourceSite;
5378
+ isInherited: boolean;
5379
+ }
5380
+ export interface RestoreSiteConfigurationCanvasVersionRequest {
5381
+ /** @format int32 */
5382
+ expectedVersion: number;
5383
+ }
5102
5384
  export interface RunLOCalculation {
5103
5385
  loanID: string;
5104
5386
  loanAmount?: string | null;
@@ -5175,9 +5457,22 @@ export interface SSOTokenRequest {
5175
5457
  email: string;
5176
5458
  redirectUri?: string | null;
5177
5459
  }
5460
+ export interface SaveSiteConfigurationCanvasRequest {
5461
+ document: CanvasDocument;
5462
+ /** @format int32 */
5463
+ expectedVersion?: number | null;
5464
+ /** @format uuid */
5465
+ forkedFromSiteConfigurationID?: string | null;
5466
+ /** @format int32 */
5467
+ forkedFromVersion?: number | null;
5468
+ }
5178
5469
  export interface SearchCriteria {
5179
5470
  searchText?: string | null;
5180
5471
  }
5472
+ export type SectionDividerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5473
+ label?: string | null;
5474
+ type: SectionDividerWidgetConfigTypeEnum;
5475
+ };
5181
5476
  export interface SendESignatureReminderRequest {
5182
5477
  /** @format uuid */
5183
5478
  userId: string;
@@ -5606,6 +5901,11 @@ export interface SiteConfigurationByUrl {
5606
5901
  losSettings?: LOSSettings | null;
5607
5902
  workflows: Workflow[];
5608
5903
  }
5904
+ export interface SiteConfigurationCanvases {
5905
+ /** @format uuid */
5906
+ siteConfigurationID: string;
5907
+ surfaces: CanvasSurfaceState[];
5908
+ }
5609
5909
  export interface SiteConfigurationForm {
5610
5910
  /** @format date-time */
5611
5911
  createdAt: string;
@@ -6081,6 +6381,10 @@ export interface TemplateTokenRoot {
6081
6381
  displayName: string;
6082
6382
  fields: TemplateToken[];
6083
6383
  }
6384
+ export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
6385
+ text: string;
6386
+ type: TextBlockWidgetConfigTypeEnum;
6387
+ };
6084
6388
  export interface Theme {
6085
6389
  logoURL: string;
6086
6390
  primaryColor: string;
@@ -6176,6 +6480,8 @@ export interface UnprocessableEntity {
6176
6480
  export interface UnprocessableEntityError {
6177
6481
  error: string;
6178
6482
  property: string;
6483
+ code?: string | null;
6484
+ params?: Record<string, any> | null;
6179
6485
  }
6180
6486
  export interface UnregisteredBorrower {
6181
6487
  /** @format uuid */
@@ -6312,6 +6618,9 @@ export interface UpdateLoanRoleTaskRequest {
6312
6618
  /** @format date */
6313
6619
  dueDate?: string | null;
6314
6620
  }
6621
+ export interface UpdateLoanSigningMethodRequest {
6622
+ signingMethod?: SigningMethod | null;
6623
+ }
6315
6624
  export interface UpdateMeRequest {
6316
6625
  phone?: string | null;
6317
6626
  firstName: string;
@@ -6835,6 +7144,12 @@ export interface Workflow {
6835
7144
  tileSubtitle: string;
6836
7145
  icon: string;
6837
7146
  }
7147
+ interface BaseCanvasWidgetConfig {
7148
+ type: string;
7149
+ }
7150
+ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
7151
+ type: Key;
7152
+ } & Type;
6838
7153
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6839
7154
  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
7155
  export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
@@ -6843,9 +7158,26 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
6843
7158
  export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6844
7159
  export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6845
7160
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
7161
+ export type AmortizationWidgetConfigTypeEnum = "Amortization";
6846
7162
  export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6847
7163
  export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6848
7164
  export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7165
+ export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
7166
+ export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
7167
+ export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
7168
+ export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
7169
+ export type CanvasFieldValueDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
7170
+ export type CanvasFieldViewDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
7171
+ export type CanvasFieldViewFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
7172
+ export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
7173
+ export type CanvasSourceSiteTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
7174
+ export type CanvasSurfaceStateSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7175
+ export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7176
+ export type CanvasWidgetTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
7177
+ export type CanvasWidgetTypeDescriptorTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
7178
+ export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
7179
+ export type CanvasWidgetViewTypeEnum = "Information" | "Kpi" | "KeyDates" | "LoanProgress" | "MonthlyPayment" | "Amortization" | "PrimaryBorrower" | "OpenTasks" | "Documents" | "EsignStatus" | "LoanTeam" | "TextBlock" | "SectionDivider" | "MyTasks" | "RecentLoans" | "ClosingSoon";
7180
+ export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
6849
7181
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
6850
7182
  export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6851
7183
  export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
@@ -6872,6 +7204,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
6872
7204
  export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6873
7205
  export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6874
7206
  export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
7207
+ export type DocumentsWidgetConfigTypeEnum = "Documents";
6875
7208
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
6876
7209
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6877
7210
  export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
@@ -6881,10 +7214,15 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
6881
7214
  export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
6882
7215
  export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6883
7216
  export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
7217
+ export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
6884
7218
  export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6885
7219
  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
7220
  export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
6887
7221
  export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
7222
+ export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
7223
+ export type InformationWidgetConfigTypeEnum = "Information";
7224
+ export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
7225
+ export type KpiWidgetConfigTypeEnum = "Kpi";
6888
7226
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6889
7227
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6890
7228
  export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
@@ -6899,14 +7237,16 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
6899
7237
  export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6900
7238
  export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6901
7239
  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";
7240
+ 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
7241
  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";
7242
+ 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";
7243
+ export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
6905
7244
  export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6906
7245
  export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6907
7246
  export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
6908
7247
  export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
6909
7248
  export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
7249
+ export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
6910
7250
  export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6911
7251
  export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6912
7252
  export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
@@ -6920,8 +7260,14 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
6920
7260
  export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6921
7261
  export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
6922
7262
  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";
7263
+ export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
7264
+ export type MyTasksWidgetConfigTypeEnum = "MyTasks";
7265
+ export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
6923
7266
  export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
6924
7267
  export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7268
+ export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
7269
+ export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
7270
+ export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
6925
7271
  export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6926
7272
  export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6927
7273
  export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -6932,6 +7278,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
6932
7278
  export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
6933
7279
  export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6934
7280
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
7281
+ export type TextBlockWidgetConfigTypeEnum = "TextBlock";
6935
7282
  export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6936
7283
  export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6937
7284
  export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
@@ -6943,9 +7290,21 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
6943
7290
  export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6944
7291
  export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6945
7292
  export type UserTableSettingsTableKeyEnum = "Pipeline";
7293
+ export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7294
+ export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
6946
7295
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6947
7296
  /** @default "Realtor" */
6948
7297
  export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
7298
+ export type SaveSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7299
+ export type SaveSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
7300
+ export type DeleteSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7301
+ export type DeleteSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
7302
+ export type PreviewSiteConfigurationCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7303
+ export type PreviewSiteConfigurationCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
7304
+ export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7305
+ export type GetSiteConfigurationCanvasVersionsParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
7306
+ export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7307
+ export type RestoreSiteConfigurationCanvasVersionParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
6949
7308
  export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6950
7309
  export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6951
7310
  export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
@@ -6993,7 +7352,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6993
7352
  }
6994
7353
  /**
6995
7354
  * @title The Big POS API
6996
- * @version v3.15.0
7355
+ * @version v3.16.0
6997
7356
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6998
7357
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6999
7358
  */
@@ -8503,6 +8862,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8503
8862
  * @response `200` `BusinessRule` OK
8504
8863
  */
8505
8864
  restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any, {}>>;
8865
+ /**
8866
+ * No description
8867
+ *
8868
+ * @tags Canvases
8869
+ * @name GetCanvas
8870
+ * @summary Get a site's canvas for one surface, as the signed-in user sees it
8871
+ * @request GET:/api/canvases/{surface}
8872
+ * @secure
8873
+ * @response `200` `CanvasView` OK
8874
+ * @response `400` `ProblemDetails` Bad Request
8875
+ * @response `404` `ProblemDetails` Not Found
8876
+ * @response `422` `ProblemDetails` Unprocessable Content
8877
+ */
8878
+ getCanvas: (surface: GetCanvasParamsEnum, query: {
8879
+ /** @format uuid */
8880
+ siteConfigurationId: string;
8881
+ }, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
8882
+ /**
8883
+ * @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.
8884
+ *
8885
+ * @tags CanvasFields
8886
+ * @name GetCanvasFields
8887
+ * @summary Get the fields a canvas can show
8888
+ * @request GET:/api/canvas/fields
8889
+ * @secure
8890
+ * @response `200` `CanvasFieldCatalog` OK
8891
+ * @response `403` `ProblemDetails` Forbidden
8892
+ * @response `404` `ProblemDetails` Not Found
8893
+ */
8894
+ getCanvasFields: (params?: RequestParams) => Promise<AxiosResponse<CanvasFieldCatalog, any, {}>>;
8895
+ /**
8896
+ * No description
8897
+ *
8898
+ * @tags CanvasWidgetTypes
8899
+ * @name GetCanvasWidgetTypes
8900
+ * @summary Get canvas widget types
8901
+ * @request GET:/api/canvas/widget-types
8902
+ * @secure
8903
+ * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
8904
+ * @response `403` `ProblemDetails` Forbidden
8905
+ * @response `404` `ProblemDetails` Not Found
8906
+ */
8907
+ getCanvasWidgetTypes: (params?: RequestParams) => Promise<AxiosResponse<CanvasWidgetTypeDescriptor[], any, {}>>;
8506
8908
  /**
8507
8909
  * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
8508
8910
  *
@@ -10324,6 +10726,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10324
10726
  * @response `423` `UnprocessableEntity` Locked
10325
10727
  */
10326
10728
  runLoanCalculator: (loanId: string, data: RunLOCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<RunLOCalculation, any, {}>>;
10729
+ /**
10730
+ * No description
10731
+ *
10732
+ * @tags LoanCanvasFieldValues
10733
+ * @name GetLoanCanvasFieldValues
10734
+ * @summary Get a loan's values for canvas fields
10735
+ * @request POST:/api/loans/{loanId}/canvas/field-values
10736
+ * @secure
10737
+ * @response `200` `CanvasFieldValues` OK
10738
+ * @response `400` `ProblemDetails` Bad Request
10739
+ * @response `403` `ProblemDetails` Forbidden
10740
+ * @response `404` `ProblemDetails` Not Found
10741
+ * @response `422` `ProblemDetails` Unprocessable Content
10742
+ */
10743
+ getLoanCanvasFieldValues: (loanId: string, data: CanvasFieldValuesRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasFieldValues, any, {}>>;
10327
10744
  /**
10328
10745
  * No description
10329
10746
  *
@@ -11464,6 +11881,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11464
11881
  * @response `404` `ProblemDetails` Not Found
11465
11882
  */
11466
11883
  triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}>>;
11884
+ /**
11885
+ * No description
11886
+ *
11887
+ * @tags LoanSigningMethod
11888
+ * @name UpdateLoanSigningMethod
11889
+ * @summary Switch the loan's signing method
11890
+ * @request PUT:/api/loans/{loanId}/signing-method
11891
+ * @secure
11892
+ * @response `204` `void` No Content
11893
+ * @response `403` `ProblemDetails` Forbidden
11894
+ * @response `404` `ProblemDetails` Not Found
11895
+ * @response `422` `ProblemDetails` Unprocessable Content
11896
+ */
11897
+ updateLoanSigningMethod: (loanId: string, data: UpdateLoanSigningMethodRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11467
11898
  /**
11468
11899
  * No description
11469
11900
  *
@@ -12290,6 +12721,104 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12290
12721
  replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
12291
12722
  applyToChildren?: boolean;
12292
12723
  }, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
12724
+ /**
12725
+ * No description
12726
+ *
12727
+ * @tags SiteConfigurationCanvases
12728
+ * @name GetSiteConfigurationCanvases
12729
+ * @summary Get a site's canvases: own, inherited and effective per surface
12730
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
12731
+ * @secure
12732
+ * @response `200` `SiteConfigurationCanvases` OK
12733
+ * @response `403` `ProblemDetails` Forbidden
12734
+ * @response `404` `ProblemDetails` Not Found
12735
+ */
12736
+ getSiteConfigurationCanvases: (siteConfigurationId: string, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationCanvases, any, {}>>;
12737
+ /**
12738
+ * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
12739
+ *
12740
+ * @tags SiteConfigurationCanvases
12741
+ * @name SaveSiteConfigurationCanvas
12742
+ * @summary Save a site's canvas for one surface
12743
+ * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
12744
+ * @secure
12745
+ * @response `200` `CanvasSurfaceState` OK
12746
+ * @response `400` `ProblemDetails` Bad Request
12747
+ * @response `403` `ProblemDetails` Forbidden
12748
+ * @response `404` `ProblemDetails` Not Found
12749
+ * @response `409` `ProblemDetails` Conflict
12750
+ * @response `422` `ProblemDetails` Unprocessable Content
12751
+ * @response `423` `ProblemDetails` Locked
12752
+ */
12753
+ saveSiteConfigurationCanvas: (siteConfigurationId: string, surface: SaveSiteConfigurationCanvasParamsEnum, data: SaveSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
12754
+ /**
12755
+ * No description
12756
+ *
12757
+ * @tags SiteConfigurationCanvases
12758
+ * @name DeleteSiteConfigurationCanvas
12759
+ * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
12760
+ * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
12761
+ * @secure
12762
+ * @response `204` `void` No Content
12763
+ * @response `400` `ProblemDetails` Bad Request
12764
+ * @response `403` `ProblemDetails` Forbidden
12765
+ * @response `404` `ProblemDetails` Not Found
12766
+ * @response `409` `ProblemDetails` Conflict
12767
+ * @response `422` `ProblemDetails` Unprocessable Content
12768
+ */
12769
+ deleteSiteConfigurationCanvas: (siteConfigurationId: string, surface: DeleteSiteConfigurationCanvasParamsEnum, query: {
12770
+ /**
12771
+ * The canvas Version the caller last read. A delete over a newer save is refused as stale.
12772
+ * @format int32
12773
+ */
12774
+ expectedVersion: number;
12775
+ }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
12776
+ /**
12777
+ * No description
12778
+ *
12779
+ * @tags SiteConfigurationCanvases
12780
+ * @name PreviewSiteConfigurationCanvas
12781
+ * @summary Preview an unsaved canvas for one surface as a role would see it
12782
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
12783
+ * @secure
12784
+ * @response `200` `CanvasView` OK
12785
+ * @response `400` `ProblemDetails` Bad Request
12786
+ * @response `403` `ProblemDetails` Forbidden
12787
+ * @response `404` `ProblemDetails` Not Found
12788
+ * @response `422` `ProblemDetails` Unprocessable Content
12789
+ */
12790
+ previewSiteConfigurationCanvas: (siteConfigurationId: string, surface: PreviewSiteConfigurationCanvasParamsEnum, data: PreviewSiteConfigurationCanvasRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasView, any, {}>>;
12791
+ /**
12792
+ * No description
12793
+ *
12794
+ * @tags SiteConfigurationCanvases
12795
+ * @name GetSiteConfigurationCanvasVersions
12796
+ * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
12797
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
12798
+ * @secure
12799
+ * @response `200` `(CanvasVersion)[]` OK
12800
+ * @response `403` `ProblemDetails` Forbidden
12801
+ * @response `404` `ProblemDetails` Not Found
12802
+ * @response `422` `ProblemDetails` Unprocessable Content
12803
+ */
12804
+ getSiteConfigurationCanvasVersions: (siteConfigurationId: string, surface: GetSiteConfigurationCanvasVersionsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<CanvasVersion[], any, {}>>;
12805
+ /**
12806
+ * No description
12807
+ *
12808
+ * @tags SiteConfigurationCanvases
12809
+ * @name RestoreSiteConfigurationCanvasVersion
12810
+ * @summary Restore a saved version of a site's canvas as a new version
12811
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
12812
+ * @secure
12813
+ * @response `200` `CanvasSurfaceState` OK
12814
+ * @response `400` `ProblemDetails` Bad Request
12815
+ * @response `403` `ProblemDetails` Forbidden
12816
+ * @response `404` `ProblemDetails` Not Found
12817
+ * @response `409` `ProblemDetails` Conflict
12818
+ * @response `422` `ProblemDetails` Unprocessable Content
12819
+ * @response `423` `ProblemDetails` Locked
12820
+ */
12821
+ restoreSiteConfigurationCanvasVersion: (siteConfigurationId: string, surface: RestoreSiteConfigurationCanvasVersionParamsEnum, version: number, data: RestoreSiteConfigurationCanvasVersionRequest, params?: RequestParams) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
12293
12822
  /**
12294
12823
  * No description
12295
12824
  *
@@ -13632,3 +14161,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13632
14161
  logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
13633
14162
  };
13634
14163
  }
14164
+ export {};