@matech/thebigpos-sdk 2.48.0-rc2 → 2.48.0-rc4

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 (10) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/README.md +10 -0
  4. package/dist/index.d.ts +287 -360
  5. package/dist/index.js +262 -363
  6. package/dist/index.js.map +1 -1
  7. package/package.json +4 -1
  8. package/scripts/apply-json-patch-content-type.js +129 -36
  9. package/src/index.ts +1271 -1218
  10. package/tsconfig.json +27 -27
package/dist/index.d.ts CHANGED
@@ -65,8 +65,6 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
65
65
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
66
66
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
67
67
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
68
- export type CompanyDocumentSourceType = "File" | "FreeText";
69
- export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
70
68
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
71
69
  export type BranchType = "Mortgage" | "RealEstate";
72
70
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -135,7 +133,7 @@ export interface AccountBilling {
135
133
  contractedRate: number;
136
134
  }
137
135
  export interface AccountBillingRequest {
138
- billingType: "ClosedLoan" | "LoanOfficer";
136
+ billingType: AccountBillingRequestBillingTypeEnum;
139
137
  /** @format double */
140
138
  contractedRate: number;
141
139
  }
@@ -183,7 +181,7 @@ export interface Action {
183
181
  comments?: string | null;
184
182
  /** @format uuid */
185
183
  siteConfigurationID: string;
186
- applicationSettings?: any;
184
+ applicationSettings?: any | null;
187
185
  surveysToken?: string | null;
188
186
  }
189
187
  export interface Address {
@@ -406,7 +404,7 @@ export interface AiAuditLog {
406
404
  conversationId?: string | null;
407
405
  /** @format uuid */
408
406
  messageId?: string | null;
409
- eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
407
+ eventType: AiAuditLogEventTypeEnum;
410
408
  modelId?: string | null;
411
409
  /** @format int32 */
412
410
  inputTokens?: number | null;
@@ -419,7 +417,7 @@ export interface AiAuditLog {
419
417
  guardrailCategory?: string | null;
420
418
  rawRequest?: string | null;
421
419
  rawResponse?: string | null;
422
- details?: any;
420
+ details?: any | null;
423
421
  /** @format date-time */
424
422
  createdAt: string;
425
423
  }
@@ -481,7 +479,7 @@ export interface AiChatMessagePaginated {
481
479
  count: number;
482
480
  }
483
481
  export interface AiChatMetadata {
484
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
482
+ intent: AiChatMetadataIntentEnum;
485
483
  fieldsAccessed: string[];
486
484
  /** @format int64 */
487
485
  queryTimeMs: number;
@@ -507,7 +505,7 @@ export interface AiChatRequest {
507
505
  promptId?: string | null;
508
506
  }
509
507
  export interface AiChatStructuredData {
510
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
508
+ type: AiChatStructuredDataTypeEnum;
511
509
  displayHint?: AiDisplayHint | null;
512
510
  detectedDocumentType?: string | null;
513
511
  columns: string[];
@@ -585,7 +583,7 @@ export interface AiGuardrail {
585
583
  /** @format uuid */
586
584
  id: string;
587
585
  name: string;
588
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
586
+ category: AiGuardrailCategoryEnum;
589
587
  description?: string | null;
590
588
  keywords: string[];
591
589
  responseTemplate: string;
@@ -712,8 +710,8 @@ export interface AiUrlSource {
712
710
  name: string;
713
711
  url: string;
714
712
  description?: string | null;
715
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
716
- scope: "FullDomain" | "SpecificPath";
713
+ category: AiUrlSourceCategoryEnum;
714
+ scope: AiUrlSourceScopeEnum;
717
715
  isActive: boolean;
718
716
  isDefault: boolean;
719
717
  hasAccountOverride: boolean;
@@ -820,14 +818,14 @@ export interface AuditLogEntry {
820
818
  /** @format uuid */
821
819
  id: string;
822
820
  entityType: string;
823
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
821
+ changeType: AuditLogEntryChangeTypeEnum;
824
822
  /** @format uuid */
825
823
  entityId: string;
826
824
  performedBy?: AuditLogUser | null;
827
825
  rootEntityType?: string | null;
828
826
  /** @format uuid */
829
827
  rootEntityId?: string | null;
830
- changes?: any;
828
+ changes?: any | null;
831
829
  /** @format date-time */
832
830
  createdAt: string;
833
831
  }
@@ -867,7 +865,7 @@ export interface BorrowerCount {
867
865
  firstName: string;
868
866
  lastName: string;
869
867
  email: string;
870
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
868
+ role: BorrowerCountRoleEnum;
871
869
  /** @format int32 */
872
870
  count: number;
873
871
  }
@@ -877,7 +875,7 @@ export interface BorrowerIdentity {
877
875
  firstName: string;
878
876
  lastName: string;
879
877
  email: string;
880
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
878
+ role: BorrowerIdentityRoleEnum;
881
879
  }
882
880
  export interface BorrowersNotUsingPosSummary {
883
881
  /** @format int32 */
@@ -1038,55 +1036,6 @@ export interface CompanyAddress {
1038
1036
  state: string;
1039
1037
  zip: string;
1040
1038
  }
1041
- export interface CompanyDocument {
1042
- /** @format uuid */
1043
- id: string;
1044
- /** @format uuid */
1045
- folderId: string;
1046
- folderName: string;
1047
- name: string;
1048
- sourceType: "File" | "FreeText";
1049
- contentType?: string | null;
1050
- /** @format int64 */
1051
- fileSizeBytes: number;
1052
- inlineContent?: string | null;
1053
- indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1054
- indexError?: string | null;
1055
- /** @format date-time */
1056
- indexedAt?: string | null;
1057
- /** @format uuid */
1058
- uploadedByUserId?: string | null;
1059
- /** @format date-time */
1060
- createdAt: string;
1061
- /** @format date-time */
1062
- updatedAt?: string | null;
1063
- }
1064
- export interface CompanyDocumentFolder {
1065
- /** @format uuid */
1066
- id: string;
1067
- name: string;
1068
- description?: string | null;
1069
- isSystemDefault: boolean;
1070
- /** @format int32 */
1071
- documentCount: number;
1072
- /** @format date-time */
1073
- createdAt: string;
1074
- /** @format date-time */
1075
- updatedAt?: string | null;
1076
- }
1077
- export interface CompanyDocumentPaginated {
1078
- rows: CompanyDocument[];
1079
- pagination: Pagination;
1080
- /** @format int64 */
1081
- count: number;
1082
- }
1083
- export interface CompanyDocumentSearchCriteria {
1084
- searchText?: string | null;
1085
- /** @format uuid */
1086
- folderID?: string | null;
1087
- indexStatuses?: CompanyDocumentIndexStatus[] | null;
1088
- sourceType?: CompanyDocumentSourceType | null;
1089
- }
1090
1039
  export interface ConditionComment {
1091
1040
  commentId: string;
1092
1041
  comments: string;
@@ -1161,7 +1110,7 @@ export interface CorporateSearchCriteria {
1161
1110
  isActive?: boolean | null;
1162
1111
  }
1163
1112
  export interface CreateAccessScopeRequest {
1164
- scopeType: "User" | "Branch";
1113
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1165
1114
  /** @format uuid */
1166
1115
  userId?: string | null;
1167
1116
  /** @format uuid */
@@ -1179,7 +1128,7 @@ export interface CreateAccountRequest {
1179
1128
  /** @format int64 */
1180
1129
  nlmsid: number;
1181
1130
  settings: AccountSettingsRequest;
1182
- environment: "Development" | "Staging" | "UAT" | "Production";
1131
+ environment: CreateAccountRequestEnvironmentEnum;
1183
1132
  losIntegration: LOSIntegration;
1184
1133
  billingSettings: AccountBillingRequest;
1185
1134
  }
@@ -1193,7 +1142,7 @@ export interface CreateAiCanonicalFieldRequest {
1193
1142
  }
1194
1143
  export interface CreateAiGuardrailRequest {
1195
1144
  name: string;
1196
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1145
+ category: CreateAiGuardrailRequestCategoryEnum;
1197
1146
  description?: string | null;
1198
1147
  keywords: string[];
1199
1148
  responseTemplate: string;
@@ -1223,8 +1172,8 @@ export interface CreateAiUrlSourceRequest {
1223
1172
  name: string;
1224
1173
  url: string;
1225
1174
  description?: string | null;
1226
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1227
- scope: "FullDomain" | "SpecificPath";
1175
+ category: CreateAiUrlSourceRequestCategoryEnum;
1176
+ scope: CreateAiUrlSourceRequestScopeEnum;
1228
1177
  }
1229
1178
  export interface CreateBranchRequest {
1230
1179
  name: string;
@@ -1232,16 +1181,6 @@ export interface CreateBranchRequest {
1232
1181
  corporateID: string;
1233
1182
  type: string;
1234
1183
  }
1235
- export interface CreateCompanyDocumentFolderRequest {
1236
- name: string;
1237
- description?: string | null;
1238
- }
1239
- export interface CreateCompanyTextDocumentRequest {
1240
- name: string;
1241
- /** @format uuid */
1242
- folderID: string;
1243
- content: string;
1244
- }
1245
1184
  export interface CreateCustomFieldDefinitionRequest {
1246
1185
  isRequired: boolean;
1247
1186
  /** @format int32 */
@@ -1257,8 +1196,8 @@ export interface CreateCustomFieldDefinitionRequest {
1257
1196
  name: string;
1258
1197
  defaultValue?: string | null;
1259
1198
  regexPattern?: string | null;
1260
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1261
- entityType: "Loan";
1199
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1200
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1262
1201
  options?: CustomFieldOptionRequest[] | null;
1263
1202
  permissions?: CustomFieldPermissionRequest[] | null;
1264
1203
  }
@@ -1273,7 +1212,7 @@ export interface CreateDocumentTemplateRequest {
1273
1212
  export interface CreateGroupMemberRequest {
1274
1213
  /** @format uuid */
1275
1214
  userId: string;
1276
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1215
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1277
1216
  }
1278
1217
  export interface CreateInviteRequest {
1279
1218
  firstName: string;
@@ -1281,7 +1220,7 @@ export interface CreateInviteRequest {
1281
1220
  emailAddress: string;
1282
1221
  phoneNumber?: string | null;
1283
1222
  /** @deprecated */
1284
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1223
+ relationship: CreateInviteRequestRelationshipEnum;
1285
1224
  loanID: string;
1286
1225
  route?: string | null;
1287
1226
  /** @format uuid */
@@ -1301,7 +1240,7 @@ export interface CreateLoanImportRequest {
1301
1240
  endDate: string;
1302
1241
  /** @format date-time */
1303
1242
  startDate: string;
1304
- importMode: "All" | "NewOnly" | "UpdateOnly";
1243
+ importMode: CreateLoanImportRequestImportModeEnum;
1305
1244
  }
1306
1245
  export interface CreateSession {
1307
1246
  sessionId: string;
@@ -1319,7 +1258,7 @@ export interface CreateUserDeviceRequest {
1319
1258
  token: string;
1320
1259
  }
1321
1260
  export interface CreateUserDraft {
1322
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1261
+ loanRole: CreateUserDraftLoanRoleEnum;
1323
1262
  }
1324
1263
  export interface CreateUserGroupRequest {
1325
1264
  name: string;
@@ -1380,8 +1319,8 @@ export interface CustomFieldDefinition {
1380
1319
  name: string;
1381
1320
  defaultValue?: string | null;
1382
1321
  regexPattern?: string | null;
1383
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1384
- entityType: "Loan";
1322
+ dataType: CustomFieldDefinitionDataTypeEnum;
1323
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1385
1324
  options: CustomFieldOption[];
1386
1325
  permissions: CustomFieldPermission[];
1387
1326
  encompassMapping?: EncompassMapping | null;
@@ -1395,7 +1334,7 @@ export interface CustomFieldEntry {
1395
1334
  displayOrder: number;
1396
1335
  name: string;
1397
1336
  value: string;
1398
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1337
+ dataType: CustomFieldEntryDataTypeEnum;
1399
1338
  }
1400
1339
  export interface CustomFieldOption {
1401
1340
  /** @format uuid */
@@ -1412,12 +1351,12 @@ export interface CustomFieldOptionRequest {
1412
1351
  export interface CustomFieldPermission {
1413
1352
  /** @format uuid */
1414
1353
  id: string;
1415
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1416
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1354
+ role: CustomFieldPermissionRoleEnum;
1355
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1417
1356
  }
1418
1357
  export interface CustomFieldPermissionRequest {
1419
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1420
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1358
+ role: CustomFieldPermissionRequestRoleEnum;
1359
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1421
1360
  }
1422
1361
  export interface CustomFieldValue {
1423
1362
  /** @format uuid */
@@ -1428,7 +1367,7 @@ export interface CustomFieldValue {
1428
1367
  customFieldDefinitionID: string;
1429
1368
  value: string;
1430
1369
  definitionName: string;
1431
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1370
+ dataType: CustomFieldValueDataTypeEnum;
1432
1371
  }
1433
1372
  export interface DetailedUser {
1434
1373
  /** @format date-time */
@@ -1654,7 +1593,7 @@ export interface Draft {
1654
1593
  siteConfiguration: SiteConfigurationReduced;
1655
1594
  /** @format uuid */
1656
1595
  loanID?: string | null;
1657
- type: "NewLoan" | "EditLoan";
1596
+ type: DraftTypeEnum;
1658
1597
  isCoBorrower: boolean;
1659
1598
  }
1660
1599
  export interface DraftContent {
@@ -1672,7 +1611,7 @@ export interface DraftContent {
1672
1611
  siteConfiguration: SiteConfigurationReduced;
1673
1612
  /** @format uuid */
1674
1613
  loanID?: string | null;
1675
- type: "NewLoan" | "EditLoan";
1614
+ type: DraftContentTypeEnum;
1676
1615
  isCoBorrower: boolean;
1677
1616
  applicationPayload: any;
1678
1617
  }
@@ -1688,7 +1627,7 @@ export interface DraftLoanOfficerReassignRequest {
1688
1627
  }
1689
1628
  export interface DraftRequest {
1690
1629
  applicationPayload: any;
1691
- customData?: any;
1630
+ customData?: any | null;
1692
1631
  isCoBorrower: boolean;
1693
1632
  }
1694
1633
  export interface EconsentPendingSummary {
@@ -1758,9 +1697,9 @@ export interface EncompassCredentialsDetail {
1758
1697
  clearStateIfUnlicensed: boolean;
1759
1698
  /** @deprecated */
1760
1699
  baseUrl?: string | null;
1761
- encompassEnvironment: "Production" | "UAT";
1700
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1762
1701
  consumerConnectWidgetHost?: string | null;
1763
- signingMethod: "ConsumerConnect" | "POSF";
1702
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1764
1703
  subscriptionId?: string | null;
1765
1704
  environment?: string | null;
1766
1705
  /** @format uuid */
@@ -1776,9 +1715,9 @@ export interface EncompassCredentialsRequest {
1776
1715
  clearStateIfUnlicensed: boolean;
1777
1716
  /** @deprecated */
1778
1717
  baseUrl?: string | null;
1779
- encompassEnvironment: "Production" | "UAT";
1718
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1780
1719
  consumerConnectWidgetHost?: string | null;
1781
- signingMethod: "ConsumerConnect" | "POSF";
1720
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1782
1721
  subscriptionId?: string | null;
1783
1722
  environment?: string | null;
1784
1723
  clientID?: string | null;
@@ -1888,8 +1827,8 @@ export interface EncompassRequestLog {
1888
1827
  losId?: string | null;
1889
1828
  /** @format uuid */
1890
1829
  accountId: string;
1891
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1892
- outcome: "Success" | "Failure" | "PartialSuccess";
1830
+ operationType: EncompassRequestLogOperationTypeEnum;
1831
+ outcome: EncompassRequestLogOutcomeEnum;
1893
1832
  message: string;
1894
1833
  endpoint?: string | null;
1895
1834
  httpMethod?: string | null;
@@ -1897,7 +1836,7 @@ export interface EncompassRequestLog {
1897
1836
  httpStatusCode?: number | null;
1898
1837
  /** @format int64 */
1899
1838
  durationMs?: number | null;
1900
- context?: any;
1839
+ context?: any | null;
1901
1840
  /** @format date-time */
1902
1841
  createdAt: string;
1903
1842
  }
@@ -1942,7 +1881,7 @@ export interface FileSearchCriteria {
1942
1881
  export interface FileWithBytes {
1943
1882
  name: string;
1944
1883
  /** @format byte */
1945
- data: string;
1884
+ data: Blob;
1946
1885
  fileName: string;
1947
1886
  mimeType?: string | null;
1948
1887
  extension?: string | null;
@@ -2018,7 +1957,7 @@ export interface FormSubmission {
2018
1957
  subjectPropertyAddressCounty?: string | null;
2019
1958
  subjectPropertyAddressState?: string | null;
2020
1959
  subjectPropertyAddressZip?: string | null;
2021
- data?: any;
1960
+ data?: any | null;
2022
1961
  /** @format uuid */
2023
1962
  listingID?: string | null;
2024
1963
  listing?: Listing | null;
@@ -2053,7 +1992,7 @@ export interface FormSubmissionRequest {
2053
1992
  subjectPropertyAddressCounty?: string | null;
2054
1993
  subjectPropertyAddressState?: string | null;
2055
1994
  subjectPropertyAddressZip?: string | null;
2056
- data?: any;
1995
+ data?: any | null;
2057
1996
  /** @format uuid */
2058
1997
  listingID?: string | null;
2059
1998
  }
@@ -2102,7 +2041,7 @@ export interface FusionFieldDisplay {
2102
2041
  fieldValue: string;
2103
2042
  }
2104
2043
  export interface FusionReportFilter {
2105
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2044
+ filterType: FusionReportFilterFilterTypeEnum;
2106
2045
  targetField: string;
2107
2046
  targetValue: string;
2108
2047
  }
@@ -2122,7 +2061,7 @@ export interface GenerateSystemPrompt {
2122
2061
  }
2123
2062
  export interface GenerateSystemPromptRequest {
2124
2063
  description: string;
2125
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2064
+ category: GenerateSystemPromptRequestCategoryEnum;
2126
2065
  }
2127
2066
  export interface GetApplications {
2128
2067
  applications: ApplicationRowData[];
@@ -2206,11 +2145,11 @@ export interface GetWorkflowRequest {
2206
2145
  export interface GuidPatchOperation {
2207
2146
  op: string;
2208
2147
  path: string;
2209
- value?: any;
2148
+ value?: any | null;
2210
2149
  from?: string | null;
2211
2150
  }
2212
2151
  export interface IPAddress {
2213
- addressFamily: "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
2152
+ addressFamily: IpAddressAddressFamilyEnum;
2214
2153
  /** @format int64 */
2215
2154
  scopeId: number;
2216
2155
  isIPv6Multicast: boolean;
@@ -2459,7 +2398,7 @@ export interface Loan {
2459
2398
  contacts: LoanContact[];
2460
2399
  customFields: CustomFieldEntry[];
2461
2400
  milestones: LoanMilestone[];
2462
- signingMethod: "ConsumerConnect" | "POSF";
2401
+ signingMethod: LoanSigningMethodEnum;
2463
2402
  }
2464
2403
  export interface LoanApplication {
2465
2404
  /** @format uuid */
@@ -2497,7 +2436,7 @@ export interface LoanApplicationRequest {
2497
2436
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2498
2437
  /** @format uuid */
2499
2438
  draftId?: string | null;
2500
- additionalFields?: Record<string, any>;
2439
+ additionalFields?: Record<string, any> | null;
2501
2440
  /** @format uuid */
2502
2441
  existingLoanId?: string | null;
2503
2442
  }
@@ -2516,7 +2455,7 @@ export interface LoanBorrower {
2516
2455
  citizenship?: LoanCitizenship | null;
2517
2456
  maritalStatus?: LoanMaritalStatus | null;
2518
2457
  languagePreference?: LoanLanguagePreference | null;
2519
- applicationStatus: "Draft" | "Complete";
2458
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2520
2459
  /** @format int32 */
2521
2460
  numberOfDependents?: number | null;
2522
2461
  /** @format int32 */
@@ -3242,7 +3181,7 @@ export interface LoanConsentRequest {
3242
3181
  borrowerEConsent?: boolean | null;
3243
3182
  borrowerCreditAuth?: boolean | null;
3244
3183
  borrowerTCPAOptIn?: boolean | null;
3245
- additionalFields?: Record<string, string>;
3184
+ additionalFields?: Record<string, string> | null;
3246
3185
  }
3247
3186
  export interface LoanContact {
3248
3187
  /** @format date-time */
@@ -3260,7 +3199,7 @@ export interface LoanContact {
3260
3199
  email?: string | null;
3261
3200
  phone?: string | null;
3262
3201
  companyName?: string | null;
3263
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3202
+ role: LoanContactRoleEnum;
3264
3203
  }
3265
3204
  export interface LoanContactList {
3266
3205
  email: string;
@@ -3282,7 +3221,7 @@ export interface LoanCostDetails {
3282
3221
  totalFinancing?: number | null;
3283
3222
  }
3284
3223
  export interface LoanCustomFieldsRequest {
3285
- additionalFields?: Record<string, string>;
3224
+ additionalFields?: Record<string, string> | null;
3286
3225
  }
3287
3226
  export interface LoanDocument {
3288
3227
  /** @format date-time */
@@ -3332,12 +3271,12 @@ export interface LoanDocumentFolderPermission {
3332
3271
  id: string;
3333
3272
  /** @format uuid */
3334
3273
  loanDocumentFolderID: string;
3335
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3336
- level: "None" | "Read" | "Write" | "Manage";
3274
+ role: LoanDocumentFolderPermissionRoleEnum;
3275
+ level: LoanDocumentFolderPermissionLevelEnum;
3337
3276
  }
3338
3277
  export interface LoanDocumentFolderPermissionRequest {
3339
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3340
- level: "None" | "Read" | "Write" | "Manage";
3278
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3279
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3341
3280
  }
3342
3281
  export interface LoanDocumentFolderUsage {
3343
3282
  /** @format uuid */
@@ -3471,13 +3410,13 @@ export interface LoanImport {
3471
3410
  /** @format int32 */
3472
3411
  importedCount: number;
3473
3412
  statusMessage?: string | null;
3474
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3475
- importMode: "All" | "NewOnly" | "UpdateOnly";
3413
+ status: LoanImportStatusEnum;
3414
+ importMode: LoanImportImportModeEnum;
3476
3415
  /** @format date-time */
3477
3416
  createdAt?: string | null;
3478
3417
  }
3479
3418
  export interface LoanImportLog {
3480
- level: "None" | "Info" | "Warning" | "Error";
3419
+ level: LoanImportLogLevelEnum;
3481
3420
  message: string;
3482
3421
  /** @format date-time */
3483
3422
  createdAt: string;
@@ -3532,8 +3471,8 @@ export interface LoanListPaginated {
3532
3471
  export interface LoanLog {
3533
3472
  /** @format uuid */
3534
3473
  id: string;
3535
- level: "None" | "Info" | "Warning" | "Error";
3536
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3474
+ level: LoanLogLevelEnum;
3475
+ type: LoanLogTypeEnum;
3537
3476
  message: string;
3538
3477
  /** @format date-time */
3539
3478
  createdAt: string;
@@ -3541,8 +3480,8 @@ export interface LoanLog {
3541
3480
  export interface LoanLogDetail {
3542
3481
  /** @format uuid */
3543
3482
  id: string;
3544
- level: "None" | "Info" | "Warning" | "Error";
3545
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3483
+ level: LoanLogDetailLevelEnum;
3484
+ type: LoanLogDetailTypeEnum;
3546
3485
  message: string;
3547
3486
  /** @format date-time */
3548
3487
  createdAt: string;
@@ -3804,7 +3743,7 @@ export interface LoanQueueWithData {
3804
3743
  user: UserPublic;
3805
3744
  loanOfficer: LoanOfficerPublic;
3806
3745
  siteConfiguration: SiteConfigurationReduced;
3807
- data?: any;
3746
+ data?: any | null;
3808
3747
  }
3809
3748
  export interface LoanRecord {
3810
3749
  loanGuid: string;
@@ -3835,7 +3774,7 @@ export interface LoanTaskSearchRequest {
3835
3774
  loanStatus?: LoanTaskActivityFilter | null;
3836
3775
  }
3837
3776
  export interface LoanTaskStatusSummary {
3838
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3777
+ status: LoanTaskStatusSummaryStatusEnum;
3839
3778
  /** @format int32 */
3840
3779
  count: number;
3841
3780
  }
@@ -3847,7 +3786,7 @@ export interface LoanUser {
3847
3786
  email: string;
3848
3787
  phone?: string | null;
3849
3788
  role: string;
3850
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3789
+ loanRole: LoanUserLoanRoleEnum;
3851
3790
  isUser: boolean;
3852
3791
  /** @format date-time */
3853
3792
  createdAt: string;
@@ -3881,7 +3820,7 @@ export interface LosOperationTracking {
3881
3820
  operationType: string;
3882
3821
  correlationKey: string;
3883
3822
  lastTriggerSource?: string | null;
3884
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3823
+ status: LosOperationTrackingStatusEnum;
3885
3824
  /** @format date-time */
3886
3825
  createdAt: string;
3887
3826
  /** @format date-time */
@@ -3922,6 +3861,12 @@ export interface LosSync {
3922
3861
  completedAtUtc?: string | null;
3923
3862
  /** @format date-time */
3924
3863
  failedAtUtc?: string | null;
3864
+ /** @format int32 */
3865
+ redriveCount: number;
3866
+ /** @format date-time */
3867
+ nextRedriveAtUtc?: string | null;
3868
+ /** @format date-time */
3869
+ redriveExhaustedAtUtc?: string | null;
3925
3870
  errors: string[];
3926
3871
  steps: LosSyncStep[];
3927
3872
  }
@@ -3961,7 +3906,7 @@ export interface LosSyncStep {
3961
3906
  /** @format int32 */
3962
3907
  order: number;
3963
3908
  name: string;
3964
- severity: "Success" | "Info" | "Warning" | "Error";
3909
+ severity: LosSyncStepSeverityEnum;
3965
3910
  message: string;
3966
3911
  /** @format date-time */
3967
3912
  atUtc: string;
@@ -3975,7 +3920,7 @@ export interface LosWebhook {
3975
3920
  enableSubscription: boolean;
3976
3921
  }
3977
3922
  export interface ManualDocumentClassificationRequest {
3978
- documentType: "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
3923
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
3979
3924
  }
3980
3925
  export interface MdmUser {
3981
3926
  user_email?: string | null;
@@ -4039,6 +3984,10 @@ export interface MobileSettings {
4039
3984
  universalUrl?: string | null;
4040
3985
  appleStoreUrl?: string | null;
4041
3986
  googlePlayStoreUrl?: string | null;
3987
+ appleTeamId?: string | null;
3988
+ appleBundleId?: string | null;
3989
+ androidPackageName?: string | null;
3990
+ androidSha256CertFingerprints?: string[] | null;
4042
3991
  }
4043
3992
  export interface Module {
4044
3993
  /** @format uuid */
@@ -4054,7 +4003,7 @@ export interface ModuleParameterValue {
4054
4003
  parameterID: string;
4055
4004
  parameterName: string;
4056
4005
  parameterType: string;
4057
- value?: any;
4006
+ value?: any | null;
4058
4007
  isInherited: boolean;
4059
4008
  }
4060
4009
  export interface MonthlyPaymentCalculator {
@@ -4227,7 +4176,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4227
4176
  }
4228
4177
  export interface Operation {
4229
4178
  op?: string;
4230
- value?: string | number | boolean | null | object;
4179
+ value?: object | null;
4231
4180
  path?: string;
4232
4181
  }
4233
4182
  export interface OverridePasswordRequest {
@@ -4430,6 +4379,10 @@ export interface RenameAiConversationRequest {
4430
4379
  export interface RequestImpersonationRequest {
4431
4380
  email: string;
4432
4381
  }
4382
+ export interface ResetPasswordRequest {
4383
+ token: string;
4384
+ password: string;
4385
+ }
4433
4386
  export interface RunLOCalculation {
4434
4387
  loanID: string;
4435
4388
  loanAmount?: string | null;
@@ -4541,6 +4494,10 @@ export interface SetCustomFieldValueRequest {
4541
4494
  definitionId: string;
4542
4495
  value?: string | null;
4543
4496
  }
4497
+ export interface SetPasswordRequest {
4498
+ token: string;
4499
+ password: string;
4500
+ }
4544
4501
  export interface SetSingleCustomFieldValueRequest {
4545
4502
  value?: string | null;
4546
4503
  }
@@ -4553,7 +4510,7 @@ export interface SiteConfiguration {
4553
4510
  deletedAt?: string | null;
4554
4511
  /** @format uuid */
4555
4512
  id: string;
4556
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4513
+ type: SiteConfigurationTypeEnum;
4557
4514
  /** @format uuid */
4558
4515
  entityID: string;
4559
4516
  /** @format int32 */
@@ -4747,7 +4704,7 @@ export interface SiteConfigurationByUrl {
4747
4704
  deletedAt?: string | null;
4748
4705
  /** @format uuid */
4749
4706
  id: string;
4750
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4707
+ type: SiteConfigurationByUrlTypeEnum;
4751
4708
  /** @format uuid */
4752
4709
  entityID: string;
4753
4710
  /** @format int32 */
@@ -4958,7 +4915,7 @@ export interface SiteConfigurationForm {
4958
4915
  export interface SiteConfigurationReduced {
4959
4916
  /** @format uuid */
4960
4917
  id: string;
4961
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4918
+ type: SiteConfigurationReducedTypeEnum;
4962
4919
  url?: string | null;
4963
4920
  name: string;
4964
4921
  /** @format int64 */
@@ -4975,7 +4932,7 @@ export interface SiteConfigurationRequest {
4975
4932
  entityID: string;
4976
4933
  /** @format int32 */
4977
4934
  entityType: number;
4978
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4935
+ type: SiteConfigurationRequestTypeEnum;
4979
4936
  url: string;
4980
4937
  name: string;
4981
4938
  introduction?: string | null;
@@ -5151,7 +5108,7 @@ export interface SiteConfigurationSearchCriteria {
5151
5108
  export interface SiteConfigurationSummary {
5152
5109
  /** @format uuid */
5153
5110
  id: string;
5154
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5111
+ type: SiteConfigurationSummaryTypeEnum;
5155
5112
  url?: string | null;
5156
5113
  name: string;
5157
5114
  /** @format int64 */
@@ -5187,7 +5144,7 @@ export interface SiteTile {
5187
5144
  title: string;
5188
5145
  description: string;
5189
5146
  linkUrl: string;
5190
- linkTarget: "Self" | "Blank";
5147
+ linkTarget: SiteTileLinkTargetEnum;
5191
5148
  siteTypes: SiteConfigurationType[];
5192
5149
  locations: SiteTileLocation[];
5193
5150
  audience: UserRole[];
@@ -5212,7 +5169,7 @@ export interface SiteTileRequest {
5212
5169
  title: string;
5213
5170
  description: string;
5214
5171
  linkUrl: string;
5215
- linkTarget: "Self" | "Blank";
5172
+ linkTarget: SiteTileRequestLinkTargetEnum;
5216
5173
  siteTypes: SiteConfigurationType[];
5217
5174
  locations: SiteTileLocation[];
5218
5175
  audience: UserRole[];
@@ -5234,7 +5191,7 @@ export interface SiteTileView {
5234
5191
  title: string;
5235
5192
  description: string;
5236
5193
  linkUrl: string;
5237
- linkTarget: "Self" | "Blank";
5194
+ linkTarget: SiteTileViewLinkTargetEnum;
5238
5195
  /** @format int32 */
5239
5196
  weight: number;
5240
5197
  }
@@ -5465,7 +5422,7 @@ export interface UnregisteredBorrower {
5465
5422
  lastName?: string | null;
5466
5423
  fullName?: string | null;
5467
5424
  email?: string | null;
5468
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5425
+ role: UnregisteredBorrowerRoleEnum;
5469
5426
  }
5470
5427
  export interface UpdateAccountRequest {
5471
5428
  name: string;
@@ -5489,7 +5446,7 @@ export interface UpdateAiCanonicalFieldRequest {
5489
5446
  }
5490
5447
  export interface UpdateAiGuardrailRequest {
5491
5448
  name: string;
5492
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5449
+ category: UpdateAiGuardrailRequestCategoryEnum;
5493
5450
  description?: string | null;
5494
5451
  keywords: string[];
5495
5452
  responseTemplate: string;
@@ -5522,18 +5479,8 @@ export interface UpdateAiUrlSourceRequest {
5522
5479
  name: string;
5523
5480
  url: string;
5524
5481
  description?: string | null;
5525
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5526
- scope: "FullDomain" | "SpecificPath";
5527
- }
5528
- export interface UpdateCompanyDocumentFolderRequest {
5529
- name: string;
5530
- description?: string | null;
5531
- }
5532
- export interface UpdateCompanyDocumentRequest {
5533
- name?: string | null;
5534
- /** @format uuid */
5535
- folderID?: string | null;
5536
- content?: string | null;
5482
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5483
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5537
5484
  }
5538
5485
  export interface UpdateCustomFieldDefinitionRequest {
5539
5486
  isRequired: boolean;
@@ -5820,7 +5767,7 @@ export interface UserDevice {
5820
5767
  export interface UserDraft {
5821
5768
  /** @format uuid */
5822
5769
  draftID: string;
5823
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5770
+ role: UserDraftRoleEnum;
5824
5771
  user: User;
5825
5772
  }
5826
5773
  export interface UserDraftPaginated {
@@ -5844,7 +5791,7 @@ export interface UserGroupAccessScope {
5844
5791
  id: string;
5845
5792
  /** @format uuid */
5846
5793
  groupId: string;
5847
- scopeType: "User" | "Branch";
5794
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5848
5795
  /** @format uuid */
5849
5796
  userId?: string | null;
5850
5797
  /** @format uuid */
@@ -5877,7 +5824,7 @@ export interface UserLoan {
5877
5824
  deletedAt?: string | null;
5878
5825
  loanID: string;
5879
5826
  user: User;
5880
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5827
+ role: UserLoanRoleEnum;
5881
5828
  /** @format int32 */
5882
5829
  borrowerPair?: number | null;
5883
5830
  /** @format int32 */
@@ -5889,11 +5836,11 @@ export interface UserLoanConsent {
5889
5836
  id: string;
5890
5837
  /** @format uuid */
5891
5838
  userLoanID: string;
5892
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5839
+ type: UserLoanConsentTypeEnum;
5893
5840
  providedConsent: boolean;
5894
5841
  source?: ConsentSource | null;
5895
5842
  ipAddress?: string | null;
5896
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5843
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5897
5844
  /** @format date-time */
5898
5845
  createdAt: string;
5899
5846
  /** @format date-time */
@@ -6023,7 +5970,10 @@ export interface UserSummary {
6023
5970
  id: string;
6024
5971
  name?: string | null;
6025
5972
  email?: string | null;
6026
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5973
+ role: UserSummaryRoleEnum;
5974
+ }
5975
+ export interface VerifyEmailRequest {
5976
+ token: string;
6027
5977
  }
6028
5978
  export interface VerifyPasswordRequest {
6029
5979
  email: string;
@@ -6050,6 +6000,92 @@ export interface Workflow {
6050
6000
  tileSubtitle: string;
6051
6001
  icon: string;
6052
6002
  }
6003
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6004
+ export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
6005
+ export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
6006
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
6007
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6008
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6009
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6010
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
6011
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6012
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6013
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6014
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6015
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6016
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6017
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6018
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6019
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6020
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6021
+ /** @deprecated */
6022
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6023
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6024
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6025
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6026
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6027
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6028
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6029
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6030
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6031
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6032
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6033
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6034
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6035
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6036
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6037
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6038
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6039
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
6040
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6041
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6042
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6043
+ export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
6044
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6045
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6046
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6047
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6048
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6049
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6050
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6051
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6052
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6053
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6054
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6055
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6056
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6057
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6058
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6059
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6060
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6061
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6062
+ export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
6063
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6064
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6065
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6066
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6067
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6068
+ export type SiteTileLinkTargetEnum = "Self" | "Blank";
6069
+ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6070
+ export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6071
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6072
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6073
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6074
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6075
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6076
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6077
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6078
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6079
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6080
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6081
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6082
+ /** @default "Realtor" */
6083
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6084
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6085
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6086
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6087
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6088
+ export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6053
6089
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6054
6090
  export type QueryParamsType = Record<string | number, any>;
6055
6091
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6072,14 +6108,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6072
6108
  secure?: boolean;
6073
6109
  format?: ResponseType;
6074
6110
  }
6075
- export declare enum ContentType {
6076
- JsonPatch = "application/json-patch+json",
6077
- Json = "application/json",
6078
- JsonApi = "application/vnd.api+json",
6079
- FormData = "multipart/form-data",
6080
- UrlEncoded = "application/x-www-form-urlencoded",
6081
- Text = "text/plain"
6082
- }
6111
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6083
6112
  export declare class HttpClient<SecurityDataType = unknown> {
6084
6113
  instance: AxiosInstance;
6085
6114
  private securityData;
@@ -7104,6 +7133,65 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7104
7133
  * @response `404` `ProblemDetails` Not Found
7105
7134
  */
7106
7135
  getAuditLogById: (id: string, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntry, any, {}>>;
7136
+ /**
7137
+ * No description
7138
+ *
7139
+ * @tags Auth
7140
+ * @name AuthForgotPassword
7141
+ * @summary Forgot Password (branded)
7142
+ * @request POST:/api/auth/forgot-password
7143
+ * @secure
7144
+ * @response `204` `void` No Content
7145
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7146
+ */
7147
+ authForgotPassword: (data: SendForgotPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7148
+ /**
7149
+ * No description
7150
+ *
7151
+ * @tags Auth
7152
+ * @name AuthResetPassword
7153
+ * @summary Reset Password (branded)
7154
+ * @request POST:/api/auth/reset-password
7155
+ * @secure
7156
+ * @response `204` `void` No Content
7157
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7158
+ */
7159
+ authResetPassword: (data: ResetPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7160
+ /**
7161
+ * No description
7162
+ *
7163
+ * @tags Auth
7164
+ * @name AuthSetPassword
7165
+ * @summary Set Password (branded account setup)
7166
+ * @request POST:/api/auth/set-password
7167
+ * @secure
7168
+ * @response `204` `void` No Content
7169
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7170
+ */
7171
+ authSetPassword: (data: SetPasswordRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7172
+ /**
7173
+ * No description
7174
+ *
7175
+ * @tags Auth
7176
+ * @name AuthSendVerificationEmail
7177
+ * @summary Send branded email-verification link to the current user
7178
+ * @request POST:/api/auth/send-verification-email
7179
+ * @secure
7180
+ * @response `204` `void` No Content
7181
+ */
7182
+ authSendVerificationEmail: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7183
+ /**
7184
+ * No description
7185
+ *
7186
+ * @tags Auth
7187
+ * @name AuthVerifyEmail
7188
+ * @summary Verify Email (branded)
7189
+ * @request POST:/api/auth/verify-email
7190
+ * @secure
7191
+ * @response `204` `void` No Content
7192
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7193
+ */
7194
+ authVerifyEmail: (data: VerifyEmailRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7107
7195
  /**
7108
7196
  * No description
7109
7197
  *
@@ -7401,186 +7489,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7401
7489
  * @response `200` `ClosedLoansReport` OK
7402
7490
  */
7403
7491
  getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
7404
- /**
7405
- * No description
7406
- *
7407
- * @tags CompanyDocumentFolders
7408
- * @name GetCompanyDocumentFolders
7409
- * @summary Get all company document folders
7410
- * @request GET:/api/company-document-folders
7411
- * @secure
7412
- * @response `200` `(CompanyDocumentFolder)[]` OK
7413
- */
7414
- getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
7415
- /**
7416
- * No description
7417
- *
7418
- * @tags CompanyDocumentFolders
7419
- * @name CreateCompanyDocumentFolder
7420
- * @summary Create company document folder
7421
- * @request POST:/api/company-document-folders
7422
- * @secure
7423
- * @response `201` `CompanyDocumentFolder` Created
7424
- * @response `400` `ProblemDetails` Bad Request
7425
- * @response `409` `ProblemDetails` Conflict
7426
- */
7427
- createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7428
- /**
7429
- * No description
7430
- *
7431
- * @tags CompanyDocumentFolders
7432
- * @name GetCompanyDocumentFolder
7433
- * @summary Get company document folder by ID
7434
- * @request GET:/api/company-document-folders/{id}
7435
- * @secure
7436
- * @response `200` `CompanyDocumentFolder` OK
7437
- * @response `404` `ProblemDetails` Not Found
7438
- */
7439
- getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7440
- /**
7441
- * No description
7442
- *
7443
- * @tags CompanyDocumentFolders
7444
- * @name UpdateCompanyDocumentFolder
7445
- * @summary Update company document folder
7446
- * @request PUT:/api/company-document-folders/{id}
7447
- * @secure
7448
- * @response `200` `CompanyDocumentFolder` OK
7449
- * @response `400` `ProblemDetails` Bad Request
7450
- * @response `404` `ProblemDetails` Not Found
7451
- * @response `409` `ProblemDetails` Conflict
7452
- */
7453
- updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7454
- /**
7455
- * No description
7456
- *
7457
- * @tags CompanyDocumentFolders
7458
- * @name DeleteCompanyDocumentFolder
7459
- * @summary Delete company document folder
7460
- * @request DELETE:/api/company-document-folders/{id}
7461
- * @secure
7462
- * @response `204` `void` No Content
7463
- * @response `400` `ProblemDetails` Bad Request
7464
- * @response `404` `ProblemDetails` Not Found
7465
- * @response `409` `ProblemDetails` Conflict
7466
- */
7467
- deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7468
- /**
7469
- * No description
7470
- *
7471
- * @tags CompanyDocuments
7472
- * @name SearchCompanyDocuments
7473
- * @summary Search company documents
7474
- * @request POST:/api/company-documents/search
7475
- * @secure
7476
- * @response `200` `CompanyDocumentPaginated` OK
7477
- * @response `400` `ProblemDetails` Bad Request
7478
- */
7479
- searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
7480
- /** @format int32 */
7481
- pageSize?: number;
7482
- /** @format int32 */
7483
- pageNumber?: number;
7484
- sortBy?: string;
7485
- sortDirection?: string;
7486
- }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
7487
- /**
7488
- * No description
7489
- *
7490
- * @tags CompanyDocuments
7491
- * @name GetCompanyDocument
7492
- * @summary Get company document by ID
7493
- * @request GET:/api/company-documents/{id}
7494
- * @secure
7495
- * @response `200` `CompanyDocument` OK
7496
- * @response `404` `ProblemDetails` Not Found
7497
- */
7498
- getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7499
- /**
7500
- * No description
7501
- *
7502
- * @tags CompanyDocuments
7503
- * @name UpdateCompanyDocument
7504
- * @summary Update company document
7505
- * @request PUT:/api/company-documents/{id}
7506
- * @secure
7507
- * @response `200` `CompanyDocument` OK
7508
- * @response `400` `ProblemDetails` Bad Request
7509
- * @response `404` `ProblemDetails` Not Found
7510
- * @response `409` `ProblemDetails` Conflict
7511
- */
7512
- updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7513
- /**
7514
- * No description
7515
- *
7516
- * @tags CompanyDocuments
7517
- * @name DeleteCompanyDocument
7518
- * @summary Delete company document
7519
- * @request DELETE:/api/company-documents/{id}
7520
- * @secure
7521
- * @response `204` `void` No Content
7522
- * @response `404` `ProblemDetails` Not Found
7523
- */
7524
- deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7525
- /**
7526
- * No description
7527
- *
7528
- * @tags CompanyDocuments
7529
- * @name DownloadCompanyDocument
7530
- * @summary Download company document
7531
- * @request GET:/api/company-documents/{id}/download
7532
- * @secure
7533
- * @response `200` `void` OK
7534
- * @response `404` `ProblemDetails` Not Found
7535
- */
7536
- downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7537
- /**
7538
- * No description
7539
- *
7540
- * @tags CompanyDocuments
7541
- * @name CreateCompanyDocument
7542
- * @summary Upload company document
7543
- * @request POST:/api/company-documents
7544
- * @secure
7545
- * @response `201` `CompanyDocument` Created
7546
- * @response `400` `ProblemDetails` Bad Request
7547
- * @response `404` `ProblemDetails` Not Found
7548
- * @response `409` `ProblemDetails` Conflict
7549
- */
7550
- createCompanyDocument: (data: {
7551
- /** @format binary */
7552
- file?: File;
7553
- /** @format uuid */
7554
- folderID?: string;
7555
- name?: string;
7556
- }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7557
- /**
7558
- * No description
7559
- *
7560
- * @tags CompanyDocuments
7561
- * @name CreateCompanyTextDocument
7562
- * @summary Create free-form text company document
7563
- * @request POST:/api/company-documents/text
7564
- * @secure
7565
- * @response `201` `CompanyDocument` Created
7566
- * @response `400` `ProblemDetails` Bad Request
7567
- * @response `404` `ProblemDetails` Not Found
7568
- * @response `409` `ProblemDetails` Conflict
7569
- */
7570
- createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7571
- /**
7572
- * No description
7573
- *
7574
- * @tags CompanyDocuments
7575
- * @name ReindexCompanyDocument
7576
- * @summary Re-index a failed company document
7577
- * @request POST:/api/company-documents/{id}/reindex
7578
- * @secure
7579
- * @response `200` `CompanyDocument` OK
7580
- * @response `400` `ProblemDetails` Bad Request
7581
- * @response `404` `ProblemDetails` Not Found
7582
- */
7583
- reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7584
7492
  /**
7585
7493
  * No description
7586
7494
  *
@@ -7770,7 +7678,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7770
7678
  * @response `200` `(CustomFieldDefinition)[]` OK
7771
7679
  */
7772
7680
  getCustomFieldDefinitions: (query?: {
7773
- entityType?: "Loan";
7681
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7774
7682
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7775
7683
  /**
7776
7684
  * No description
@@ -9282,10 +9190,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9282
9190
  * @summary Download By ID
9283
9191
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9284
9192
  * @secure
9285
- * @response `200` `string` OK
9193
+ * @response `200` `Blob` OK
9286
9194
  * @response `404` `ProblemDetails` Not Found
9287
9195
  */
9288
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
9196
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9289
9197
  /**
9290
9198
  * No description
9291
9199
  *
@@ -10253,6 +10161,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10253
10161
  /** @format uuid */
10254
10162
  accountId?: string;
10255
10163
  }, params?: RequestParams) => Promise<AxiosResponse<LosSyncFailuresSummary, any, {}>>;
10164
+ /**
10165
+ * No description
10166
+ *
10167
+ * @tags LosSyncFailures
10168
+ * @name RedriveInboundSyncFailure
10169
+ * @summary Manually re-drive a failed inbound Encompass sync (SuperAdmin)
10170
+ * @request POST:/api/monitoring/inbound-sync-failures/{correlationId}/redrive
10171
+ * @secure
10172
+ * @response `202` `void` Accepted
10173
+ * @response `401` `ProblemDetails` Unauthorized
10174
+ * @response `403` `ProblemDetails` Forbidden
10175
+ * @response `404` `ProblemDetails` Not Found
10176
+ */
10177
+ redriveInboundSyncFailure: (correlationId: string, query?: {
10178
+ /** @format uuid */
10179
+ accountId?: string;
10180
+ }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10256
10181
  /**
10257
10182
  * No description
10258
10183
  *
@@ -10531,7 +10456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10531
10456
  getPartners: (query?: {
10532
10457
  showAll?: boolean;
10533
10458
  /** @default "Realtor" */
10534
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
10459
+ role?: GetPartnersParamsRoleEnum;
10535
10460
  /** @format int32 */
10536
10461
  pageSize?: number;
10537
10462
  /** @format int32 */
@@ -10709,7 +10634,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10709
10634
  * @response `200` `File` OK
10710
10635
  * @response `404` `ProblemDetails` Not Found
10711
10636
  */
10712
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10637
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10713
10638
  /**
10714
10639
  * No description
10715
10640
  *
@@ -10720,7 +10645,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10720
10645
  * @secure
10721
10646
  * @response `200` `File` OK
10722
10647
  */
10723
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10648
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10724
10649
  /**
10725
10650
  * No description
10726
10651
  *
@@ -10813,7 +10738,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10813
10738
  getSiteTilesBySiteConfiguration: (query?: {
10814
10739
  /** @format uuid */
10815
10740
  siteConfigurationId?: string;
10816
- location?: "HomePage" | "Dashboard";
10741
+ location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
10817
10742
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
10818
10743
  /**
10819
10744
  * No description
@@ -11678,8 +11603,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11678
11603
  *
11679
11604
  * @tags Users
11680
11605
  * @name VerifyPassword
11681
- * @summary Verify Password
11606
+ * @summary Verify Password (deprecated; use api/auth/reset-password)
11682
11607
  * @request POST:/api/users/verify-password
11608
+ * @deprecated
11683
11609
  * @secure
11684
11610
  * @response `204` `void` No Content
11685
11611
  * @response `422` `UnprocessableEntity` Unprocessable Content
@@ -11702,8 +11628,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11702
11628
  *
11703
11629
  * @tags Users
11704
11630
  * @name ForgotPassword
11705
- * @summary Forgot Password
11631
+ * @summary Forgot Password (deprecated; use api/auth/forgot-password)
11706
11632
  * @request POST:/api/users/forgot-password
11633
+ * @deprecated
11707
11634
  * @secure
11708
11635
  * @response `204` `void` No Content
11709
11636
  * @response `422` `UnprocessableEntity` Unprocessable Content