@matech/thebigpos-sdk 2.45.1-rc1 → 2.45.1-rc11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -31,14 +31,14 @@ export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
31
31
  export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
32
32
  export type LoanLienPosition = "First" | "Subordinate";
33
33
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
34
- export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
34
+ export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
35
35
  export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
36
36
  export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
37
37
  export type LoanHousingType = "NoExpense" | "Own" | "Rent";
38
38
  export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
39
39
  export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
40
40
  export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
41
- export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
41
+ export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
42
42
  export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
43
43
  export type LoanGenderType = "Male" | "Female";
44
44
  export type LoanDocumentType = "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";
@@ -79,9 +79,7 @@ export type AiOutputType = "Text" | "Document";
79
79
  export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
80
80
  export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
81
81
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
82
- export type AiConfigEntityType = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
83
- export type AiConfigChangeAction = "Created" | "Updated" | "Deleted" | "Toggled";
84
- export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
82
+ export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied";
85
83
  export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
86
84
  export interface ASOSettings {
87
85
  enabled: boolean;
@@ -132,7 +130,7 @@ export interface AccountBilling {
132
130
  contractedRate: number;
133
131
  }
134
132
  export interface AccountBillingRequest {
135
- billingType: AccountBillingRequestBillingTypeEnum;
133
+ billingType: "ClosedLoan" | "LoanOfficer";
136
134
  /** @format double */
137
135
  contractedRate: number;
138
136
  }
@@ -161,13 +159,11 @@ export interface AccountSettings {
161
159
  smsNumber?: string | null;
162
160
  ssoHostOverride?: string | null;
163
161
  isEarlyAdopter: boolean;
164
- isAIEnabled: boolean;
165
162
  }
166
163
  export interface AccountSettingsRequest {
167
164
  isSmsEnabled: boolean;
168
165
  smsNumber?: string | null;
169
166
  isEarlyAdopter: boolean;
170
- isAIEnabled: boolean;
171
167
  }
172
168
  export interface Action {
173
169
  /** @format uuid */
@@ -176,7 +172,7 @@ export interface Action {
176
172
  comments?: string | null;
177
173
  /** @format uuid */
178
174
  siteConfigurationID: string;
179
- applicationSettings?: any | null;
175
+ applicationSettings?: any;
180
176
  surveysToken?: string | null;
181
177
  }
182
178
  export interface Address {
@@ -397,7 +393,7 @@ export interface AiAuditLog {
397
393
  conversationId?: string | null;
398
394
  /** @format uuid */
399
395
  messageId?: string | null;
400
- eventType: AiAuditLogEventTypeEnum;
396
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied";
401
397
  modelId?: string | null;
402
398
  /** @format int32 */
403
399
  inputTokens?: number | null;
@@ -410,7 +406,7 @@ export interface AiAuditLog {
410
406
  guardrailCategory?: string | null;
411
407
  rawRequest?: string | null;
412
408
  rawResponse?: string | null;
413
- details?: any | null;
409
+ details?: any;
414
410
  /** @format date-time */
415
411
  createdAt: string;
416
412
  }
@@ -472,7 +468,7 @@ export interface AiChatMessagePaginated {
472
468
  count: number;
473
469
  }
474
470
  export interface AiChatMetadata {
475
- intent: AiChatMetadataIntentEnum;
471
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
476
472
  fieldsAccessed: string[];
477
473
  /** @format int64 */
478
474
  queryTimeMs: number;
@@ -498,7 +494,7 @@ export interface AiChatRequest {
498
494
  promptId?: string | null;
499
495
  }
500
496
  export interface AiChatStructuredData {
501
- type: AiChatStructuredDataTypeEnum;
497
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
502
498
  displayHint?: AiDisplayHint | null;
503
499
  detectedDocumentType?: string | null;
504
500
  columns: string[];
@@ -507,28 +503,6 @@ export interface AiChatStructuredData {
507
503
  generatedDocumentId?: string | null;
508
504
  generatedFileName?: string | null;
509
505
  }
510
- export interface AiConfigChangeLog {
511
- /** @format uuid */
512
- id: string;
513
- /** @format uuid */
514
- accountId?: string | null;
515
- /** @format uuid */
516
- actorUserId: string;
517
- entityType: AiConfigChangeLogEntityTypeEnum;
518
- /** @format uuid */
519
- entityId?: string | null;
520
- action: AiConfigChangeLogActionEnum;
521
- before?: any | null;
522
- after?: any | null;
523
- /** @format date-time */
524
- createdAt: string;
525
- }
526
- export interface AiConfigChangeLogPaginated {
527
- rows: AiConfigChangeLog[];
528
- pagination: Pagination;
529
- /** @format int64 */
530
- count: number;
531
- }
532
506
  export interface AiConversationAuditSummary {
533
507
  /** @format uuid */
534
508
  conversationId: string;
@@ -589,16 +563,19 @@ export interface AiConversationListItemPaginated {
589
563
  /** @format int64 */
590
564
  count: number;
591
565
  }
566
+ export interface AiEnabled {
567
+ isEnabled: boolean;
568
+ }
592
569
  export interface AiGuardrail {
593
570
  /** @format uuid */
594
571
  id: string;
595
572
  name: string;
596
- category: AiGuardrailCategoryEnum;
573
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
597
574
  description?: string | null;
598
575
  keywords: string[];
599
576
  responseTemplate: string;
600
577
  isDefault: boolean;
601
- isEnabled: boolean;
578
+ isActive: boolean;
602
579
  hasAccountOverride: boolean;
603
580
  /** @format date-time */
604
581
  createdAt: string;
@@ -699,8 +676,8 @@ export interface AiUrlSource {
699
676
  name: string;
700
677
  url: string;
701
678
  description?: string | null;
702
- category: AiUrlSourceCategoryEnum;
703
- scope: AiUrlSourceScopeEnum;
679
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
680
+ scope: "FullDomain" | "SpecificPath";
704
681
  isActive: boolean;
705
682
  isDefault: boolean;
706
683
  hasAccountOverride: boolean;
@@ -799,10 +776,6 @@ export interface ApplicationRowData {
799
776
  escrowAgent?: EncompassContact | null;
800
777
  titleInsuranceAgent?: EncompassContact | null;
801
778
  }
802
- export interface Attachment {
803
- fileName: string;
804
- base64Data: string;
805
- }
806
779
  export interface AuditEntityType {
807
780
  entityType: string;
808
781
  rootEntityType?: string | null;
@@ -811,14 +784,14 @@ export interface AuditLogEntry {
811
784
  /** @format uuid */
812
785
  id: string;
813
786
  entityType: string;
814
- changeType: AuditLogEntryChangeTypeEnum;
787
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
815
788
  /** @format uuid */
816
789
  entityId: string;
817
790
  performedBy?: AuditLogUser | null;
818
791
  rootEntityType?: string | null;
819
792
  /** @format uuid */
820
793
  rootEntityId?: string | null;
821
- changes?: any | null;
794
+ changes?: any;
822
795
  /** @format date-time */
823
796
  createdAt: string;
824
797
  }
@@ -858,7 +831,7 @@ export interface BorrowerCount {
858
831
  firstName: string;
859
832
  lastName: string;
860
833
  email: string;
861
- role: BorrowerCountRoleEnum;
834
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
862
835
  /** @format int32 */
863
836
  count: number;
864
837
  }
@@ -868,7 +841,7 @@ export interface BorrowerIdentity {
868
841
  firstName: string;
869
842
  lastName: string;
870
843
  email: string;
871
- role: BorrowerIdentityRoleEnum;
844
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
872
845
  }
873
846
  export interface BorrowersNotUsingPosSummary {
874
847
  /** @format int32 */
@@ -1102,7 +1075,7 @@ export interface CorporateSearchCriteria {
1102
1075
  isActive?: boolean | null;
1103
1076
  }
1104
1077
  export interface CreateAccessScopeRequest {
1105
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1078
+ scopeType: "User" | "Branch";
1106
1079
  /** @format uuid */
1107
1080
  userId?: string | null;
1108
1081
  /** @format uuid */
@@ -1120,7 +1093,7 @@ export interface CreateAccountRequest {
1120
1093
  /** @format int64 */
1121
1094
  nlmsid: number;
1122
1095
  settings: AccountSettingsRequest;
1123
- environment: CreateAccountRequestEnvironmentEnum;
1096
+ environment: "Development" | "Staging" | "UAT" | "Production";
1124
1097
  losIntegration: LOSIntegration;
1125
1098
  billingSettings: AccountBillingRequest;
1126
1099
  }
@@ -1134,7 +1107,7 @@ export interface CreateAiCanonicalFieldRequest {
1134
1107
  }
1135
1108
  export interface CreateAiGuardrailRequest {
1136
1109
  name: string;
1137
- category: CreateAiGuardrailRequestCategoryEnum;
1110
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1138
1111
  description?: string | null;
1139
1112
  keywords: string[];
1140
1113
  responseTemplate: string;
@@ -1160,8 +1133,8 @@ export interface CreateAiUrlSourceRequest {
1160
1133
  name: string;
1161
1134
  url: string;
1162
1135
  description?: string | null;
1163
- category: CreateAiUrlSourceRequestCategoryEnum;
1164
- scope: CreateAiUrlSourceRequestScopeEnum;
1136
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1137
+ scope: "FullDomain" | "SpecificPath";
1165
1138
  }
1166
1139
  export interface CreateBranchRequest {
1167
1140
  name: string;
@@ -1184,8 +1157,8 @@ export interface CreateCustomFieldDefinitionRequest {
1184
1157
  name: string;
1185
1158
  defaultValue?: string | null;
1186
1159
  regexPattern?: string | null;
1187
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1188
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1160
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1161
+ entityType: "Loan";
1189
1162
  options?: CustomFieldOptionRequest[] | null;
1190
1163
  permissions?: CustomFieldPermissionRequest[] | null;
1191
1164
  }
@@ -1200,7 +1173,7 @@ export interface CreateDocumentTemplateRequest {
1200
1173
  export interface CreateGroupMemberRequest {
1201
1174
  /** @format uuid */
1202
1175
  userId: string;
1203
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1176
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1204
1177
  }
1205
1178
  export interface CreateInviteRequest {
1206
1179
  firstName: string;
@@ -1208,7 +1181,7 @@ export interface CreateInviteRequest {
1208
1181
  emailAddress: string;
1209
1182
  phoneNumber?: string | null;
1210
1183
  /** @deprecated */
1211
- relationship: CreateInviteRequestRelationshipEnum;
1184
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1212
1185
  loanID: string;
1213
1186
  route?: string | null;
1214
1187
  /** @format uuid */
@@ -1228,7 +1201,7 @@ export interface CreateLoanImportRequest {
1228
1201
  endDate: string;
1229
1202
  /** @format date-time */
1230
1203
  startDate: string;
1231
- importMode: CreateLoanImportRequestImportModeEnum;
1204
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1232
1205
  }
1233
1206
  export interface CreateSession {
1234
1207
  sessionId: string;
@@ -1246,7 +1219,7 @@ export interface CreateUserDeviceRequest {
1246
1219
  token: string;
1247
1220
  }
1248
1221
  export interface CreateUserDraft {
1249
- loanRole: CreateUserDraftLoanRoleEnum;
1222
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1250
1223
  }
1251
1224
  export interface CreateUserGroupRequest {
1252
1225
  name: string;
@@ -1307,8 +1280,8 @@ export interface CustomFieldDefinition {
1307
1280
  name: string;
1308
1281
  defaultValue?: string | null;
1309
1282
  regexPattern?: string | null;
1310
- dataType: CustomFieldDefinitionDataTypeEnum;
1311
- entityType: CustomFieldDefinitionEntityTypeEnum;
1283
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1284
+ entityType: "Loan";
1312
1285
  options: CustomFieldOption[];
1313
1286
  permissions: CustomFieldPermission[];
1314
1287
  encompassMapping?: EncompassMapping | null;
@@ -1322,7 +1295,7 @@ export interface CustomFieldEntry {
1322
1295
  displayOrder: number;
1323
1296
  name: string;
1324
1297
  value: string;
1325
- dataType: CustomFieldEntryDataTypeEnum;
1298
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1326
1299
  }
1327
1300
  export interface CustomFieldOption {
1328
1301
  /** @format uuid */
@@ -1339,12 +1312,12 @@ export interface CustomFieldOptionRequest {
1339
1312
  export interface CustomFieldPermission {
1340
1313
  /** @format uuid */
1341
1314
  id: string;
1342
- role: CustomFieldPermissionRoleEnum;
1343
- accessLevel: CustomFieldPermissionAccessLevelEnum;
1315
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1316
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1344
1317
  }
1345
1318
  export interface CustomFieldPermissionRequest {
1346
- role: CustomFieldPermissionRequestRoleEnum;
1347
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1319
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1320
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1348
1321
  }
1349
1322
  export interface CustomFieldValue {
1350
1323
  /** @format uuid */
@@ -1355,7 +1328,7 @@ export interface CustomFieldValue {
1355
1328
  customFieldDefinitionID: string;
1356
1329
  value: string;
1357
1330
  definitionName: string;
1358
- dataType: CustomFieldValueDataTypeEnum;
1331
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1359
1332
  }
1360
1333
  export interface DetailedUser {
1361
1334
  /** @format date-time */
@@ -1593,7 +1566,7 @@ export interface Draft {
1593
1566
  siteConfiguration: SiteConfigurationReduced;
1594
1567
  /** @format uuid */
1595
1568
  loanID?: string | null;
1596
- type: DraftTypeEnum;
1569
+ type: "NewLoan" | "EditLoan";
1597
1570
  isCoBorrower: boolean;
1598
1571
  }
1599
1572
  export interface DraftContent {
@@ -1611,7 +1584,7 @@ export interface DraftContent {
1611
1584
  siteConfiguration: SiteConfigurationReduced;
1612
1585
  /** @format uuid */
1613
1586
  loanID?: string | null;
1614
- type: DraftContentTypeEnum;
1587
+ type: "NewLoan" | "EditLoan";
1615
1588
  isCoBorrower: boolean;
1616
1589
  applicationPayload: any;
1617
1590
  }
@@ -1627,7 +1600,7 @@ export interface DraftLoanOfficerReassignRequest {
1627
1600
  }
1628
1601
  export interface DraftRequest {
1629
1602
  applicationPayload: any;
1630
- customData?: any | null;
1603
+ customData?: any;
1631
1604
  isCoBorrower: boolean;
1632
1605
  }
1633
1606
  export interface EconsentPendingSummary {
@@ -1701,9 +1674,9 @@ export interface EncompassCredentialsDetail {
1701
1674
  clearStateIfUnlicensed: boolean;
1702
1675
  /** @deprecated */
1703
1676
  baseUrl?: string | null;
1704
- encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1677
+ encompassEnvironment: "Production" | "UAT";
1705
1678
  consumerConnectWidgetHost?: string | null;
1706
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1679
+ signingMethod: "ConsumerConnect" | "POSF";
1707
1680
  subscriptionId?: string | null;
1708
1681
  environment?: string | null;
1709
1682
  }
@@ -1719,9 +1692,9 @@ export interface EncompassCredentialsRequest {
1719
1692
  clearStateIfUnlicensed: boolean;
1720
1693
  /** @deprecated */
1721
1694
  baseUrl?: string | null;
1722
- encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1695
+ encompassEnvironment: "Production" | "UAT";
1723
1696
  consumerConnectWidgetHost?: string | null;
1724
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1697
+ signingMethod: "ConsumerConnect" | "POSF";
1725
1698
  subscriptionId?: string | null;
1726
1699
  environment?: string | null;
1727
1700
  clientID?: string | null;
@@ -1792,6 +1765,7 @@ export interface EncompassPackageItem {
1792
1765
  /** @format date-time */
1793
1766
  createdAt: string;
1794
1767
  recipientId: string;
1768
+ borrowerName?: string | null;
1795
1769
  title?: string | null;
1796
1770
  /** @format date-time */
1797
1771
  issuedAt?: string | null;
@@ -1830,8 +1804,8 @@ export interface EncompassRequestLog {
1830
1804
  losId?: string | null;
1831
1805
  /** @format uuid */
1832
1806
  accountId: string;
1833
- operationType: EncompassRequestLogOperationTypeEnum;
1834
- outcome: EncompassRequestLogOutcomeEnum;
1807
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1808
+ outcome: "Success" | "Failure" | "PartialSuccess";
1835
1809
  message: string;
1836
1810
  endpoint?: string | null;
1837
1811
  httpMethod?: string | null;
@@ -1839,7 +1813,7 @@ export interface EncompassRequestLog {
1839
1813
  httpStatusCode?: number | null;
1840
1814
  /** @format int64 */
1841
1815
  durationMs?: number | null;
1842
- context?: any | null;
1816
+ context?: any;
1843
1817
  /** @format date-time */
1844
1818
  createdAt: string;
1845
1819
  }
@@ -1878,7 +1852,7 @@ export interface FileSearchCriteria {
1878
1852
  export interface FileWithBytes {
1879
1853
  name: string;
1880
1854
  /** @format byte */
1881
- data: Blob;
1855
+ data: string;
1882
1856
  fileName: string;
1883
1857
  mimeType?: string | null;
1884
1858
  extension?: string | null;
@@ -1954,7 +1928,7 @@ export interface FormSubmission {
1954
1928
  subjectPropertyAddressCounty?: string | null;
1955
1929
  subjectPropertyAddressState?: string | null;
1956
1930
  subjectPropertyAddressZip?: string | null;
1957
- data?: any | null;
1931
+ data?: any;
1958
1932
  /** @format uuid */
1959
1933
  listingID?: string | null;
1960
1934
  listing?: Listing | null;
@@ -1989,7 +1963,7 @@ export interface FormSubmissionRequest {
1989
1963
  subjectPropertyAddressCounty?: string | null;
1990
1964
  subjectPropertyAddressState?: string | null;
1991
1965
  subjectPropertyAddressZip?: string | null;
1992
- data?: any | null;
1966
+ data?: any;
1993
1967
  /** @format uuid */
1994
1968
  listingID?: string | null;
1995
1969
  }
@@ -2038,13 +2012,11 @@ export interface FusionFieldDisplay {
2038
2012
  fieldValue: string;
2039
2013
  }
2040
2014
  export interface FusionReportFilter {
2041
- filterType: FusionReportFilterFilterTypeEnum;
2015
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2042
2016
  targetField: string;
2043
2017
  targetValue: string;
2044
2018
  }
2045
2019
  export interface GenerateDocumentRequest {
2046
- /** @deprecated */
2047
- loanID?: string | null;
2048
2020
  /** @format uuid */
2049
2021
  templateID: string;
2050
2022
  /**
@@ -2060,7 +2032,7 @@ export interface GenerateSystemPrompt {
2060
2032
  }
2061
2033
  export interface GenerateSystemPromptRequest {
2062
2034
  description: string;
2063
- category: GenerateSystemPromptRequestCategoryEnum;
2035
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2064
2036
  }
2065
2037
  export interface GetApplications {
2066
2038
  applications: ApplicationRowData[];
@@ -2144,11 +2116,11 @@ export interface GetWorkflowRequest {
2144
2116
  export interface GuidPatchOperation {
2145
2117
  op: string;
2146
2118
  path: string;
2147
- value?: any | null;
2119
+ value?: any;
2148
2120
  from?: string | null;
2149
2121
  }
2150
2122
  export interface IPAddress {
2151
- addressFamily: IpAddressAddressFamilyEnum;
2123
+ 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
2124
  /** @format int64 */
2153
2125
  scopeId: number;
2154
2126
  isIPv6Multicast: boolean;
@@ -2389,13 +2361,15 @@ export interface Loan {
2389
2361
  financial?: LoanFinancial | null;
2390
2362
  financialTerms?: LoanFinancialTerms | null;
2391
2363
  monthlyPayment?: LoanMonthlyPayment | null;
2364
+ costDetails?: LoanCostDetails | null;
2365
+ metrics?: LoanMetrics | null;
2392
2366
  borrowers: LoanBorrower[];
2393
2367
  nonOwningBorrowers: LoanNonOwningBorrower[];
2394
2368
  userLoans: UserLoan[];
2395
2369
  contacts: LoanContact[];
2396
2370
  customFields: CustomFieldEntry[];
2397
2371
  milestones: LoanMilestone[];
2398
- signingMethod: LoanSigningMethodEnum;
2372
+ signingMethod: "ConsumerConnect" | "POSF";
2399
2373
  }
2400
2374
  export interface LoanApplication {
2401
2375
  /** @format uuid */
@@ -2427,11 +2401,13 @@ export interface LoanApplicationRequest {
2427
2401
  companyName?: string | null;
2428
2402
  property?: LoanPropertyRequest | null;
2429
2403
  financial?: LoanFinancialRequest | null;
2404
+ financialTerms?: LoanFinancialTermsRequest | null;
2405
+ monthlyPayment?: LoanMonthlyPaymentRequest | null;
2430
2406
  borrowers: LoanBorrowerRequest[];
2431
2407
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2432
2408
  /** @format uuid */
2433
2409
  draftId?: string | null;
2434
- additionalFields?: Record<string, any> | null;
2410
+ additionalFields?: Record<string, any>;
2435
2411
  /** @format uuid */
2436
2412
  existingLoanId?: string | null;
2437
2413
  }
@@ -2450,9 +2426,11 @@ export interface LoanBorrower {
2450
2426
  citizenship?: LoanCitizenship | null;
2451
2427
  maritalStatus?: LoanMaritalStatus | null;
2452
2428
  languagePreference?: LoanLanguagePreference | null;
2453
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2429
+ applicationStatus: "Draft" | "Complete";
2454
2430
  /** @format int32 */
2455
2431
  numberOfDependents?: number | null;
2432
+ /** @format int32 */
2433
+ creditDecisionScore?: number | null;
2456
2434
  isPrimaryBorrower: boolean;
2457
2435
  isFirstTimeHomeBuyer?: boolean | null;
2458
2436
  hasJointAssetsAndLiabilities?: boolean | null;
@@ -2810,6 +2788,11 @@ export interface LoanBorrowerGift {
2810
2788
  isDeposited?: boolean | null;
2811
2789
  source?: LoanGiftSource | null;
2812
2790
  assetType?: LoanGiftAssetType | null;
2791
+ grantorDonorName?: string | null;
2792
+ /** @format double */
2793
+ amountAppliedToDownPayment?: number | null;
2794
+ /** @format double */
2795
+ amountAppliedToClosingCosts?: number | null;
2813
2796
  }
2814
2797
  export interface LoanBorrowerGiftRequest {
2815
2798
  /** @format double */
@@ -2976,9 +2959,26 @@ export interface LoanBorrowerRealEstateAsset {
2976
2959
  /** @format double */
2977
2960
  marketValue?: number | null;
2978
2961
  /** @format double */
2962
+ purchasePrice?: number | null;
2963
+ /** @format int32 */
2964
+ yearBuilt?: number | null;
2965
+ /** @format int32 */
2966
+ numberOfUnits?: number | null;
2967
+ /** @format double */
2979
2968
  monthlyInsTaxDues?: number | null;
2980
2969
  /** @format double */
2981
2970
  monthlyRentalIncome?: number | null;
2971
+ /** @format double */
2972
+ rentalIncomeNetAmount?: number | null;
2973
+ /** @format double */
2974
+ maintenanceExpense?: number | null;
2975
+ /** @format double */
2976
+ percentageOfRental?: number | null;
2977
+ /** @format double */
2978
+ participationPercentage?: number | null;
2979
+ /** @format date */
2980
+ acquiredDate?: string | null;
2981
+ dispositionStatus?: string | null;
2982
2982
  address?: AddressV3 | null;
2983
2983
  mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
2984
2984
  }
@@ -3152,7 +3152,7 @@ export interface LoanConsentRequest {
3152
3152
  borrowerEConsent?: boolean | null;
3153
3153
  borrowerCreditAuth?: boolean | null;
3154
3154
  borrowerTCPAOptIn?: boolean | null;
3155
- additionalFields?: Record<string, string> | null;
3155
+ additionalFields?: Record<string, string>;
3156
3156
  }
3157
3157
  export interface LoanContact {
3158
3158
  /** @format date-time */
@@ -3170,13 +3170,29 @@ export interface LoanContact {
3170
3170
  email?: string | null;
3171
3171
  phone?: string | null;
3172
3172
  companyName?: string | null;
3173
- role: LoanContactRoleEnum;
3173
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3174
3174
  }
3175
3175
  export interface LoanContactList {
3176
3176
  email: string;
3177
3177
  }
3178
+ export interface LoanCostDetails {
3179
+ /** @format uuid */
3180
+ id?: string | null;
3181
+ /** @format double */
3182
+ closingCosts?: number | null;
3183
+ /** @format double */
3184
+ prepaidCharges?: number | null;
3185
+ /** @format double */
3186
+ discount?: number | null;
3187
+ /** @format double */
3188
+ lenderCredit?: number | null;
3189
+ /** @format double */
3190
+ totalCost?: number | null;
3191
+ /** @format double */
3192
+ totalFinancing?: number | null;
3193
+ }
3178
3194
  export interface LoanCustomFieldsRequest {
3179
- additionalFields?: Record<string, string> | null;
3195
+ additionalFields?: Record<string, string>;
3180
3196
  }
3181
3197
  export interface LoanDocument {
3182
3198
  /** @format date-time */
@@ -3226,12 +3242,12 @@ export interface LoanDocumentFolderPermission {
3226
3242
  id: string;
3227
3243
  /** @format uuid */
3228
3244
  loanDocumentFolderID: string;
3229
- role: LoanDocumentFolderPermissionRoleEnum;
3230
- level: LoanDocumentFolderPermissionLevelEnum;
3245
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3246
+ level: "None" | "Read" | "Write" | "Manage";
3231
3247
  }
3232
3248
  export interface LoanDocumentFolderPermissionRequest {
3233
- role: LoanDocumentFolderPermissionRequestRoleEnum;
3234
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3249
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3250
+ level: "None" | "Read" | "Write" | "Manage";
3235
3251
  }
3236
3252
  export interface LoanDocumentFolderUsage {
3237
3253
  /** @format uuid */
@@ -3327,6 +3343,24 @@ export interface LoanFinancialTerms {
3327
3343
  baseLoanAmount?: number | null;
3328
3344
  /** @format double */
3329
3345
  totalLoanAmount?: number | null;
3346
+ /** @format double */
3347
+ mortgageInsuranceFactor?: number | null;
3348
+ isEscrowWaived?: boolean | null;
3349
+ }
3350
+ export interface LoanFinancialTermsRequest {
3351
+ /** @format int32 */
3352
+ loanTermMonths?: number | null;
3353
+ amortizationType?: LoanAmortizationType | null;
3354
+ /** @format double */
3355
+ apr?: number | null;
3356
+ /** @format double */
3357
+ interestRate?: number | null;
3358
+ /** @format double */
3359
+ downPayment?: number | null;
3360
+ /** @format double */
3361
+ baseLoanAmount?: number | null;
3362
+ /** @format double */
3363
+ totalLoanAmount?: number | null;
3330
3364
  }
3331
3365
  export interface LoanIdentifier {
3332
3366
  /** @format uuid */
@@ -3347,13 +3381,13 @@ export interface LoanImport {
3347
3381
  /** @format int32 */
3348
3382
  importedCount: number;
3349
3383
  statusMessage?: string | null;
3350
- status: LoanImportStatusEnum;
3351
- importMode: LoanImportImportModeEnum;
3384
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3385
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3352
3386
  /** @format date-time */
3353
3387
  createdAt?: string | null;
3354
3388
  }
3355
3389
  export interface LoanImportLog {
3356
- level: LoanImportLogLevelEnum;
3390
+ level: "None" | "Info" | "Warning" | "Error";
3357
3391
  message: string;
3358
3392
  /** @format date-time */
3359
3393
  createdAt: string;
@@ -3408,8 +3442,8 @@ export interface LoanListPaginated {
3408
3442
  export interface LoanLog {
3409
3443
  /** @format uuid */
3410
3444
  id: string;
3411
- level: LoanLogLevelEnum;
3412
- type: LoanLogTypeEnum;
3445
+ level: "None" | "Info" | "Warning" | "Error";
3446
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
3413
3447
  message: string;
3414
3448
  /** @format date-time */
3415
3449
  createdAt: string;
@@ -3417,8 +3451,8 @@ export interface LoanLog {
3417
3451
  export interface LoanLogDetail {
3418
3452
  /** @format uuid */
3419
3453
  id: string;
3420
- level: LoanLogDetailLevelEnum;
3421
- type: LoanLogDetailTypeEnum;
3454
+ level: "None" | "Info" | "Warning" | "Error";
3455
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
3422
3456
  message: string;
3423
3457
  /** @format date-time */
3424
3458
  createdAt: string;
@@ -3435,6 +3469,18 @@ export interface LoanLogSearchCriteria {
3435
3469
  types?: LoanLogType[] | null;
3436
3470
  levels?: LogLevel[] | null;
3437
3471
  }
3472
+ export interface LoanMetrics {
3473
+ /** @format uuid */
3474
+ id?: string | null;
3475
+ /** @format double */
3476
+ ltv?: number | null;
3477
+ /** @format double */
3478
+ cltv?: number | null;
3479
+ /** @format double */
3480
+ frontDti?: number | null;
3481
+ /** @format double */
3482
+ backDti?: number | null;
3483
+ }
3438
3484
  export interface LoanMilestone {
3439
3485
  /** @format uuid */
3440
3486
  id: string;
@@ -3461,6 +3507,22 @@ export interface LoanMonthlyPayment {
3461
3507
  /** @format double */
3462
3508
  other?: number | null;
3463
3509
  }
3510
+ export interface LoanMonthlyPaymentRequest {
3511
+ /** @format double */
3512
+ principalAndInterest?: number | null;
3513
+ /** @format double */
3514
+ taxes?: number | null;
3515
+ /** @format double */
3516
+ insurance?: number | null;
3517
+ /** @format double */
3518
+ mortgageInsurance?: number | null;
3519
+ /** @format double */
3520
+ floodInsurance?: number | null;
3521
+ /** @format double */
3522
+ hoa?: number | null;
3523
+ /** @format double */
3524
+ other?: number | null;
3525
+ }
3464
3526
  export interface LoanNonOwningBorrower {
3465
3527
  /** @format uuid */
3466
3528
  id?: string | null;
@@ -3652,7 +3714,7 @@ export interface LoanQueueWithData {
3652
3714
  user: UserPublic;
3653
3715
  loanOfficer: LoanOfficerPublic;
3654
3716
  siteConfiguration: SiteConfigurationReduced;
3655
- data?: any | null;
3717
+ data?: any;
3656
3718
  }
3657
3719
  export interface LoanRecord {
3658
3720
  loanGuid: string;
@@ -3683,7 +3745,7 @@ export interface LoanTaskSearchRequest {
3683
3745
  loanStatus?: LoanTaskActivityFilter | null;
3684
3746
  }
3685
3747
  export interface LoanTaskStatusSummary {
3686
- status: LoanTaskStatusSummaryStatusEnum;
3748
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3687
3749
  /** @format int32 */
3688
3750
  count: number;
3689
3751
  }
@@ -3695,7 +3757,7 @@ export interface LoanUser {
3695
3757
  email: string;
3696
3758
  phone?: string | null;
3697
3759
  role: string;
3698
- loanRole: LoanUserLoanRoleEnum;
3760
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3699
3761
  isUser: boolean;
3700
3762
  /** @format date-time */
3701
3763
  createdAt: string;
@@ -3728,7 +3790,7 @@ export interface LosOperationTracking {
3728
3790
  operationType: string;
3729
3791
  correlationKey: string;
3730
3792
  lastTriggerSource?: string | null;
3731
- status: LosOperationTrackingStatusEnum;
3793
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3732
3794
  /** @format date-time */
3733
3795
  createdAt: string;
3734
3796
  /** @format date-time */
@@ -3789,7 +3851,7 @@ export interface LosSyncStep {
3789
3851
  /** @format int32 */
3790
3852
  order: number;
3791
3853
  name: string;
3792
- severity: LosSyncStepSeverityEnum;
3854
+ severity: "Success" | "Info" | "Warning" | "Error";
3793
3855
  message: string;
3794
3856
  /** @format date-time */
3795
3857
  atUtc: string;
@@ -3803,7 +3865,7 @@ export interface LosWebhook {
3803
3865
  enableSubscription: boolean;
3804
3866
  }
3805
3867
  export interface ManualDocumentClassificationRequest {
3806
- documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
3868
+ 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";
3807
3869
  }
3808
3870
  export interface MdmUser {
3809
3871
  user_email?: string | null;
@@ -3882,7 +3944,7 @@ export interface ModuleParameterValue {
3882
3944
  parameterID: string;
3883
3945
  parameterName: string;
3884
3946
  parameterType: string;
3885
- value?: any | null;
3947
+ value?: any;
3886
3948
  isInherited: boolean;
3887
3949
  }
3888
3950
  export interface MonthlyPaymentCalculator {
@@ -4055,7 +4117,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4055
4117
  }
4056
4118
  export interface Operation {
4057
4119
  op?: string;
4058
- value?: object | null;
4120
+ value?: string | number | boolean | null | object;
4059
4121
  path?: string;
4060
4122
  }
4061
4123
  export interface OverridePasswordRequest {
@@ -4358,15 +4420,11 @@ export interface SendLoanTaskReminderRequest {
4358
4420
  templateId: string;
4359
4421
  userIds?: string[] | null;
4360
4422
  }
4361
- export interface SendNotificationForLoanRequest {
4362
- loanID: string;
4363
- templateKey: string;
4364
- loanOfficerEmail?: string | null;
4365
- /** @format uuid */
4366
- siteConfigurationId?: string | null;
4367
- email?: string | null;
4368
- phone?: string | null;
4369
- attachments: Attachment[];
4423
+ export interface SendOutstandingTaskReminderRequest {
4424
+ userIds?: string[] | null;
4425
+ }
4426
+ export interface SetAiEnabledRequest {
4427
+ isEnabled: boolean;
4370
4428
  }
4371
4429
  export interface SetCustomFieldValueRequest {
4372
4430
  /** @format uuid */
@@ -4385,7 +4443,7 @@ export interface SiteConfiguration {
4385
4443
  deletedAt?: string | null;
4386
4444
  /** @format uuid */
4387
4445
  id: string;
4388
- type: SiteConfigurationTypeEnum;
4446
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4389
4447
  /** @format uuid */
4390
4448
  entityID: string;
4391
4449
  /** @format int32 */
@@ -4578,7 +4636,7 @@ export interface SiteConfigurationByUrl {
4578
4636
  deletedAt?: string | null;
4579
4637
  /** @format uuid */
4580
4638
  id: string;
4581
- type: SiteConfigurationByUrlTypeEnum;
4639
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4582
4640
  /** @format uuid */
4583
4641
  entityID: string;
4584
4642
  /** @format int32 */
@@ -4788,7 +4846,7 @@ export interface SiteConfigurationForm {
4788
4846
  export interface SiteConfigurationReduced {
4789
4847
  /** @format uuid */
4790
4848
  id: string;
4791
- type: SiteConfigurationReducedTypeEnum;
4849
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4792
4850
  url?: string | null;
4793
4851
  name: string;
4794
4852
  /** @format int64 */
@@ -4805,7 +4863,7 @@ export interface SiteConfigurationRequest {
4805
4863
  entityID: string;
4806
4864
  /** @format int32 */
4807
4865
  entityType: number;
4808
- type: SiteConfigurationRequestTypeEnum;
4866
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4809
4867
  url: string;
4810
4868
  name: string;
4811
4869
  introduction?: string | null;
@@ -4980,7 +5038,7 @@ export interface SiteConfigurationSearchCriteria {
4980
5038
  export interface SiteConfigurationSummary {
4981
5039
  /** @format uuid */
4982
5040
  id: string;
4983
- type: SiteConfigurationSummaryTypeEnum;
5041
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4984
5042
  url?: string | null;
4985
5043
  name: string;
4986
5044
  /** @format int64 */
@@ -5131,15 +5189,6 @@ export interface TaxRatesRequest {
5131
5189
  /** @format double */
5132
5190
  marginalIncomeTaxRate: number;
5133
5191
  }
5134
- export interface TestSendNotificationForLoanRequest {
5135
- loanData: Record<string, string>;
5136
- /** @format uuid */
5137
- siteConfigurationId: string;
5138
- toAddress?: string | null;
5139
- toPhoneNumber?: string | null;
5140
- templateKey?: string | null;
5141
- attachments: Attachment[];
5142
- }
5143
5192
  export interface Theme {
5144
5193
  logoURL: string;
5145
5194
  primaryColor: string;
@@ -5243,7 +5292,7 @@ export interface UnregisteredBorrower {
5243
5292
  lastName?: string | null;
5244
5293
  fullName?: string | null;
5245
5294
  email?: string | null;
5246
- role: UnregisteredBorrowerRoleEnum;
5295
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5247
5296
  }
5248
5297
  export interface UpdateAccountRequest {
5249
5298
  name: string;
@@ -5267,7 +5316,7 @@ export interface UpdateAiCanonicalFieldRequest {
5267
5316
  }
5268
5317
  export interface UpdateAiGuardrailRequest {
5269
5318
  name: string;
5270
- category: UpdateAiGuardrailRequestCategoryEnum;
5319
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5271
5320
  description?: string | null;
5272
5321
  keywords: string[];
5273
5322
  responseTemplate: string;
@@ -5292,8 +5341,8 @@ export interface UpdateAiUrlSourceRequest {
5292
5341
  name: string;
5293
5342
  url: string;
5294
5343
  description?: string | null;
5295
- category: UpdateAiUrlSourceRequestCategoryEnum;
5296
- scope: UpdateAiUrlSourceRequestScopeEnum;
5344
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5345
+ scope: "FullDomain" | "SpecificPath";
5297
5346
  }
5298
5347
  export interface UpdateCustomFieldDefinitionRequest {
5299
5348
  isRequired: boolean;
@@ -5580,7 +5629,7 @@ export interface UserDevice {
5580
5629
  export interface UserDraft {
5581
5630
  /** @format uuid */
5582
5631
  draftID: string;
5583
- role: UserDraftRoleEnum;
5632
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5584
5633
  user: User;
5585
5634
  }
5586
5635
  export interface UserDraftPaginated {
@@ -5604,7 +5653,7 @@ export interface UserGroupAccessScope {
5604
5653
  id: string;
5605
5654
  /** @format uuid */
5606
5655
  groupId: string;
5607
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5656
+ scopeType: "User" | "Branch";
5608
5657
  /** @format uuid */
5609
5658
  userId?: string | null;
5610
5659
  /** @format uuid */
@@ -5637,7 +5686,7 @@ export interface UserLoan {
5637
5686
  deletedAt?: string | null;
5638
5687
  loanID: string;
5639
5688
  user: User;
5640
- role: UserLoanRoleEnum;
5689
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5641
5690
  /** @format int32 */
5642
5691
  borrowerPair?: number | null;
5643
5692
  /** @format int32 */
@@ -5649,11 +5698,11 @@ export interface UserLoanConsent {
5649
5698
  id: string;
5650
5699
  /** @format uuid */
5651
5700
  userLoanID: string;
5652
- type: UserLoanConsentTypeEnum;
5701
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5653
5702
  providedConsent: boolean;
5654
5703
  source?: ConsentSource | null;
5655
5704
  ipAddress?: string | null;
5656
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5705
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5657
5706
  /** @format date-time */
5658
5707
  createdAt: string;
5659
5708
  /** @format date-time */
@@ -5783,7 +5832,7 @@ export interface UserSummary {
5783
5832
  id: string;
5784
5833
  name?: string | null;
5785
5834
  email?: string | null;
5786
- role: UserSummaryRoleEnum;
5835
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5787
5836
  }
5788
5837
  export interface VerifyPasswordRequest {
5789
5838
  email: string;
@@ -5810,90 +5859,6 @@ export interface Workflow {
5810
5859
  tileSubtitle: string;
5811
5860
  icon: string;
5812
5861
  }
5813
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5814
- 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";
5815
- export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
5816
- export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
5817
- export type AiConfigChangeLogEntityTypeEnum = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
5818
- export type AiConfigChangeLogActionEnum = "Created" | "Updated" | "Deleted" | "Toggled";
5819
- export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5820
- export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5821
- export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
5822
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5823
- export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5824
- export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5825
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5826
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5827
- export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5828
- export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5829
- export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
5830
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5831
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5832
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5833
- /** @deprecated */
5834
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5835
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5836
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5837
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5838
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5839
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5840
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5841
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5842
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5843
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5844
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5845
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5846
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5847
- export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5848
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5849
- export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5850
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5851
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5852
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5853
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5854
- export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
5855
- 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";
5856
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5857
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5858
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5859
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5860
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5861
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5862
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5863
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5864
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5865
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5866
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5867
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
5868
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5869
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
5870
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5871
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5872
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5873
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5874
- 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";
5875
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5876
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5877
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5878
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5879
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5880
- export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5881
- export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5882
- export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5883
- export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
5884
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5885
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5886
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5887
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5888
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5889
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5890
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5891
- /** @default "Realtor" */
5892
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5893
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5894
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5895
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5896
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5897
5862
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5898
5863
  export type QueryParamsType = Record<string | number, any>;
5899
5864
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5916,7 +5881,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5916
5881
  secure?: boolean;
5917
5882
  format?: ResponseType;
5918
5883
  }
5919
- export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5884
+ export declare enum ContentType {
5885
+ JsonPatch = "application/json-patch+json",
5886
+ Json = "application/json",
5887
+ JsonApi = "application/vnd.api+json",
5888
+ FormData = "multipart/form-data",
5889
+ UrlEncoded = "application/x-www-form-urlencoded",
5890
+ Text = "text/plain"
5891
+ }
5920
5892
  export declare class HttpClient<SecurityDataType = unknown> {
5921
5893
  instance: AxiosInstance;
5922
5894
  private securityData;
@@ -5932,7 +5904,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5932
5904
  }
5933
5905
  /**
5934
5906
  * @title The Big POS API
5935
- * @version v2.45.0
5907
+ * @version v2.45.1
5936
5908
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5937
5909
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5938
5910
  */
@@ -6096,141 +6068,66 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6096
6068
  /**
6097
6069
  * No description
6098
6070
  *
6099
- * @tags AiAccountSettings
6100
- * @name GetAiAccountSettings
6101
- * @summary Get account AI settings
6102
- * @request GET:/api/ai/admin/account-settings
6103
- * @secure
6104
- * @response `200` `AiAccountSettings` OK
6105
- */
6106
- getAiAccountSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
6107
- /**
6108
- * No description
6109
- *
6110
- * @tags AiAccountSettings
6111
- * @name UpdateAiAccountSettings
6112
- * @summary Update account AI settings
6113
- * @request PUT:/api/ai/admin/account-settings
6114
- * @secure
6115
- * @response `200` `AiAccountSettings` OK
6116
- * @response `400` `ProblemDetails` Bad Request
6117
- */
6118
- updateAiAccountSettings: (data: AiAccountSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
6119
- /**
6120
- * No description
6121
- *
6122
- * @tags AiAdmin
6123
- * @name GetAiAuditLogs
6124
- * @summary Get paginated audit logs
6125
- * @request GET:/api/ai/admin/audit-logs
6071
+ * @tags AiAccess
6072
+ * @name GetAiAccess
6073
+ * @summary Get whether AI is enabled for the current user's account
6074
+ * @request GET:/api/ai/access
6126
6075
  * @secure
6127
- * @response `200` `AiAuditLogPaginated` OK
6076
+ * @response `200` `AiEnabled` OK
6128
6077
  */
6129
- getAiAuditLogs: (query?: {
6130
- eventType?: AiAuditEventType;
6131
- /** @format uuid */
6132
- requestId?: string;
6133
- /** @format uuid */
6134
- userId?: string;
6135
- /** @format uuid */
6136
- conversationId?: string;
6137
- blockedOnly?: boolean;
6138
- /** @format date-time */
6139
- startDate?: string;
6140
- /** @format date-time */
6141
- endDate?: string;
6142
- /** @format int32 */
6143
- pageSize?: number;
6144
- /** @format int32 */
6145
- pageNumber?: number;
6146
- sortBy?: string;
6147
- sortDirection?: string;
6148
- }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
6078
+ getAiAccess: (params?: RequestParams) => Promise<AxiosResponse<AiEnabled, any, {}>>;
6149
6079
  /**
6150
6080
  * No description
6151
6081
  *
6152
- * @tags AiAdmin
6153
- * @name GetAiRequestLifecycle
6154
- * @summary Get the full event lifecycle of a single AI request
6155
- * @request GET:/api/ai/admin/audit-logs/request/{requestId}
6082
+ * @tags AiAccount
6083
+ * @name GetAccountAiEnabled
6084
+ * @summary Get whether AI is enabled for an account (SuperAdmin only)
6085
+ * @request GET:/api/ai/accounts/{accountId}/ai-enabled
6156
6086
  * @secure
6157
- * @response `200` `(AiAuditLog)[]` OK
6087
+ * @response `200` `AiEnabled` OK
6158
6088
  */
6159
- getAiRequestLifecycle: (requestId: string, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
6089
+ getAccountAiEnabled: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<AiEnabled, any, {}>>;
6160
6090
  /**
6161
6091
  * No description
6162
6092
  *
6163
- * @tags AiAdmin
6164
- * @name GetAiAuditConversations
6165
- * @summary List conversations with their audit roll-up origin user, turns, status, tokens
6166
- * @request GET:/api/ai/admin/audit-conversations
6093
+ * @tags AiAccount
6094
+ * @name SetAccountAiEnabled
6095
+ * @summary Enable or disable AI for an account (SuperAdmin only)
6096
+ * @request PUT:/api/ai/accounts/{accountId}/ai-enabled
6167
6097
  * @secure
6168
- * @response `200` `AiConversationAuditSummaryPaginated` OK
6098
+ * @response `204` `void` No Content
6169
6099
  */
6170
- getAiAuditConversations: (query?: {
6171
- searchText?: string;
6172
- /** @format date-time */
6173
- startDate?: string;
6174
- /** @format date-time */
6175
- endDate?: string;
6176
- /** @format int32 */
6177
- pageSize?: number;
6178
- /** @format int32 */
6179
- pageNumber?: number;
6180
- sortBy?: string;
6181
- sortDirection?: string;
6182
- }, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
6100
+ setAccountAiEnabled: (accountId: string, data: SetAiEnabledRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6183
6101
  /**
6184
6102
  * No description
6185
6103
  *
6186
- * @tags AiAdmin
6187
- * @name GetAiAdminStats
6188
- * @summary Get AI admin dashboard stats
6189
- * @request GET:/api/ai/admin/stats
6104
+ * @tags AiAccountSettings
6105
+ * @name GetAiAccountSettings
6106
+ * @summary Get account AI settings
6107
+ * @request GET:/api/ai/account-settings
6190
6108
  * @secure
6191
- * @response `200` `AiAdminStats` OK
6109
+ * @response `200` `AiAccountSettings` OK
6192
6110
  */
6193
- getAiAdminStats: (query?: {
6194
- /** @format date-time */
6195
- startDate?: string;
6196
- /** @format date-time */
6197
- endDate?: string;
6198
- }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
6111
+ getAiAccountSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
6199
6112
  /**
6200
6113
  * No description
6201
6114
  *
6202
- * @tags AiAdmin
6203
- * @name GetAiConfigChanges
6204
- * @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
6205
- * @request GET:/api/ai/admin/config-changes
6115
+ * @tags AiAccountSettings
6116
+ * @name UpdateAiAccountSettings
6117
+ * @summary Update account AI settings
6118
+ * @request PUT:/api/ai/account-settings
6206
6119
  * @secure
6207
- * @response `200` `AiConfigChangeLogPaginated` OK
6120
+ * @response `200` `AiAccountSettings` OK
6121
+ * @response `400` `ProblemDetails` Bad Request
6208
6122
  */
6209
- getAiConfigChanges: (query?: {
6210
- entityType?: AiConfigEntityType;
6211
- /** @format uuid */
6212
- entityId?: string;
6213
- /** @format uuid */
6214
- actorUserId?: string;
6215
- action?: AiConfigChangeAction;
6216
- /** @format date-time */
6217
- startDate?: string;
6218
- /** @format date-time */
6219
- endDate?: string;
6220
- /** @format int32 */
6221
- pageSize?: number;
6222
- /** @format int32 */
6223
- pageNumber?: number;
6224
- sortBy?: string;
6225
- sortDirection?: string;
6226
- }, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
6123
+ updateAiAccountSettings: (data: AiAccountSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
6227
6124
  /**
6228
6125
  * No description
6229
6126
  *
6230
6127
  * @tags AiAdminPrompt
6231
6128
  * @name GetAiPrompts
6232
6129
  * @summary Get all prompts
6233
- * @request GET:/api/ai/admin/prompts
6130
+ * @request GET:/api/ai/prompts
6234
6131
  * @secure
6235
6132
  * @response `200` `(AiPrompt)[]` OK
6236
6133
  */
@@ -6241,7 +6138,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6241
6138
  * @tags AiAdminPrompt
6242
6139
  * @name CreateAiPrompt
6243
6140
  * @summary Create custom prompt
6244
- * @request POST:/api/ai/admin/prompts
6141
+ * @request POST:/api/ai/prompts
6245
6142
  * @secure
6246
6143
  * @response `201` `AiPrompt` Created
6247
6144
  * @response `400` `ProblemDetails` Bad Request
@@ -6253,7 +6150,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6253
6150
  * @tags AiAdminPrompt
6254
6151
  * @name GetAiPrompt
6255
6152
  * @summary Get prompt by ID
6256
- * @request GET:/api/ai/admin/prompts/{id}
6153
+ * @request GET:/api/ai/prompts/{id}
6257
6154
  * @secure
6258
6155
  * @response `200` `AiPrompt` OK
6259
6156
  * @response `404` `ProblemDetails` Not Found
@@ -6265,7 +6162,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6265
6162
  * @tags AiAdminPrompt
6266
6163
  * @name UpdateAiPrompt
6267
6164
  * @summary Update prompt
6268
- * @request PUT:/api/ai/admin/prompts/{id}
6165
+ * @request PUT:/api/ai/prompts/{id}
6269
6166
  * @secure
6270
6167
  * @response `200` `AiPrompt` OK
6271
6168
  * @response `400` `ProblemDetails` Bad Request
@@ -6278,7 +6175,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6278
6175
  * @tags AiAdminPrompt
6279
6176
  * @name DeleteAiPrompt
6280
6177
  * @summary Delete prompt
6281
- * @request DELETE:/api/ai/admin/prompts/{id}
6178
+ * @request DELETE:/api/ai/prompts/{id}
6282
6179
  * @secure
6283
6180
  * @response `204` `void` No Content
6284
6181
  * @response `400` `ProblemDetails` Bad Request
@@ -6291,7 +6188,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6291
6188
  * @tags AiAdminPrompt
6292
6189
  * @name ToggleAiPrompt
6293
6190
  * @summary Toggle prompt active/inactive
6294
- * @request PATCH:/api/ai/admin/prompts/{id}/toggle
6191
+ * @request PATCH:/api/ai/prompts/{id}/toggle
6295
6192
  * @secure
6296
6193
  * @response `200` `AiPrompt` OK
6297
6194
  * @response `404` `ProblemDetails` Not Found
@@ -6303,7 +6200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6303
6200
  * @tags AiAdminPrompt
6304
6201
  * @name GenerateAiSystemPrompt
6305
6202
  * @summary Generate a system prompt from description
6306
- * @request POST:/api/ai/admin/prompts/generate
6203
+ * @request POST:/api/ai/prompts/generate
6307
6204
  * @secure
6308
6205
  * @response `200` `GenerateSystemPrompt` OK
6309
6206
  * @response `400` `ProblemDetails` Bad Request
@@ -6313,20 +6210,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6313
6210
  * No description
6314
6211
  *
6315
6212
  * @tags AiAdminPrompt
6316
- * @name GetSupportedModels
6213
+ * @name GetAiSupportedModels
6317
6214
  * @summary Get supported LLM models
6318
- * @request GET:/api/ai/admin/prompts/supported-models
6215
+ * @request GET:/api/ai/prompts/supported-models
6319
6216
  * @secure
6320
6217
  * @response `200` `(SupportedModel)[]` OK
6321
6218
  */
6322
- getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
6219
+ getAiSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
6323
6220
  /**
6324
6221
  * No description
6325
6222
  *
6326
6223
  * @tags AiAdminSettings
6327
6224
  * @name GetAiAdminSettings
6328
6225
  * @summary Get global AI settings
6329
- * @request GET:/api/ai/admin/settings
6226
+ * @request GET:/api/ai/settings
6330
6227
  * @secure
6331
6228
  * @response `200` `AiAdminSettings` OK
6332
6229
  */
@@ -6337,19 +6234,136 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6337
6234
  * @tags AiAdminSettings
6338
6235
  * @name UpdateAiAdminSettings
6339
6236
  * @summary Update global AI settings
6340
- * @request PUT:/api/ai/admin/settings
6237
+ * @request PUT:/api/ai/settings
6341
6238
  * @secure
6342
6239
  * @response `200` `AiAdminSettings` OK
6343
6240
  * @response `400` `ProblemDetails` Bad Request
6344
6241
  */
6345
6242
  updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
6243
+ /**
6244
+ * No description
6245
+ *
6246
+ * @tags AiAudit
6247
+ * @name GetAiAuditLogs
6248
+ * @summary Get paginated AI audit logs (own account, or any/all accounts for SuperAdmin)
6249
+ * @request GET:/api/ai/audit-logs
6250
+ * @secure
6251
+ * @response `200` `AiAuditLogPaginated` OK
6252
+ */
6253
+ getAiAuditLogs: (query?: {
6254
+ /** @format uuid */
6255
+ accountId?: string;
6256
+ eventType?: AiAuditEventType;
6257
+ /** @format uuid */
6258
+ requestId?: string;
6259
+ /** @format uuid */
6260
+ userId?: string;
6261
+ /** @format uuid */
6262
+ conversationId?: string;
6263
+ blockedOnly?: boolean;
6264
+ /** @format date-time */
6265
+ startDate?: string;
6266
+ /** @format date-time */
6267
+ endDate?: string;
6268
+ /** @format int32 */
6269
+ pageSize?: number;
6270
+ /** @format int32 */
6271
+ pageNumber?: number;
6272
+ sortBy?: string;
6273
+ sortDirection?: string;
6274
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
6275
+ /**
6276
+ * No description
6277
+ *
6278
+ * @tags AiAudit
6279
+ * @name GetAiRequestLifecycle
6280
+ * @summary Get the full event lifecycle of a single AI request
6281
+ * @request GET:/api/ai/audit-logs/request/{requestId}
6282
+ * @secure
6283
+ * @response `200` `(AiAuditLog)[]` OK
6284
+ */
6285
+ getAiRequestLifecycle: (requestId: string, query?: {
6286
+ /** @format uuid */
6287
+ accountId?: string;
6288
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
6289
+ /**
6290
+ * No description
6291
+ *
6292
+ * @tags AiAudit
6293
+ * @name GetAiAuditConversations
6294
+ * @summary List conversations with their audit roll-up — origin user, turns, status, tokens
6295
+ * @request GET:/api/ai/audit-conversations
6296
+ * @secure
6297
+ * @response `200` `AiConversationAuditSummaryPaginated` OK
6298
+ */
6299
+ getAiAuditConversations: (query?: {
6300
+ /** @format uuid */
6301
+ accountId?: string;
6302
+ searchText?: string;
6303
+ /** @format date-time */
6304
+ startDate?: string;
6305
+ /** @format date-time */
6306
+ endDate?: string;
6307
+ /** @format int32 */
6308
+ pageSize?: number;
6309
+ /** @format int32 */
6310
+ pageNumber?: number;
6311
+ sortBy?: string;
6312
+ sortDirection?: string;
6313
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
6314
+ /**
6315
+ * No description
6316
+ *
6317
+ * @tags AiAudit
6318
+ * @name GetAiStats
6319
+ * @summary Get AI dashboard stats (own account, or any/all accounts for SuperAdmin)
6320
+ * @request GET:/api/ai/stats
6321
+ * @secure
6322
+ * @response `200` `AiAdminStats` OK
6323
+ */
6324
+ getAiStats: (query?: {
6325
+ /** @format uuid */
6326
+ accountId?: string;
6327
+ /** @format date-time */
6328
+ startDate?: string;
6329
+ /** @format date-time */
6330
+ endDate?: string;
6331
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
6332
+ /**
6333
+ * No description
6334
+ *
6335
+ * @tags AiAudit
6336
+ * @name GetAiConfigChanges
6337
+ * @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
6338
+ * @request GET:/api/ai/config-changes
6339
+ * @secure
6340
+ * @response `200` `AuditLogEntryPaginated` OK
6341
+ */
6342
+ getAiConfigChanges: (query?: {
6343
+ /** @format uuid */
6344
+ accountId?: string;
6345
+ /** @format uuid */
6346
+ entityId?: string;
6347
+ /** @format uuid */
6348
+ actorUserId?: string;
6349
+ /** @format date-time */
6350
+ startDate?: string;
6351
+ /** @format date-time */
6352
+ endDate?: string;
6353
+ /** @format int32 */
6354
+ pageSize?: number;
6355
+ /** @format int32 */
6356
+ pageNumber?: number;
6357
+ sortBy?: string;
6358
+ sortDirection?: string;
6359
+ }, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntryPaginated, any, {}>>;
6346
6360
  /**
6347
6361
  * No description
6348
6362
  *
6349
6363
  * @tags AiCanonicalField
6350
6364
  * @name GetAiCanonicalFields
6351
6365
  * @summary Get all canonical fields
6352
- * @request GET:/api/ai/admin/fields
6366
+ * @request GET:/api/ai/canonical-fields
6353
6367
  * @secure
6354
6368
  * @response `200` `(AiCanonicalField)[]` OK
6355
6369
  */
@@ -6360,7 +6374,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6360
6374
  * @tags AiCanonicalField
6361
6375
  * @name CreateAiCanonicalField
6362
6376
  * @summary Create canonical field
6363
- * @request POST:/api/ai/admin/fields
6377
+ * @request POST:/api/ai/canonical-fields
6364
6378
  * @secure
6365
6379
  * @response `201` `AiCanonicalField` Created
6366
6380
  * @response `400` `ProblemDetails` Bad Request
@@ -6372,7 +6386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6372
6386
  * @tags AiCanonicalField
6373
6387
  * @name GetAiCanonicalField
6374
6388
  * @summary Get canonical field by ID
6375
- * @request GET:/api/ai/admin/fields/{id}
6389
+ * @request GET:/api/ai/canonical-fields/{id}
6376
6390
  * @secure
6377
6391
  * @response `200` `AiCanonicalField` OK
6378
6392
  * @response `404` `ProblemDetails` Not Found
@@ -6384,7 +6398,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6384
6398
  * @tags AiCanonicalField
6385
6399
  * @name UpdateAiCanonicalField
6386
6400
  * @summary Update canonical field
6387
- * @request PUT:/api/ai/admin/fields/{id}
6401
+ * @request PUT:/api/ai/canonical-fields/{id}
6388
6402
  * @secure
6389
6403
  * @response `200` `AiCanonicalField` OK
6390
6404
  * @response `400` `ProblemDetails` Bad Request
@@ -6397,7 +6411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6397
6411
  * @tags AiCanonicalField
6398
6412
  * @name DeleteAiCanonicalField
6399
6413
  * @summary Delete canonical field
6400
- * @request DELETE:/api/ai/admin/fields/{id}
6414
+ * @request DELETE:/api/ai/canonical-fields/{id}
6401
6415
  * @secure
6402
6416
  * @response `204` `void` No Content
6403
6417
  * @response `404` `ProblemDetails` Not Found
@@ -6409,7 +6423,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6409
6423
  * @tags AiCanonicalField
6410
6424
  * @name ToggleAiCanonicalField
6411
6425
  * @summary Toggle canonical field active/inactive
6412
- * @request PATCH:/api/ai/admin/fields/{id}/toggle
6426
+ * @request PATCH:/api/ai/canonical-fields/{id}/toggle
6413
6427
  * @secure
6414
6428
  * @response `200` `AiCanonicalField` OK
6415
6429
  * @response `404` `ProblemDetails` Not Found
@@ -6421,7 +6435,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6421
6435
  * @tags AiChat
6422
6436
  * @name AiChat
6423
6437
  * @summary Send AI chat message
6424
- * @request POST:/api/ai/chat
6438
+ * @request POST:/api/ai/chats
6425
6439
  * @secure
6426
6440
  * @response `200` `AiChat` OK
6427
6441
  * @response `400` `ProblemDetails` Bad Request
@@ -6538,7 +6552,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6538
6552
  * @tags AiConversationAdmin
6539
6553
  * @name GetAiAccountConversations
6540
6554
  * @summary List AI conversations across the account, optionally filtered by user (admin supervision)
6541
- * @request GET:/api/ai/admin/conversations
6555
+ * @request GET:/api/ai/conversations/all
6542
6556
  * @secure
6543
6557
  * @response `200` `AiConversationListItemPaginated` OK
6544
6558
  */
@@ -6558,7 +6572,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6558
6572
  * @tags AiConversationAdmin
6559
6573
  * @name GetAiAccountConversation
6560
6574
  * @summary Get an account conversation's detail (admin supervision)
6561
- * @request GET:/api/ai/admin/conversations/{id}
6575
+ * @request GET:/api/ai/conversations/all/{id}
6562
6576
  * @secure
6563
6577
  * @response `200` `AiConversationDetail` OK
6564
6578
  * @response `404` `ProblemDetails` Not Found
@@ -6570,7 +6584,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6570
6584
  * @tags AiConversationAdmin
6571
6585
  * @name GetAiAccountConversationMessages
6572
6586
  * @summary Get an account conversation's messages (admin supervision)
6573
- * @request GET:/api/ai/admin/conversations/{id}/messages
6587
+ * @request GET:/api/ai/conversations/all/{id}/messages
6574
6588
  * @secure
6575
6589
  * @response `200` `AiChatMessagePaginated` OK
6576
6590
  * @response `404` `ProblemDetails` Not Found
@@ -6589,7 +6603,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6589
6603
  * @tags AiGuardrail
6590
6604
  * @name GetAiGuardrails
6591
6605
  * @summary Get all guardrails
6592
- * @request GET:/api/ai/admin/guardrails
6606
+ * @request GET:/api/ai/guardrails
6593
6607
  * @secure
6594
6608
  * @response `200` `(AiGuardrail)[]` OK
6595
6609
  */
@@ -6600,7 +6614,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6600
6614
  * @tags AiGuardrail
6601
6615
  * @name CreateAiGuardrail
6602
6616
  * @summary Create custom guardrail
6603
- * @request POST:/api/ai/admin/guardrails
6617
+ * @request POST:/api/ai/guardrails
6604
6618
  * @secure
6605
6619
  * @response `201` `AiGuardrail` Created
6606
6620
  * @response `400` `ProblemDetails` Bad Request
@@ -6612,7 +6626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6612
6626
  * @tags AiGuardrail
6613
6627
  * @name GetAiGuardrail
6614
6628
  * @summary Get guardrail by ID
6615
- * @request GET:/api/ai/admin/guardrails/{id}
6629
+ * @request GET:/api/ai/guardrails/{id}
6616
6630
  * @secure
6617
6631
  * @response `200` `AiGuardrail` OK
6618
6632
  * @response `404` `ProblemDetails` Not Found
@@ -6624,7 +6638,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6624
6638
  * @tags AiGuardrail
6625
6639
  * @name UpdateAiGuardrail
6626
6640
  * @summary Update guardrail
6627
- * @request PUT:/api/ai/admin/guardrails/{id}
6641
+ * @request PUT:/api/ai/guardrails/{id}
6628
6642
  * @secure
6629
6643
  * @response `200` `AiGuardrail` OK
6630
6644
  * @response `400` `ProblemDetails` Bad Request
@@ -6637,7 +6651,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6637
6651
  * @tags AiGuardrail
6638
6652
  * @name DeleteAiGuardrail
6639
6653
  * @summary Delete guardrail
6640
- * @request DELETE:/api/ai/admin/guardrails/{id}
6654
+ * @request DELETE:/api/ai/guardrails/{id}
6641
6655
  * @secure
6642
6656
  * @response `204` `void` No Content
6643
6657
  * @response `400` `ProblemDetails` Bad Request
@@ -6650,7 +6664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6650
6664
  * @tags AiGuardrail
6651
6665
  * @name ToggleAiGuardrail
6652
6666
  * @summary Toggle guardrail enabled/disabled
6653
- * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6667
+ * @request PATCH:/api/ai/guardrails/{id}/toggle
6654
6668
  * @secure
6655
6669
  * @response `200` `AiGuardrail` OK
6656
6670
  * @response `404` `ProblemDetails` Not Found
@@ -6660,116 +6674,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6660
6674
  * No description
6661
6675
  *
6662
6676
  * @tags AiPrompt
6663
- * @name GetAvailablePrompts
6677
+ * @name GetAiAvailablePrompts
6664
6678
  * @summary Get available prompts for current user
6665
- * @request GET:/api/ai/prompts
6679
+ * @request GET:/api/ai/prompts/available
6666
6680
  * @secure
6667
6681
  * @response `200` `(AiPromptSummary)[]` OK
6668
6682
  */
6669
- getAvailablePrompts: (query?: {
6683
+ getAiAvailablePrompts: (query?: {
6670
6684
  documentType?: string;
6671
6685
  }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
6672
- /**
6673
- * No description
6674
- *
6675
- * @tags AiSuperAdmin
6676
- * @name GetAiAuditLogsCrossAccount
6677
- * @summary Get AI audit logs for a specific account or across all accounts
6678
- * @request GET:/api/ai/superadmin/audit-logs
6679
- * @secure
6680
- * @response `200` `AiAuditLogPaginated` OK
6681
- */
6682
- getAiAuditLogsCrossAccount: (query?: {
6683
- /** @format uuid */
6684
- accountId?: string;
6685
- eventType?: AiAuditEventType;
6686
- /** @format uuid */
6687
- requestId?: string;
6688
- /** @format uuid */
6689
- userId?: string;
6690
- /** @format uuid */
6691
- conversationId?: string;
6692
- blockedOnly?: boolean;
6693
- /** @format date-time */
6694
- startDate?: string;
6695
- /** @format date-time */
6696
- endDate?: string;
6697
- /** @format int32 */
6698
- pageSize?: number;
6699
- /** @format int32 */
6700
- pageNumber?: number;
6701
- sortBy?: string;
6702
- sortDirection?: string;
6703
- }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
6704
- /**
6705
- * No description
6706
- *
6707
- * @tags AiSuperAdmin
6708
- * @name GetAiRequestLifecycleCrossAccount
6709
- * @summary Get the full event lifecycle of a single AI request from any account
6710
- * @request GET:/api/ai/superadmin/audit-logs/request/{requestId}
6711
- * @secure
6712
- * @response `200` `(AiAuditLog)[]` OK
6713
- */
6714
- getAiRequestLifecycleCrossAccount: (requestId: string, query?: {
6715
- /** @format uuid */
6716
- accountId?: string;
6717
- }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
6718
- /**
6719
- * No description
6720
- *
6721
- * @tags AiSuperAdmin
6722
- * @name GetAiStatsCrossAccount
6723
- * @summary Get AI stats for a specific account or platform-wide
6724
- * @request GET:/api/ai/superadmin/stats
6725
- * @secure
6726
- * @response `200` `AiAdminStats` OK
6727
- */
6728
- getAiStatsCrossAccount: (query?: {
6729
- /** @format uuid */
6730
- accountId?: string;
6731
- /** @format date-time */
6732
- startDate?: string;
6733
- /** @format date-time */
6734
- endDate?: string;
6735
- }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
6736
- /**
6737
- * No description
6738
- *
6739
- * @tags AiSuperAdmin
6740
- * @name GetAiConfigChangesCrossAccount
6741
- * @summary Get AI configuration change history for a specific account or across all accounts (incl. global defaults)
6742
- * @request GET:/api/ai/superadmin/config-changes
6743
- * @secure
6744
- * @response `200` `AiConfigChangeLogPaginated` OK
6745
- */
6746
- getAiConfigChangesCrossAccount: (query?: {
6747
- /** @format uuid */
6748
- accountId?: string;
6749
- entityType?: AiConfigEntityType;
6750
- /** @format uuid */
6751
- entityId?: string;
6752
- /** @format uuid */
6753
- actorUserId?: string;
6754
- action?: AiConfigChangeAction;
6755
- /** @format date-time */
6756
- startDate?: string;
6757
- /** @format date-time */
6758
- endDate?: string;
6759
- /** @format int32 */
6760
- pageSize?: number;
6761
- /** @format int32 */
6762
- pageNumber?: number;
6763
- sortBy?: string;
6764
- sortDirection?: string;
6765
- }, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
6766
6686
  /**
6767
6687
  * No description
6768
6688
  *
6769
6689
  * @tags AiTokenUsageAdmin
6770
6690
  * @name SearchAiAccountTokenUsage
6771
6691
  * @summary Search accounts by current-month AI token usage and classification
6772
- * @request POST:/api/ai/admin/token-usage/search
6692
+ * @request POST:/api/ai/token-usage/search
6773
6693
  * @secure
6774
6694
  * @response `200` `AiAccountUsageOverviewPaginated` OK
6775
6695
  */
@@ -6787,7 +6707,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6787
6707
  * @tags AiTokenUsageAdmin
6788
6708
  * @name GetAiAccountTokenUsage
6789
6709
  * @summary Get an account's current-month AI token usage
6790
- * @request GET:/api/ai/admin/token-usage/{accountId}
6710
+ * @request GET:/api/ai/token-usage/{accountId}
6791
6711
  * @secure
6792
6712
  * @response `200` `AiTokenBudgetStatus` OK
6793
6713
  */
@@ -6798,7 +6718,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6798
6718
  * @tags AiTokenUsageAdmin
6799
6719
  * @name GetAiAccountTokenUsageHistory
6800
6720
  * @summary Get an account's monthly AI token usage history
6801
- * @request GET:/api/ai/admin/token-usage/{accountId}/history
6721
+ * @request GET:/api/ai/token-usage/{accountId}/history
6802
6722
  * @secure
6803
6723
  * @response `200` `AiTokenUsageWindowPaginated` OK
6804
6724
  */
@@ -6816,7 +6736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6816
6736
  * @tags AiTokenUsageAdmin
6817
6737
  * @name SetAiAccountTokenLimit
6818
6738
  * @summary Set or raise an account's monthly AI token limit
6819
- * @request PUT:/api/ai/admin/token-usage/{accountId}/limit
6739
+ * @request PUT:/api/ai/token-usage/{accountId}/limit
6820
6740
  * @secure
6821
6741
  * @response `200` `AiTokenBudgetStatus` OK
6822
6742
  * @response `400` `ProblemDetails` Bad Request
@@ -6828,7 +6748,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6828
6748
  * @tags AiUrlSource
6829
6749
  * @name GetAiUrlSources
6830
6750
  * @summary Get all URL sources
6831
- * @request GET:/api/ai/admin/url-sources
6751
+ * @request GET:/api/ai/url-sources
6832
6752
  * @secure
6833
6753
  * @response `200` `(AiUrlSource)[]` OK
6834
6754
  */
@@ -6839,7 +6759,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6839
6759
  * @tags AiUrlSource
6840
6760
  * @name CreateAiUrlSource
6841
6761
  * @summary Create URL source
6842
- * @request POST:/api/ai/admin/url-sources
6762
+ * @request POST:/api/ai/url-sources
6843
6763
  * @secure
6844
6764
  * @response `201` `AiUrlSource` Created
6845
6765
  * @response `400` `ProblemDetails` Bad Request
@@ -6852,7 +6772,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6852
6772
  * @tags AiUrlSource
6853
6773
  * @name GetAiUrlSource
6854
6774
  * @summary Get URL source by ID
6855
- * @request GET:/api/ai/admin/url-sources/{id}
6775
+ * @request GET:/api/ai/url-sources/{id}
6856
6776
  * @secure
6857
6777
  * @response `200` `AiUrlSource` OK
6858
6778
  * @response `404` `ProblemDetails` Not Found
@@ -6864,7 +6784,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6864
6784
  * @tags AiUrlSource
6865
6785
  * @name UpdateAiUrlSource
6866
6786
  * @summary Update URL source
6867
- * @request PUT:/api/ai/admin/url-sources/{id}
6787
+ * @request PUT:/api/ai/url-sources/{id}
6868
6788
  * @secure
6869
6789
  * @response `200` `AiUrlSource` OK
6870
6790
  * @response `400` `ProblemDetails` Bad Request
@@ -6878,7 +6798,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6878
6798
  * @tags AiUrlSource
6879
6799
  * @name DeleteAiUrlSource
6880
6800
  * @summary Delete URL source
6881
- * @request DELETE:/api/ai/admin/url-sources/{id}
6801
+ * @request DELETE:/api/ai/url-sources/{id}
6882
6802
  * @secure
6883
6803
  * @response `204` `void` No Content
6884
6804
  * @response `404` `ProblemDetails` Not Found
@@ -6890,7 +6810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6890
6810
  * @tags AiUrlSource
6891
6811
  * @name ToggleAiUrlSource
6892
6812
  * @summary Toggle URL source active/inactive
6893
- * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
6813
+ * @request PATCH:/api/ai/url-sources/{id}/toggle
6894
6814
  * @secure
6895
6815
  * @response `200` `AiUrlSource` OK
6896
6816
  * @response `404` `ProblemDetails` Not Found
@@ -7449,7 +7369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7449
7369
  * @response `200` `(CustomFieldDefinition)[]` OK
7450
7370
  */
7451
7371
  getCustomFieldDefinitions: (query?: {
7452
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7372
+ entityType?: "Loan";
7453
7373
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7454
7374
  /**
7455
7375
  * No description
@@ -7860,6 +7780,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7860
7780
  sortBy?: string;
7861
7781
  sortDirection?: string;
7862
7782
  }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
7783
+ /**
7784
+ * No description
7785
+ *
7786
+ * @tags Encompass Packages
7787
+ * @name GetLoanPackages
7788
+ * @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
7789
+ * @secure
7790
+ * @response `200` `EncompassPackageList` OK
7791
+ * @response `400` `EncompassError` Bad Request
7792
+ * @response `401` `EncompassError` Unauthorized
7793
+ * @response `403` `EncompassError` Forbidden
7794
+ * @response `500` `EncompassError` Internal Server Error
7795
+ */
7796
+ getLoanPackages: (loanId: string, query?: {
7797
+ status?: string;
7798
+ /**
7799
+ * @format int32
7800
+ * @default 1
7801
+ */
7802
+ page?: number;
7803
+ /**
7804
+ * @format int32
7805
+ * @default 20
7806
+ */
7807
+ pageSize?: number;
7808
+ sortBy?: string;
7809
+ sortDirection?: string;
7810
+ }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
7863
7811
  /**
7864
7812
  * No description
7865
7813
  *
@@ -8397,18 +8345,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8397
8345
  * @response `200` `string` OK
8398
8346
  */
8399
8347
  getLoanEmbeddedSigningLink: (envelopeId: string, userName: string, email: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
8400
- /**
8401
- * No description
8402
- *
8403
- * @tags LegacyLoan
8404
- * @name CreateLegacyLoanDocument
8405
- * @summary Create Document
8406
- * @request POST:/api/los/loan/generatedocument
8407
- * @deprecated
8408
- * @secure
8409
- * @response `200` `DocumentDataRequest` OK
8410
- */
8411
- createLegacyLoanDocument: (data: GenerateDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<DocumentDataRequest, any, {}>>;
8412
8348
  /**
8413
8349
  * No description
8414
8350
  *
@@ -8956,10 +8892,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8956
8892
  * @summary Download By ID
8957
8893
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
8958
8894
  * @secure
8959
- * @response `200` `Blob` OK
8895
+ * @response `200` `string` OK
8960
8896
  * @response `404` `ProblemDetails` Not Found
8961
8897
  */
8962
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8898
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
8963
8899
  /**
8964
8900
  * No description
8965
8901
  *
@@ -9661,18 +9597,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9661
9597
  /** @format uuid */
9662
9598
  folderID?: string;
9663
9599
  }, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
9664
- /**
9665
- * No description
9666
- *
9667
- * @tags LoanTaskDocuments
9668
- * @name CreateLoanTaskDocumentBucket
9669
- * @summary Create Bucket
9670
- * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
9671
- * @secure
9672
- * @response `204` `UserLoanTask` No Content
9673
- * @response `422` `UnprocessableEntity` Unprocessable Content
9674
- */
9675
- createLoanTaskDocumentBucket: (loanId: string, loanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
9676
9600
  /**
9677
9601
  * No description
9678
9602
  *
@@ -9682,9 +9606,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9682
9606
  * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
9683
9607
  * @secure
9684
9608
  * @response `204` `void` No Content
9609
+ * @response `400` `ProblemDetails` Bad Request
9685
9610
  * @response `404` `ProblemDetails` Not Found
9611
+ * @response `422` `ProblemDetails` Unprocessable Content
9686
9612
  */
9687
- sendOutstandingLoanTaskNotification: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
9613
+ sendOutstandingLoanTaskNotification: (loanId: string, data: SendOutstandingTaskReminderRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
9688
9614
  /**
9689
9615
  * No description
9690
9616
  *
@@ -10021,32 +9947,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10021
9947
  * @response `422` `ProblemDetails` Unprocessable Content
10022
9948
  */
10023
9949
  calculateMortgageRefinance: (data: RefinanceCalculatorRequest, params?: RequestParams) => Promise<AxiosResponse<RefinanceCalculator, any, {}>>;
10024
- /**
10025
- * No description
10026
- *
10027
- * @tags Notifications
10028
- * @name SendNotificationForLoan
10029
- * @summary Send Notification for Loan
10030
- * @request POST:/api/notifications
10031
- * @deprecated
10032
- * @secure
10033
- * @response `200` `void` OK
10034
- * @response `422` `UnprocessableEntity` Unprocessable Content
10035
- */
10036
- sendNotificationForLoan: (data: SendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10037
- /**
10038
- * No description
10039
- *
10040
- * @tags Notifications
10041
- * @name SendTestNotificationForLoan
10042
- * @summary Send Test Notification for Loan
10043
- * @request POST:/api/notifications/test
10044
- * @deprecated
10045
- * @secure
10046
- * @response `200` `void` OK
10047
- * @response `422` `UnprocessableEntity` Unprocessable Content
10048
- */
10049
- sendTestNotificationForLoan: (data: TestSendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10050
9950
  /**
10051
9951
  * No description
10052
9952
  *
@@ -10203,7 +10103,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10203
10103
  getPartners: (query?: {
10204
10104
  showAll?: boolean;
10205
10105
  /** @default "Realtor" */
10206
- role?: GetPartnersParamsRoleEnum;
10106
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
10207
10107
  /** @format int32 */
10208
10108
  pageSize?: number;
10209
10109
  /** @format int32 */
@@ -10381,7 +10281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10381
10281
  * @response `200` `File` OK
10382
10282
  * @response `404` `ProblemDetails` Not Found
10383
10283
  */
10384
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10284
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10385
10285
  /**
10386
10286
  * No description
10387
10287
  *
@@ -10392,7 +10292,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10392
10292
  * @secure
10393
10293
  * @response `200` `File` OK
10394
10294
  */
10395
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10295
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10396
10296
  /**
10397
10297
  * No description
10398
10298
  *