@matech/thebigpos-sdk 3.1.2-rc1 → 3.1.6-dev-324

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.
Files changed (8) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/dist/index.d.ts +493 -122
  4. package/dist/index.js +360 -213
  5. package/dist/index.js.map +1 -1
  6. package/package.json +1 -1
  7. package/src/index.ts +1578 -776
  8. package/tsconfig.json +27 -27
package/dist/index.d.ts CHANGED
@@ -5,6 +5,8 @@ export type SiteTileLocation = "HomePage" | "Dashboard";
5
5
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6
6
  export type SigningMethod = "ConsumerConnect" | "POSF";
7
7
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
8
+ export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
9
+ export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
8
10
  export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
9
11
  export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
10
12
  export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
@@ -60,6 +62,7 @@ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Fai
60
62
  export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
61
63
  export type Environment = "Development" | "Staging" | "UAT" | "Production";
62
64
  export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
65
+ export type EncompassWebhookType = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
63
66
  export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
64
67
  export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
65
68
  export type EncompassEnvironment = "Production" | "UAT";
@@ -82,6 +85,8 @@ export type BillingType = "ClosedLoan" | "LoanOfficer";
82
85
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
83
86
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
84
87
  export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
88
+ export type AiUrlSourceApprovalStatus = "Pending" | "Approved" | "Rejected";
89
+ export type AiUrlDomainStatus = "Approved" | "Rejected";
85
90
  export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
86
91
  export type AiPromptScope = "General" | "LoanSpecific";
87
92
  export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
@@ -138,7 +143,7 @@ export interface AccountBilling {
138
143
  contractedRate: number;
139
144
  }
140
145
  export interface AccountBillingRequest {
141
- billingType: "ClosedLoan" | "LoanOfficer";
146
+ billingType: AccountBillingRequestBillingTypeEnum;
142
147
  /** @format double */
143
148
  contractedRate: number;
144
149
  }
@@ -167,7 +172,7 @@ export interface Action {
167
172
  comments?: string | null;
168
173
  /** @format uuid */
169
174
  siteConfigurationID: string;
170
- applicationSettings?: any;
175
+ applicationSettings?: any | null;
171
176
  surveysToken?: string | null;
172
177
  }
173
178
  export interface Address {
@@ -386,7 +391,7 @@ export interface AiAuditLog {
386
391
  conversationId?: string | null;
387
392
  /** @format uuid */
388
393
  messageId?: string | null;
389
- 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" | "PromptResolutionFailed";
394
+ eventType: AiAuditLogEventTypeEnum;
390
395
  modelId?: string | null;
391
396
  /** @format int32 */
392
397
  inputTokens?: number | null;
@@ -399,7 +404,7 @@ export interface AiAuditLog {
399
404
  guardrailCategory?: string | null;
400
405
  rawRequest?: string | null;
401
406
  rawResponse?: string | null;
402
- details?: any;
407
+ details?: any | null;
403
408
  /** @format date-time */
404
409
  createdAt: string;
405
410
  }
@@ -483,7 +488,7 @@ export interface AiChatRequest {
483
488
  promptId?: string | null;
484
489
  }
485
490
  export interface AiChatStructuredData {
486
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
491
+ type: AiChatStructuredDataTypeEnum;
487
492
  displayHint?: AiDisplayHint | null;
488
493
  detectedDocumentType?: string | null;
489
494
  columns: string[];
@@ -500,7 +505,7 @@ export interface AiCitedDocument {
500
505
  folderId: string;
501
506
  folderName: string;
502
507
  name: string;
503
- sourceType: "File" | "FreeText";
508
+ sourceType: AiCitedDocumentSourceTypeEnum;
504
509
  contentType?: string | null;
505
510
  /** @format int64 */
506
511
  fileSizeBytes: number;
@@ -592,7 +597,7 @@ export interface AiGuardrail {
592
597
  /** @format uuid */
593
598
  id: string;
594
599
  name: string;
595
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
600
+ category: AiGuardrailCategoryEnum;
596
601
  description?: string | null;
597
602
  keywords: string[];
598
603
  responseTemplate: string;
@@ -705,6 +710,23 @@ export interface AiToolCatalogItem {
705
710
  displayName: string;
706
711
  description: string;
707
712
  }
713
+ export interface AiUrlDomain {
714
+ host: string;
715
+ status?: AiUrlDomainStatus | null;
716
+ reason?: string | null;
717
+ /** @format date-time */
718
+ reviewedAt?: string | null;
719
+ usages: AiUrlDomainUsage[];
720
+ }
721
+ export interface AiUrlDomainUsage {
722
+ /** @format uuid */
723
+ urlSourceId: string;
724
+ /** @format uuid */
725
+ accountId?: string | null;
726
+ name: string;
727
+ url: string;
728
+ isOverride: boolean;
729
+ }
708
730
  export interface AiUrlSource {
709
731
  /** @format uuid */
710
732
  id: string;
@@ -712,8 +734,8 @@ export interface AiUrlSource {
712
734
  name: string;
713
735
  url: string;
714
736
  description?: string | null;
715
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
716
- scope: "FullDomain" | "SpecificPath";
737
+ category: AiUrlSourceCategoryEnum;
738
+ scope: AiUrlSourceScopeEnum;
717
739
  isActive: boolean;
718
740
  isDefault: boolean;
719
741
  hasAccountOverride: boolean;
@@ -725,6 +747,8 @@ export interface AiUrlSource {
725
747
  indexError?: string | null;
726
748
  /** @format date-time */
727
749
  fetchedAt?: string | null;
750
+ approvalStatus: AiUrlSourceApprovalStatusEnum;
751
+ approvalReason?: string | null;
728
752
  /** @format int32 */
729
753
  grantedByPromptCount: number;
730
754
  }
@@ -818,6 +842,9 @@ export interface ApplicationRowData {
818
842
  escrowAgent?: EncompassContact | null;
819
843
  titleInsuranceAgent?: EncompassContact | null;
820
844
  }
845
+ export interface ApproveAiUrlDomainRequest {
846
+ host: string;
847
+ }
821
848
  export interface AuditEntityType {
822
849
  entityType: string;
823
850
  rootEntityType?: string | null;
@@ -826,14 +853,14 @@ export interface AuditLogEntry {
826
853
  /** @format uuid */
827
854
  id: string;
828
855
  entityType: string;
829
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
856
+ changeType: AuditLogEntryChangeTypeEnum;
830
857
  /** @format uuid */
831
858
  entityId: string;
832
859
  performedBy?: AuditLogUser | null;
833
860
  rootEntityType?: string | null;
834
861
  /** @format uuid */
835
862
  rootEntityId?: string | null;
836
- changes?: any;
863
+ changes?: any | null;
837
864
  /** @format date-time */
838
865
  createdAt: string;
839
866
  }
@@ -873,7 +900,7 @@ export interface BorrowerCount {
873
900
  firstName: string;
874
901
  lastName: string;
875
902
  email: string;
876
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
903
+ role: BorrowerCountRoleEnum;
877
904
  /** @format int32 */
878
905
  count: number;
879
906
  }
@@ -883,7 +910,7 @@ export interface BorrowerIdentity {
883
910
  firstName: string;
884
911
  lastName: string;
885
912
  email: string;
886
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
913
+ role: BorrowerIdentityRoleEnum;
887
914
  }
888
915
  export interface BorrowersNotUsingPosSummary {
889
916
  /** @format int32 */
@@ -1051,13 +1078,13 @@ export interface CompanyDocument {
1051
1078
  folderId: string;
1052
1079
  folderName: string;
1053
1080
  name: string;
1054
- sourceType: "File" | "FreeText";
1081
+ sourceType: CompanyDocumentSourceTypeEnum;
1055
1082
  contentType?: string | null;
1056
1083
  /** @format int64 */
1057
1084
  fileSizeBytes: number;
1058
1085
  inlineContent?: string | null;
1059
1086
  previewImage?: string | null;
1060
- indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1087
+ indexStatus: CompanyDocumentIndexStatusEnum;
1061
1088
  indexError?: string | null;
1062
1089
  /** @format date-time */
1063
1090
  indexedAt?: string | null;
@@ -1086,8 +1113,8 @@ export interface CompanyDocumentFolderFile {
1086
1113
  /** @format uuid */
1087
1114
  id: string;
1088
1115
  name: string;
1089
- sourceType: "File" | "FreeText";
1090
- indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1116
+ sourceType: CompanyDocumentFolderFileSourceTypeEnum;
1117
+ indexStatus: CompanyDocumentFolderFileIndexStatusEnum;
1091
1118
  }
1092
1119
  export interface CompanyDocumentPaginated {
1093
1120
  rows: CompanyDocument[];
@@ -1179,7 +1206,7 @@ export interface CorporateSearchCriteria {
1179
1206
  isActive?: boolean | null;
1180
1207
  }
1181
1208
  export interface CreateAccessScopeRequest {
1182
- scopeType: "User" | "Branch";
1209
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1183
1210
  /** @format uuid */
1184
1211
  userId?: string | null;
1185
1212
  /** @format uuid */
@@ -1197,7 +1224,7 @@ export interface CreateAccountRequest {
1197
1224
  /** @format int64 */
1198
1225
  nlmsid: number;
1199
1226
  settings: AccountSettingsRequest;
1200
- environment: "Development" | "Staging" | "UAT" | "Production";
1227
+ environment: CreateAccountRequestEnvironmentEnum;
1201
1228
  losIntegration: LOSIntegration;
1202
1229
  billingSettings: AccountBillingRequest;
1203
1230
  }
@@ -1211,7 +1238,7 @@ export interface CreateAiCanonicalFieldRequest {
1211
1238
  }
1212
1239
  export interface CreateAiGuardrailRequest {
1213
1240
  name: string;
1214
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1241
+ category: CreateAiGuardrailRequestCategoryEnum;
1215
1242
  description?: string | null;
1216
1243
  keywords: string[];
1217
1244
  responseTemplate: string;
@@ -1238,8 +1265,8 @@ export interface CreateAiUrlSourceRequest {
1238
1265
  name: string;
1239
1266
  url: string;
1240
1267
  description?: string | null;
1241
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1242
- scope: "FullDomain" | "SpecificPath";
1268
+ category: CreateAiUrlSourceRequestCategoryEnum;
1269
+ scope: CreateAiUrlSourceRequestScopeEnum;
1243
1270
  }
1244
1271
  export interface CreateBranchRequest {
1245
1272
  name: string;
@@ -1272,8 +1299,8 @@ export interface CreateCustomFieldDefinitionRequest {
1272
1299
  name: string;
1273
1300
  defaultValue?: string | null;
1274
1301
  regexPattern?: string | null;
1275
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1276
- entityType: "Loan";
1302
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1303
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1277
1304
  options?: CustomFieldOptionRequest[] | null;
1278
1305
  permissions?: CustomFieldPermissionRequest[] | null;
1279
1306
  }
@@ -1291,7 +1318,7 @@ export interface CreateDocumentTemplateRequest {
1291
1318
  export interface CreateGroupMemberRequest {
1292
1319
  /** @format uuid */
1293
1320
  userId: string;
1294
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1321
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1295
1322
  }
1296
1323
  export interface CreateInviteRequest {
1297
1324
  firstName: string;
@@ -1299,7 +1326,7 @@ export interface CreateInviteRequest {
1299
1326
  emailAddress: string;
1300
1327
  phoneNumber?: string | null;
1301
1328
  /** @deprecated */
1302
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1329
+ relationship: CreateInviteRequestRelationshipEnum;
1303
1330
  loanID: string;
1304
1331
  route?: string | null;
1305
1332
  /** @format uuid */
@@ -1319,7 +1346,7 @@ export interface CreateLoanImportRequest {
1319
1346
  endDate: string;
1320
1347
  /** @format date-time */
1321
1348
  startDate: string;
1322
- importMode: "All" | "NewOnly" | "UpdateOnly";
1349
+ importMode: CreateLoanImportRequestImportModeEnum;
1323
1350
  }
1324
1351
  export interface CreateSession {
1325
1352
  sessionId: string;
@@ -1337,7 +1364,7 @@ export interface CreateUserDeviceRequest {
1337
1364
  token: string;
1338
1365
  }
1339
1366
  export interface CreateUserDraft {
1340
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1367
+ loanRole: CreateUserDraftLoanRoleEnum;
1341
1368
  }
1342
1369
  export interface CreateUserGroupRequest {
1343
1370
  name: string;
@@ -1398,8 +1425,8 @@ export interface CustomFieldDefinition {
1398
1425
  name: string;
1399
1426
  defaultValue?: string | null;
1400
1427
  regexPattern?: string | null;
1401
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1402
- entityType: "Loan";
1428
+ dataType: CustomFieldDefinitionDataTypeEnum;
1429
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1403
1430
  options: CustomFieldOption[];
1404
1431
  permissions: CustomFieldPermission[];
1405
1432
  encompassMapping?: EncompassMapping | null;
@@ -1413,7 +1440,7 @@ export interface CustomFieldEntry {
1413
1440
  displayOrder: number;
1414
1441
  name: string;
1415
1442
  value: string;
1416
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1443
+ dataType: CustomFieldEntryDataTypeEnum;
1417
1444
  }
1418
1445
  export interface CustomFieldOption {
1419
1446
  /** @format uuid */
@@ -1430,12 +1457,12 @@ export interface CustomFieldOptionRequest {
1430
1457
  export interface CustomFieldPermission {
1431
1458
  /** @format uuid */
1432
1459
  id: string;
1433
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1434
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1460
+ role: CustomFieldPermissionRoleEnum;
1461
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1435
1462
  }
1436
1463
  export interface CustomFieldPermissionRequest {
1437
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1438
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1464
+ role: CustomFieldPermissionRequestRoleEnum;
1465
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1439
1466
  }
1440
1467
  export interface CustomFieldValue {
1441
1468
  /** @format uuid */
@@ -1446,7 +1473,7 @@ export interface CustomFieldValue {
1446
1473
  customFieldDefinitionID: string;
1447
1474
  value: string;
1448
1475
  definitionName: string;
1449
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1476
+ dataType: CustomFieldValueDataTypeEnum;
1450
1477
  }
1451
1478
  export interface DetailedUser {
1452
1479
  /** @format date-time */
@@ -1676,7 +1703,7 @@ export interface Draft {
1676
1703
  siteConfiguration: SiteConfigurationReduced;
1677
1704
  /** @format uuid */
1678
1705
  loanID?: string | null;
1679
- type: "NewLoan" | "EditLoan";
1706
+ type: DraftTypeEnum;
1680
1707
  isCoBorrower: boolean;
1681
1708
  }
1682
1709
  export interface DraftContent {
@@ -1694,7 +1721,7 @@ export interface DraftContent {
1694
1721
  siteConfiguration: SiteConfigurationReduced;
1695
1722
  /** @format uuid */
1696
1723
  loanID?: string | null;
1697
- type: "NewLoan" | "EditLoan";
1724
+ type: DraftContentTypeEnum;
1698
1725
  isCoBorrower: boolean;
1699
1726
  applicationPayload: any;
1700
1727
  }
@@ -1710,7 +1737,7 @@ export interface DraftLoanOfficerReassignRequest {
1710
1737
  }
1711
1738
  export interface DraftRequest {
1712
1739
  applicationPayload: any;
1713
- customData?: any;
1740
+ customData?: any | null;
1714
1741
  isCoBorrower: boolean;
1715
1742
  }
1716
1743
  export interface EconsentPendingSummary {
@@ -1780,9 +1807,9 @@ export interface EncompassCredentialsDetail {
1780
1807
  clearStateIfUnlicensed: boolean;
1781
1808
  /** @deprecated */
1782
1809
  baseUrl?: string | null;
1783
- encompassEnvironment: "Production" | "UAT";
1810
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1784
1811
  consumerConnectWidgetHost?: string | null;
1785
- signingMethod: "ConsumerConnect" | "POSF";
1812
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1786
1813
  subscriptionId?: string | null;
1787
1814
  environment?: string | null;
1788
1815
  /** @format uuid */
@@ -1798,9 +1825,9 @@ export interface EncompassCredentialsRequest {
1798
1825
  clearStateIfUnlicensed: boolean;
1799
1826
  /** @deprecated */
1800
1827
  baseUrl?: string | null;
1801
- encompassEnvironment: "Production" | "UAT";
1828
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1802
1829
  consumerConnectWidgetHost?: string | null;
1803
- signingMethod: "ConsumerConnect" | "POSF";
1830
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1804
1831
  subscriptionId?: string | null;
1805
1832
  environment?: string | null;
1806
1833
  clientID?: string | null;
@@ -1917,8 +1944,8 @@ export interface EncompassRequestLog {
1917
1944
  losId?: string | null;
1918
1945
  /** @format uuid */
1919
1946
  accountId: string;
1920
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
1921
- outcome: "Success" | "Failure" | "PartialSuccess";
1947
+ operationType: EncompassRequestLogOperationTypeEnum;
1948
+ outcome: EncompassRequestLogOutcomeEnum;
1922
1949
  message: string;
1923
1950
  endpoint?: string | null;
1924
1951
  httpMethod?: string | null;
@@ -1926,7 +1953,7 @@ export interface EncompassRequestLog {
1926
1953
  httpStatusCode?: number | null;
1927
1954
  /** @format int64 */
1928
1955
  durationMs?: number | null;
1929
- context?: any;
1956
+ context?: any | null;
1930
1957
  /** @format date-time */
1931
1958
  createdAt: string;
1932
1959
  }
@@ -1936,6 +1963,18 @@ export interface EncompassRequestLogPaginated {
1936
1963
  /** @format int64 */
1937
1964
  count: number;
1938
1965
  }
1966
+ export interface EncompassWebhookSubscription {
1967
+ /** @format uuid */
1968
+ accountID: string;
1969
+ instanceID: string;
1970
+ webhookType: EncompassWebhookSubscriptionWebhookTypeEnum;
1971
+ subscriptionId?: string | null;
1972
+ endpoint?: string | null;
1973
+ hasSigningKey: boolean;
1974
+ isSignatureValidationEnabled: boolean;
1975
+ /** @format date-time */
1976
+ updatedAt?: string | null;
1977
+ }
1939
1978
  export interface Error {
1940
1979
  message: string;
1941
1980
  }
@@ -1971,7 +2010,7 @@ export interface FileSearchCriteria {
1971
2010
  export interface FileWithBytes {
1972
2011
  name: string;
1973
2012
  /** @format byte */
1974
- data: string;
2013
+ data: Blob;
1975
2014
  fileName: string;
1976
2015
  mimeType?: string | null;
1977
2016
  extension?: string | null;
@@ -2047,7 +2086,7 @@ export interface FormSubmission {
2047
2086
  subjectPropertyAddressCounty?: string | null;
2048
2087
  subjectPropertyAddressState?: string | null;
2049
2088
  subjectPropertyAddressZip?: string | null;
2050
- data?: any;
2089
+ data?: any | null;
2051
2090
  /** @format uuid */
2052
2091
  listingID?: string | null;
2053
2092
  listing?: Listing | null;
@@ -2082,7 +2121,7 @@ export interface FormSubmissionRequest {
2082
2121
  subjectPropertyAddressCounty?: string | null;
2083
2122
  subjectPropertyAddressState?: string | null;
2084
2123
  subjectPropertyAddressZip?: string | null;
2085
- data?: any;
2124
+ data?: any | null;
2086
2125
  /** @format uuid */
2087
2126
  listingID?: string | null;
2088
2127
  }
@@ -2131,7 +2170,7 @@ export interface FusionFieldDisplay {
2131
2170
  fieldValue: string;
2132
2171
  }
2133
2172
  export interface FusionReportFilter {
2134
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2173
+ filterType: FusionReportFilterFilterTypeEnum;
2135
2174
  targetField: string;
2136
2175
  targetValue: string;
2137
2176
  }
@@ -2151,7 +2190,7 @@ export interface GenerateSystemPrompt {
2151
2190
  }
2152
2191
  export interface GenerateSystemPromptRequest {
2153
2192
  description: string;
2154
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2193
+ category: GenerateSystemPromptRequestCategoryEnum;
2155
2194
  }
2156
2195
  export interface GetApplications {
2157
2196
  applications: ApplicationRowData[];
@@ -2235,11 +2274,11 @@ export interface GetWorkflowRequest {
2235
2274
  export interface GuidPatchOperation {
2236
2275
  op: string;
2237
2276
  path: string;
2238
- value?: any;
2277
+ value?: any | null;
2239
2278
  from?: string | null;
2240
2279
  }
2241
2280
  export interface IPAddress {
2242
- 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";
2281
+ addressFamily: IpAddressAddressFamilyEnum;
2243
2282
  /** @format int64 */
2244
2283
  scopeId: number;
2245
2284
  isIPv6Multicast: boolean;
@@ -2332,6 +2371,7 @@ export interface LOSSettings {
2332
2371
  wholesaleLoanClosingDateFieldID: string;
2333
2372
  brokerLoanClosingDateFieldID: string;
2334
2373
  correspondentLoanClosingDateFieldID: string;
2374
+ estimatedClosingDateFieldID: string;
2335
2375
  customEConsentBucketTitle?: string | null;
2336
2376
  loanMilestoneNotificationsEnabled: boolean;
2337
2377
  useLocalPipeline: boolean;
@@ -2342,6 +2382,7 @@ export interface LOSSettingsUpdateRequest {
2342
2382
  wholesaleLoanClosingDateFieldID: string;
2343
2383
  brokerLoanClosingDateFieldID: string;
2344
2384
  correspondentLoanClosingDateFieldID: string;
2385
+ estimatedClosingDateFieldID?: string | null;
2345
2386
  customEConsentBucketTitle?: string | null;
2346
2387
  loanMilestoneNotificationsEnabled: boolean;
2347
2388
  usageReportLoanStatusFilter?: string | null;
@@ -2491,7 +2532,7 @@ export interface Loan {
2491
2532
  contacts: LoanContact[];
2492
2533
  customFields: CustomFieldEntry[];
2493
2534
  milestones: LoanMilestone[];
2494
- signingMethod: "ConsumerConnect" | "POSF";
2535
+ signingMethod: LoanSigningMethodEnum;
2495
2536
  }
2496
2537
  export interface LoanApplication {
2497
2538
  /** @format uuid */
@@ -2529,7 +2570,7 @@ export interface LoanApplicationRequest {
2529
2570
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2530
2571
  /** @format uuid */
2531
2572
  draftId?: string | null;
2532
- additionalFields?: Record<string, any>;
2573
+ additionalFields?: Record<string, any> | null;
2533
2574
  /** @format uuid */
2534
2575
  existingLoanId?: string | null;
2535
2576
  }
@@ -2548,7 +2589,7 @@ export interface LoanBorrower {
2548
2589
  citizenship?: LoanCitizenship | null;
2549
2590
  maritalStatus?: LoanMaritalStatus | null;
2550
2591
  languagePreference?: LoanLanguagePreference | null;
2551
- applicationStatus: "Draft" | "Complete";
2592
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2552
2593
  /** @format int32 */
2553
2594
  numberOfDependents?: number | null;
2554
2595
  /** @format int32 */
@@ -3292,7 +3333,7 @@ export interface LoanConsentRequest {
3292
3333
  borrowerEConsent?: boolean | null;
3293
3334
  borrowerCreditAuth?: boolean | null;
3294
3335
  borrowerTCPAOptIn?: boolean | null;
3295
- additionalFields?: Record<string, string>;
3336
+ additionalFields?: Record<string, string> | null;
3296
3337
  }
3297
3338
  export interface LoanContact {
3298
3339
  /** @format date-time */
@@ -3310,7 +3351,7 @@ export interface LoanContact {
3310
3351
  email?: string | null;
3311
3352
  phone?: string | null;
3312
3353
  companyName?: string | null;
3313
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3354
+ role: LoanContactRoleEnum;
3314
3355
  }
3315
3356
  export interface LoanContactList {
3316
3357
  email: string;
@@ -3332,7 +3373,7 @@ export interface LoanCostDetails {
3332
3373
  totalFinancing?: number | null;
3333
3374
  }
3334
3375
  export interface LoanCustomFieldsRequest {
3335
- additionalFields?: Record<string, string>;
3376
+ additionalFields?: Record<string, string> | null;
3336
3377
  }
3337
3378
  export interface LoanDocument {
3338
3379
  /** @format date-time */
@@ -3389,14 +3430,14 @@ export interface LoanDocumentFolderPermission {
3389
3430
  id: string;
3390
3431
  /** @format uuid */
3391
3432
  loanDocumentFolderID: string;
3392
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3393
- level: "None" | "Read" | "Write" | "Manage";
3394
- readScope: "Own" | "All";
3433
+ role: LoanDocumentFolderPermissionRoleEnum;
3434
+ level: LoanDocumentFolderPermissionLevelEnum;
3435
+ readScope: LoanDocumentFolderPermissionReadScopeEnum;
3395
3436
  }
3396
3437
  export interface LoanDocumentFolderPermissionRequest {
3397
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3398
- level: "None" | "Read" | "Write" | "Manage";
3399
- readScope: "Own" | "All";
3438
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3439
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3440
+ readScope: LoanDocumentFolderPermissionRequestReadScopeEnum;
3400
3441
  }
3401
3442
  export interface LoanDocumentFolderSearchCriteria {
3402
3443
  searchText?: string | null;
@@ -3448,6 +3489,10 @@ export interface LoanDocumentSearch {
3448
3489
  failoverDocumentPath?: string | null;
3449
3490
  /** @format date-time */
3450
3491
  sensitiveDataPurgedOn?: string | null;
3492
+ observedDocumentType?: LoanDocumentType | null;
3493
+ verified?: boolean | null;
3494
+ classificationMismatch?: boolean | null;
3495
+ classificationMismatchReason?: string | null;
3451
3496
  }
3452
3497
  export interface LoanDocumentSearchCriteria {
3453
3498
  searchText?: string | null;
@@ -3556,13 +3601,13 @@ export interface LoanImport {
3556
3601
  /** @format int32 */
3557
3602
  importedCount: number;
3558
3603
  statusMessage?: string | null;
3559
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3560
- importMode: "All" | "NewOnly" | "UpdateOnly";
3604
+ status: LoanImportStatusEnum;
3605
+ importMode: LoanImportImportModeEnum;
3561
3606
  /** @format date-time */
3562
3607
  createdAt?: string | null;
3563
3608
  }
3564
3609
  export interface LoanImportLog {
3565
- level: "None" | "Info" | "Warning" | "Error";
3610
+ level: LoanImportLogLevelEnum;
3566
3611
  message: string;
3567
3612
  /** @format date-time */
3568
3613
  createdAt: string;
@@ -3617,8 +3662,8 @@ export interface LoanListPaginated {
3617
3662
  export interface LoanLog {
3618
3663
  /** @format uuid */
3619
3664
  id: string;
3620
- level: "None" | "Info" | "Warning" | "Error";
3621
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
3665
+ level: LoanLogLevelEnum;
3666
+ type: LoanLogTypeEnum;
3622
3667
  message: string;
3623
3668
  /** @format date-time */
3624
3669
  createdAt: string;
@@ -3626,8 +3671,8 @@ export interface LoanLog {
3626
3671
  export interface LoanLogDetail {
3627
3672
  /** @format uuid */
3628
3673
  id: string;
3629
- level: "None" | "Info" | "Warning" | "Error";
3630
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
3674
+ level: LoanLogDetailLevelEnum;
3675
+ type: LoanLogDetailTypeEnum;
3631
3676
  message: string;
3632
3677
  /** @format date-time */
3633
3678
  createdAt: string;
@@ -3889,7 +3934,7 @@ export interface LoanQueueWithData {
3889
3934
  user: UserPublic;
3890
3935
  loanOfficer: LoanOfficerPublic;
3891
3936
  siteConfiguration: SiteConfigurationReduced;
3892
- data?: any;
3937
+ data?: any | null;
3893
3938
  }
3894
3939
  export interface LoanRecord {
3895
3940
  loanGuid: string;
@@ -3920,7 +3965,7 @@ export interface LoanTaskSearchRequest {
3920
3965
  loanStatus?: LoanTaskActivityFilter | null;
3921
3966
  }
3922
3967
  export interface LoanTaskStatusSummary {
3923
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3968
+ status: LoanTaskStatusSummaryStatusEnum;
3924
3969
  /** @format int32 */
3925
3970
  count: number;
3926
3971
  }
@@ -3932,7 +3977,7 @@ export interface LoanUser {
3932
3977
  email: string;
3933
3978
  phone?: string | null;
3934
3979
  role: string;
3935
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3980
+ loanRole: LoanUserLoanRoleEnum;
3936
3981
  isUser: boolean;
3937
3982
  /** @format date-time */
3938
3983
  createdAt: string;
@@ -3940,7 +3985,7 @@ export interface LoanUser {
3940
3985
  export interface LosCredentialHealth {
3941
3986
  /** @format uuid */
3942
3987
  accountId: string;
3943
- status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
3988
+ status: LosCredentialHealthStatusEnum;
3944
3989
  /** @format date-time */
3945
3990
  checkedAtUtc: string;
3946
3991
  message: string;
@@ -3957,8 +4002,8 @@ export interface LosIntegration {
3957
4002
  accountId: string;
3958
4003
  accountName?: string | null;
3959
4004
  instanceID: string;
3960
- encompassEnvironment: "Production" | "UAT";
3961
- signingMethod: "ConsumerConnect" | "POSF";
4005
+ encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
4006
+ signingMethod: LosIntegrationSigningMethodEnum;
3962
4007
  consumerConnectWidgetHost?: string | null;
3963
4008
  defaultLoanOfficerUserName?: string | null;
3964
4009
  loanTemplate?: string | null;
@@ -3976,8 +4021,8 @@ export interface LosIntegrationCredentials {
3976
4021
  /** @format uuid */
3977
4022
  accountID: string;
3978
4023
  instanceID: string;
3979
- encompassEnvironment: "Production" | "UAT";
3980
- signingMethod: "ConsumerConnect" | "POSF";
4024
+ encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
4025
+ signingMethod: LosIntegrationCredentialsSigningMethodEnum;
3981
4026
  consumerConnectWidgetHost?: string | null;
3982
4027
  defaultLoanOfficerUserName?: string | null;
3983
4028
  loanTemplate?: string | null;
@@ -4039,7 +4084,7 @@ export interface LosOperationTracking {
4039
4084
  operationType: string;
4040
4085
  correlationKey: string;
4041
4086
  lastTriggerSource?: string | null;
4042
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
4087
+ status: LosOperationTrackingStatusEnum;
4043
4088
  /** @format date-time */
4044
4089
  createdAt: string;
4045
4090
  /** @format date-time */
@@ -4086,6 +4131,7 @@ export interface LosSync {
4086
4131
  nextRedriveAtUtc?: string | null;
4087
4132
  /** @format date-time */
4088
4133
  redriveExhaustedAtUtc?: string | null;
4134
+ lastFailedStep?: string | null;
4089
4135
  errors: string[];
4090
4136
  steps: LosSyncStep[];
4091
4137
  }
@@ -4106,6 +4152,28 @@ export interface LosSyncFailuresSummary {
4106
4152
  /** @format int32 */
4107
4153
  previousTotalFailures: number;
4108
4154
  }
4155
+ export interface LosSyncOutboundFailuresSearchCriteria {
4156
+ searchText?: string | null;
4157
+ /** @format date-time */
4158
+ terminalFromUtc?: string | null;
4159
+ /** @format date-time */
4160
+ terminalToUtc?: string | null;
4161
+ severity: LosSyncOutboundFailuresSearchCriteriaSeverityEnum;
4162
+ }
4163
+ export interface LosSyncOutboundFailuresSummary {
4164
+ /** @format int32 */
4165
+ failedCount: number;
4166
+ /** @format int32 */
4167
+ completedWithErrorsCount: number;
4168
+ /** @format int32 */
4169
+ accountsAffected: number;
4170
+ topAccounts: AccountFailureCount[];
4171
+ buckets: OutboundFailureBucket[];
4172
+ /** @format int32 */
4173
+ previousFailedCount: number;
4174
+ /** @format int32 */
4175
+ previousCompletedWithErrorsCount: number;
4176
+ }
4109
4177
  export interface LosSyncPaginated {
4110
4178
  rows: LosSync[];
4111
4179
  pagination: Pagination;
@@ -4125,7 +4193,7 @@ export interface LosSyncStep {
4125
4193
  /** @format int32 */
4126
4194
  order: number;
4127
4195
  name: string;
4128
- severity: "Success" | "Info" | "Warning" | "Error";
4196
+ severity: LosSyncStepSeverityEnum;
4129
4197
  message: string;
4130
4198
  /** @format date-time */
4131
4199
  atUtc: string;
@@ -4146,12 +4214,12 @@ export interface LosWebhookEntry {
4146
4214
  /** @format uuid */
4147
4215
  subscriptionId?: string | null;
4148
4216
  enableSubscription?: boolean | null;
4149
- status: "Registered" | "Disabled" | "Missing" | "Extra";
4217
+ status: LosWebhookEntryStatusEnum;
4150
4218
  }
4151
4219
  export interface LosWebhookInventory {
4152
4220
  /** @format uuid */
4153
4221
  accountId: string;
4154
- overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
4222
+ overallStatus: LosWebhookInventoryOverallStatusEnum;
4155
4223
  entries: LosWebhookEntry[];
4156
4224
  /** @format int32 */
4157
4225
  missingCount: number;
@@ -4159,8 +4227,22 @@ export interface LosWebhookInventory {
4159
4227
  checkedAtUtc: string;
4160
4228
  message: string;
4161
4229
  }
4230
+ export interface LosWebhookSigningKeySyncResult {
4231
+ /** @format uuid */
4232
+ accountId: string;
4233
+ status: LosWebhookSigningKeySyncResultStatusEnum;
4234
+ /** @format int32 */
4235
+ storedCount: number;
4236
+ /** @format int32 */
4237
+ skippedCount: number;
4238
+ /** @format int32 */
4239
+ failedCount: number;
4240
+ /** @format date-time */
4241
+ checkedAtUtc: string;
4242
+ message: string;
4243
+ }
4162
4244
  export interface ManualDocumentClassificationRequest {
4163
- 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";
4245
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4164
4246
  }
4165
4247
  export interface MdmUser {
4166
4248
  user_email?: string | null;
@@ -4243,7 +4325,7 @@ export interface ModuleParameterValue {
4243
4325
  parameterID: string;
4244
4326
  parameterName: string;
4245
4327
  parameterType: string;
4246
- value?: any;
4328
+ value?: any | null;
4247
4329
  isInherited: boolean;
4248
4330
  }
4249
4331
  export interface MonthlyPaymentCalculator {
@@ -4419,6 +4501,14 @@ export interface Operation {
4419
4501
  value?: string | number | boolean | null | object;
4420
4502
  path?: string;
4421
4503
  }
4504
+ export interface OutboundFailureBucket {
4505
+ /** @format date-time */
4506
+ startUtc: string;
4507
+ /** @format int32 */
4508
+ failedCount: number;
4509
+ /** @format int32 */
4510
+ completedWithErrorsCount: number;
4511
+ }
4422
4512
  export interface OverridePasswordRequest {
4423
4513
  password: string;
4424
4514
  }
@@ -4613,6 +4703,10 @@ export interface RegisterUserRequest {
4613
4703
  /** @format uuid */
4614
4704
  inviteCode?: string | null;
4615
4705
  }
4706
+ export interface RejectAiUrlDomainRequest {
4707
+ host: string;
4708
+ reason: string;
4709
+ }
4616
4710
  export interface RenameAiConversationRequest {
4617
4711
  name: string;
4618
4712
  }
@@ -4741,6 +4835,9 @@ export interface SetPasswordRequest {
4741
4835
  export interface SetSingleCustomFieldValueRequest {
4742
4836
  value?: string | null;
4743
4837
  }
4838
+ export interface SetWebhookSignatureValidationRequest {
4839
+ enabled: boolean;
4840
+ }
4744
4841
  export interface SiteConfiguration {
4745
4842
  /** @format date-time */
4746
4843
  createdAt: string;
@@ -4750,7 +4847,7 @@ export interface SiteConfiguration {
4750
4847
  deletedAt?: string | null;
4751
4848
  /** @format uuid */
4752
4849
  id: string;
4753
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4850
+ type: SiteConfigurationTypeEnum;
4754
4851
  /** @format uuid */
4755
4852
  entityID: string;
4756
4853
  /** @format int32 */
@@ -4944,7 +5041,7 @@ export interface SiteConfigurationByUrl {
4944
5041
  deletedAt?: string | null;
4945
5042
  /** @format uuid */
4946
5043
  id: string;
4947
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5044
+ type: SiteConfigurationByUrlTypeEnum;
4948
5045
  /** @format uuid */
4949
5046
  entityID: string;
4950
5047
  /** @format int32 */
@@ -5155,7 +5252,7 @@ export interface SiteConfigurationForm {
5155
5252
  export interface SiteConfigurationReduced {
5156
5253
  /** @format uuid */
5157
5254
  id: string;
5158
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5255
+ type: SiteConfigurationReducedTypeEnum;
5159
5256
  url?: string | null;
5160
5257
  name: string;
5161
5258
  /** @format int64 */
@@ -5172,7 +5269,7 @@ export interface SiteConfigurationRequest {
5172
5269
  entityID: string;
5173
5270
  /** @format int32 */
5174
5271
  entityType: number;
5175
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5272
+ type: SiteConfigurationRequestTypeEnum;
5176
5273
  url: string;
5177
5274
  name: string;
5178
5275
  introduction?: string | null;
@@ -5348,7 +5445,7 @@ export interface SiteConfigurationSearchCriteria {
5348
5445
  export interface SiteConfigurationSummary {
5349
5446
  /** @format uuid */
5350
5447
  id: string;
5351
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5448
+ type: SiteConfigurationSummaryTypeEnum;
5352
5449
  url?: string | null;
5353
5450
  name: string;
5354
5451
  /** @format int64 */
@@ -5384,7 +5481,7 @@ export interface SiteTile {
5384
5481
  title: string;
5385
5482
  description: string;
5386
5483
  linkUrl: string;
5387
- linkTarget: "Self" | "Blank";
5484
+ linkTarget: SiteTileLinkTargetEnum;
5388
5485
  siteTypes: SiteConfigurationType[];
5389
5486
  locationAudiences: SiteTileLocationAudience[];
5390
5487
  /** @format int32 */
@@ -5396,11 +5493,11 @@ export interface SiteTile {
5396
5493
  updatedAt?: string | null;
5397
5494
  }
5398
5495
  export interface SiteTileLocationAudience {
5399
- location: "HomePage" | "Dashboard";
5496
+ location: SiteTileLocationAudienceLocationEnum;
5400
5497
  audience: UserRole[];
5401
5498
  }
5402
5499
  export interface SiteTileLocationAudienceRequest {
5403
- location: "HomePage" | "Dashboard";
5500
+ location: SiteTileLocationAudienceRequestLocationEnum;
5404
5501
  audience: UserRole[];
5405
5502
  }
5406
5503
  export interface SiteTilePaginated {
@@ -5416,7 +5513,7 @@ export interface SiteTileRequest {
5416
5513
  title: string;
5417
5514
  description: string;
5418
5515
  linkUrl: string;
5419
- linkTarget: "Self" | "Blank";
5516
+ linkTarget: SiteTileRequestLinkTargetEnum;
5420
5517
  siteTypes: SiteConfigurationType[];
5421
5518
  locationAudiences: SiteTileLocationAudienceRequest[];
5422
5519
  /** @format int32 */
@@ -5437,7 +5534,7 @@ export interface SiteTileView {
5437
5534
  title: string;
5438
5535
  description: string;
5439
5536
  linkUrl: string;
5440
- linkTarget: "Self" | "Blank";
5537
+ linkTarget: SiteTileViewLinkTargetEnum;
5441
5538
  /** @format int32 */
5442
5539
  weight: number;
5443
5540
  }
@@ -5668,7 +5765,7 @@ export interface UnregisteredBorrower {
5668
5765
  lastName?: string | null;
5669
5766
  fullName?: string | null;
5670
5767
  email?: string | null;
5671
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5768
+ role: UnregisteredBorrowerRoleEnum;
5672
5769
  }
5673
5770
  export interface UpdateAccountRequest {
5674
5771
  name: string;
@@ -5692,7 +5789,7 @@ export interface UpdateAiCanonicalFieldRequest {
5692
5789
  }
5693
5790
  export interface UpdateAiGuardrailRequest {
5694
5791
  name: string;
5695
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5792
+ category: UpdateAiGuardrailRequestCategoryEnum;
5696
5793
  description?: string | null;
5697
5794
  keywords: string[];
5698
5795
  responseTemplate: string;
@@ -5722,8 +5819,8 @@ export interface UpdateAiUrlSourceRequest {
5722
5819
  name: string;
5723
5820
  url: string;
5724
5821
  description?: string | null;
5725
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5726
- scope: "FullDomain" | "SpecificPath";
5822
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5823
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5727
5824
  }
5728
5825
  export interface UpdateCompanyDocumentFolderRequest {
5729
5826
  name: string;
@@ -6027,7 +6124,7 @@ export interface UserDevice {
6027
6124
  export interface UserDraft {
6028
6125
  /** @format uuid */
6029
6126
  draftID: string;
6030
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6127
+ role: UserDraftRoleEnum;
6031
6128
  user: User;
6032
6129
  }
6033
6130
  export interface UserDraftPaginated {
@@ -6051,7 +6148,7 @@ export interface UserGroupAccessScope {
6051
6148
  id: string;
6052
6149
  /** @format uuid */
6053
6150
  groupId: string;
6054
- scopeType: "User" | "Branch";
6151
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
6055
6152
  /** @format uuid */
6056
6153
  userId?: string | null;
6057
6154
  /** @format uuid */
@@ -6074,7 +6171,7 @@ export interface UserGroupMemberUserSummary {
6074
6171
  id: string;
6075
6172
  name?: string | null;
6076
6173
  email?: string | null;
6077
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6174
+ role: UserGroupMemberUserSummaryRoleEnum;
6078
6175
  }
6079
6176
  export interface UserGroupPaginated {
6080
6177
  rows: UserGroup[];
@@ -6091,7 +6188,7 @@ export interface UserLoan {
6091
6188
  deletedAt?: string | null;
6092
6189
  loanID: string;
6093
6190
  user: User;
6094
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6191
+ role: UserLoanRoleEnum;
6095
6192
  /** @format int32 */
6096
6193
  borrowerPair?: number | null;
6097
6194
  /** @format int32 */
@@ -6103,11 +6200,11 @@ export interface UserLoanConsent {
6103
6200
  id: string;
6104
6201
  /** @format uuid */
6105
6202
  userLoanID: string;
6106
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
6203
+ type: UserLoanConsentTypeEnum;
6107
6204
  providedConsent: boolean;
6108
6205
  source?: ConsentSource | null;
6109
6206
  ipAddress?: string | null;
6110
- losSyncStatus: "NotStarted" | "Failed" | "Success";
6207
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6111
6208
  /** @format date-time */
6112
6209
  createdAt: string;
6113
6210
  /** @format date-time */
@@ -6281,6 +6378,113 @@ export interface Workflow {
6281
6378
  tileSubtitle: string;
6282
6379
  icon: string;
6283
6380
  }
6381
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6382
+ export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed";
6383
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
6384
+ export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
6385
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6386
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6387
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6388
+ export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
6389
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6390
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6391
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6392
+ export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
6393
+ export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6394
+ export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
6395
+ export type CompanyDocumentFolderFileIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6396
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6397
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6398
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6399
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6400
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6401
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6402
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6403
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6404
+ /** @deprecated */
6405
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6406
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6407
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6408
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6409
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6410
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6411
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6412
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6413
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6414
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6415
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6416
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6417
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6418
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6419
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6420
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6421
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6422
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
6423
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6424
+ export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6425
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6426
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6427
+ 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";
6428
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6429
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6430
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6431
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6432
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6433
+ export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
6434
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6435
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6436
+ export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
6437
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6438
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6439
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6440
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6441
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6442
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6443
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6444
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6445
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6446
+ export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6447
+ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6448
+ export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6449
+ export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6450
+ export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6451
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6452
+ export type LosSyncOutboundFailuresSearchCriteriaSeverityEnum = "All" | "Failed" | "CompletedWithErrors";
6453
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6454
+ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
6455
+ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6456
+ export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
6457
+ 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";
6458
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6459
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6460
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6461
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6462
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6463
+ export type SiteTileLinkTargetEnum = "Self" | "Blank";
6464
+ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
6465
+ export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
6466
+ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6467
+ export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6468
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6469
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6470
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6471
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6472
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6473
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6474
+ export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6475
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6476
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6477
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6478
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6479
+ export type SetEncompassIntegrationWebhookSignatureValidationParamsWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6480
+ export type SetEncompassIntegrationWebhookSignatureValidationParamsEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6481
+ /** @default "Realtor" */
6482
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6483
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6484
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6485
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6486
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6487
+ export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6284
6488
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6285
6489
  export type QueryParamsType = Record<string | number, any>;
6286
6490
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6303,14 +6507,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6303
6507
  secure?: boolean;
6304
6508
  format?: ResponseType;
6305
6509
  }
6306
- export declare enum ContentType {
6307
- JsonPatch = "application/json-patch+json",
6308
- Json = "application/json",
6309
- JsonApi = "application/vnd.api+json",
6310
- FormData = "multipart/form-data",
6311
- UrlEncoded = "application/x-www-form-urlencoded",
6312
- Text = "text/plain"
6313
- }
6510
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6314
6511
  export declare class HttpClient<SecurityDataType = unknown> {
6315
6512
  instance: AxiosInstance;
6316
6513
  private securityData;
@@ -6326,7 +6523,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6326
6523
  }
6327
6524
  /**
6328
6525
  * @title The Big POS API
6329
- * @version v3.1.2
6526
+ * @version v3.1.6
6330
6527
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6331
6528
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6332
6529
  */
@@ -7195,6 +7392,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7195
7392
  * @response `400` `ProblemDetails` Bad Request
7196
7393
  */
7197
7394
  setAiAccountTokenLimit: (accountId: string, data: UpdateAiAccountTokenLimitRequest, params?: RequestParams) => Promise<AxiosResponse<AiTokenBudgetStatus, any, {}>>;
7395
+ /**
7396
+ * No description
7397
+ *
7398
+ * @tags AiUrlDomain
7399
+ * @name GetPendingAiUrlDomains
7400
+ * @summary Get domains awaiting review
7401
+ * @request GET:/api/ai/url-domains/pending
7402
+ * @secure
7403
+ * @response `200` `(AiUrlDomain)[]` OK
7404
+ */
7405
+ getPendingAiUrlDomains: (params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain[], any, {}>>;
7406
+ /**
7407
+ * No description
7408
+ *
7409
+ * @tags AiUrlDomain
7410
+ * @name GetAiUrlDomains
7411
+ * @summary Get reviewed domains
7412
+ * @request GET:/api/ai/url-domains
7413
+ * @secure
7414
+ * @response `200` `(AiUrlDomain)[]` OK
7415
+ */
7416
+ getAiUrlDomains: (params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain[], any, {}>>;
7417
+ /**
7418
+ * No description
7419
+ *
7420
+ * @tags AiUrlDomain
7421
+ * @name ApproveAiUrlDomain
7422
+ * @summary Approve a domain for URL source fetching
7423
+ * @request POST:/api/ai/url-domains/approve
7424
+ * @secure
7425
+ * @response `200` `AiUrlDomain` OK
7426
+ * @response `400` `ProblemDetails` Bad Request
7427
+ */
7428
+ approveAiUrlDomain: (data: ApproveAiUrlDomainRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain, any, {}>>;
7429
+ /**
7430
+ * No description
7431
+ *
7432
+ * @tags AiUrlDomain
7433
+ * @name RejectAiUrlDomain
7434
+ * @summary Reject a domain for URL source fetching
7435
+ * @request POST:/api/ai/url-domains/reject
7436
+ * @secure
7437
+ * @response `200` `AiUrlDomain` OK
7438
+ * @response `400` `ProblemDetails` Bad Request
7439
+ */
7440
+ rejectAiUrlDomain: (data: RejectAiUrlDomainRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain, any, {}>>;
7198
7441
  /**
7199
7442
  * No description
7200
7443
  *
@@ -8110,7 +8353,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8110
8353
  * @response `200` `(CustomFieldDefinition)[]` OK
8111
8354
  */
8112
8355
  getCustomFieldDefinitions: (query?: {
8113
- entityType?: "Loan";
8356
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8114
8357
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
8115
8358
  /**
8116
8359
  * No description
@@ -8710,6 +8953,61 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8710
8953
  * @response `403` `ProblemDetails` Forbidden
8711
8954
  */
8712
8955
  recheckEncompassIntegrationWebhooks: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory, any, {}>>;
8956
+ /**
8957
+ * No description
8958
+ *
8959
+ * @tags EncompassIntegrations
8960
+ * @name SyncEncompassIntegrationsWebhookSigningKeys
8961
+ * @summary Backfill the Encompass webhook signing keys for a set of accounts (SuperAdmin)
8962
+ * @request POST:/api/monitoring/encompass-integrations/webhooks/signing-keys/sync
8963
+ * @secure
8964
+ * @response `200` `(LosWebhookSigningKeySyncResult)[]` OK
8965
+ * @response `400` `ProblemDetails` Bad Request
8966
+ * @response `401` `ProblemDetails` Unauthorized
8967
+ * @response `403` `ProblemDetails` Forbidden
8968
+ */
8969
+ syncEncompassIntegrationsWebhookSigningKeys: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhookSigningKeySyncResult[], any, {}>>;
8970
+ /**
8971
+ * No description
8972
+ *
8973
+ * @tags EncompassIntegrations
8974
+ * @name SyncEncompassIntegrationWebhookSigningKeys
8975
+ * @summary Backfill the Encompass webhook signing keys for one account (SuperAdmin)
8976
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/signing-keys/sync
8977
+ * @secure
8978
+ * @response `200` `LosWebhookSigningKeySyncResult` OK
8979
+ * @response `401` `ProblemDetails` Unauthorized
8980
+ * @response `403` `ProblemDetails` Forbidden
8981
+ */
8982
+ syncEncompassIntegrationWebhookSigningKeys: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookSigningKeySyncResult, any, {}>>;
8983
+ /**
8984
+ * No description
8985
+ *
8986
+ * @tags EncompassIntegrations
8987
+ * @name GetEncompassIntegrationWebhookSubscriptions
8988
+ * @summary Get the stored Encompass webhook subscriptions for one account (SuperAdmin)
8989
+ * @request GET:/api/monitoring/encompass-integrations/{accountId}/webhooks/subscriptions
8990
+ * @secure
8991
+ * @response `200` `(EncompassWebhookSubscription)[]` OK
8992
+ * @response `401` `ProblemDetails` Unauthorized
8993
+ * @response `403` `ProblemDetails` Forbidden
8994
+ */
8995
+ getEncompassIntegrationWebhookSubscriptions: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription[], any, {}>>;
8996
+ /**
8997
+ * No description
8998
+ *
8999
+ * @tags EncompassIntegrations
9000
+ * @name SetEncompassIntegrationWebhookSignatureValidation
9001
+ * @summary Turn inbound signature validation on or off for one Encompass webhook subscription (SuperAdmin)
9002
+ * @request PUT:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookType}/signature-validation
9003
+ * @secure
9004
+ * @response `200` `EncompassWebhookSubscription` OK
9005
+ * @response `400` `ProblemDetails` Bad Request
9006
+ * @response `401` `ProblemDetails` Unauthorized
9007
+ * @response `403` `ProblemDetails` Forbidden
9008
+ * @response `404` `ProblemDetails` Not Found
9009
+ */
9010
+ setEncompassIntegrationWebhookSignatureValidation: (accountId: string, webhookType: SetEncompassIntegrationWebhookSignatureValidationParamsEnum, data: SetWebhookSignatureValidationRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription, any, {}>>;
8713
9011
  /**
8714
9012
  * No description
8715
9013
  *
@@ -9821,10 +10119,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9821
10119
  * @summary Download By ID
9822
10120
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9823
10121
  * @secure
9824
- * @response `200` `string` OK
10122
+ * @response `200` `Blob` OK
9825
10123
  * @response `404` `ProblemDetails` Not Found
9826
10124
  */
9827
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
10125
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9828
10126
  /**
9829
10127
  * No description
9830
10128
  *
@@ -10768,6 +11066,79 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10768
11066
  sortBy?: string;
10769
11067
  sortDirection?: string;
10770
11068
  }, params?: RequestParams) => Promise<AxiosResponse<LosOperationTrackingPaginated, any, {}>>;
11069
+ /**
11070
+ * No description
11071
+ *
11072
+ * @tags LosOutboundSyncFailures
11073
+ * @name SearchOutboundSyncFailures
11074
+ * @summary Search cross-account failed outbound Encompass syncs (SuperAdmin)
11075
+ * @request POST:/api/monitoring/outbound-sync-failures/search
11076
+ * @secure
11077
+ * @response `200` `LosSyncPaginated` OK
11078
+ * @response `400` `ProblemDetails` Bad Request
11079
+ * @response `401` `ProblemDetails` Unauthorized
11080
+ * @response `403` `ProblemDetails` Forbidden
11081
+ */
11082
+ searchOutboundSyncFailures: (data: LosSyncOutboundFailuresSearchCriteria, query?: {
11083
+ /** @format int32 */
11084
+ pageSize?: number;
11085
+ /** @format int32 */
11086
+ pageNumber?: number;
11087
+ sortBy?: string;
11088
+ sortDirection?: string;
11089
+ /** @format uuid */
11090
+ accountId?: string;
11091
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSyncPaginated, any, {}>>;
11092
+ /**
11093
+ * No description
11094
+ *
11095
+ * @tags LosOutboundSyncFailures
11096
+ * @name GetOutboundSyncFailuresSummary
11097
+ * @summary Summarize cross-account failed outbound Encompass syncs (SuperAdmin)
11098
+ * @request POST:/api/monitoring/outbound-sync-failures/summary
11099
+ * @secure
11100
+ * @response `200` `LosSyncOutboundFailuresSummary` OK
11101
+ * @response `401` `ProblemDetails` Unauthorized
11102
+ * @response `403` `ProblemDetails` Forbidden
11103
+ */
11104
+ getOutboundSyncFailuresSummary: (data: LosSyncOutboundFailuresSearchCriteria, query?: {
11105
+ /** @format uuid */
11106
+ accountId?: string;
11107
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSyncOutboundFailuresSummary, any, {}>>;
11108
+ /**
11109
+ * No description
11110
+ *
11111
+ * @tags LosOutboundSyncFailures
11112
+ * @name ResyncOutboundSyncFailure
11113
+ * @summary Manually re-sync a failed outbound Encompass sync (SuperAdmin)
11114
+ * @request POST:/api/monitoring/outbound-sync-failures/{correlationId}/resync
11115
+ * @secure
11116
+ * @response `202` `void` Accepted
11117
+ * @response `401` `ProblemDetails` Unauthorized
11118
+ * @response `403` `ProblemDetails` Forbidden
11119
+ * @response `404` `ProblemDetails` Not Found
11120
+ */
11121
+ resyncOutboundSyncFailure: (correlationId: string, query?: {
11122
+ /** @format uuid */
11123
+ accountId?: string;
11124
+ }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11125
+ /**
11126
+ * No description
11127
+ *
11128
+ * @tags LosOutboundSyncFailures
11129
+ * @name GetCurrentOutboundSync
11130
+ * @summary Get the latest outbound Encompass sync for a loan in any state, including in-flight (SuperAdmin)
11131
+ * @request GET:/api/monitoring/outbound-sync-failures/loans/{loanId}/current
11132
+ * @secure
11133
+ * @response `200` `LosSync` OK
11134
+ * @response `401` `ProblemDetails` Unauthorized
11135
+ * @response `403` `ProblemDetails` Forbidden
11136
+ * @response `404` `ProblemDetails` Not Found
11137
+ */
11138
+ getCurrentOutboundSync: (loanId: string, query?: {
11139
+ /** @format uuid */
11140
+ accountId?: string;
11141
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSync, any, {}>>;
10771
11142
  /**
10772
11143
  * No description
10773
11144
  *
@@ -11101,7 +11472,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11101
11472
  getPartners: (query?: {
11102
11473
  showAll?: boolean;
11103
11474
  /** @default "Realtor" */
11104
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
11475
+ role?: GetPartnersParamsRoleEnum;
11105
11476
  /** @format int32 */
11106
11477
  pageSize?: number;
11107
11478
  /** @format int32 */
@@ -11279,7 +11650,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11279
11650
  * @response `200` `File` OK
11280
11651
  * @response `404` `ProblemDetails` Not Found
11281
11652
  */
11282
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11653
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11283
11654
  /**
11284
11655
  * No description
11285
11656
  *
@@ -11290,7 +11661,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11290
11661
  * @secure
11291
11662
  * @response `200` `File` OK
11292
11663
  */
11293
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11664
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11294
11665
  /**
11295
11666
  * No description
11296
11667
  *
@@ -11383,7 +11754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11383
11754
  getSiteTilesBySiteConfiguration: (query?: {
11384
11755
  /** @format uuid */
11385
11756
  siteConfigurationId?: string;
11386
- location?: "HomePage" | "Dashboard";
11757
+ location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
11387
11758
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
11388
11759
  /**
11389
11760
  * No description