@matech/thebigpos-sdk 3.1.2-rc1 → 3.1.5-dev-219

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 +491 -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 +1576 -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;
@@ -2491,7 +2530,7 @@ export interface Loan {
2491
2530
  contacts: LoanContact[];
2492
2531
  customFields: CustomFieldEntry[];
2493
2532
  milestones: LoanMilestone[];
2494
- signingMethod: "ConsumerConnect" | "POSF";
2533
+ signingMethod: LoanSigningMethodEnum;
2495
2534
  }
2496
2535
  export interface LoanApplication {
2497
2536
  /** @format uuid */
@@ -2529,7 +2568,7 @@ export interface LoanApplicationRequest {
2529
2568
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2530
2569
  /** @format uuid */
2531
2570
  draftId?: string | null;
2532
- additionalFields?: Record<string, any>;
2571
+ additionalFields?: Record<string, any> | null;
2533
2572
  /** @format uuid */
2534
2573
  existingLoanId?: string | null;
2535
2574
  }
@@ -2548,7 +2587,7 @@ export interface LoanBorrower {
2548
2587
  citizenship?: LoanCitizenship | null;
2549
2588
  maritalStatus?: LoanMaritalStatus | null;
2550
2589
  languagePreference?: LoanLanguagePreference | null;
2551
- applicationStatus: "Draft" | "Complete";
2590
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2552
2591
  /** @format int32 */
2553
2592
  numberOfDependents?: number | null;
2554
2593
  /** @format int32 */
@@ -3292,7 +3331,7 @@ export interface LoanConsentRequest {
3292
3331
  borrowerEConsent?: boolean | null;
3293
3332
  borrowerCreditAuth?: boolean | null;
3294
3333
  borrowerTCPAOptIn?: boolean | null;
3295
- additionalFields?: Record<string, string>;
3334
+ additionalFields?: Record<string, string> | null;
3296
3335
  }
3297
3336
  export interface LoanContact {
3298
3337
  /** @format date-time */
@@ -3310,7 +3349,7 @@ export interface LoanContact {
3310
3349
  email?: string | null;
3311
3350
  phone?: string | null;
3312
3351
  companyName?: string | null;
3313
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3352
+ role: LoanContactRoleEnum;
3314
3353
  }
3315
3354
  export interface LoanContactList {
3316
3355
  email: string;
@@ -3332,7 +3371,7 @@ export interface LoanCostDetails {
3332
3371
  totalFinancing?: number | null;
3333
3372
  }
3334
3373
  export interface LoanCustomFieldsRequest {
3335
- additionalFields?: Record<string, string>;
3374
+ additionalFields?: Record<string, string> | null;
3336
3375
  }
3337
3376
  export interface LoanDocument {
3338
3377
  /** @format date-time */
@@ -3389,14 +3428,14 @@ export interface LoanDocumentFolderPermission {
3389
3428
  id: string;
3390
3429
  /** @format uuid */
3391
3430
  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";
3431
+ role: LoanDocumentFolderPermissionRoleEnum;
3432
+ level: LoanDocumentFolderPermissionLevelEnum;
3433
+ readScope: LoanDocumentFolderPermissionReadScopeEnum;
3395
3434
  }
3396
3435
  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";
3436
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3437
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3438
+ readScope: LoanDocumentFolderPermissionRequestReadScopeEnum;
3400
3439
  }
3401
3440
  export interface LoanDocumentFolderSearchCriteria {
3402
3441
  searchText?: string | null;
@@ -3448,6 +3487,10 @@ export interface LoanDocumentSearch {
3448
3487
  failoverDocumentPath?: string | null;
3449
3488
  /** @format date-time */
3450
3489
  sensitiveDataPurgedOn?: string | null;
3490
+ observedDocumentType?: LoanDocumentType | null;
3491
+ verified?: boolean | null;
3492
+ classificationMismatch?: boolean | null;
3493
+ classificationMismatchReason?: string | null;
3451
3494
  }
3452
3495
  export interface LoanDocumentSearchCriteria {
3453
3496
  searchText?: string | null;
@@ -3556,13 +3599,13 @@ export interface LoanImport {
3556
3599
  /** @format int32 */
3557
3600
  importedCount: number;
3558
3601
  statusMessage?: string | null;
3559
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3560
- importMode: "All" | "NewOnly" | "UpdateOnly";
3602
+ status: LoanImportStatusEnum;
3603
+ importMode: LoanImportImportModeEnum;
3561
3604
  /** @format date-time */
3562
3605
  createdAt?: string | null;
3563
3606
  }
3564
3607
  export interface LoanImportLog {
3565
- level: "None" | "Info" | "Warning" | "Error";
3608
+ level: LoanImportLogLevelEnum;
3566
3609
  message: string;
3567
3610
  /** @format date-time */
3568
3611
  createdAt: string;
@@ -3617,8 +3660,8 @@ export interface LoanListPaginated {
3617
3660
  export interface LoanLog {
3618
3661
  /** @format uuid */
3619
3662
  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";
3663
+ level: LoanLogLevelEnum;
3664
+ type: LoanLogTypeEnum;
3622
3665
  message: string;
3623
3666
  /** @format date-time */
3624
3667
  createdAt: string;
@@ -3626,8 +3669,8 @@ export interface LoanLog {
3626
3669
  export interface LoanLogDetail {
3627
3670
  /** @format uuid */
3628
3671
  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";
3672
+ level: LoanLogDetailLevelEnum;
3673
+ type: LoanLogDetailTypeEnum;
3631
3674
  message: string;
3632
3675
  /** @format date-time */
3633
3676
  createdAt: string;
@@ -3889,7 +3932,7 @@ export interface LoanQueueWithData {
3889
3932
  user: UserPublic;
3890
3933
  loanOfficer: LoanOfficerPublic;
3891
3934
  siteConfiguration: SiteConfigurationReduced;
3892
- data?: any;
3935
+ data?: any | null;
3893
3936
  }
3894
3937
  export interface LoanRecord {
3895
3938
  loanGuid: string;
@@ -3920,7 +3963,7 @@ export interface LoanTaskSearchRequest {
3920
3963
  loanStatus?: LoanTaskActivityFilter | null;
3921
3964
  }
3922
3965
  export interface LoanTaskStatusSummary {
3923
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3966
+ status: LoanTaskStatusSummaryStatusEnum;
3924
3967
  /** @format int32 */
3925
3968
  count: number;
3926
3969
  }
@@ -3932,7 +3975,7 @@ export interface LoanUser {
3932
3975
  email: string;
3933
3976
  phone?: string | null;
3934
3977
  role: string;
3935
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3978
+ loanRole: LoanUserLoanRoleEnum;
3936
3979
  isUser: boolean;
3937
3980
  /** @format date-time */
3938
3981
  createdAt: string;
@@ -3940,7 +3983,7 @@ export interface LoanUser {
3940
3983
  export interface LosCredentialHealth {
3941
3984
  /** @format uuid */
3942
3985
  accountId: string;
3943
- status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
3986
+ status: LosCredentialHealthStatusEnum;
3944
3987
  /** @format date-time */
3945
3988
  checkedAtUtc: string;
3946
3989
  message: string;
@@ -3957,8 +4000,8 @@ export interface LosIntegration {
3957
4000
  accountId: string;
3958
4001
  accountName?: string | null;
3959
4002
  instanceID: string;
3960
- encompassEnvironment: "Production" | "UAT";
3961
- signingMethod: "ConsumerConnect" | "POSF";
4003
+ encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
4004
+ signingMethod: LosIntegrationSigningMethodEnum;
3962
4005
  consumerConnectWidgetHost?: string | null;
3963
4006
  defaultLoanOfficerUserName?: string | null;
3964
4007
  loanTemplate?: string | null;
@@ -3976,8 +4019,8 @@ export interface LosIntegrationCredentials {
3976
4019
  /** @format uuid */
3977
4020
  accountID: string;
3978
4021
  instanceID: string;
3979
- encompassEnvironment: "Production" | "UAT";
3980
- signingMethod: "ConsumerConnect" | "POSF";
4022
+ encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
4023
+ signingMethod: LosIntegrationCredentialsSigningMethodEnum;
3981
4024
  consumerConnectWidgetHost?: string | null;
3982
4025
  defaultLoanOfficerUserName?: string | null;
3983
4026
  loanTemplate?: string | null;
@@ -4039,7 +4082,7 @@ export interface LosOperationTracking {
4039
4082
  operationType: string;
4040
4083
  correlationKey: string;
4041
4084
  lastTriggerSource?: string | null;
4042
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
4085
+ status: LosOperationTrackingStatusEnum;
4043
4086
  /** @format date-time */
4044
4087
  createdAt: string;
4045
4088
  /** @format date-time */
@@ -4086,6 +4129,7 @@ export interface LosSync {
4086
4129
  nextRedriveAtUtc?: string | null;
4087
4130
  /** @format date-time */
4088
4131
  redriveExhaustedAtUtc?: string | null;
4132
+ lastFailedStep?: string | null;
4089
4133
  errors: string[];
4090
4134
  steps: LosSyncStep[];
4091
4135
  }
@@ -4106,6 +4150,28 @@ export interface LosSyncFailuresSummary {
4106
4150
  /** @format int32 */
4107
4151
  previousTotalFailures: number;
4108
4152
  }
4153
+ export interface LosSyncOutboundFailuresSearchCriteria {
4154
+ searchText?: string | null;
4155
+ /** @format date-time */
4156
+ terminalFromUtc?: string | null;
4157
+ /** @format date-time */
4158
+ terminalToUtc?: string | null;
4159
+ severity: LosSyncOutboundFailuresSearchCriteriaSeverityEnum;
4160
+ }
4161
+ export interface LosSyncOutboundFailuresSummary {
4162
+ /** @format int32 */
4163
+ failedCount: number;
4164
+ /** @format int32 */
4165
+ completedWithErrorsCount: number;
4166
+ /** @format int32 */
4167
+ accountsAffected: number;
4168
+ topAccounts: AccountFailureCount[];
4169
+ buckets: OutboundFailureBucket[];
4170
+ /** @format int32 */
4171
+ previousFailedCount: number;
4172
+ /** @format int32 */
4173
+ previousCompletedWithErrorsCount: number;
4174
+ }
4109
4175
  export interface LosSyncPaginated {
4110
4176
  rows: LosSync[];
4111
4177
  pagination: Pagination;
@@ -4125,7 +4191,7 @@ export interface LosSyncStep {
4125
4191
  /** @format int32 */
4126
4192
  order: number;
4127
4193
  name: string;
4128
- severity: "Success" | "Info" | "Warning" | "Error";
4194
+ severity: LosSyncStepSeverityEnum;
4129
4195
  message: string;
4130
4196
  /** @format date-time */
4131
4197
  atUtc: string;
@@ -4146,12 +4212,12 @@ export interface LosWebhookEntry {
4146
4212
  /** @format uuid */
4147
4213
  subscriptionId?: string | null;
4148
4214
  enableSubscription?: boolean | null;
4149
- status: "Registered" | "Disabled" | "Missing" | "Extra";
4215
+ status: LosWebhookEntryStatusEnum;
4150
4216
  }
4151
4217
  export interface LosWebhookInventory {
4152
4218
  /** @format uuid */
4153
4219
  accountId: string;
4154
- overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
4220
+ overallStatus: LosWebhookInventoryOverallStatusEnum;
4155
4221
  entries: LosWebhookEntry[];
4156
4222
  /** @format int32 */
4157
4223
  missingCount: number;
@@ -4159,8 +4225,22 @@ export interface LosWebhookInventory {
4159
4225
  checkedAtUtc: string;
4160
4226
  message: string;
4161
4227
  }
4228
+ export interface LosWebhookSigningKeySyncResult {
4229
+ /** @format uuid */
4230
+ accountId: string;
4231
+ status: LosWebhookSigningKeySyncResultStatusEnum;
4232
+ /** @format int32 */
4233
+ storedCount: number;
4234
+ /** @format int32 */
4235
+ skippedCount: number;
4236
+ /** @format int32 */
4237
+ failedCount: number;
4238
+ /** @format date-time */
4239
+ checkedAtUtc: string;
4240
+ message: string;
4241
+ }
4162
4242
  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";
4243
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4164
4244
  }
4165
4245
  export interface MdmUser {
4166
4246
  user_email?: string | null;
@@ -4243,7 +4323,7 @@ export interface ModuleParameterValue {
4243
4323
  parameterID: string;
4244
4324
  parameterName: string;
4245
4325
  parameterType: string;
4246
- value?: any;
4326
+ value?: any | null;
4247
4327
  isInherited: boolean;
4248
4328
  }
4249
4329
  export interface MonthlyPaymentCalculator {
@@ -4419,6 +4499,14 @@ export interface Operation {
4419
4499
  value?: string | number | boolean | null | object;
4420
4500
  path?: string;
4421
4501
  }
4502
+ export interface OutboundFailureBucket {
4503
+ /** @format date-time */
4504
+ startUtc: string;
4505
+ /** @format int32 */
4506
+ failedCount: number;
4507
+ /** @format int32 */
4508
+ completedWithErrorsCount: number;
4509
+ }
4422
4510
  export interface OverridePasswordRequest {
4423
4511
  password: string;
4424
4512
  }
@@ -4613,6 +4701,10 @@ export interface RegisterUserRequest {
4613
4701
  /** @format uuid */
4614
4702
  inviteCode?: string | null;
4615
4703
  }
4704
+ export interface RejectAiUrlDomainRequest {
4705
+ host: string;
4706
+ reason: string;
4707
+ }
4616
4708
  export interface RenameAiConversationRequest {
4617
4709
  name: string;
4618
4710
  }
@@ -4741,6 +4833,9 @@ export interface SetPasswordRequest {
4741
4833
  export interface SetSingleCustomFieldValueRequest {
4742
4834
  value?: string | null;
4743
4835
  }
4836
+ export interface SetWebhookSignatureValidationRequest {
4837
+ enabled: boolean;
4838
+ }
4744
4839
  export interface SiteConfiguration {
4745
4840
  /** @format date-time */
4746
4841
  createdAt: string;
@@ -4750,7 +4845,7 @@ export interface SiteConfiguration {
4750
4845
  deletedAt?: string | null;
4751
4846
  /** @format uuid */
4752
4847
  id: string;
4753
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4848
+ type: SiteConfigurationTypeEnum;
4754
4849
  /** @format uuid */
4755
4850
  entityID: string;
4756
4851
  /** @format int32 */
@@ -4944,7 +5039,7 @@ export interface SiteConfigurationByUrl {
4944
5039
  deletedAt?: string | null;
4945
5040
  /** @format uuid */
4946
5041
  id: string;
4947
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5042
+ type: SiteConfigurationByUrlTypeEnum;
4948
5043
  /** @format uuid */
4949
5044
  entityID: string;
4950
5045
  /** @format int32 */
@@ -5155,7 +5250,7 @@ export interface SiteConfigurationForm {
5155
5250
  export interface SiteConfigurationReduced {
5156
5251
  /** @format uuid */
5157
5252
  id: string;
5158
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5253
+ type: SiteConfigurationReducedTypeEnum;
5159
5254
  url?: string | null;
5160
5255
  name: string;
5161
5256
  /** @format int64 */
@@ -5172,7 +5267,7 @@ export interface SiteConfigurationRequest {
5172
5267
  entityID: string;
5173
5268
  /** @format int32 */
5174
5269
  entityType: number;
5175
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5270
+ type: SiteConfigurationRequestTypeEnum;
5176
5271
  url: string;
5177
5272
  name: string;
5178
5273
  introduction?: string | null;
@@ -5348,7 +5443,7 @@ export interface SiteConfigurationSearchCriteria {
5348
5443
  export interface SiteConfigurationSummary {
5349
5444
  /** @format uuid */
5350
5445
  id: string;
5351
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5446
+ type: SiteConfigurationSummaryTypeEnum;
5352
5447
  url?: string | null;
5353
5448
  name: string;
5354
5449
  /** @format int64 */
@@ -5384,7 +5479,7 @@ export interface SiteTile {
5384
5479
  title: string;
5385
5480
  description: string;
5386
5481
  linkUrl: string;
5387
- linkTarget: "Self" | "Blank";
5482
+ linkTarget: SiteTileLinkTargetEnum;
5388
5483
  siteTypes: SiteConfigurationType[];
5389
5484
  locationAudiences: SiteTileLocationAudience[];
5390
5485
  /** @format int32 */
@@ -5396,11 +5491,11 @@ export interface SiteTile {
5396
5491
  updatedAt?: string | null;
5397
5492
  }
5398
5493
  export interface SiteTileLocationAudience {
5399
- location: "HomePage" | "Dashboard";
5494
+ location: SiteTileLocationAudienceLocationEnum;
5400
5495
  audience: UserRole[];
5401
5496
  }
5402
5497
  export interface SiteTileLocationAudienceRequest {
5403
- location: "HomePage" | "Dashboard";
5498
+ location: SiteTileLocationAudienceRequestLocationEnum;
5404
5499
  audience: UserRole[];
5405
5500
  }
5406
5501
  export interface SiteTilePaginated {
@@ -5416,7 +5511,7 @@ export interface SiteTileRequest {
5416
5511
  title: string;
5417
5512
  description: string;
5418
5513
  linkUrl: string;
5419
- linkTarget: "Self" | "Blank";
5514
+ linkTarget: SiteTileRequestLinkTargetEnum;
5420
5515
  siteTypes: SiteConfigurationType[];
5421
5516
  locationAudiences: SiteTileLocationAudienceRequest[];
5422
5517
  /** @format int32 */
@@ -5437,7 +5532,7 @@ export interface SiteTileView {
5437
5532
  title: string;
5438
5533
  description: string;
5439
5534
  linkUrl: string;
5440
- linkTarget: "Self" | "Blank";
5535
+ linkTarget: SiteTileViewLinkTargetEnum;
5441
5536
  /** @format int32 */
5442
5537
  weight: number;
5443
5538
  }
@@ -5668,7 +5763,7 @@ export interface UnregisteredBorrower {
5668
5763
  lastName?: string | null;
5669
5764
  fullName?: string | null;
5670
5765
  email?: string | null;
5671
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5766
+ role: UnregisteredBorrowerRoleEnum;
5672
5767
  }
5673
5768
  export interface UpdateAccountRequest {
5674
5769
  name: string;
@@ -5692,7 +5787,7 @@ export interface UpdateAiCanonicalFieldRequest {
5692
5787
  }
5693
5788
  export interface UpdateAiGuardrailRequest {
5694
5789
  name: string;
5695
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5790
+ category: UpdateAiGuardrailRequestCategoryEnum;
5696
5791
  description?: string | null;
5697
5792
  keywords: string[];
5698
5793
  responseTemplate: string;
@@ -5722,8 +5817,8 @@ export interface UpdateAiUrlSourceRequest {
5722
5817
  name: string;
5723
5818
  url: string;
5724
5819
  description?: string | null;
5725
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5726
- scope: "FullDomain" | "SpecificPath";
5820
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5821
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5727
5822
  }
5728
5823
  export interface UpdateCompanyDocumentFolderRequest {
5729
5824
  name: string;
@@ -6027,7 +6122,7 @@ export interface UserDevice {
6027
6122
  export interface UserDraft {
6028
6123
  /** @format uuid */
6029
6124
  draftID: string;
6030
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6125
+ role: UserDraftRoleEnum;
6031
6126
  user: User;
6032
6127
  }
6033
6128
  export interface UserDraftPaginated {
@@ -6051,7 +6146,7 @@ export interface UserGroupAccessScope {
6051
6146
  id: string;
6052
6147
  /** @format uuid */
6053
6148
  groupId: string;
6054
- scopeType: "User" | "Branch";
6149
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
6055
6150
  /** @format uuid */
6056
6151
  userId?: string | null;
6057
6152
  /** @format uuid */
@@ -6074,7 +6169,7 @@ export interface UserGroupMemberUserSummary {
6074
6169
  id: string;
6075
6170
  name?: string | null;
6076
6171
  email?: string | null;
6077
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6172
+ role: UserGroupMemberUserSummaryRoleEnum;
6078
6173
  }
6079
6174
  export interface UserGroupPaginated {
6080
6175
  rows: UserGroup[];
@@ -6091,7 +6186,7 @@ export interface UserLoan {
6091
6186
  deletedAt?: string | null;
6092
6187
  loanID: string;
6093
6188
  user: User;
6094
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6189
+ role: UserLoanRoleEnum;
6095
6190
  /** @format int32 */
6096
6191
  borrowerPair?: number | null;
6097
6192
  /** @format int32 */
@@ -6103,11 +6198,11 @@ export interface UserLoanConsent {
6103
6198
  id: string;
6104
6199
  /** @format uuid */
6105
6200
  userLoanID: string;
6106
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
6201
+ type: UserLoanConsentTypeEnum;
6107
6202
  providedConsent: boolean;
6108
6203
  source?: ConsentSource | null;
6109
6204
  ipAddress?: string | null;
6110
- losSyncStatus: "NotStarted" | "Failed" | "Success";
6205
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6111
6206
  /** @format date-time */
6112
6207
  createdAt: string;
6113
6208
  /** @format date-time */
@@ -6281,6 +6376,113 @@ export interface Workflow {
6281
6376
  tileSubtitle: string;
6282
6377
  icon: string;
6283
6378
  }
6379
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6380
+ 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";
6381
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
6382
+ export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
6383
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6384
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6385
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6386
+ export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
6387
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6388
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6389
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6390
+ export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
6391
+ export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6392
+ export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
6393
+ export type CompanyDocumentFolderFileIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6394
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6395
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6396
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6397
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6398
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6399
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6400
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6401
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6402
+ /** @deprecated */
6403
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6404
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6405
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6406
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6407
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6408
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6409
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6410
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6411
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6412
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6413
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6414
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6415
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6416
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6417
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6418
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6419
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6420
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
6421
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6422
+ export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6423
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6424
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6425
+ 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";
6426
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6427
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6428
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6429
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6430
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6431
+ export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
6432
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6433
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6434
+ export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
6435
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6436
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6437
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6438
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6439
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6440
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6441
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6442
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6443
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6444
+ export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6445
+ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6446
+ export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6447
+ export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6448
+ export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6449
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6450
+ export type LosSyncOutboundFailuresSearchCriteriaSeverityEnum = "All" | "Failed" | "CompletedWithErrors";
6451
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6452
+ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
6453
+ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6454
+ export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
6455
+ 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";
6456
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6457
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6458
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6459
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6460
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6461
+ export type SiteTileLinkTargetEnum = "Self" | "Blank";
6462
+ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
6463
+ export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
6464
+ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6465
+ export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6466
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6467
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6468
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6469
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6470
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6471
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6472
+ export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6473
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6474
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6475
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6476
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6477
+ export type SetEncompassIntegrationWebhookSignatureValidationParamsWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6478
+ export type SetEncompassIntegrationWebhookSignatureValidationParamsEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6479
+ /** @default "Realtor" */
6480
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6481
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6482
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6483
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6484
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6485
+ export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6284
6486
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6285
6487
  export type QueryParamsType = Record<string | number, any>;
6286
6488
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6303,14 +6505,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6303
6505
  secure?: boolean;
6304
6506
  format?: ResponseType;
6305
6507
  }
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
- }
6508
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6314
6509
  export declare class HttpClient<SecurityDataType = unknown> {
6315
6510
  instance: AxiosInstance;
6316
6511
  private securityData;
@@ -6326,7 +6521,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6326
6521
  }
6327
6522
  /**
6328
6523
  * @title The Big POS API
6329
- * @version v3.1.2
6524
+ * @version v3.1.5
6330
6525
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6331
6526
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6332
6527
  */
@@ -7195,6 +7390,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7195
7390
  * @response `400` `ProblemDetails` Bad Request
7196
7391
  */
7197
7392
  setAiAccountTokenLimit: (accountId: string, data: UpdateAiAccountTokenLimitRequest, params?: RequestParams) => Promise<AxiosResponse<AiTokenBudgetStatus, any, {}>>;
7393
+ /**
7394
+ * No description
7395
+ *
7396
+ * @tags AiUrlDomain
7397
+ * @name GetPendingAiUrlDomains
7398
+ * @summary Get domains awaiting review
7399
+ * @request GET:/api/ai/url-domains/pending
7400
+ * @secure
7401
+ * @response `200` `(AiUrlDomain)[]` OK
7402
+ */
7403
+ getPendingAiUrlDomains: (params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain[], any, {}>>;
7404
+ /**
7405
+ * No description
7406
+ *
7407
+ * @tags AiUrlDomain
7408
+ * @name GetAiUrlDomains
7409
+ * @summary Get reviewed domains
7410
+ * @request GET:/api/ai/url-domains
7411
+ * @secure
7412
+ * @response `200` `(AiUrlDomain)[]` OK
7413
+ */
7414
+ getAiUrlDomains: (params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain[], any, {}>>;
7415
+ /**
7416
+ * No description
7417
+ *
7418
+ * @tags AiUrlDomain
7419
+ * @name ApproveAiUrlDomain
7420
+ * @summary Approve a domain for URL source fetching
7421
+ * @request POST:/api/ai/url-domains/approve
7422
+ * @secure
7423
+ * @response `200` `AiUrlDomain` OK
7424
+ * @response `400` `ProblemDetails` Bad Request
7425
+ */
7426
+ approveAiUrlDomain: (data: ApproveAiUrlDomainRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain, any, {}>>;
7427
+ /**
7428
+ * No description
7429
+ *
7430
+ * @tags AiUrlDomain
7431
+ * @name RejectAiUrlDomain
7432
+ * @summary Reject a domain for URL source fetching
7433
+ * @request POST:/api/ai/url-domains/reject
7434
+ * @secure
7435
+ * @response `200` `AiUrlDomain` OK
7436
+ * @response `400` `ProblemDetails` Bad Request
7437
+ */
7438
+ rejectAiUrlDomain: (data: RejectAiUrlDomainRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlDomain, any, {}>>;
7198
7439
  /**
7199
7440
  * No description
7200
7441
  *
@@ -8110,7 +8351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8110
8351
  * @response `200` `(CustomFieldDefinition)[]` OK
8111
8352
  */
8112
8353
  getCustomFieldDefinitions: (query?: {
8113
- entityType?: "Loan";
8354
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8114
8355
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
8115
8356
  /**
8116
8357
  * No description
@@ -8710,6 +8951,61 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8710
8951
  * @response `403` `ProblemDetails` Forbidden
8711
8952
  */
8712
8953
  recheckEncompassIntegrationWebhooks: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory, any, {}>>;
8954
+ /**
8955
+ * No description
8956
+ *
8957
+ * @tags EncompassIntegrations
8958
+ * @name SyncEncompassIntegrationsWebhookSigningKeys
8959
+ * @summary Backfill the Encompass webhook signing keys for a set of accounts (SuperAdmin)
8960
+ * @request POST:/api/monitoring/encompass-integrations/webhooks/signing-keys/sync
8961
+ * @secure
8962
+ * @response `200` `(LosWebhookSigningKeySyncResult)[]` OK
8963
+ * @response `400` `ProblemDetails` Bad Request
8964
+ * @response `401` `ProblemDetails` Unauthorized
8965
+ * @response `403` `ProblemDetails` Forbidden
8966
+ */
8967
+ syncEncompassIntegrationsWebhookSigningKeys: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhookSigningKeySyncResult[], any, {}>>;
8968
+ /**
8969
+ * No description
8970
+ *
8971
+ * @tags EncompassIntegrations
8972
+ * @name SyncEncompassIntegrationWebhookSigningKeys
8973
+ * @summary Backfill the Encompass webhook signing keys for one account (SuperAdmin)
8974
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/signing-keys/sync
8975
+ * @secure
8976
+ * @response `200` `LosWebhookSigningKeySyncResult` OK
8977
+ * @response `401` `ProblemDetails` Unauthorized
8978
+ * @response `403` `ProblemDetails` Forbidden
8979
+ */
8980
+ syncEncompassIntegrationWebhookSigningKeys: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookSigningKeySyncResult, any, {}>>;
8981
+ /**
8982
+ * No description
8983
+ *
8984
+ * @tags EncompassIntegrations
8985
+ * @name GetEncompassIntegrationWebhookSubscriptions
8986
+ * @summary Get the stored Encompass webhook subscriptions for one account (SuperAdmin)
8987
+ * @request GET:/api/monitoring/encompass-integrations/{accountId}/webhooks/subscriptions
8988
+ * @secure
8989
+ * @response `200` `(EncompassWebhookSubscription)[]` OK
8990
+ * @response `401` `ProblemDetails` Unauthorized
8991
+ * @response `403` `ProblemDetails` Forbidden
8992
+ */
8993
+ getEncompassIntegrationWebhookSubscriptions: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription[], any, {}>>;
8994
+ /**
8995
+ * No description
8996
+ *
8997
+ * @tags EncompassIntegrations
8998
+ * @name SetEncompassIntegrationWebhookSignatureValidation
8999
+ * @summary Turn inbound signature validation on or off for one Encompass webhook subscription (SuperAdmin)
9000
+ * @request PUT:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookType}/signature-validation
9001
+ * @secure
9002
+ * @response `200` `EncompassWebhookSubscription` OK
9003
+ * @response `400` `ProblemDetails` Bad Request
9004
+ * @response `401` `ProblemDetails` Unauthorized
9005
+ * @response `403` `ProblemDetails` Forbidden
9006
+ * @response `404` `ProblemDetails` Not Found
9007
+ */
9008
+ setEncompassIntegrationWebhookSignatureValidation: (accountId: string, webhookType: SetEncompassIntegrationWebhookSignatureValidationParamsEnum, data: SetWebhookSignatureValidationRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription, any, {}>>;
8713
9009
  /**
8714
9010
  * No description
8715
9011
  *
@@ -9821,10 +10117,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9821
10117
  * @summary Download By ID
9822
10118
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9823
10119
  * @secure
9824
- * @response `200` `string` OK
10120
+ * @response `200` `Blob` OK
9825
10121
  * @response `404` `ProblemDetails` Not Found
9826
10122
  */
9827
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
10123
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9828
10124
  /**
9829
10125
  * No description
9830
10126
  *
@@ -10768,6 +11064,79 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10768
11064
  sortBy?: string;
10769
11065
  sortDirection?: string;
10770
11066
  }, params?: RequestParams) => Promise<AxiosResponse<LosOperationTrackingPaginated, any, {}>>;
11067
+ /**
11068
+ * No description
11069
+ *
11070
+ * @tags LosOutboundSyncFailures
11071
+ * @name SearchOutboundSyncFailures
11072
+ * @summary Search cross-account failed outbound Encompass syncs (SuperAdmin)
11073
+ * @request POST:/api/monitoring/outbound-sync-failures/search
11074
+ * @secure
11075
+ * @response `200` `LosSyncPaginated` OK
11076
+ * @response `400` `ProblemDetails` Bad Request
11077
+ * @response `401` `ProblemDetails` Unauthorized
11078
+ * @response `403` `ProblemDetails` Forbidden
11079
+ */
11080
+ searchOutboundSyncFailures: (data: LosSyncOutboundFailuresSearchCriteria, query?: {
11081
+ /** @format int32 */
11082
+ pageSize?: number;
11083
+ /** @format int32 */
11084
+ pageNumber?: number;
11085
+ sortBy?: string;
11086
+ sortDirection?: string;
11087
+ /** @format uuid */
11088
+ accountId?: string;
11089
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSyncPaginated, any, {}>>;
11090
+ /**
11091
+ * No description
11092
+ *
11093
+ * @tags LosOutboundSyncFailures
11094
+ * @name GetOutboundSyncFailuresSummary
11095
+ * @summary Summarize cross-account failed outbound Encompass syncs (SuperAdmin)
11096
+ * @request POST:/api/monitoring/outbound-sync-failures/summary
11097
+ * @secure
11098
+ * @response `200` `LosSyncOutboundFailuresSummary` OK
11099
+ * @response `401` `ProblemDetails` Unauthorized
11100
+ * @response `403` `ProblemDetails` Forbidden
11101
+ */
11102
+ getOutboundSyncFailuresSummary: (data: LosSyncOutboundFailuresSearchCriteria, query?: {
11103
+ /** @format uuid */
11104
+ accountId?: string;
11105
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSyncOutboundFailuresSummary, any, {}>>;
11106
+ /**
11107
+ * No description
11108
+ *
11109
+ * @tags LosOutboundSyncFailures
11110
+ * @name ResyncOutboundSyncFailure
11111
+ * @summary Manually re-sync a failed outbound Encompass sync (SuperAdmin)
11112
+ * @request POST:/api/monitoring/outbound-sync-failures/{correlationId}/resync
11113
+ * @secure
11114
+ * @response `202` `void` Accepted
11115
+ * @response `401` `ProblemDetails` Unauthorized
11116
+ * @response `403` `ProblemDetails` Forbidden
11117
+ * @response `404` `ProblemDetails` Not Found
11118
+ */
11119
+ resyncOutboundSyncFailure: (correlationId: string, query?: {
11120
+ /** @format uuid */
11121
+ accountId?: string;
11122
+ }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11123
+ /**
11124
+ * No description
11125
+ *
11126
+ * @tags LosOutboundSyncFailures
11127
+ * @name GetCurrentOutboundSync
11128
+ * @summary Get the latest outbound Encompass sync for a loan in any state, including in-flight (SuperAdmin)
11129
+ * @request GET:/api/monitoring/outbound-sync-failures/loans/{loanId}/current
11130
+ * @secure
11131
+ * @response `200` `LosSync` OK
11132
+ * @response `401` `ProblemDetails` Unauthorized
11133
+ * @response `403` `ProblemDetails` Forbidden
11134
+ * @response `404` `ProblemDetails` Not Found
11135
+ */
11136
+ getCurrentOutboundSync: (loanId: string, query?: {
11137
+ /** @format uuid */
11138
+ accountId?: string;
11139
+ }, params?: RequestParams) => Promise<AxiosResponse<LosSync, any, {}>>;
10771
11140
  /**
10772
11141
  * No description
10773
11142
  *
@@ -11101,7 +11470,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11101
11470
  getPartners: (query?: {
11102
11471
  showAll?: boolean;
11103
11472
  /** @default "Realtor" */
11104
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
11473
+ role?: GetPartnersParamsRoleEnum;
11105
11474
  /** @format int32 */
11106
11475
  pageSize?: number;
11107
11476
  /** @format int32 */
@@ -11279,7 +11648,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11279
11648
  * @response `200` `File` OK
11280
11649
  * @response `404` `ProblemDetails` Not Found
11281
11650
  */
11282
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11651
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11283
11652
  /**
11284
11653
  * No description
11285
11654
  *
@@ -11290,7 +11659,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11290
11659
  * @secure
11291
11660
  * @response `200` `File` OK
11292
11661
  */
11293
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11662
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11294
11663
  /**
11295
11664
  * No description
11296
11665
  *
@@ -11383,7 +11752,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11383
11752
  getSiteTilesBySiteConfiguration: (query?: {
11384
11753
  /** @format uuid */
11385
11754
  siteConfigurationId?: string;
11386
- location?: "HomePage" | "Dashboard";
11755
+ location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
11387
11756
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
11388
11757
  /**
11389
11758
  * No description