@matech/thebigpos-sdk 2.48.0-rc3 → 2.48.0-rc5

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
@@ -65,8 +65,6 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
65
65
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
66
66
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
67
67
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
68
- export type CompanyDocumentSourceType = "File" | "FreeText";
69
- export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
70
68
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
71
69
  export type BranchType = "Mortgage" | "RealEstate";
72
70
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -76,7 +74,7 @@ export type BillingType = "ClosedLoan" | "LoanOfficer";
76
74
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
77
75
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
78
76
  export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
79
- export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
77
+ export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
80
78
  export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility" | "OutstandingTasks" | "ConsentTracking" | "TaskStatusBreakdown" | "ConsentSyncHealth";
81
79
  export type AiPromptScope = "General" | "LoanSpecific";
82
80
  export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
@@ -84,7 +82,7 @@ export type AiOutputType = "Text" | "Document";
84
82
  export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
85
83
  export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
86
84
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
87
- 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";
85
+ 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";
88
86
  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";
89
87
  export interface ASOSettings {
90
88
  enabled: boolean;
@@ -135,7 +133,7 @@ export interface AccountBilling {
135
133
  contractedRate: number;
136
134
  }
137
135
  export interface AccountBillingRequest {
138
- billingType: "ClosedLoan" | "LoanOfficer";
136
+ billingType: AccountBillingRequestBillingTypeEnum;
139
137
  /** @format double */
140
138
  contractedRate: number;
141
139
  }
@@ -183,7 +181,7 @@ export interface Action {
183
181
  comments?: string | null;
184
182
  /** @format uuid */
185
183
  siteConfigurationID: string;
186
- applicationSettings?: any;
184
+ applicationSettings?: any | null;
187
185
  surveysToken?: string | null;
188
186
  }
189
187
  export interface Address {
@@ -406,7 +404,7 @@ export interface AiAuditLog {
406
404
  conversationId?: string | null;
407
405
  /** @format uuid */
408
406
  messageId?: string | null;
409
- eventType: "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";
407
+ eventType: AiAuditLogEventTypeEnum;
410
408
  modelId?: string | null;
411
409
  /** @format int32 */
412
410
  inputTokens?: number | null;
@@ -419,7 +417,7 @@ export interface AiAuditLog {
419
417
  guardrailCategory?: string | null;
420
418
  rawRequest?: string | null;
421
419
  rawResponse?: string | null;
422
- details?: any;
420
+ details?: any | null;
423
421
  /** @format date-time */
424
422
  createdAt: string;
425
423
  }
@@ -481,7 +479,7 @@ export interface AiChatMessagePaginated {
481
479
  count: number;
482
480
  }
483
481
  export interface AiChatMetadata {
484
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
482
+ intent: AiChatMetadataIntentEnum;
485
483
  fieldsAccessed: string[];
486
484
  /** @format int64 */
487
485
  queryTimeMs: number;
@@ -507,7 +505,7 @@ export interface AiChatRequest {
507
505
  promptId?: string | null;
508
506
  }
509
507
  export interface AiChatStructuredData {
510
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
508
+ type: AiChatStructuredDataTypeEnum;
511
509
  displayHint?: AiDisplayHint | null;
512
510
  detectedDocumentType?: string | null;
513
511
  columns: string[];
@@ -515,14 +513,6 @@ export interface AiChatStructuredData {
515
513
  /** @format uuid */
516
514
  generatedDocumentId?: string | null;
517
515
  generatedFileName?: string | null;
518
- passages?: AiCitedPassage[] | null;
519
- }
520
- export interface AiCitedPassage {
521
- folderName: string;
522
- documentName: string;
523
- excerpt: string;
524
- /** @format double */
525
- score?: number | null;
526
516
  }
527
517
  export interface AiConversationAuditSummary {
528
518
  /** @format uuid */
@@ -593,7 +583,7 @@ export interface AiGuardrail {
593
583
  /** @format uuid */
594
584
  id: string;
595
585
  name: string;
596
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
586
+ category: AiGuardrailCategoryEnum;
597
587
  description?: string | null;
598
588
  keywords: string[];
599
589
  responseTemplate: string;
@@ -613,7 +603,6 @@ export interface AiPrompt {
613
603
  description: string;
614
604
  documentTypes: string[];
615
605
  applicableUrlSourceIds: string[];
616
- knowledgeBaseFolderIds: string[];
617
606
  allowedRoles: string[];
618
607
  systemPrompt: string;
619
608
  /** @format int32 */
@@ -721,8 +710,8 @@ export interface AiUrlSource {
721
710
  name: string;
722
711
  url: string;
723
712
  description?: string | null;
724
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
725
- scope: "FullDomain" | "SpecificPath";
713
+ category: AiUrlSourceCategoryEnum;
714
+ scope: AiUrlSourceScopeEnum;
726
715
  isActive: boolean;
727
716
  isDefault: boolean;
728
717
  hasAccountOverride: boolean;
@@ -829,14 +818,14 @@ export interface AuditLogEntry {
829
818
  /** @format uuid */
830
819
  id: string;
831
820
  entityType: string;
832
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
821
+ changeType: AuditLogEntryChangeTypeEnum;
833
822
  /** @format uuid */
834
823
  entityId: string;
835
824
  performedBy?: AuditLogUser | null;
836
825
  rootEntityType?: string | null;
837
826
  /** @format uuid */
838
827
  rootEntityId?: string | null;
839
- changes?: any;
828
+ changes?: any | null;
840
829
  /** @format date-time */
841
830
  createdAt: string;
842
831
  }
@@ -876,7 +865,7 @@ export interface BorrowerCount {
876
865
  firstName: string;
877
866
  lastName: string;
878
867
  email: string;
879
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
868
+ role: BorrowerCountRoleEnum;
880
869
  /** @format int32 */
881
870
  count: number;
882
871
  }
@@ -886,7 +875,7 @@ export interface BorrowerIdentity {
886
875
  firstName: string;
887
876
  lastName: string;
888
877
  email: string;
889
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
878
+ role: BorrowerIdentityRoleEnum;
890
879
  }
891
880
  export interface BorrowersNotUsingPosSummary {
892
881
  /** @format int32 */
@@ -1047,55 +1036,6 @@ export interface CompanyAddress {
1047
1036
  state: string;
1048
1037
  zip: string;
1049
1038
  }
1050
- export interface CompanyDocument {
1051
- /** @format uuid */
1052
- id: string;
1053
- /** @format uuid */
1054
- folderId: string;
1055
- folderName: string;
1056
- name: string;
1057
- sourceType: "File" | "FreeText";
1058
- contentType?: string | null;
1059
- /** @format int64 */
1060
- fileSizeBytes: number;
1061
- inlineContent?: string | null;
1062
- indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1063
- indexError?: string | null;
1064
- /** @format date-time */
1065
- indexedAt?: string | null;
1066
- /** @format uuid */
1067
- uploadedByUserId?: string | null;
1068
- /** @format date-time */
1069
- createdAt: string;
1070
- /** @format date-time */
1071
- updatedAt?: string | null;
1072
- }
1073
- export interface CompanyDocumentFolder {
1074
- /** @format uuid */
1075
- id: string;
1076
- name: string;
1077
- description?: string | null;
1078
- isSystemDefault: boolean;
1079
- /** @format int32 */
1080
- documentCount: number;
1081
- /** @format date-time */
1082
- createdAt: string;
1083
- /** @format date-time */
1084
- updatedAt?: string | null;
1085
- }
1086
- export interface CompanyDocumentPaginated {
1087
- rows: CompanyDocument[];
1088
- pagination: Pagination;
1089
- /** @format int64 */
1090
- count: number;
1091
- }
1092
- export interface CompanyDocumentSearchCriteria {
1093
- searchText?: string | null;
1094
- /** @format uuid */
1095
- folderID?: string | null;
1096
- indexStatuses?: CompanyDocumentIndexStatus[] | null;
1097
- sourceType?: CompanyDocumentSourceType | null;
1098
- }
1099
1039
  export interface ConditionComment {
1100
1040
  commentId: string;
1101
1041
  comments: string;
@@ -1170,7 +1110,7 @@ export interface CorporateSearchCriteria {
1170
1110
  isActive?: boolean | null;
1171
1111
  }
1172
1112
  export interface CreateAccessScopeRequest {
1173
- scopeType: "User" | "Branch";
1113
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1174
1114
  /** @format uuid */
1175
1115
  userId?: string | null;
1176
1116
  /** @format uuid */
@@ -1188,7 +1128,7 @@ export interface CreateAccountRequest {
1188
1128
  /** @format int64 */
1189
1129
  nlmsid: number;
1190
1130
  settings: AccountSettingsRequest;
1191
- environment: "Development" | "Staging" | "UAT" | "Production";
1131
+ environment: CreateAccountRequestEnvironmentEnum;
1192
1132
  losIntegration: LOSIntegration;
1193
1133
  billingSettings: AccountBillingRequest;
1194
1134
  }
@@ -1202,7 +1142,7 @@ export interface CreateAiCanonicalFieldRequest {
1202
1142
  }
1203
1143
  export interface CreateAiGuardrailRequest {
1204
1144
  name: string;
1205
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1145
+ category: CreateAiGuardrailRequestCategoryEnum;
1206
1146
  description?: string | null;
1207
1147
  keywords: string[];
1208
1148
  responseTemplate: string;
@@ -1213,7 +1153,6 @@ export interface CreateAiPromptRequest {
1213
1153
  description: string;
1214
1154
  documentTypes: string[];
1215
1155
  applicableUrlSourceIds: string[];
1216
- knowledgeBaseFolderIds: string[];
1217
1156
  allowedRoles: string[];
1218
1157
  systemPrompt: string;
1219
1158
  /** @format int32 */
@@ -1233,8 +1172,8 @@ export interface CreateAiUrlSourceRequest {
1233
1172
  name: string;
1234
1173
  url: string;
1235
1174
  description?: string | null;
1236
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1237
- scope: "FullDomain" | "SpecificPath";
1175
+ category: CreateAiUrlSourceRequestCategoryEnum;
1176
+ scope: CreateAiUrlSourceRequestScopeEnum;
1238
1177
  }
1239
1178
  export interface CreateBranchRequest {
1240
1179
  name: string;
@@ -1242,16 +1181,6 @@ export interface CreateBranchRequest {
1242
1181
  corporateID: string;
1243
1182
  type: string;
1244
1183
  }
1245
- export interface CreateCompanyDocumentFolderRequest {
1246
- name: string;
1247
- description?: string | null;
1248
- }
1249
- export interface CreateCompanyTextDocumentRequest {
1250
- name: string;
1251
- /** @format uuid */
1252
- folderID: string;
1253
- content: string;
1254
- }
1255
1184
  export interface CreateCustomFieldDefinitionRequest {
1256
1185
  isRequired: boolean;
1257
1186
  /** @format int32 */
@@ -1267,8 +1196,8 @@ export interface CreateCustomFieldDefinitionRequest {
1267
1196
  name: string;
1268
1197
  defaultValue?: string | null;
1269
1198
  regexPattern?: string | null;
1270
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1271
- entityType: "Loan";
1199
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1200
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1272
1201
  options?: CustomFieldOptionRequest[] | null;
1273
1202
  permissions?: CustomFieldPermissionRequest[] | null;
1274
1203
  }
@@ -1283,7 +1212,7 @@ export interface CreateDocumentTemplateRequest {
1283
1212
  export interface CreateGroupMemberRequest {
1284
1213
  /** @format uuid */
1285
1214
  userId: string;
1286
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1215
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1287
1216
  }
1288
1217
  export interface CreateInviteRequest {
1289
1218
  firstName: string;
@@ -1291,7 +1220,7 @@ export interface CreateInviteRequest {
1291
1220
  emailAddress: string;
1292
1221
  phoneNumber?: string | null;
1293
1222
  /** @deprecated */
1294
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1223
+ relationship: CreateInviteRequestRelationshipEnum;
1295
1224
  loanID: string;
1296
1225
  route?: string | null;
1297
1226
  /** @format uuid */
@@ -1311,7 +1240,7 @@ export interface CreateLoanImportRequest {
1311
1240
  endDate: string;
1312
1241
  /** @format date-time */
1313
1242
  startDate: string;
1314
- importMode: "All" | "NewOnly" | "UpdateOnly";
1243
+ importMode: CreateLoanImportRequestImportModeEnum;
1315
1244
  }
1316
1245
  export interface CreateSession {
1317
1246
  sessionId: string;
@@ -1329,7 +1258,7 @@ export interface CreateUserDeviceRequest {
1329
1258
  token: string;
1330
1259
  }
1331
1260
  export interface CreateUserDraft {
1332
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1261
+ loanRole: CreateUserDraftLoanRoleEnum;
1333
1262
  }
1334
1263
  export interface CreateUserGroupRequest {
1335
1264
  name: string;
@@ -1390,8 +1319,8 @@ export interface CustomFieldDefinition {
1390
1319
  name: string;
1391
1320
  defaultValue?: string | null;
1392
1321
  regexPattern?: string | null;
1393
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1394
- entityType: "Loan";
1322
+ dataType: CustomFieldDefinitionDataTypeEnum;
1323
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1395
1324
  options: CustomFieldOption[];
1396
1325
  permissions: CustomFieldPermission[];
1397
1326
  encompassMapping?: EncompassMapping | null;
@@ -1405,7 +1334,7 @@ export interface CustomFieldEntry {
1405
1334
  displayOrder: number;
1406
1335
  name: string;
1407
1336
  value: string;
1408
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1337
+ dataType: CustomFieldEntryDataTypeEnum;
1409
1338
  }
1410
1339
  export interface CustomFieldOption {
1411
1340
  /** @format uuid */
@@ -1422,12 +1351,12 @@ export interface CustomFieldOptionRequest {
1422
1351
  export interface CustomFieldPermission {
1423
1352
  /** @format uuid */
1424
1353
  id: string;
1425
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1426
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1354
+ role: CustomFieldPermissionRoleEnum;
1355
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1427
1356
  }
1428
1357
  export interface CustomFieldPermissionRequest {
1429
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1430
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1358
+ role: CustomFieldPermissionRequestRoleEnum;
1359
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1431
1360
  }
1432
1361
  export interface CustomFieldValue {
1433
1362
  /** @format uuid */
@@ -1438,7 +1367,7 @@ export interface CustomFieldValue {
1438
1367
  customFieldDefinitionID: string;
1439
1368
  value: string;
1440
1369
  definitionName: string;
1441
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1370
+ dataType: CustomFieldValueDataTypeEnum;
1442
1371
  }
1443
1372
  export interface DetailedUser {
1444
1373
  /** @format date-time */
@@ -1664,7 +1593,7 @@ export interface Draft {
1664
1593
  siteConfiguration: SiteConfigurationReduced;
1665
1594
  /** @format uuid */
1666
1595
  loanID?: string | null;
1667
- type: "NewLoan" | "EditLoan";
1596
+ type: DraftTypeEnum;
1668
1597
  isCoBorrower: boolean;
1669
1598
  }
1670
1599
  export interface DraftContent {
@@ -1682,7 +1611,7 @@ export interface DraftContent {
1682
1611
  siteConfiguration: SiteConfigurationReduced;
1683
1612
  /** @format uuid */
1684
1613
  loanID?: string | null;
1685
- type: "NewLoan" | "EditLoan";
1614
+ type: DraftContentTypeEnum;
1686
1615
  isCoBorrower: boolean;
1687
1616
  applicationPayload: any;
1688
1617
  }
@@ -1698,7 +1627,7 @@ export interface DraftLoanOfficerReassignRequest {
1698
1627
  }
1699
1628
  export interface DraftRequest {
1700
1629
  applicationPayload: any;
1701
- customData?: any;
1630
+ customData?: any | null;
1702
1631
  isCoBorrower: boolean;
1703
1632
  }
1704
1633
  export interface EconsentPendingSummary {
@@ -1768,9 +1697,9 @@ export interface EncompassCredentialsDetail {
1768
1697
  clearStateIfUnlicensed: boolean;
1769
1698
  /** @deprecated */
1770
1699
  baseUrl?: string | null;
1771
- encompassEnvironment: "Production" | "UAT";
1700
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1772
1701
  consumerConnectWidgetHost?: string | null;
1773
- signingMethod: "ConsumerConnect" | "POSF";
1702
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1774
1703
  subscriptionId?: string | null;
1775
1704
  environment?: string | null;
1776
1705
  /** @format uuid */
@@ -1786,9 +1715,9 @@ export interface EncompassCredentialsRequest {
1786
1715
  clearStateIfUnlicensed: boolean;
1787
1716
  /** @deprecated */
1788
1717
  baseUrl?: string | null;
1789
- encompassEnvironment: "Production" | "UAT";
1718
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1790
1719
  consumerConnectWidgetHost?: string | null;
1791
- signingMethod: "ConsumerConnect" | "POSF";
1720
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1792
1721
  subscriptionId?: string | null;
1793
1722
  environment?: string | null;
1794
1723
  clientID?: string | null;
@@ -1898,8 +1827,8 @@ export interface EncompassRequestLog {
1898
1827
  losId?: string | null;
1899
1828
  /** @format uuid */
1900
1829
  accountId: string;
1901
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1902
- outcome: "Success" | "Failure" | "PartialSuccess";
1830
+ operationType: EncompassRequestLogOperationTypeEnum;
1831
+ outcome: EncompassRequestLogOutcomeEnum;
1903
1832
  message: string;
1904
1833
  endpoint?: string | null;
1905
1834
  httpMethod?: string | null;
@@ -1907,7 +1836,7 @@ export interface EncompassRequestLog {
1907
1836
  httpStatusCode?: number | null;
1908
1837
  /** @format int64 */
1909
1838
  durationMs?: number | null;
1910
- context?: any;
1839
+ context?: any | null;
1911
1840
  /** @format date-time */
1912
1841
  createdAt: string;
1913
1842
  }
@@ -1952,7 +1881,7 @@ export interface FileSearchCriteria {
1952
1881
  export interface FileWithBytes {
1953
1882
  name: string;
1954
1883
  /** @format byte */
1955
- data: string;
1884
+ data: Blob;
1956
1885
  fileName: string;
1957
1886
  mimeType?: string | null;
1958
1887
  extension?: string | null;
@@ -2028,7 +1957,7 @@ export interface FormSubmission {
2028
1957
  subjectPropertyAddressCounty?: string | null;
2029
1958
  subjectPropertyAddressState?: string | null;
2030
1959
  subjectPropertyAddressZip?: string | null;
2031
- data?: any;
1960
+ data?: any | null;
2032
1961
  /** @format uuid */
2033
1962
  listingID?: string | null;
2034
1963
  listing?: Listing | null;
@@ -2063,7 +1992,7 @@ export interface FormSubmissionRequest {
2063
1992
  subjectPropertyAddressCounty?: string | null;
2064
1993
  subjectPropertyAddressState?: string | null;
2065
1994
  subjectPropertyAddressZip?: string | null;
2066
- data?: any;
1995
+ data?: any | null;
2067
1996
  /** @format uuid */
2068
1997
  listingID?: string | null;
2069
1998
  }
@@ -2112,7 +2041,7 @@ export interface FusionFieldDisplay {
2112
2041
  fieldValue: string;
2113
2042
  }
2114
2043
  export interface FusionReportFilter {
2115
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2044
+ filterType: FusionReportFilterFilterTypeEnum;
2116
2045
  targetField: string;
2117
2046
  targetValue: string;
2118
2047
  }
@@ -2132,7 +2061,7 @@ export interface GenerateSystemPrompt {
2132
2061
  }
2133
2062
  export interface GenerateSystemPromptRequest {
2134
2063
  description: string;
2135
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2064
+ category: GenerateSystemPromptRequestCategoryEnum;
2136
2065
  }
2137
2066
  export interface GetApplications {
2138
2067
  applications: ApplicationRowData[];
@@ -2216,11 +2145,11 @@ export interface GetWorkflowRequest {
2216
2145
  export interface GuidPatchOperation {
2217
2146
  op: string;
2218
2147
  path: string;
2219
- value?: any;
2148
+ value?: any | null;
2220
2149
  from?: string | null;
2221
2150
  }
2222
2151
  export interface IPAddress {
2223
- 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";
2152
+ addressFamily: IpAddressAddressFamilyEnum;
2224
2153
  /** @format int64 */
2225
2154
  scopeId: number;
2226
2155
  isIPv6Multicast: boolean;
@@ -2469,7 +2398,7 @@ export interface Loan {
2469
2398
  contacts: LoanContact[];
2470
2399
  customFields: CustomFieldEntry[];
2471
2400
  milestones: LoanMilestone[];
2472
- signingMethod: "ConsumerConnect" | "POSF";
2401
+ signingMethod: LoanSigningMethodEnum;
2473
2402
  }
2474
2403
  export interface LoanApplication {
2475
2404
  /** @format uuid */
@@ -2507,7 +2436,7 @@ export interface LoanApplicationRequest {
2507
2436
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2508
2437
  /** @format uuid */
2509
2438
  draftId?: string | null;
2510
- additionalFields?: Record<string, any>;
2439
+ additionalFields?: Record<string, any> | null;
2511
2440
  /** @format uuid */
2512
2441
  existingLoanId?: string | null;
2513
2442
  }
@@ -2526,7 +2455,7 @@ export interface LoanBorrower {
2526
2455
  citizenship?: LoanCitizenship | null;
2527
2456
  maritalStatus?: LoanMaritalStatus | null;
2528
2457
  languagePreference?: LoanLanguagePreference | null;
2529
- applicationStatus: "Draft" | "Complete";
2458
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2530
2459
  /** @format int32 */
2531
2460
  numberOfDependents?: number | null;
2532
2461
  /** @format int32 */
@@ -3252,7 +3181,7 @@ export interface LoanConsentRequest {
3252
3181
  borrowerEConsent?: boolean | null;
3253
3182
  borrowerCreditAuth?: boolean | null;
3254
3183
  borrowerTCPAOptIn?: boolean | null;
3255
- additionalFields?: Record<string, string>;
3184
+ additionalFields?: Record<string, string> | null;
3256
3185
  }
3257
3186
  export interface LoanContact {
3258
3187
  /** @format date-time */
@@ -3270,7 +3199,7 @@ export interface LoanContact {
3270
3199
  email?: string | null;
3271
3200
  phone?: string | null;
3272
3201
  companyName?: string | null;
3273
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3202
+ role: LoanContactRoleEnum;
3274
3203
  }
3275
3204
  export interface LoanContactList {
3276
3205
  email: string;
@@ -3292,7 +3221,7 @@ export interface LoanCostDetails {
3292
3221
  totalFinancing?: number | null;
3293
3222
  }
3294
3223
  export interface LoanCustomFieldsRequest {
3295
- additionalFields?: Record<string, string>;
3224
+ additionalFields?: Record<string, string> | null;
3296
3225
  }
3297
3226
  export interface LoanDocument {
3298
3227
  /** @format date-time */
@@ -3342,12 +3271,12 @@ export interface LoanDocumentFolderPermission {
3342
3271
  id: string;
3343
3272
  /** @format uuid */
3344
3273
  loanDocumentFolderID: string;
3345
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3346
- level: "None" | "Read" | "Write" | "Manage";
3274
+ role: LoanDocumentFolderPermissionRoleEnum;
3275
+ level: LoanDocumentFolderPermissionLevelEnum;
3347
3276
  }
3348
3277
  export interface LoanDocumentFolderPermissionRequest {
3349
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3350
- level: "None" | "Read" | "Write" | "Manage";
3278
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3279
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3351
3280
  }
3352
3281
  export interface LoanDocumentFolderUsage {
3353
3282
  /** @format uuid */
@@ -3481,13 +3410,13 @@ export interface LoanImport {
3481
3410
  /** @format int32 */
3482
3411
  importedCount: number;
3483
3412
  statusMessage?: string | null;
3484
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3485
- importMode: "All" | "NewOnly" | "UpdateOnly";
3413
+ status: LoanImportStatusEnum;
3414
+ importMode: LoanImportImportModeEnum;
3486
3415
  /** @format date-time */
3487
3416
  createdAt?: string | null;
3488
3417
  }
3489
3418
  export interface LoanImportLog {
3490
- level: "None" | "Info" | "Warning" | "Error";
3419
+ level: LoanImportLogLevelEnum;
3491
3420
  message: string;
3492
3421
  /** @format date-time */
3493
3422
  createdAt: string;
@@ -3542,8 +3471,8 @@ export interface LoanListPaginated {
3542
3471
  export interface LoanLog {
3543
3472
  /** @format uuid */
3544
3473
  id: string;
3545
- level: "None" | "Info" | "Warning" | "Error";
3546
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3474
+ level: LoanLogLevelEnum;
3475
+ type: LoanLogTypeEnum;
3547
3476
  message: string;
3548
3477
  /** @format date-time */
3549
3478
  createdAt: string;
@@ -3551,8 +3480,8 @@ export interface LoanLog {
3551
3480
  export interface LoanLogDetail {
3552
3481
  /** @format uuid */
3553
3482
  id: string;
3554
- level: "None" | "Info" | "Warning" | "Error";
3555
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3483
+ level: LoanLogDetailLevelEnum;
3484
+ type: LoanLogDetailTypeEnum;
3556
3485
  message: string;
3557
3486
  /** @format date-time */
3558
3487
  createdAt: string;
@@ -3814,7 +3743,7 @@ export interface LoanQueueWithData {
3814
3743
  user: UserPublic;
3815
3744
  loanOfficer: LoanOfficerPublic;
3816
3745
  siteConfiguration: SiteConfigurationReduced;
3817
- data?: any;
3746
+ data?: any | null;
3818
3747
  }
3819
3748
  export interface LoanRecord {
3820
3749
  loanGuid: string;
@@ -3845,7 +3774,7 @@ export interface LoanTaskSearchRequest {
3845
3774
  loanStatus?: LoanTaskActivityFilter | null;
3846
3775
  }
3847
3776
  export interface LoanTaskStatusSummary {
3848
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3777
+ status: LoanTaskStatusSummaryStatusEnum;
3849
3778
  /** @format int32 */
3850
3779
  count: number;
3851
3780
  }
@@ -3857,7 +3786,7 @@ export interface LoanUser {
3857
3786
  email: string;
3858
3787
  phone?: string | null;
3859
3788
  role: string;
3860
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3789
+ loanRole: LoanUserLoanRoleEnum;
3861
3790
  isUser: boolean;
3862
3791
  /** @format date-time */
3863
3792
  createdAt: string;
@@ -3891,7 +3820,7 @@ export interface LosOperationTracking {
3891
3820
  operationType: string;
3892
3821
  correlationKey: string;
3893
3822
  lastTriggerSource?: string | null;
3894
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3823
+ status: LosOperationTrackingStatusEnum;
3895
3824
  /** @format date-time */
3896
3825
  createdAt: string;
3897
3826
  /** @format date-time */
@@ -3932,6 +3861,12 @@ export interface LosSync {
3932
3861
  completedAtUtc?: string | null;
3933
3862
  /** @format date-time */
3934
3863
  failedAtUtc?: string | null;
3864
+ /** @format int32 */
3865
+ redriveCount: number;
3866
+ /** @format date-time */
3867
+ nextRedriveAtUtc?: string | null;
3868
+ /** @format date-time */
3869
+ redriveExhaustedAtUtc?: string | null;
3935
3870
  errors: string[];
3936
3871
  steps: LosSyncStep[];
3937
3872
  }
@@ -3971,7 +3906,7 @@ export interface LosSyncStep {
3971
3906
  /** @format int32 */
3972
3907
  order: number;
3973
3908
  name: string;
3974
- severity: "Success" | "Info" | "Warning" | "Error";
3909
+ severity: LosSyncStepSeverityEnum;
3975
3910
  message: string;
3976
3911
  /** @format date-time */
3977
3912
  atUtc: string;
@@ -3985,7 +3920,7 @@ export interface LosWebhook {
3985
3920
  enableSubscription: boolean;
3986
3921
  }
3987
3922
  export interface ManualDocumentClassificationRequest {
3988
- documentType: "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";
3923
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
3989
3924
  }
3990
3925
  export interface MdmUser {
3991
3926
  user_email?: string | null;
@@ -4049,6 +3984,10 @@ export interface MobileSettings {
4049
3984
  universalUrl?: string | null;
4050
3985
  appleStoreUrl?: string | null;
4051
3986
  googlePlayStoreUrl?: string | null;
3987
+ appleTeamId?: string | null;
3988
+ appleBundleId?: string | null;
3989
+ androidPackageName?: string | null;
3990
+ androidSha256CertFingerprints?: string[] | null;
4052
3991
  }
4053
3992
  export interface Module {
4054
3993
  /** @format uuid */
@@ -4064,7 +4003,7 @@ export interface ModuleParameterValue {
4064
4003
  parameterID: string;
4065
4004
  parameterName: string;
4066
4005
  parameterType: string;
4067
- value?: any;
4006
+ value?: any | null;
4068
4007
  isInherited: boolean;
4069
4008
  }
4070
4009
  export interface MonthlyPaymentCalculator {
@@ -4237,7 +4176,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4237
4176
  }
4238
4177
  export interface Operation {
4239
4178
  op?: string;
4240
- value?: string | number | boolean | null | object;
4179
+ value?: object | null;
4241
4180
  path?: string;
4242
4181
  }
4243
4182
  export interface OverridePasswordRequest {
@@ -4440,6 +4379,10 @@ export interface RenameAiConversationRequest {
4440
4379
  export interface RequestImpersonationRequest {
4441
4380
  email: string;
4442
4381
  }
4382
+ export interface ResetPasswordRequest {
4383
+ token: string;
4384
+ password: string;
4385
+ }
4443
4386
  export interface RunLOCalculation {
4444
4387
  loanID: string;
4445
4388
  loanAmount?: string | null;
@@ -4551,6 +4494,10 @@ export interface SetCustomFieldValueRequest {
4551
4494
  definitionId: string;
4552
4495
  value?: string | null;
4553
4496
  }
4497
+ export interface SetPasswordRequest {
4498
+ token: string;
4499
+ password: string;
4500
+ }
4554
4501
  export interface SetSingleCustomFieldValueRequest {
4555
4502
  value?: string | null;
4556
4503
  }
@@ -4563,7 +4510,7 @@ export interface SiteConfiguration {
4563
4510
  deletedAt?: string | null;
4564
4511
  /** @format uuid */
4565
4512
  id: string;
4566
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4513
+ type: SiteConfigurationTypeEnum;
4567
4514
  /** @format uuid */
4568
4515
  entityID: string;
4569
4516
  /** @format int32 */
@@ -4757,7 +4704,7 @@ export interface SiteConfigurationByUrl {
4757
4704
  deletedAt?: string | null;
4758
4705
  /** @format uuid */
4759
4706
  id: string;
4760
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4707
+ type: SiteConfigurationByUrlTypeEnum;
4761
4708
  /** @format uuid */
4762
4709
  entityID: string;
4763
4710
  /** @format int32 */
@@ -4968,7 +4915,7 @@ export interface SiteConfigurationForm {
4968
4915
  export interface SiteConfigurationReduced {
4969
4916
  /** @format uuid */
4970
4917
  id: string;
4971
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4918
+ type: SiteConfigurationReducedTypeEnum;
4972
4919
  url?: string | null;
4973
4920
  name: string;
4974
4921
  /** @format int64 */
@@ -4985,7 +4932,7 @@ export interface SiteConfigurationRequest {
4985
4932
  entityID: string;
4986
4933
  /** @format int32 */
4987
4934
  entityType: number;
4988
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4935
+ type: SiteConfigurationRequestTypeEnum;
4989
4936
  url: string;
4990
4937
  name: string;
4991
4938
  introduction?: string | null;
@@ -5161,7 +5108,7 @@ export interface SiteConfigurationSearchCriteria {
5161
5108
  export interface SiteConfigurationSummary {
5162
5109
  /** @format uuid */
5163
5110
  id: string;
5164
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5111
+ type: SiteConfigurationSummaryTypeEnum;
5165
5112
  url?: string | null;
5166
5113
  name: string;
5167
5114
  /** @format int64 */
@@ -5197,7 +5144,7 @@ export interface SiteTile {
5197
5144
  title: string;
5198
5145
  description: string;
5199
5146
  linkUrl: string;
5200
- linkTarget: "Self" | "Blank";
5147
+ linkTarget: SiteTileLinkTargetEnum;
5201
5148
  siteTypes: SiteConfigurationType[];
5202
5149
  locations: SiteTileLocation[];
5203
5150
  audience: UserRole[];
@@ -5222,7 +5169,7 @@ export interface SiteTileRequest {
5222
5169
  title: string;
5223
5170
  description: string;
5224
5171
  linkUrl: string;
5225
- linkTarget: "Self" | "Blank";
5172
+ linkTarget: SiteTileRequestLinkTargetEnum;
5226
5173
  siteTypes: SiteConfigurationType[];
5227
5174
  locations: SiteTileLocation[];
5228
5175
  audience: UserRole[];
@@ -5244,7 +5191,7 @@ export interface SiteTileView {
5244
5191
  title: string;
5245
5192
  description: string;
5246
5193
  linkUrl: string;
5247
- linkTarget: "Self" | "Blank";
5194
+ linkTarget: SiteTileViewLinkTargetEnum;
5248
5195
  /** @format int32 */
5249
5196
  weight: number;
5250
5197
  }
@@ -5475,7 +5422,7 @@ export interface UnregisteredBorrower {
5475
5422
  lastName?: string | null;
5476
5423
  fullName?: string | null;
5477
5424
  email?: string | null;
5478
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5425
+ role: UnregisteredBorrowerRoleEnum;
5479
5426
  }
5480
5427
  export interface UpdateAccountRequest {
5481
5428
  name: string;
@@ -5499,7 +5446,7 @@ export interface UpdateAiCanonicalFieldRequest {
5499
5446
  }
5500
5447
  export interface UpdateAiGuardrailRequest {
5501
5448
  name: string;
5502
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5449
+ category: UpdateAiGuardrailRequestCategoryEnum;
5503
5450
  description?: string | null;
5504
5451
  keywords: string[];
5505
5452
  responseTemplate: string;
@@ -5509,7 +5456,6 @@ export interface UpdateAiPromptRequest {
5509
5456
  description: string;
5510
5457
  documentTypes: string[];
5511
5458
  applicableUrlSourceIds: string[];
5512
- knowledgeBaseFolderIds: string[];
5513
5459
  allowedRoles: string[];
5514
5460
  systemPrompt: string;
5515
5461
  /** @format int32 */
@@ -5533,18 +5479,8 @@ export interface UpdateAiUrlSourceRequest {
5533
5479
  name: string;
5534
5480
  url: string;
5535
5481
  description?: string | null;
5536
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5537
- scope: "FullDomain" | "SpecificPath";
5538
- }
5539
- export interface UpdateCompanyDocumentFolderRequest {
5540
- name: string;
5541
- description?: string | null;
5542
- }
5543
- export interface UpdateCompanyDocumentRequest {
5544
- name?: string | null;
5545
- /** @format uuid */
5546
- folderID?: string | null;
5547
- content?: string | null;
5482
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5483
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5548
5484
  }
5549
5485
  export interface UpdateCustomFieldDefinitionRequest {
5550
5486
  isRequired: boolean;
@@ -5831,7 +5767,7 @@ export interface UserDevice {
5831
5767
  export interface UserDraft {
5832
5768
  /** @format uuid */
5833
5769
  draftID: string;
5834
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5770
+ role: UserDraftRoleEnum;
5835
5771
  user: User;
5836
5772
  }
5837
5773
  export interface UserDraftPaginated {
@@ -5855,7 +5791,7 @@ export interface UserGroupAccessScope {
5855
5791
  id: string;
5856
5792
  /** @format uuid */
5857
5793
  groupId: string;
5858
- scopeType: "User" | "Branch";
5794
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5859
5795
  /** @format uuid */
5860
5796
  userId?: string | null;
5861
5797
  /** @format uuid */
@@ -5888,7 +5824,7 @@ export interface UserLoan {
5888
5824
  deletedAt?: string | null;
5889
5825
  loanID: string;
5890
5826
  user: User;
5891
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5827
+ role: UserLoanRoleEnum;
5892
5828
  /** @format int32 */
5893
5829
  borrowerPair?: number | null;
5894
5830
  /** @format int32 */
@@ -5900,11 +5836,11 @@ export interface UserLoanConsent {
5900
5836
  id: string;
5901
5837
  /** @format uuid */
5902
5838
  userLoanID: string;
5903
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5839
+ type: UserLoanConsentTypeEnum;
5904
5840
  providedConsent: boolean;
5905
5841
  source?: ConsentSource | null;
5906
5842
  ipAddress?: string | null;
5907
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5843
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5908
5844
  /** @format date-time */
5909
5845
  createdAt: string;
5910
5846
  /** @format date-time */
@@ -6034,7 +5970,10 @@ export interface UserSummary {
6034
5970
  id: string;
6035
5971
  name?: string | null;
6036
5972
  email?: string | null;
6037
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5973
+ role: UserSummaryRoleEnum;
5974
+ }
5975
+ export interface VerifyEmailRequest {
5976
+ token: string;
6038
5977
  }
6039
5978
  export interface VerifyPasswordRequest {
6040
5979
  email: string;
@@ -6061,6 +6000,92 @@ export interface Workflow {
6061
6000
  tileSubtitle: string;
6062
6001
  icon: string;
6063
6002
  }
6003
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6004
+ 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";
6005
+ export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
6006
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
6007
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6008
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6009
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6010
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
6011
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6012
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6013
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6014
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6015
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6016
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6017
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6018
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6019
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6020
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6021
+ /** @deprecated */
6022
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6023
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6024
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6025
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6026
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6027
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6028
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6029
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6030
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6031
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6032
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6033
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6034
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6035
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6036
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6037
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6038
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6039
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
6040
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6041
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6042
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6043
+ 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";
6044
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6045
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6046
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6047
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6048
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6049
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6050
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6051
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6052
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6053
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6054
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6055
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6056
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6057
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6058
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6059
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6060
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6061
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6062
+ 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";
6063
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6064
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6065
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6066
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6067
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6068
+ export type SiteTileLinkTargetEnum = "Self" | "Blank";
6069
+ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6070
+ export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6071
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6072
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6073
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6074
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6075
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6076
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6077
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6078
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6079
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6080
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6081
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6082
+ /** @default "Realtor" */
6083
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6084
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6085
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6086
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6087
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6088
+ export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6064
6089
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6065
6090
  export type QueryParamsType = Record<string | number, any>;
6066
6091
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6083,14 +6108,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6083
6108
  secure?: boolean;
6084
6109
  format?: ResponseType;
6085
6110
  }
6086
- export declare enum ContentType {
6087
- JsonPatch = "application/json-patch+json",
6088
- Json = "application/json",
6089
- JsonApi = "application/vnd.api+json",
6090
- FormData = "multipart/form-data",
6091
- UrlEncoded = "application/x-www-form-urlencoded",
6092
- Text = "text/plain"
6093
- }
6111
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6094
6112
  export declare class HttpClient<SecurityDataType = unknown> {
6095
6113
  instance: AxiosInstance;
6096
6114
  private securityData;
@@ -7115,6 +7133,65 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7115
7133
  * @response `404` `ProblemDetails` Not Found
7116
7134
  */
7117
7135
  getAuditLogById: (id: string, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntry, any, {}>>;
7136
+ /**
7137
+ * No description
7138
+ *
7139
+ * @tags Auth
7140
+ * @name AuthForgotPassword
7141
+ * @summary Forgot Password (branded)
7142
+ * @request POST:/api/auth/forgot-password
7143
+ * @secure
7144
+ * @response `204` `void` No Content
7145
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7146
+ */
7147
+ authForgotPassword: (data: SendForgotPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7148
+ /**
7149
+ * No description
7150
+ *
7151
+ * @tags Auth
7152
+ * @name AuthResetPassword
7153
+ * @summary Reset Password (branded)
7154
+ * @request POST:/api/auth/reset-password
7155
+ * @secure
7156
+ * @response `204` `void` No Content
7157
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7158
+ */
7159
+ authResetPassword: (data: ResetPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7160
+ /**
7161
+ * No description
7162
+ *
7163
+ * @tags Auth
7164
+ * @name AuthSetPassword
7165
+ * @summary Set Password (branded account setup)
7166
+ * @request POST:/api/auth/set-password
7167
+ * @secure
7168
+ * @response `204` `void` No Content
7169
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7170
+ */
7171
+ authSetPassword: (data: SetPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7172
+ /**
7173
+ * No description
7174
+ *
7175
+ * @tags Auth
7176
+ * @name AuthSendVerificationEmail
7177
+ * @summary Send branded email-verification link to the current user
7178
+ * @request POST:/api/auth/send-verification-email
7179
+ * @secure
7180
+ * @response `204` `void` No Content
7181
+ */
7182
+ authSendVerificationEmail: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7183
+ /**
7184
+ * No description
7185
+ *
7186
+ * @tags Auth
7187
+ * @name AuthVerifyEmail
7188
+ * @summary Verify Email (branded)
7189
+ * @request POST:/api/auth/verify-email
7190
+ * @secure
7191
+ * @response `204` `void` No Content
7192
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7193
+ */
7194
+ authVerifyEmail: (data: VerifyEmailRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7118
7195
  /**
7119
7196
  * No description
7120
7197
  *
@@ -7412,186 +7489,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7412
7489
  * @response `200` `ClosedLoansReport` OK
7413
7490
  */
7414
7491
  getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
7415
- /**
7416
- * No description
7417
- *
7418
- * @tags CompanyDocumentFolders
7419
- * @name GetCompanyDocumentFolders
7420
- * @summary Get all company document folders
7421
- * @request GET:/api/company-document-folders
7422
- * @secure
7423
- * @response `200` `(CompanyDocumentFolder)[]` OK
7424
- */
7425
- getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
7426
- /**
7427
- * No description
7428
- *
7429
- * @tags CompanyDocumentFolders
7430
- * @name CreateCompanyDocumentFolder
7431
- * @summary Create company document folder
7432
- * @request POST:/api/company-document-folders
7433
- * @secure
7434
- * @response `201` `CompanyDocumentFolder` Created
7435
- * @response `400` `ProblemDetails` Bad Request
7436
- * @response `409` `ProblemDetails` Conflict
7437
- */
7438
- createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7439
- /**
7440
- * No description
7441
- *
7442
- * @tags CompanyDocumentFolders
7443
- * @name GetCompanyDocumentFolder
7444
- * @summary Get company document folder by ID
7445
- * @request GET:/api/company-document-folders/{id}
7446
- * @secure
7447
- * @response `200` `CompanyDocumentFolder` OK
7448
- * @response `404` `ProblemDetails` Not Found
7449
- */
7450
- getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7451
- /**
7452
- * No description
7453
- *
7454
- * @tags CompanyDocumentFolders
7455
- * @name UpdateCompanyDocumentFolder
7456
- * @summary Update company document folder
7457
- * @request PUT:/api/company-document-folders/{id}
7458
- * @secure
7459
- * @response `200` `CompanyDocumentFolder` OK
7460
- * @response `400` `ProblemDetails` Bad Request
7461
- * @response `404` `ProblemDetails` Not Found
7462
- * @response `409` `ProblemDetails` Conflict
7463
- */
7464
- updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7465
- /**
7466
- * No description
7467
- *
7468
- * @tags CompanyDocumentFolders
7469
- * @name DeleteCompanyDocumentFolder
7470
- * @summary Delete company document folder
7471
- * @request DELETE:/api/company-document-folders/{id}
7472
- * @secure
7473
- * @response `204` `void` No Content
7474
- * @response `400` `ProblemDetails` Bad Request
7475
- * @response `404` `ProblemDetails` Not Found
7476
- * @response `409` `ProblemDetails` Conflict
7477
- */
7478
- deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7479
- /**
7480
- * No description
7481
- *
7482
- * @tags CompanyDocuments
7483
- * @name SearchCompanyDocuments
7484
- * @summary Search company documents
7485
- * @request POST:/api/company-documents/search
7486
- * @secure
7487
- * @response `200` `CompanyDocumentPaginated` OK
7488
- * @response `400` `ProblemDetails` Bad Request
7489
- */
7490
- searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
7491
- /** @format int32 */
7492
- pageSize?: number;
7493
- /** @format int32 */
7494
- pageNumber?: number;
7495
- sortBy?: string;
7496
- sortDirection?: string;
7497
- }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
7498
- /**
7499
- * No description
7500
- *
7501
- * @tags CompanyDocuments
7502
- * @name GetCompanyDocument
7503
- * @summary Get company document by ID
7504
- * @request GET:/api/company-documents/{id}
7505
- * @secure
7506
- * @response `200` `CompanyDocument` OK
7507
- * @response `404` `ProblemDetails` Not Found
7508
- */
7509
- getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7510
- /**
7511
- * No description
7512
- *
7513
- * @tags CompanyDocuments
7514
- * @name UpdateCompanyDocument
7515
- * @summary Update company document
7516
- * @request PUT:/api/company-documents/{id}
7517
- * @secure
7518
- * @response `200` `CompanyDocument` OK
7519
- * @response `400` `ProblemDetails` Bad Request
7520
- * @response `404` `ProblemDetails` Not Found
7521
- * @response `409` `ProblemDetails` Conflict
7522
- */
7523
- updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7524
- /**
7525
- * No description
7526
- *
7527
- * @tags CompanyDocuments
7528
- * @name DeleteCompanyDocument
7529
- * @summary Delete company document
7530
- * @request DELETE:/api/company-documents/{id}
7531
- * @secure
7532
- * @response `204` `void` No Content
7533
- * @response `404` `ProblemDetails` Not Found
7534
- */
7535
- deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7536
- /**
7537
- * No description
7538
- *
7539
- * @tags CompanyDocuments
7540
- * @name DownloadCompanyDocument
7541
- * @summary Download company document
7542
- * @request GET:/api/company-documents/{id}/download
7543
- * @secure
7544
- * @response `200` `void` OK
7545
- * @response `404` `ProblemDetails` Not Found
7546
- */
7547
- downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7548
- /**
7549
- * No description
7550
- *
7551
- * @tags CompanyDocuments
7552
- * @name CreateCompanyDocument
7553
- * @summary Upload company document
7554
- * @request POST:/api/company-documents
7555
- * @secure
7556
- * @response `201` `CompanyDocument` Created
7557
- * @response `400` `ProblemDetails` Bad Request
7558
- * @response `404` `ProblemDetails` Not Found
7559
- * @response `409` `ProblemDetails` Conflict
7560
- */
7561
- createCompanyDocument: (data: {
7562
- /** @format binary */
7563
- file?: File;
7564
- /** @format uuid */
7565
- folderID?: string;
7566
- name?: string;
7567
- }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7568
- /**
7569
- * No description
7570
- *
7571
- * @tags CompanyDocuments
7572
- * @name CreateCompanyTextDocument
7573
- * @summary Create free-form text company document
7574
- * @request POST:/api/company-documents/text
7575
- * @secure
7576
- * @response `201` `CompanyDocument` Created
7577
- * @response `400` `ProblemDetails` Bad Request
7578
- * @response `404` `ProblemDetails` Not Found
7579
- * @response `409` `ProblemDetails` Conflict
7580
- */
7581
- createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7582
- /**
7583
- * No description
7584
- *
7585
- * @tags CompanyDocuments
7586
- * @name ReindexCompanyDocument
7587
- * @summary Re-index a failed company document
7588
- * @request POST:/api/company-documents/{id}/reindex
7589
- * @secure
7590
- * @response `200` `CompanyDocument` OK
7591
- * @response `400` `ProblemDetails` Bad Request
7592
- * @response `404` `ProblemDetails` Not Found
7593
- */
7594
- reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7595
7492
  /**
7596
7493
  * No description
7597
7494
  *
@@ -7781,7 +7678,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7781
7678
  * @response `200` `(CustomFieldDefinition)[]` OK
7782
7679
  */
7783
7680
  getCustomFieldDefinitions: (query?: {
7784
- entityType?: "Loan";
7681
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7785
7682
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7786
7683
  /**
7787
7684
  * No description
@@ -9293,10 +9190,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9293
9190
  * @summary Download By ID
9294
9191
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9295
9192
  * @secure
9296
- * @response `200` `string` OK
9193
+ * @response `200` `Blob` OK
9297
9194
  * @response `404` `ProblemDetails` Not Found
9298
9195
  */
9299
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
9196
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9300
9197
  /**
9301
9198
  * No description
9302
9199
  *
@@ -10264,6 +10161,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10264
10161
  /** @format uuid */
10265
10162
  accountId?: string;
10266
10163
  }, params?: RequestParams) => Promise<AxiosResponse<LosSyncFailuresSummary, any, {}>>;
10164
+ /**
10165
+ * No description
10166
+ *
10167
+ * @tags LosSyncFailures
10168
+ * @name RedriveInboundSyncFailure
10169
+ * @summary Manually re-drive a failed inbound Encompass sync (SuperAdmin)
10170
+ * @request POST:/api/monitoring/inbound-sync-failures/{correlationId}/redrive
10171
+ * @secure
10172
+ * @response `202` `void` Accepted
10173
+ * @response `401` `ProblemDetails` Unauthorized
10174
+ * @response `403` `ProblemDetails` Forbidden
10175
+ * @response `404` `ProblemDetails` Not Found
10176
+ */
10177
+ redriveInboundSyncFailure: (correlationId: string, query?: {
10178
+ /** @format uuid */
10179
+ accountId?: string;
10180
+ }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10267
10181
  /**
10268
10182
  * No description
10269
10183
  *
@@ -10542,7 +10456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10542
10456
  getPartners: (query?: {
10543
10457
  showAll?: boolean;
10544
10458
  /** @default "Realtor" */
10545
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
10459
+ role?: GetPartnersParamsRoleEnum;
10546
10460
  /** @format int32 */
10547
10461
  pageSize?: number;
10548
10462
  /** @format int32 */
@@ -10720,7 +10634,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10720
10634
  * @response `200` `File` OK
10721
10635
  * @response `404` `ProblemDetails` Not Found
10722
10636
  */
10723
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10637
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10724
10638
  /**
10725
10639
  * No description
10726
10640
  *
@@ -10731,7 +10645,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10731
10645
  * @secure
10732
10646
  * @response `200` `File` OK
10733
10647
  */
10734
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10648
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10735
10649
  /**
10736
10650
  * No description
10737
10651
  *
@@ -10824,7 +10738,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10824
10738
  getSiteTilesBySiteConfiguration: (query?: {
10825
10739
  /** @format uuid */
10826
10740
  siteConfigurationId?: string;
10827
- location?: "HomePage" | "Dashboard";
10741
+ location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
10828
10742
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
10829
10743
  /**
10830
10744
  * No description
@@ -11689,8 +11603,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11689
11603
  *
11690
11604
  * @tags Users
11691
11605
  * @name VerifyPassword
11692
- * @summary Verify Password
11606
+ * @summary Verify Password (deprecated; use api/auth/reset-password)
11693
11607
  * @request POST:/api/users/verify-password
11608
+ * @deprecated
11694
11609
  * @secure
11695
11610
  * @response `204` `void` No Content
11696
11611
  * @response `422` `UnprocessableEntity` Unprocessable Content
@@ -11713,8 +11628,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11713
11628
  *
11714
11629
  * @tags Users
11715
11630
  * @name ForgotPassword
11716
- * @summary Forgot Password
11631
+ * @summary Forgot Password (deprecated; use api/auth/forgot-password)
11717
11632
  * @request POST:/api/users/forgot-password
11633
+ * @deprecated
11718
11634
  * @secure
11719
11635
  * @response `204` `void` No Content
11720
11636
  * @response `422` `UnprocessableEntity` Unprocessable Content