@matech/thebigpos-sdk 2.49.3-rc1 → 2.49.3-rc2

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
@@ -141,7 +141,7 @@ export interface AccountBilling {
141
141
  contractedRate: number;
142
142
  }
143
143
  export interface AccountBillingRequest {
144
- billingType: AccountBillingRequestBillingTypeEnum;
144
+ billingType: "ClosedLoan" | "LoanOfficer";
145
145
  /** @format double */
146
146
  contractedRate: number;
147
147
  }
@@ -170,7 +170,7 @@ export interface Action {
170
170
  comments?: string | null;
171
171
  /** @format uuid */
172
172
  siteConfigurationID: string;
173
- applicationSettings?: any | null;
173
+ applicationSettings?: any;
174
174
  surveysToken?: string | null;
175
175
  }
176
176
  export interface Address {
@@ -393,7 +393,7 @@ export interface AiAuditLog {
393
393
  conversationId?: string | null;
394
394
  /** @format uuid */
395
395
  messageId?: string | null;
396
- eventType: AiAuditLogEventTypeEnum;
396
+ 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";
397
397
  modelId?: string | null;
398
398
  /** @format int32 */
399
399
  inputTokens?: number | null;
@@ -406,7 +406,7 @@ export interface AiAuditLog {
406
406
  guardrailCategory?: string | null;
407
407
  rawRequest?: string | null;
408
408
  rawResponse?: string | null;
409
- details?: any | null;
409
+ details?: any;
410
410
  /** @format date-time */
411
411
  createdAt: string;
412
412
  }
@@ -468,7 +468,7 @@ export interface AiChatMessagePaginated {
468
468
  count: number;
469
469
  }
470
470
  export interface AiChatMetadata {
471
- intent: AiChatMetadataIntentEnum;
471
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
472
472
  fieldsAccessed: string[];
473
473
  /** @format int64 */
474
474
  queryTimeMs: number;
@@ -494,7 +494,7 @@ export interface AiChatRequest {
494
494
  promptId?: string | null;
495
495
  }
496
496
  export interface AiChatStructuredData {
497
- type: AiChatStructuredDataTypeEnum;
497
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
498
498
  displayHint?: AiDisplayHint | null;
499
499
  detectedDocumentType?: string | null;
500
500
  columns: string[];
@@ -580,7 +580,7 @@ export interface AiGuardrail {
580
580
  /** @format uuid */
581
581
  id: string;
582
582
  name: string;
583
- category: AiGuardrailCategoryEnum;
583
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
584
584
  description?: string | null;
585
585
  keywords: string[];
586
586
  responseTemplate: string;
@@ -708,8 +708,8 @@ export interface AiUrlSource {
708
708
  name: string;
709
709
  url: string;
710
710
  description?: string | null;
711
- category: AiUrlSourceCategoryEnum;
712
- scope: AiUrlSourceScopeEnum;
711
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
712
+ scope: "FullDomain" | "SpecificPath";
713
713
  isActive: boolean;
714
714
  isDefault: boolean;
715
715
  hasAccountOverride: boolean;
@@ -816,14 +816,14 @@ export interface AuditLogEntry {
816
816
  /** @format uuid */
817
817
  id: string;
818
818
  entityType: string;
819
- changeType: AuditLogEntryChangeTypeEnum;
819
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
820
820
  /** @format uuid */
821
821
  entityId: string;
822
822
  performedBy?: AuditLogUser | null;
823
823
  rootEntityType?: string | null;
824
824
  /** @format uuid */
825
825
  rootEntityId?: string | null;
826
- changes?: any | null;
826
+ changes?: any;
827
827
  /** @format date-time */
828
828
  createdAt: string;
829
829
  }
@@ -863,7 +863,7 @@ export interface BorrowerCount {
863
863
  firstName: string;
864
864
  lastName: string;
865
865
  email: string;
866
- role: BorrowerCountRoleEnum;
866
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
867
867
  /** @format int32 */
868
868
  count: number;
869
869
  }
@@ -873,7 +873,7 @@ export interface BorrowerIdentity {
873
873
  firstName: string;
874
874
  lastName: string;
875
875
  email: string;
876
- role: BorrowerIdentityRoleEnum;
876
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
877
877
  }
878
878
  export interface BorrowersNotUsingPosSummary {
879
879
  /** @format int32 */
@@ -1041,13 +1041,13 @@ export interface CompanyDocument {
1041
1041
  folderId: string;
1042
1042
  folderName: string;
1043
1043
  name: string;
1044
- sourceType: CompanyDocumentSourceTypeEnum;
1044
+ sourceType: "File" | "FreeText";
1045
1045
  contentType?: string | null;
1046
1046
  /** @format int64 */
1047
1047
  fileSizeBytes: number;
1048
1048
  inlineContent?: string | null;
1049
1049
  previewImage?: string | null;
1050
- indexStatus: CompanyDocumentIndexStatusEnum;
1050
+ indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1051
1051
  indexError?: string | null;
1052
1052
  /** @format date-time */
1053
1053
  indexedAt?: string | null;
@@ -1070,6 +1070,14 @@ export interface CompanyDocumentFolder {
1070
1070
  createdAt: string;
1071
1071
  /** @format date-time */
1072
1072
  updatedAt?: string | null;
1073
+ files?: CompanyDocumentFolderFile[] | null;
1074
+ }
1075
+ export interface CompanyDocumentFolderFile {
1076
+ /** @format uuid */
1077
+ id: string;
1078
+ name: string;
1079
+ sourceType: "File" | "FreeText";
1080
+ indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1073
1081
  }
1074
1082
  export interface CompanyDocumentPaginated {
1075
1083
  rows: CompanyDocument[];
@@ -1161,7 +1169,7 @@ export interface CorporateSearchCriteria {
1161
1169
  isActive?: boolean | null;
1162
1170
  }
1163
1171
  export interface CreateAccessScopeRequest {
1164
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1172
+ scopeType: "User" | "Branch";
1165
1173
  /** @format uuid */
1166
1174
  userId?: string | null;
1167
1175
  /** @format uuid */
@@ -1179,7 +1187,7 @@ export interface CreateAccountRequest {
1179
1187
  /** @format int64 */
1180
1188
  nlmsid: number;
1181
1189
  settings: AccountSettingsRequest;
1182
- environment: CreateAccountRequestEnvironmentEnum;
1190
+ environment: "Development" | "Staging" | "UAT" | "Production";
1183
1191
  losIntegration: LOSIntegration;
1184
1192
  billingSettings: AccountBillingRequest;
1185
1193
  }
@@ -1193,7 +1201,7 @@ export interface CreateAiCanonicalFieldRequest {
1193
1201
  }
1194
1202
  export interface CreateAiGuardrailRequest {
1195
1203
  name: string;
1196
- category: CreateAiGuardrailRequestCategoryEnum;
1204
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1197
1205
  description?: string | null;
1198
1206
  keywords: string[];
1199
1207
  responseTemplate: string;
@@ -1224,8 +1232,8 @@ export interface CreateAiUrlSourceRequest {
1224
1232
  name: string;
1225
1233
  url: string;
1226
1234
  description?: string | null;
1227
- category: CreateAiUrlSourceRequestCategoryEnum;
1228
- scope: CreateAiUrlSourceRequestScopeEnum;
1235
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1236
+ scope: "FullDomain" | "SpecificPath";
1229
1237
  }
1230
1238
  export interface CreateBranchRequest {
1231
1239
  name: string;
@@ -1258,8 +1266,8 @@ export interface CreateCustomFieldDefinitionRequest {
1258
1266
  name: string;
1259
1267
  defaultValue?: string | null;
1260
1268
  regexPattern?: string | null;
1261
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1262
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1269
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1270
+ entityType: "Loan";
1263
1271
  options?: CustomFieldOptionRequest[] | null;
1264
1272
  permissions?: CustomFieldPermissionRequest[] | null;
1265
1273
  }
@@ -1277,7 +1285,7 @@ export interface CreateDocumentTemplateRequest {
1277
1285
  export interface CreateGroupMemberRequest {
1278
1286
  /** @format uuid */
1279
1287
  userId: string;
1280
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1288
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1281
1289
  }
1282
1290
  export interface CreateInviteRequest {
1283
1291
  firstName: string;
@@ -1285,7 +1293,7 @@ export interface CreateInviteRequest {
1285
1293
  emailAddress: string;
1286
1294
  phoneNumber?: string | null;
1287
1295
  /** @deprecated */
1288
- relationship: CreateInviteRequestRelationshipEnum;
1296
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1289
1297
  loanID: string;
1290
1298
  route?: string | null;
1291
1299
  /** @format uuid */
@@ -1305,7 +1313,7 @@ export interface CreateLoanImportRequest {
1305
1313
  endDate: string;
1306
1314
  /** @format date-time */
1307
1315
  startDate: string;
1308
- importMode: CreateLoanImportRequestImportModeEnum;
1316
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1309
1317
  }
1310
1318
  export interface CreateSession {
1311
1319
  sessionId: string;
@@ -1323,7 +1331,7 @@ export interface CreateUserDeviceRequest {
1323
1331
  token: string;
1324
1332
  }
1325
1333
  export interface CreateUserDraft {
1326
- loanRole: CreateUserDraftLoanRoleEnum;
1334
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1327
1335
  }
1328
1336
  export interface CreateUserGroupRequest {
1329
1337
  name: string;
@@ -1384,8 +1392,8 @@ export interface CustomFieldDefinition {
1384
1392
  name: string;
1385
1393
  defaultValue?: string | null;
1386
1394
  regexPattern?: string | null;
1387
- dataType: CustomFieldDefinitionDataTypeEnum;
1388
- entityType: CustomFieldDefinitionEntityTypeEnum;
1395
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1396
+ entityType: "Loan";
1389
1397
  options: CustomFieldOption[];
1390
1398
  permissions: CustomFieldPermission[];
1391
1399
  encompassMapping?: EncompassMapping | null;
@@ -1399,7 +1407,7 @@ export interface CustomFieldEntry {
1399
1407
  displayOrder: number;
1400
1408
  name: string;
1401
1409
  value: string;
1402
- dataType: CustomFieldEntryDataTypeEnum;
1410
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1403
1411
  }
1404
1412
  export interface CustomFieldOption {
1405
1413
  /** @format uuid */
@@ -1416,12 +1424,12 @@ export interface CustomFieldOptionRequest {
1416
1424
  export interface CustomFieldPermission {
1417
1425
  /** @format uuid */
1418
1426
  id: string;
1419
- role: CustomFieldPermissionRoleEnum;
1420
- accessLevel: CustomFieldPermissionAccessLevelEnum;
1427
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1428
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1421
1429
  }
1422
1430
  export interface CustomFieldPermissionRequest {
1423
- role: CustomFieldPermissionRequestRoleEnum;
1424
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1431
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1432
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1425
1433
  }
1426
1434
  export interface CustomFieldValue {
1427
1435
  /** @format uuid */
@@ -1432,7 +1440,7 @@ export interface CustomFieldValue {
1432
1440
  customFieldDefinitionID: string;
1433
1441
  value: string;
1434
1442
  definitionName: string;
1435
- dataType: CustomFieldValueDataTypeEnum;
1443
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1436
1444
  }
1437
1445
  export interface DetailedUser {
1438
1446
  /** @format date-time */
@@ -1662,7 +1670,7 @@ export interface Draft {
1662
1670
  siteConfiguration: SiteConfigurationReduced;
1663
1671
  /** @format uuid */
1664
1672
  loanID?: string | null;
1665
- type: DraftTypeEnum;
1673
+ type: "NewLoan" | "EditLoan";
1666
1674
  isCoBorrower: boolean;
1667
1675
  }
1668
1676
  export interface DraftContent {
@@ -1680,7 +1688,7 @@ export interface DraftContent {
1680
1688
  siteConfiguration: SiteConfigurationReduced;
1681
1689
  /** @format uuid */
1682
1690
  loanID?: string | null;
1683
- type: DraftContentTypeEnum;
1691
+ type: "NewLoan" | "EditLoan";
1684
1692
  isCoBorrower: boolean;
1685
1693
  applicationPayload: any;
1686
1694
  }
@@ -1696,7 +1704,7 @@ export interface DraftLoanOfficerReassignRequest {
1696
1704
  }
1697
1705
  export interface DraftRequest {
1698
1706
  applicationPayload: any;
1699
- customData?: any | null;
1707
+ customData?: any;
1700
1708
  isCoBorrower: boolean;
1701
1709
  }
1702
1710
  export interface EconsentPendingSummary {
@@ -1766,9 +1774,9 @@ export interface EncompassCredentialsDetail {
1766
1774
  clearStateIfUnlicensed: boolean;
1767
1775
  /** @deprecated */
1768
1776
  baseUrl?: string | null;
1769
- encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1777
+ encompassEnvironment: "Production" | "UAT";
1770
1778
  consumerConnectWidgetHost?: string | null;
1771
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1779
+ signingMethod: "ConsumerConnect" | "POSF";
1772
1780
  subscriptionId?: string | null;
1773
1781
  environment?: string | null;
1774
1782
  /** @format uuid */
@@ -1784,9 +1792,9 @@ export interface EncompassCredentialsRequest {
1784
1792
  clearStateIfUnlicensed: boolean;
1785
1793
  /** @deprecated */
1786
1794
  baseUrl?: string | null;
1787
- encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1795
+ encompassEnvironment: "Production" | "UAT";
1788
1796
  consumerConnectWidgetHost?: string | null;
1789
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1797
+ signingMethod: "ConsumerConnect" | "POSF";
1790
1798
  subscriptionId?: string | null;
1791
1799
  environment?: string | null;
1792
1800
  clientID?: string | null;
@@ -1896,8 +1904,8 @@ export interface EncompassRequestLog {
1896
1904
  losId?: string | null;
1897
1905
  /** @format uuid */
1898
1906
  accountId: string;
1899
- operationType: EncompassRequestLogOperationTypeEnum;
1900
- outcome: EncompassRequestLogOutcomeEnum;
1907
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
1908
+ outcome: "Success" | "Failure" | "PartialSuccess";
1901
1909
  message: string;
1902
1910
  endpoint?: string | null;
1903
1911
  httpMethod?: string | null;
@@ -1905,7 +1913,7 @@ export interface EncompassRequestLog {
1905
1913
  httpStatusCode?: number | null;
1906
1914
  /** @format int64 */
1907
1915
  durationMs?: number | null;
1908
- context?: any | null;
1916
+ context?: any;
1909
1917
  /** @format date-time */
1910
1918
  createdAt: string;
1911
1919
  }
@@ -1950,7 +1958,7 @@ export interface FileSearchCriteria {
1950
1958
  export interface FileWithBytes {
1951
1959
  name: string;
1952
1960
  /** @format byte */
1953
- data: Blob;
1961
+ data: string;
1954
1962
  fileName: string;
1955
1963
  mimeType?: string | null;
1956
1964
  extension?: string | null;
@@ -2026,7 +2034,7 @@ export interface FormSubmission {
2026
2034
  subjectPropertyAddressCounty?: string | null;
2027
2035
  subjectPropertyAddressState?: string | null;
2028
2036
  subjectPropertyAddressZip?: string | null;
2029
- data?: any | null;
2037
+ data?: any;
2030
2038
  /** @format uuid */
2031
2039
  listingID?: string | null;
2032
2040
  listing?: Listing | null;
@@ -2061,7 +2069,7 @@ export interface FormSubmissionRequest {
2061
2069
  subjectPropertyAddressCounty?: string | null;
2062
2070
  subjectPropertyAddressState?: string | null;
2063
2071
  subjectPropertyAddressZip?: string | null;
2064
- data?: any | null;
2072
+ data?: any;
2065
2073
  /** @format uuid */
2066
2074
  listingID?: string | null;
2067
2075
  }
@@ -2110,7 +2118,7 @@ export interface FusionFieldDisplay {
2110
2118
  fieldValue: string;
2111
2119
  }
2112
2120
  export interface FusionReportFilter {
2113
- filterType: FusionReportFilterFilterTypeEnum;
2121
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2114
2122
  targetField: string;
2115
2123
  targetValue: string;
2116
2124
  }
@@ -2130,7 +2138,7 @@ export interface GenerateSystemPrompt {
2130
2138
  }
2131
2139
  export interface GenerateSystemPromptRequest {
2132
2140
  description: string;
2133
- category: GenerateSystemPromptRequestCategoryEnum;
2141
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2134
2142
  }
2135
2143
  export interface GetApplications {
2136
2144
  applications: ApplicationRowData[];
@@ -2214,11 +2222,11 @@ export interface GetWorkflowRequest {
2214
2222
  export interface GuidPatchOperation {
2215
2223
  op: string;
2216
2224
  path: string;
2217
- value?: any | null;
2225
+ value?: any;
2218
2226
  from?: string | null;
2219
2227
  }
2220
2228
  export interface IPAddress {
2221
- addressFamily: IpAddressAddressFamilyEnum;
2229
+ 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";
2222
2230
  /** @format int64 */
2223
2231
  scopeId: number;
2224
2232
  isIPv6Multicast: boolean;
@@ -2470,7 +2478,7 @@ export interface Loan {
2470
2478
  contacts: LoanContact[];
2471
2479
  customFields: CustomFieldEntry[];
2472
2480
  milestones: LoanMilestone[];
2473
- signingMethod: LoanSigningMethodEnum;
2481
+ signingMethod: "ConsumerConnect" | "POSF";
2474
2482
  }
2475
2483
  export interface LoanApplication {
2476
2484
  /** @format uuid */
@@ -2508,7 +2516,7 @@ export interface LoanApplicationRequest {
2508
2516
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2509
2517
  /** @format uuid */
2510
2518
  draftId?: string | null;
2511
- additionalFields?: Record<string, any> | null;
2519
+ additionalFields?: Record<string, any>;
2512
2520
  /** @format uuid */
2513
2521
  existingLoanId?: string | null;
2514
2522
  }
@@ -2527,7 +2535,7 @@ export interface LoanBorrower {
2527
2535
  citizenship?: LoanCitizenship | null;
2528
2536
  maritalStatus?: LoanMaritalStatus | null;
2529
2537
  languagePreference?: LoanLanguagePreference | null;
2530
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2538
+ applicationStatus: "Draft" | "Complete";
2531
2539
  /** @format int32 */
2532
2540
  numberOfDependents?: number | null;
2533
2541
  /** @format int32 */
@@ -3266,7 +3274,7 @@ export interface LoanConsentRequest {
3266
3274
  borrowerEConsent?: boolean | null;
3267
3275
  borrowerCreditAuth?: boolean | null;
3268
3276
  borrowerTCPAOptIn?: boolean | null;
3269
- additionalFields?: Record<string, string> | null;
3277
+ additionalFields?: Record<string, string>;
3270
3278
  }
3271
3279
  export interface LoanContact {
3272
3280
  /** @format date-time */
@@ -3284,7 +3292,7 @@ export interface LoanContact {
3284
3292
  email?: string | null;
3285
3293
  phone?: string | null;
3286
3294
  companyName?: string | null;
3287
- role: LoanContactRoleEnum;
3295
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3288
3296
  }
3289
3297
  export interface LoanContactList {
3290
3298
  email: string;
@@ -3306,7 +3314,7 @@ export interface LoanCostDetails {
3306
3314
  totalFinancing?: number | null;
3307
3315
  }
3308
3316
  export interface LoanCustomFieldsRequest {
3309
- additionalFields?: Record<string, string> | null;
3317
+ additionalFields?: Record<string, string>;
3310
3318
  }
3311
3319
  export interface LoanDocument {
3312
3320
  /** @format date-time */
@@ -3363,14 +3371,14 @@ export interface LoanDocumentFolderPermission {
3363
3371
  id: string;
3364
3372
  /** @format uuid */
3365
3373
  loanDocumentFolderID: string;
3366
- role: LoanDocumentFolderPermissionRoleEnum;
3367
- level: LoanDocumentFolderPermissionLevelEnum;
3368
- readScope: LoanDocumentFolderPermissionReadScopeEnum;
3374
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3375
+ level: "None" | "Read" | "Write" | "Manage";
3376
+ readScope: "Own" | "All";
3369
3377
  }
3370
3378
  export interface LoanDocumentFolderPermissionRequest {
3371
- role: LoanDocumentFolderPermissionRequestRoleEnum;
3372
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3373
- readScope: LoanDocumentFolderPermissionRequestReadScopeEnum;
3379
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3380
+ level: "None" | "Read" | "Write" | "Manage";
3381
+ readScope: "Own" | "All";
3374
3382
  }
3375
3383
  export interface LoanDocumentFolderSearchCriteria {
3376
3384
  searchText?: string | null;
@@ -3530,13 +3538,13 @@ export interface LoanImport {
3530
3538
  /** @format int32 */
3531
3539
  importedCount: number;
3532
3540
  statusMessage?: string | null;
3533
- status: LoanImportStatusEnum;
3534
- importMode: LoanImportImportModeEnum;
3541
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3542
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3535
3543
  /** @format date-time */
3536
3544
  createdAt?: string | null;
3537
3545
  }
3538
3546
  export interface LoanImportLog {
3539
- level: LoanImportLogLevelEnum;
3547
+ level: "None" | "Info" | "Warning" | "Error";
3540
3548
  message: string;
3541
3549
  /** @format date-time */
3542
3550
  createdAt: string;
@@ -3591,8 +3599,8 @@ export interface LoanListPaginated {
3591
3599
  export interface LoanLog {
3592
3600
  /** @format uuid */
3593
3601
  id: string;
3594
- level: LoanLogLevelEnum;
3595
- type: LoanLogTypeEnum;
3602
+ level: "None" | "Info" | "Warning" | "Error";
3603
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3596
3604
  message: string;
3597
3605
  /** @format date-time */
3598
3606
  createdAt: string;
@@ -3600,8 +3608,8 @@ export interface LoanLog {
3600
3608
  export interface LoanLogDetail {
3601
3609
  /** @format uuid */
3602
3610
  id: string;
3603
- level: LoanLogDetailLevelEnum;
3604
- type: LoanLogDetailTypeEnum;
3611
+ level: "None" | "Info" | "Warning" | "Error";
3612
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3605
3613
  message: string;
3606
3614
  /** @format date-time */
3607
3615
  createdAt: string;
@@ -3863,7 +3871,7 @@ export interface LoanQueueWithData {
3863
3871
  user: UserPublic;
3864
3872
  loanOfficer: LoanOfficerPublic;
3865
3873
  siteConfiguration: SiteConfigurationReduced;
3866
- data?: any | null;
3874
+ data?: any;
3867
3875
  }
3868
3876
  export interface LoanRecord {
3869
3877
  loanGuid: string;
@@ -3894,7 +3902,7 @@ export interface LoanTaskSearchRequest {
3894
3902
  loanStatus?: LoanTaskActivityFilter | null;
3895
3903
  }
3896
3904
  export interface LoanTaskStatusSummary {
3897
- status: LoanTaskStatusSummaryStatusEnum;
3905
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3898
3906
  /** @format int32 */
3899
3907
  count: number;
3900
3908
  }
@@ -3906,7 +3914,7 @@ export interface LoanUser {
3906
3914
  email: string;
3907
3915
  phone?: string | null;
3908
3916
  role: string;
3909
- loanRole: LoanUserLoanRoleEnum;
3917
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3910
3918
  isUser: boolean;
3911
3919
  /** @format date-time */
3912
3920
  createdAt: string;
@@ -3914,7 +3922,7 @@ export interface LoanUser {
3914
3922
  export interface LosCredentialHealth {
3915
3923
  /** @format uuid */
3916
3924
  accountId: string;
3917
- status: LosCredentialHealthStatusEnum;
3925
+ status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
3918
3926
  /** @format date-time */
3919
3927
  checkedAtUtc: string;
3920
3928
  message: string;
@@ -3931,8 +3939,8 @@ export interface LosIntegration {
3931
3939
  accountId: string;
3932
3940
  accountName?: string | null;
3933
3941
  instanceID: string;
3934
- encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
3935
- signingMethod: LosIntegrationSigningMethodEnum;
3942
+ encompassEnvironment: "Production" | "UAT";
3943
+ signingMethod: "ConsumerConnect" | "POSF";
3936
3944
  consumerConnectWidgetHost?: string | null;
3937
3945
  defaultLoanOfficerUserName?: string | null;
3938
3946
  loanTemplate?: string | null;
@@ -3950,8 +3958,8 @@ export interface LosIntegrationCredentials {
3950
3958
  /** @format uuid */
3951
3959
  accountID: string;
3952
3960
  instanceID: string;
3953
- encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
3954
- signingMethod: LosIntegrationCredentialsSigningMethodEnum;
3961
+ encompassEnvironment: "Production" | "UAT";
3962
+ signingMethod: "ConsumerConnect" | "POSF";
3955
3963
  consumerConnectWidgetHost?: string | null;
3956
3964
  defaultLoanOfficerUserName?: string | null;
3957
3965
  loanTemplate?: string | null;
@@ -4013,7 +4021,7 @@ export interface LosOperationTracking {
4013
4021
  operationType: string;
4014
4022
  correlationKey: string;
4015
4023
  lastTriggerSource?: string | null;
4016
- status: LosOperationTrackingStatusEnum;
4024
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
4017
4025
  /** @format date-time */
4018
4026
  createdAt: string;
4019
4027
  /** @format date-time */
@@ -4099,7 +4107,7 @@ export interface LosSyncStep {
4099
4107
  /** @format int32 */
4100
4108
  order: number;
4101
4109
  name: string;
4102
- severity: LosSyncStepSeverityEnum;
4110
+ severity: "Success" | "Info" | "Warning" | "Error";
4103
4111
  message: string;
4104
4112
  /** @format date-time */
4105
4113
  atUtc: string;
@@ -4120,12 +4128,12 @@ export interface LosWebhookEntry {
4120
4128
  /** @format uuid */
4121
4129
  subscriptionId?: string | null;
4122
4130
  enableSubscription?: boolean | null;
4123
- status: LosWebhookEntryStatusEnum;
4131
+ status: "Registered" | "Disabled" | "Missing" | "Extra";
4124
4132
  }
4125
4133
  export interface LosWebhookInventory {
4126
4134
  /** @format uuid */
4127
4135
  accountId: string;
4128
- overallStatus: LosWebhookInventoryOverallStatusEnum;
4136
+ overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
4129
4137
  entries: LosWebhookEntry[];
4130
4138
  /** @format int32 */
4131
4139
  missingCount: number;
@@ -4134,7 +4142,7 @@ export interface LosWebhookInventory {
4134
4142
  message: string;
4135
4143
  }
4136
4144
  export interface ManualDocumentClassificationRequest {
4137
- documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4145
+ 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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
4138
4146
  }
4139
4147
  export interface MdmUser {
4140
4148
  user_email?: string | null;
@@ -4217,7 +4225,7 @@ export interface ModuleParameterValue {
4217
4225
  parameterID: string;
4218
4226
  parameterName: string;
4219
4227
  parameterType: string;
4220
- value?: any | null;
4228
+ value?: any;
4221
4229
  isInherited: boolean;
4222
4230
  }
4223
4231
  export interface MonthlyPaymentCalculator {
@@ -4390,7 +4398,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4390
4398
  }
4391
4399
  export interface Operation {
4392
4400
  op?: string;
4393
- value?: object | null;
4401
+ value?: string | number | boolean | null | object;
4394
4402
  path?: string;
4395
4403
  }
4396
4404
  export interface OverridePasswordRequest {
@@ -4724,7 +4732,7 @@ export interface SiteConfiguration {
4724
4732
  deletedAt?: string | null;
4725
4733
  /** @format uuid */
4726
4734
  id: string;
4727
- type: SiteConfigurationTypeEnum;
4735
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4728
4736
  /** @format uuid */
4729
4737
  entityID: string;
4730
4738
  /** @format int32 */
@@ -4918,7 +4926,7 @@ export interface SiteConfigurationByUrl {
4918
4926
  deletedAt?: string | null;
4919
4927
  /** @format uuid */
4920
4928
  id: string;
4921
- type: SiteConfigurationByUrlTypeEnum;
4929
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4922
4930
  /** @format uuid */
4923
4931
  entityID: string;
4924
4932
  /** @format int32 */
@@ -5129,7 +5137,7 @@ export interface SiteConfigurationForm {
5129
5137
  export interface SiteConfigurationReduced {
5130
5138
  /** @format uuid */
5131
5139
  id: string;
5132
- type: SiteConfigurationReducedTypeEnum;
5140
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5133
5141
  url?: string | null;
5134
5142
  name: string;
5135
5143
  /** @format int64 */
@@ -5146,7 +5154,7 @@ export interface SiteConfigurationRequest {
5146
5154
  entityID: string;
5147
5155
  /** @format int32 */
5148
5156
  entityType: number;
5149
- type: SiteConfigurationRequestTypeEnum;
5157
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5150
5158
  url: string;
5151
5159
  name: string;
5152
5160
  introduction?: string | null;
@@ -5322,7 +5330,7 @@ export interface SiteConfigurationSearchCriteria {
5322
5330
  export interface SiteConfigurationSummary {
5323
5331
  /** @format uuid */
5324
5332
  id: string;
5325
- type: SiteConfigurationSummaryTypeEnum;
5333
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5326
5334
  url?: string | null;
5327
5335
  name: string;
5328
5336
  /** @format int64 */
@@ -5358,7 +5366,7 @@ export interface SiteTile {
5358
5366
  title: string;
5359
5367
  description: string;
5360
5368
  linkUrl: string;
5361
- linkTarget: SiteTileLinkTargetEnum;
5369
+ linkTarget: "Self" | "Blank";
5362
5370
  siteTypes: SiteConfigurationType[];
5363
5371
  locationAudiences: SiteTileLocationAudience[];
5364
5372
  /** @format int32 */
@@ -5370,11 +5378,11 @@ export interface SiteTile {
5370
5378
  updatedAt?: string | null;
5371
5379
  }
5372
5380
  export interface SiteTileLocationAudience {
5373
- location: SiteTileLocationAudienceLocationEnum;
5381
+ location: "HomePage" | "Dashboard";
5374
5382
  audience: UserRole[];
5375
5383
  }
5376
5384
  export interface SiteTileLocationAudienceRequest {
5377
- location: SiteTileLocationAudienceRequestLocationEnum;
5385
+ location: "HomePage" | "Dashboard";
5378
5386
  audience: UserRole[];
5379
5387
  }
5380
5388
  export interface SiteTilePaginated {
@@ -5390,7 +5398,7 @@ export interface SiteTileRequest {
5390
5398
  title: string;
5391
5399
  description: string;
5392
5400
  linkUrl: string;
5393
- linkTarget: SiteTileRequestLinkTargetEnum;
5401
+ linkTarget: "Self" | "Blank";
5394
5402
  siteTypes: SiteConfigurationType[];
5395
5403
  locationAudiences: SiteTileLocationAudienceRequest[];
5396
5404
  /** @format int32 */
@@ -5411,7 +5419,7 @@ export interface SiteTileView {
5411
5419
  title: string;
5412
5420
  description: string;
5413
5421
  linkUrl: string;
5414
- linkTarget: SiteTileViewLinkTargetEnum;
5422
+ linkTarget: "Self" | "Blank";
5415
5423
  /** @format int32 */
5416
5424
  weight: number;
5417
5425
  }
@@ -5642,7 +5650,7 @@ export interface UnregisteredBorrower {
5642
5650
  lastName?: string | null;
5643
5651
  fullName?: string | null;
5644
5652
  email?: string | null;
5645
- role: UnregisteredBorrowerRoleEnum;
5653
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5646
5654
  }
5647
5655
  export interface UpdateAccountRequest {
5648
5656
  name: string;
@@ -5666,7 +5674,7 @@ export interface UpdateAiCanonicalFieldRequest {
5666
5674
  }
5667
5675
  export interface UpdateAiGuardrailRequest {
5668
5676
  name: string;
5669
- category: UpdateAiGuardrailRequestCategoryEnum;
5677
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5670
5678
  description?: string | null;
5671
5679
  keywords: string[];
5672
5680
  responseTemplate: string;
@@ -5700,8 +5708,8 @@ export interface UpdateAiUrlSourceRequest {
5700
5708
  name: string;
5701
5709
  url: string;
5702
5710
  description?: string | null;
5703
- category: UpdateAiUrlSourceRequestCategoryEnum;
5704
- scope: UpdateAiUrlSourceRequestScopeEnum;
5711
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5712
+ scope: "FullDomain" | "SpecificPath";
5705
5713
  }
5706
5714
  export interface UpdateCompanyDocumentFolderRequest {
5707
5715
  name: string;
@@ -6005,7 +6013,7 @@ export interface UserDevice {
6005
6013
  export interface UserDraft {
6006
6014
  /** @format uuid */
6007
6015
  draftID: string;
6008
- role: UserDraftRoleEnum;
6016
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6009
6017
  user: User;
6010
6018
  }
6011
6019
  export interface UserDraftPaginated {
@@ -6029,7 +6037,7 @@ export interface UserGroupAccessScope {
6029
6037
  id: string;
6030
6038
  /** @format uuid */
6031
6039
  groupId: string;
6032
- scopeType: UserGroupAccessScopeScopeTypeEnum;
6040
+ scopeType: "User" | "Branch";
6033
6041
  /** @format uuid */
6034
6042
  userId?: string | null;
6035
6043
  /** @format uuid */
@@ -6052,7 +6060,7 @@ export interface UserGroupMemberUserSummary {
6052
6060
  id: string;
6053
6061
  name?: string | null;
6054
6062
  email?: string | null;
6055
- role: UserGroupMemberUserSummaryRoleEnum;
6063
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6056
6064
  }
6057
6065
  export interface UserGroupPaginated {
6058
6066
  rows: UserGroup[];
@@ -6069,7 +6077,7 @@ export interface UserLoan {
6069
6077
  deletedAt?: string | null;
6070
6078
  loanID: string;
6071
6079
  user: User;
6072
- role: UserLoanRoleEnum;
6080
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6073
6081
  /** @format int32 */
6074
6082
  borrowerPair?: number | null;
6075
6083
  /** @format int32 */
@@ -6081,11 +6089,11 @@ export interface UserLoanConsent {
6081
6089
  id: string;
6082
6090
  /** @format uuid */
6083
6091
  userLoanID: string;
6084
- type: UserLoanConsentTypeEnum;
6092
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
6085
6093
  providedConsent: boolean;
6086
6094
  source?: ConsentSource | null;
6087
6095
  ipAddress?: string | null;
6088
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6096
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
6089
6097
  /** @format date-time */
6090
6098
  createdAt: string;
6091
6099
  /** @format date-time */
@@ -6259,105 +6267,6 @@ export interface Workflow {
6259
6267
  tileSubtitle: string;
6260
6268
  icon: string;
6261
6269
  }
6262
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6263
- 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";
6264
- export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
6265
- export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
6266
- export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6267
- export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6268
- export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6269
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6270
- export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6271
- export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6272
- export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
6273
- export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6274
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6275
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6276
- export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6277
- export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6278
- export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6279
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6280
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6281
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6282
- /** @deprecated */
6283
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6284
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6285
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6286
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6287
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6288
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6289
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6290
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6291
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6292
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6293
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6294
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
6295
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6296
- export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6297
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6298
- export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6299
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6300
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
6301
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6302
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6303
- export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6304
- 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";
6305
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6306
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6307
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6308
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6309
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6310
- export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
6311
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6312
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6313
- export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
6314
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6315
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6316
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6317
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6318
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6319
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6320
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6321
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6322
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6323
- export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6324
- export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6325
- export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6326
- export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6327
- export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6328
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6329
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6330
- export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
6331
- export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6332
- 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";
6333
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6334
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6335
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6336
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6337
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6338
- export type SiteTileLinkTargetEnum = "Self" | "Blank";
6339
- export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
6340
- export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
6341
- export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6342
- export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6343
- export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6344
- export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6345
- export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6346
- export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6347
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6348
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6349
- export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6350
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6351
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6352
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6353
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6354
- /** @default "Realtor" */
6355
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6356
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6357
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6358
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6359
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6360
- export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6361
6270
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6362
6271
  export type QueryParamsType = Record<string | number, any>;
6363
6272
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6380,7 +6289,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6380
6289
  secure?: boolean;
6381
6290
  format?: ResponseType;
6382
6291
  }
6383
- export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6292
+ export declare enum ContentType {
6293
+ JsonPatch = "application/json-patch+json",
6294
+ Json = "application/json",
6295
+ JsonApi = "application/vnd.api+json",
6296
+ FormData = "multipart/form-data",
6297
+ UrlEncoded = "application/x-www-form-urlencoded",
6298
+ Text = "text/plain"
6299
+ }
6384
6300
  export declare class HttpClient<SecurityDataType = unknown> {
6385
6301
  instance: AxiosInstance;
6386
6302
  private securityData;
@@ -7748,7 +7664,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7748
7664
  * @secure
7749
7665
  * @response `200` `(CompanyDocumentFolder)[]` OK
7750
7666
  */
7751
- getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
7667
+ getCompanyDocumentFolders: (query?: {
7668
+ /** @default false */
7669
+ includeFiles?: boolean;
7670
+ }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
7752
7671
  /**
7753
7672
  * No description
7754
7673
  *
@@ -8122,7 +8041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8122
8041
  * @response `200` `(CustomFieldDefinition)[]` OK
8123
8042
  */
8124
8043
  getCustomFieldDefinitions: (query?: {
8125
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8044
+ entityType?: "Loan";
8126
8045
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
8127
8046
  /**
8128
8047
  * No description
@@ -9793,10 +9712,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9793
9712
  * @summary Download By ID
9794
9713
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9795
9714
  * @secure
9796
- * @response `200` `Blob` OK
9715
+ * @response `200` `string` OK
9797
9716
  * @response `404` `ProblemDetails` Not Found
9798
9717
  */
9799
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9718
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
9800
9719
  /**
9801
9720
  * No description
9802
9721
  *
@@ -11073,7 +10992,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11073
10992
  getPartners: (query?: {
11074
10993
  showAll?: boolean;
11075
10994
  /** @default "Realtor" */
11076
- role?: GetPartnersParamsRoleEnum;
10995
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
11077
10996
  /** @format int32 */
11078
10997
  pageSize?: number;
11079
10998
  /** @format int32 */
@@ -11251,7 +11170,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11251
11170
  * @response `200` `File` OK
11252
11171
  * @response `404` `ProblemDetails` Not Found
11253
11172
  */
11254
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11173
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11255
11174
  /**
11256
11175
  * No description
11257
11176
  *
@@ -11262,7 +11181,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11262
11181
  * @secure
11263
11182
  * @response `200` `File` OK
11264
11183
  */
11265
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11184
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11266
11185
  /**
11267
11186
  * No description
11268
11187
  *
@@ -11355,7 +11274,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11355
11274
  getSiteTilesBySiteConfiguration: (query?: {
11356
11275
  /** @format uuid */
11357
11276
  siteConfigurationId?: string;
11358
- location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
11277
+ location?: "HomePage" | "Dashboard";
11359
11278
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
11360
11279
  /**
11361
11280
  * No description