@matech/thebigpos-sdk 3.15.0-dev-6040 → 3.15.0-main-6054

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,4 +1,3 @@
1
- type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
2
1
  export type VersionStatusType = "Draft" | "Published";
3
2
  export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
4
3
  export type TaskType = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
@@ -26,7 +25,6 @@ export type LoanRoleTaskSource = "Rule" | "Manual";
26
25
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
27
26
  export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
28
27
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
29
- export type LoanRealEstatePropertyType = "SingleFamily" | "Condominium" | "Townhouse" | "Cooperative" | "TwoToFourUnitProperty" | "MultifamilyMoreThanFourUnits" | "ManufacturedMobileHome" | "CommercialNonResidential" | "HomeAndBusinessCombined" | "MixedUseResidential" | "Farm" | "Land";
30
28
  export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
31
29
  export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
32
30
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
@@ -44,7 +42,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
44
42
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
45
43
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
46
44
  export type LoanMaritalStatus = "Married" | "Separated" | "Single";
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";
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";
48
46
  export type LoanLienPosition = "First" | "Subordinate";
49
47
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
50
48
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
@@ -88,15 +86,6 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
88
86
  export type CompanyDocumentSourceType = "File" | "FreeText";
89
87
  export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
90
88
  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";
100
89
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
101
90
  export type BranchType = "Mortgage" | "RealEstate";
102
91
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -115,7 +104,6 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
115
104
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
116
105
  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";
117
106
  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>);
119
107
  export interface ASOSettings {
120
108
  enabled: boolean;
121
109
  softPull: boolean;
@@ -434,7 +422,7 @@ export interface AiAuditLog {
434
422
  guardrailCategory?: string | null;
435
423
  rawRequest?: string | null;
436
424
  rawResponse?: string | null;
437
- details?: any | null;
425
+ details: any;
438
426
  /** @format date-time */
439
427
  createdAt: string;
440
428
  }
@@ -906,9 +894,6 @@ export interface AmortizationSchedule {
906
894
  /** @format double */
907
895
  pmi: number;
908
896
  }
909
- export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
910
- type: AmortizationWidgetConfigTypeEnum;
911
- };
912
897
  export interface ApplicationRowData {
913
898
  borrowerEmail?: string | null;
914
899
  borrowerFirstName?: string | null;
@@ -981,7 +966,7 @@ export interface AuditLogEntry {
981
966
  rootEntityType?: string | null;
982
967
  /** @format uuid */
983
968
  rootEntityId?: string | null;
984
- changes?: any | null;
969
+ changes: any;
985
970
  /** @format date-time */
986
971
  createdAt: string;
987
972
  }
@@ -1159,173 +1144,6 @@ export interface BusinessRuleRequest {
1159
1144
  filter: BusinessRuleCondition[];
1160
1145
  applyToAllBorrowerPairs: boolean;
1161
1146
  }
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
- }
1329
1147
  export interface ChangePasswordRequest {
1330
1148
  oldPassword: string;
1331
1149
  newPassword: string;
@@ -1356,13 +1174,6 @@ export interface ClosedLoansReportRequest {
1356
1174
  /** @format date */
1357
1175
  endDate: string;
1358
1176
  }
1359
- export type ClosingSoonWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
1360
- /** @format int32 */
1361
- withinDays: number;
1362
- /** @format int32 */
1363
- maxItems: number;
1364
- type: ClosingSoonWidgetConfigTypeEnum;
1365
- };
1366
1177
  export interface CommentUserInformation {
1367
1178
  entityId: string;
1368
1179
  entityType: string;
@@ -1958,12 +1769,6 @@ export interface DocumentTemplateVersionUpdateRequest {
1958
1769
  isActive: boolean;
1959
1770
  htmlBody: string;
1960
1771
  }
1961
- export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
1962
- /** @format int32 */
1963
- maxItems: number;
1964
- onlyOutstanding: boolean;
1965
- type: DocumentsWidgetConfigTypeEnum;
1966
- };
1967
1772
  export interface Draft {
1968
1773
  /** @format date-time */
1969
1774
  createdAt: string;
@@ -2013,7 +1818,7 @@ export interface DraftLoanOfficerReassignRequest {
2013
1818
  }
2014
1819
  export interface DraftRequest {
2015
1820
  applicationPayload: any;
2016
- customData?: any | null;
1821
+ customData: any;
2017
1822
  isCoBorrower: boolean;
2018
1823
  }
2019
1824
  export interface EconsentPendingSummary {
@@ -2238,7 +2043,7 @@ export interface EncompassRequestLog {
2238
2043
  httpStatusCode?: number | null;
2239
2044
  /** @format int64 */
2240
2045
  durationMs?: number | null;
2241
- context?: any | null;
2046
+ context: any;
2242
2047
  /** @format date-time */
2243
2048
  createdAt: string;
2244
2049
  }
@@ -2262,9 +2067,6 @@ export interface EncompassWebhookSubscription {
2262
2067
  export interface Error {
2263
2068
  message: string;
2264
2069
  }
2265
- export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
2266
- type: EsignStatusWidgetConfigTypeEnum;
2267
- };
2268
2070
  export interface FailureBucket {
2269
2071
  /** @format date-time */
2270
2072
  startUtc: string;
@@ -2370,7 +2172,7 @@ export interface FormSubmission {
2370
2172
  subjectPropertyAddressCounty?: string | null;
2371
2173
  subjectPropertyAddressState?: string | null;
2372
2174
  subjectPropertyAddressZip?: string | null;
2373
- data?: any | null;
2175
+ data: any;
2374
2176
  /** @format uuid */
2375
2177
  listingID?: string | null;
2376
2178
  listing?: Listing | null;
@@ -2412,7 +2214,7 @@ export interface FormSubmissionRequest {
2412
2214
  subjectPropertyAddressCounty?: string | null;
2413
2215
  subjectPropertyAddressState?: string | null;
2414
2216
  subjectPropertyAddressZip?: string | null;
2415
- data?: any | null;
2217
+ data: any;
2416
2218
  /** @format uuid */
2417
2219
  listingID?: string | null;
2418
2220
  }
@@ -2544,7 +2346,7 @@ export interface GetWorkflowRequest {
2544
2346
  export interface GuidPatchOperation {
2545
2347
  op: string;
2546
2348
  path: string;
2547
- value?: any | null;
2349
+ value: any;
2548
2350
  from?: string | null;
2549
2351
  }
2550
2352
  export interface HttpError {
@@ -2617,7 +2419,6 @@ export interface InProgressLoan {
2617
2419
  siteConfigurationId?: string | null;
2618
2420
  /** @format date-time */
2619
2421
  updatedAt?: string | null;
2620
- applicationSession?: LoanApplicationSessionRoute | null;
2621
2422
  }
2622
2423
  export interface IncompleteApplicationSummary {
2623
2424
  /** @format int32 */
@@ -2651,7 +2452,6 @@ export interface IncompleteLoanBorrower {
2651
2452
  applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
2652
2453
  /** @format date-time */
2653
2454
  deletedAt?: string | null;
2654
- applicationSession?: LoanApplicationSessionRoute | null;
2655
2455
  }
2656
2456
  export interface IncompleteLoanDraft {
2657
2457
  /** @format uuid */
@@ -2681,15 +2481,6 @@ export interface IncompleteLoanSiteConfiguration {
2681
2481
  id: string;
2682
2482
  name: string;
2683
2483
  }
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
- };
2693
2484
  export interface IntegrationSettings {
2694
2485
  encompass?: EncompassIntegrationSettings | null;
2695
2486
  }
@@ -2724,16 +2515,6 @@ export interface Invite {
2724
2515
  }
2725
2516
  /** Array of operations to perform */
2726
2517
  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
- };
2737
2518
  export interface LOSIntegration {
2738
2519
  instanceID: string;
2739
2520
  }
@@ -2965,9 +2746,6 @@ export interface LoanApplicationSessionRequest {
2965
2746
  currentQuestionId?: string | null;
2966
2747
  questionHistory: string[];
2967
2748
  }
2968
- export interface LoanApplicationSessionRoute {
2969
- routeName: string;
2970
- }
2971
2749
  export interface LoanBorrower {
2972
2750
  /** @format uuid */
2973
2751
  id: string;
@@ -2988,8 +2766,6 @@ export interface LoanBorrower {
2988
2766
  numberOfDependents?: number | null;
2989
2767
  /** @format int32 */
2990
2768
  creditDecisionScore?: number | null;
2991
- /** @format int32 */
2992
- estimatedCreditScore?: number | null;
2993
2769
  isPrimaryBorrower: boolean;
2994
2770
  isFirstTimeHomeBuyer?: boolean | null;
2995
2771
  hasJointAssetsAndLiabilities?: boolean | null;
@@ -3340,12 +3116,6 @@ export interface LoanBorrowerEmploymentPrevious {
3340
3116
  /** @format double */
3341
3117
  grossIncome?: number | null;
3342
3118
  isSelfEmployed?: boolean | null;
3343
- /** @format double */
3344
- bonus?: number | null;
3345
- /** @format double */
3346
- overtime?: number | null;
3347
- /** @format double */
3348
- commission?: number | null;
3349
3119
  address?: AddressV3 | null;
3350
3120
  }
3351
3121
  export interface LoanBorrowerEmploymentPreviousRequest {
@@ -3359,12 +3129,6 @@ export interface LoanBorrowerEmploymentPreviousRequest {
3359
3129
  /** @format double */
3360
3130
  grossIncome?: number | null;
3361
3131
  isSelfEmployed?: boolean | null;
3362
- /** @format double */
3363
- bonus?: number | null;
3364
- /** @format double */
3365
- overtime?: number | null;
3366
- /** @format double */
3367
- commission?: number | null;
3368
3132
  address?: AddressRequest | null;
3369
3133
  }
3370
3134
  export interface LoanBorrowerGift {
@@ -3554,7 +3318,6 @@ export interface LoanBorrowerRealEstateAsset {
3554
3318
  occupancy?: LoanRealEstateOccupancyType | null;
3555
3319
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
3556
3320
  intendedUsageOtherDescription?: string | null;
3557
- propertyType?: LoanRealEstatePropertyType | null;
3558
3321
  /** @format double */
3559
3322
  marketValue?: number | null;
3560
3323
  /** @format double */
@@ -3612,7 +3375,6 @@ export interface LoanBorrowerRealEstateAssetRequest {
3612
3375
  occupancy?: LoanRealEstateOccupancyType | null;
3613
3376
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
3614
3377
  intendedUsageOtherDescription?: string | null;
3615
- propertyType?: LoanRealEstatePropertyType | null;
3616
3378
  /** @format double */
3617
3379
  marketValue?: number | null;
3618
3380
  /** @format double */
@@ -3647,8 +3409,6 @@ export interface LoanBorrowerRequest {
3647
3409
  isFirstTimeHomeBuyer?: boolean | null;
3648
3410
  hasJointAssetsAndLiabilities?: boolean | null;
3649
3411
  dependentAges?: number[] | null;
3650
- /** @format int32 */
3651
- estimatedCreditScore?: number | null;
3652
3412
  demographics?: LoanBorrowerDemographicsRequest | null;
3653
3413
  declarations?: LoanBorrowerDeclarationsRequest | null;
3654
3414
  militaryService?: LoanBorrowerMilitaryServiceRequest | null;
@@ -4251,9 +4011,6 @@ export interface LoanOutstandingItems {
4251
4011
  export interface LoanPatchRequestGuidPatchDocument {
4252
4012
  operations: GuidPatchOperation[];
4253
4013
  }
4254
- export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4255
- type: LoanProgressWidgetConfigTypeEnum;
4256
- };
4257
4014
  export interface LoanProperty {
4258
4015
  /** @format uuid */
4259
4016
  id?: string | null;
@@ -4382,7 +4139,7 @@ export interface LoanQueueWithData {
4382
4139
  user: UserPublic;
4383
4140
  loanOfficer: LoanOfficerPublic;
4384
4141
  siteConfiguration: SiteConfigurationReduced;
4385
- data?: any | null;
4142
+ data: any;
4386
4143
  }
4387
4144
  export interface LoanRecommendation {
4388
4145
  /** @format uuid */
@@ -4391,7 +4148,7 @@ export interface LoanRecommendation {
4391
4148
  displayName: string;
4392
4149
  extractedValue: string;
4393
4150
  mintable: boolean;
4394
- currentLoanValue?: any | null;
4151
+ currentLoanValue: any;
4395
4152
  /** @format uuid */
4396
4153
  sourceDocumentId: string;
4397
4154
  sourceDocumentName?: string | null;
@@ -4557,9 +4314,6 @@ export interface LoanTaskStatusSummary {
4557
4314
  /** @format int32 */
4558
4315
  count: number;
4559
4316
  }
4560
- export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4561
- type: LoanTeamWidgetConfigTypeEnum;
4562
- };
4563
4317
  export interface LoanUser {
4564
4318
  /** @format uuid */
4565
4319
  id: string;
@@ -4923,7 +4677,7 @@ export interface ModuleParameterValue {
4923
4677
  parameterID: string;
4924
4678
  parameterName: string;
4925
4679
  parameterType: string;
4926
- value?: any | null;
4680
+ value: any;
4927
4681
  isInherited: boolean;
4928
4682
  }
4929
4683
  export interface MonthlyPaymentCalculator {
@@ -4957,16 +4711,6 @@ export interface MonthlyPaymentCalculatorRequest {
4957
4711
  /** @format int32 */
4958
4712
  term: number;
4959
4713
  }
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
- };
4970
4714
  export interface NoContentResult {
4971
4715
  /** @format int32 */
4972
4716
  statusCode: number;
@@ -5104,11 +4848,6 @@ export interface NotificationTemplateVersionUpdateRequest {
5104
4848
  textBody?: string | null;
5105
4849
  pushNotificationBody?: string | null;
5106
4850
  }
5107
- export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5108
- /** @format int32 */
5109
- maxItems: number;
5110
- type: OpenTasksWidgetConfigTypeEnum;
5111
- };
5112
4851
  export interface Operation {
5113
4852
  op?: string;
5114
4853
  value?: string | number | boolean | null | object;
@@ -5244,13 +4983,6 @@ export interface PreliminaryCondition {
5244
4983
  rerequestedDate?: string | null;
5245
4984
  rerequestedBy?: CommentUserInformation | null;
5246
4985
  }
5247
- export interface PreviewSiteConfigurationCanvasRequest {
5248
- document: CanvasDocument;
5249
- role?: UserRole | null;
5250
- }
5251
- export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5252
- type: PrimaryBorrowerWidgetConfigTypeEnum;
5253
- };
5254
4986
  export interface ProblemDetails {
5255
4987
  type?: string | null;
5256
4988
  title?: string | null;
@@ -5260,11 +4992,6 @@ export interface ProblemDetails {
5260
4992
  instance?: string | null;
5261
4993
  [key: string]: any;
5262
4994
  }
5263
- export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5264
- /** @format int32 */
5265
- maxItems: number;
5266
- type: RecentLoansWidgetConfigTypeEnum;
5267
- };
5268
4995
  export interface RefinanceCalculator {
5269
4996
  currentLoan: RefinanceLoan;
5270
4997
  refinanceLoan: RefinanceLoan;
@@ -5372,15 +5099,6 @@ export interface ResetPasswordRequest {
5372
5099
  token: string;
5373
5100
  password: string;
5374
5101
  }
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
- }
5384
5102
  export interface RunLOCalculation {
5385
5103
  loanID: string;
5386
5104
  loanAmount?: string | null;
@@ -5457,22 +5175,9 @@ export interface SSOTokenRequest {
5457
5175
  email: string;
5458
5176
  redirectUri?: string | null;
5459
5177
  }
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
- }
5469
5178
  export interface SearchCriteria {
5470
5179
  searchText?: string | null;
5471
5180
  }
5472
- export type SectionDividerWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
5473
- label?: string | null;
5474
- type: SectionDividerWidgetConfigTypeEnum;
5475
- };
5476
5181
  export interface SendESignatureReminderRequest {
5477
5182
  /** @format uuid */
5478
5183
  userId: string;
@@ -5901,11 +5606,6 @@ export interface SiteConfigurationByUrl {
5901
5606
  losSettings?: LOSSettings | null;
5902
5607
  workflows: Workflow[];
5903
5608
  }
5904
- export interface SiteConfigurationCanvases {
5905
- /** @format uuid */
5906
- siteConfigurationID: string;
5907
- surfaces: CanvasSurfaceState[];
5908
- }
5909
5609
  export interface SiteConfigurationForm {
5910
5610
  /** @format date-time */
5911
5611
  createdAt: string;
@@ -6381,10 +6081,6 @@ export interface TemplateTokenRoot {
6381
6081
  displayName: string;
6382
6082
  fields: TemplateToken[];
6383
6083
  }
6384
- export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
6385
- text: string;
6386
- type: TextBlockWidgetConfigTypeEnum;
6387
- };
6388
6084
  export interface Theme {
6389
6085
  logoURL: string;
6390
6086
  primaryColor: string;
@@ -6480,8 +6176,6 @@ export interface UnprocessableEntity {
6480
6176
  export interface UnprocessableEntityError {
6481
6177
  error: string;
6482
6178
  property: string;
6483
- code?: string | null;
6484
- params?: Record<string, any> | null;
6485
6179
  }
6486
6180
  export interface UnregisteredBorrower {
6487
6181
  /** @format uuid */
@@ -6618,9 +6312,6 @@ export interface UpdateLoanRoleTaskRequest {
6618
6312
  /** @format date */
6619
6313
  dueDate?: string | null;
6620
6314
  }
6621
- export interface UpdateLoanSigningMethodRequest {
6622
- signingMethod?: SigningMethod | null;
6623
- }
6624
6315
  export interface UpdateMeRequest {
6625
6316
  phone?: string | null;
6626
6317
  firstName: string;
@@ -7144,12 +6835,6 @@ export interface Workflow {
7144
6835
  tileSubtitle: string;
7145
6836
  icon: string;
7146
6837
  }
7147
- interface BaseCanvasWidgetConfig {
7148
- type: string;
7149
- }
7150
- type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
7151
- type: Key;
7152
- } & Type;
7153
6838
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
7154
6839
  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";
7155
6840
  export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
@@ -7158,26 +6843,9 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
7158
6843
  export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
7159
6844
  export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
7160
6845
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
7161
- export type AmortizationWidgetConfigTypeEnum = "Amortization";
7162
6846
  export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
7163
6847
  export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7164
6848
  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";
7181
6849
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
7182
6850
  export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
7183
6851
  export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
@@ -7204,7 +6872,6 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
7204
6872
  export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
7205
6873
  export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
7206
6874
  export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
7207
- export type DocumentsWidgetConfigTypeEnum = "Documents";
7208
6875
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
7209
6876
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
7210
6877
  export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
@@ -7214,15 +6881,10 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
7214
6881
  export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
7215
6882
  export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
7216
6883
  export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
7217
- export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
7218
6884
  export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
7219
6885
  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";
7220
6886
  export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
7221
6887
  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";
7226
6888
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
7227
6889
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
7228
6890
  export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
@@ -7237,16 +6899,14 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
7237
6899
  export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
7238
6900
  export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
7239
6901
  export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
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";
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";
7241
6903
  export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
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";
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";
7244
6905
  export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7245
6906
  export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7246
6907
  export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
7247
6908
  export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
7248
6909
  export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
7249
- export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
7250
6910
  export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7251
6911
  export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
7252
6912
  export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
@@ -7260,14 +6920,8 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
7260
6920
  export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
7261
6921
  export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
7262
6922
  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";
7266
6923
  export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
7267
6924
  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";
7271
6925
  export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
7272
6926
  export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
7273
6927
  export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -7278,7 +6932,6 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
7278
6932
  export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
7279
6933
  export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
7280
6934
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
7281
- export type TextBlockWidgetConfigTypeEnum = "TextBlock";
7282
6935
  export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7283
6936
  export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
7284
6937
  export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
@@ -7290,21 +6943,9 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
7290
6943
  export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
7291
6944
  export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
7292
6945
  export type UserTableSettingsTableKeyEnum = "Pipeline";
7293
- export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
7294
- export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
7295
6946
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
7296
6947
  /** @default "Realtor" */
7297
6948
  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";
7308
6949
  export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
7309
6950
  export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
7310
6951
  export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
@@ -8862,49 +8503,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8862
8503
  * @response `200` `BusinessRule` OK
8863
8504
  */
8864
8505
  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, {}>>;
8908
8506
  /**
8909
8507
  * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
8910
8508
  *
@@ -10726,21 +10324,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10726
10324
  * @response `423` `UnprocessableEntity` Locked
10727
10325
  */
10728
10326
  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, {}>>;
10744
10327
  /**
10745
10328
  * No description
10746
10329
  *
@@ -11881,20 +11464,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11881
11464
  * @response `404` `ProblemDetails` Not Found
11882
11465
  */
11883
11466
  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, {}>>;
11898
11467
  /**
11899
11468
  * No description
11900
11469
  *
@@ -12721,104 +12290,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12721
12290
  replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
12722
12291
  applyToChildren?: boolean;
12723
12292
  }, 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, {}>>;
12822
12293
  /**
12823
12294
  * No description
12824
12295
  *
@@ -14161,4 +13632,3 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14161
13632
  logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
14162
13633
  };
14163
13634
  }
14164
- export {};