@matech/thebigpos-sdk 2.48.0-rc6 → 2.49.3-rc0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/README.md +0 -10
  4. package/dist/index.d.ts +836 -298
  5. package/dist/index.js +583 -250
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -4
  8. package/scripts/apply-json-patch-content-type.js +36 -129
  9. package/src/index.ts +2608 -1902
  10. package/tsconfig.json +27 -27
package/dist/index.d.ts CHANGED
@@ -5,15 +5,20 @@ export type SiteTileLocation = "HomePage" | "Dashboard";
5
5
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6
6
  export type SigningMethod = "ConsumerConnect" | "POSF";
7
7
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
8
+ export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
9
+ export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
8
10
  export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
9
11
  export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
12
+ export type LosCredentialHealthStatus = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
10
13
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
11
14
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
12
15
  export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
13
16
  export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
14
17
  export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
15
18
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
16
- export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
19
+ export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
20
+ export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
21
+ export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
17
22
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
18
23
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
19
24
  export type LoanPurpose = "Purchase" | "Refinance";
@@ -37,18 +42,18 @@ export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "
37
42
  export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
38
43
  export type LoanHousingType = "NoExpense" | "Own" | "Rent";
39
44
  export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
40
- export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
45
+ export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone" | "FaceToFace" | "Hybrid" | "Internet";
41
46
  export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
42
47
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
43
- export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
48
+ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
44
49
  export type LoanGenderType = "Male" | "Female";
45
- 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";
50
+ 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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
46
51
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
47
52
  export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
48
53
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
49
54
  export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese" | "Korean" | "Vietnamese" | "Other";
50
55
  export type LoanAmortizationType = "Fixed" | "Arm" | "Balloon" | "Other";
51
- export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
56
+ export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other" | "StockOptions";
52
57
  export type LoanAccessScopeType = "User" | "Branch";
53
58
  export type LinkTarget = "Self" | "Blank";
54
59
  export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
@@ -56,25 +61,28 @@ export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateL
56
61
  export type Environment = "Development" | "Staging" | "UAT" | "Production";
57
62
  export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
58
63
  export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
59
- export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
64
+ export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
60
65
  export type EncompassEnvironment = "Production" | "UAT";
61
66
  export type DraftType = "NewLoan" | "EditLoan";
67
+ export type DocumentVisibilityScope = "Own" | "All";
62
68
  export type CustomFieldEntityType = "Loan";
63
69
  export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
64
70
  export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
65
71
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
66
72
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
67
73
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
74
+ export type CompanyDocumentSourceType = "File" | "FreeText";
75
+ export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
68
76
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
69
77
  export type BranchType = "Mortgage" | "RealEstate";
70
78
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
71
79
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
72
80
  export type BorrowerApplicationStatus = "Draft" | "Complete";
73
81
  export type BillingType = "ClosedLoan" | "LoanOfficer";
74
- export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
82
+ export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
75
83
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
76
84
  export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
77
- export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
85
+ export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
78
86
  export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility" | "OutstandingTasks" | "ConsentTracking" | "TaskStatusBreakdown" | "ConsentSyncHealth";
79
87
  export type AiPromptScope = "General" | "LoanSpecific";
80
88
  export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
@@ -82,7 +90,7 @@ export type AiOutputType = "Text" | "Document";
82
90
  export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
83
91
  export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
84
92
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
85
- 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" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
93
+ 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" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
86
94
  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";
87
95
  export interface ASOSettings {
88
96
  enabled: boolean;
@@ -133,35 +141,16 @@ export interface AccountBilling {
133
141
  contractedRate: number;
134
142
  }
135
143
  export interface AccountBillingRequest {
136
- billingType: AccountBillingRequestBillingTypeEnum;
144
+ billingType: "ClosedLoan" | "LoanOfficer";
137
145
  /** @format double */
138
146
  contractedRate: number;
139
147
  }
140
- export interface AccountDeactivated {
141
- accountDeactivated: boolean;
142
- email: string;
143
- }
144
148
  export interface AccountFailureCount {
145
149
  /** @format uuid */
146
150
  accountId: string;
147
151
  /** @format int32 */
148
152
  count: number;
149
153
  }
150
- export interface AccountReactivationCompleteRequest {
151
- /** @format uuid */
152
- token: string;
153
- /** @minLength 8 */
154
- newPassword: string;
155
- }
156
- export interface AccountReactivationRequest {
157
- /**
158
- * @format email
159
- * @minLength 1
160
- */
161
- email: string;
162
- /** @format uuid */
163
- siteConfigurationId: string;
164
- }
165
154
  export interface AccountSettings {
166
155
  isSmsEnabled: boolean;
167
156
  isLoanEditEnabled: boolean;
@@ -181,7 +170,7 @@ export interface Action {
181
170
  comments?: string | null;
182
171
  /** @format uuid */
183
172
  siteConfigurationID: string;
184
- applicationSettings?: any | null;
173
+ applicationSettings?: any;
185
174
  surveysToken?: string | null;
186
175
  }
187
176
  export interface Address {
@@ -404,7 +393,7 @@ export interface AiAuditLog {
404
393
  conversationId?: string | null;
405
394
  /** @format uuid */
406
395
  messageId?: string | null;
407
- eventType: AiAuditLogEventTypeEnum;
396
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
408
397
  modelId?: string | null;
409
398
  /** @format int32 */
410
399
  inputTokens?: number | null;
@@ -417,7 +406,7 @@ export interface AiAuditLog {
417
406
  guardrailCategory?: string | null;
418
407
  rawRequest?: string | null;
419
408
  rawResponse?: string | null;
420
- details?: any | null;
409
+ details?: any;
421
410
  /** @format date-time */
422
411
  createdAt: string;
423
412
  }
@@ -479,7 +468,7 @@ export interface AiChatMessagePaginated {
479
468
  count: number;
480
469
  }
481
470
  export interface AiChatMetadata {
482
- intent: AiChatMetadataIntentEnum;
471
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
483
472
  fieldsAccessed: string[];
484
473
  /** @format int64 */
485
474
  queryTimeMs: number;
@@ -505,7 +494,7 @@ export interface AiChatRequest {
505
494
  promptId?: string | null;
506
495
  }
507
496
  export interface AiChatStructuredData {
508
- type: AiChatStructuredDataTypeEnum;
497
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
509
498
  displayHint?: AiDisplayHint | null;
510
499
  detectedDocumentType?: string | null;
511
500
  columns: string[];
@@ -513,6 +502,14 @@ export interface AiChatStructuredData {
513
502
  /** @format uuid */
514
503
  generatedDocumentId?: string | null;
515
504
  generatedFileName?: string | null;
505
+ passages?: AiCitedPassage[] | null;
506
+ }
507
+ export interface AiCitedPassage {
508
+ folderName: string;
509
+ documentName: string;
510
+ excerpt: string;
511
+ /** @format double */
512
+ score?: number | null;
516
513
  }
517
514
  export interface AiConversationAuditSummary {
518
515
  /** @format uuid */
@@ -583,7 +580,7 @@ export interface AiGuardrail {
583
580
  /** @format uuid */
584
581
  id: string;
585
582
  name: string;
586
- category: AiGuardrailCategoryEnum;
583
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
587
584
  description?: string | null;
588
585
  keywords: string[];
589
586
  responseTemplate: string;
@@ -603,6 +600,7 @@ export interface AiPrompt {
603
600
  description: string;
604
601
  documentTypes: string[];
605
602
  applicableUrlSourceIds: string[];
603
+ knowledgeBaseFolderIds: string[];
606
604
  allowedRoles: string[];
607
605
  systemPrompt: string;
608
606
  /** @format int32 */
@@ -710,8 +708,8 @@ export interface AiUrlSource {
710
708
  name: string;
711
709
  url: string;
712
710
  description?: string | null;
713
- category: AiUrlSourceCategoryEnum;
714
- scope: AiUrlSourceScopeEnum;
711
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
712
+ scope: "FullDomain" | "SpecificPath";
715
713
  isActive: boolean;
716
714
  isDefault: boolean;
717
715
  hasAccountOverride: boolean;
@@ -818,14 +816,14 @@ export interface AuditLogEntry {
818
816
  /** @format uuid */
819
817
  id: string;
820
818
  entityType: string;
821
- changeType: AuditLogEntryChangeTypeEnum;
819
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
822
820
  /** @format uuid */
823
821
  entityId: string;
824
822
  performedBy?: AuditLogUser | null;
825
823
  rootEntityType?: string | null;
826
824
  /** @format uuid */
827
825
  rootEntityId?: string | null;
828
- changes?: any | null;
826
+ changes?: any;
829
827
  /** @format date-time */
830
828
  createdAt: string;
831
829
  }
@@ -865,7 +863,7 @@ export interface BorrowerCount {
865
863
  firstName: string;
866
864
  lastName: string;
867
865
  email: string;
868
- role: BorrowerCountRoleEnum;
866
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
869
867
  /** @format int32 */
870
868
  count: number;
871
869
  }
@@ -875,7 +873,7 @@ export interface BorrowerIdentity {
875
873
  firstName: string;
876
874
  lastName: string;
877
875
  email: string;
878
- role: BorrowerIdentityRoleEnum;
876
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
879
877
  }
880
878
  export interface BorrowersNotUsingPosSummary {
881
879
  /** @format int32 */
@@ -1036,6 +1034,59 @@ export interface CompanyAddress {
1036
1034
  state: string;
1037
1035
  zip: string;
1038
1036
  }
1037
+ export interface CompanyDocument {
1038
+ /** @format uuid */
1039
+ id: string;
1040
+ /** @format uuid */
1041
+ folderId: string;
1042
+ folderName: string;
1043
+ name: string;
1044
+ sourceType: "File" | "FreeText";
1045
+ contentType?: string | null;
1046
+ /** @format int64 */
1047
+ fileSizeBytes: number;
1048
+ inlineContent?: string | null;
1049
+ previewImage?: string | null;
1050
+ indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1051
+ indexError?: string | null;
1052
+ /** @format date-time */
1053
+ indexedAt?: string | null;
1054
+ /** @format uuid */
1055
+ uploadedByUserId?: string | null;
1056
+ /** @format date-time */
1057
+ createdAt: string;
1058
+ /** @format date-time */
1059
+ updatedAt?: string | null;
1060
+ }
1061
+ export interface CompanyDocumentFolder {
1062
+ /** @format uuid */
1063
+ id: string;
1064
+ name: string;
1065
+ description?: string | null;
1066
+ isSystemDefault: boolean;
1067
+ /** @format int32 */
1068
+ documentCount: number;
1069
+ /** @format date-time */
1070
+ createdAt: string;
1071
+ /** @format date-time */
1072
+ updatedAt?: string | null;
1073
+ }
1074
+ export interface CompanyDocumentPaginated {
1075
+ rows: CompanyDocument[];
1076
+ pagination: Pagination;
1077
+ /** @format int64 */
1078
+ count: number;
1079
+ }
1080
+ export interface CompanyDocumentPreviewsRequest {
1081
+ documentIds: string[];
1082
+ }
1083
+ export interface CompanyDocumentSearchCriteria {
1084
+ searchText?: string | null;
1085
+ /** @format uuid */
1086
+ folderID?: string | null;
1087
+ indexStatuses?: CompanyDocumentIndexStatus[] | null;
1088
+ sourceType?: CompanyDocumentSourceType | null;
1089
+ }
1039
1090
  export interface ConditionComment {
1040
1091
  commentId: string;
1041
1092
  comments: string;
@@ -1110,7 +1161,7 @@ export interface CorporateSearchCriteria {
1110
1161
  isActive?: boolean | null;
1111
1162
  }
1112
1163
  export interface CreateAccessScopeRequest {
1113
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1164
+ scopeType: "User" | "Branch";
1114
1165
  /** @format uuid */
1115
1166
  userId?: string | null;
1116
1167
  /** @format uuid */
@@ -1128,7 +1179,7 @@ export interface CreateAccountRequest {
1128
1179
  /** @format int64 */
1129
1180
  nlmsid: number;
1130
1181
  settings: AccountSettingsRequest;
1131
- environment: CreateAccountRequestEnvironmentEnum;
1182
+ environment: "Development" | "Staging" | "UAT" | "Production";
1132
1183
  losIntegration: LOSIntegration;
1133
1184
  billingSettings: AccountBillingRequest;
1134
1185
  }
@@ -1142,7 +1193,7 @@ export interface CreateAiCanonicalFieldRequest {
1142
1193
  }
1143
1194
  export interface CreateAiGuardrailRequest {
1144
1195
  name: string;
1145
- category: CreateAiGuardrailRequestCategoryEnum;
1196
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1146
1197
  description?: string | null;
1147
1198
  keywords: string[];
1148
1199
  responseTemplate: string;
@@ -1153,6 +1204,7 @@ export interface CreateAiPromptRequest {
1153
1204
  description: string;
1154
1205
  documentTypes: string[];
1155
1206
  applicableUrlSourceIds: string[];
1207
+ knowledgeBaseFolderIds: string[];
1156
1208
  allowedRoles: string[];
1157
1209
  systemPrompt: string;
1158
1210
  /** @format int32 */
@@ -1172,8 +1224,8 @@ export interface CreateAiUrlSourceRequest {
1172
1224
  name: string;
1173
1225
  url: string;
1174
1226
  description?: string | null;
1175
- category: CreateAiUrlSourceRequestCategoryEnum;
1176
- scope: CreateAiUrlSourceRequestScopeEnum;
1227
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1228
+ scope: "FullDomain" | "SpecificPath";
1177
1229
  }
1178
1230
  export interface CreateBranchRequest {
1179
1231
  name: string;
@@ -1181,6 +1233,16 @@ export interface CreateBranchRequest {
1181
1233
  corporateID: string;
1182
1234
  type: string;
1183
1235
  }
1236
+ export interface CreateCompanyDocumentFolderRequest {
1237
+ name: string;
1238
+ description?: string | null;
1239
+ }
1240
+ export interface CreateCompanyTextDocumentRequest {
1241
+ name: string;
1242
+ /** @format uuid */
1243
+ folderID: string;
1244
+ content: string;
1245
+ }
1184
1246
  export interface CreateCustomFieldDefinitionRequest {
1185
1247
  isRequired: boolean;
1186
1248
  /** @format int32 */
@@ -1196,8 +1258,8 @@ export interface CreateCustomFieldDefinitionRequest {
1196
1258
  name: string;
1197
1259
  defaultValue?: string | null;
1198
1260
  regexPattern?: string | null;
1199
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1200
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1261
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1262
+ entityType: "Loan";
1201
1263
  options?: CustomFieldOptionRequest[] | null;
1202
1264
  permissions?: CustomFieldPermissionRequest[] | null;
1203
1265
  }
@@ -1206,13 +1268,16 @@ export interface CreateDocumentTemplateRequest {
1206
1268
  name: string;
1207
1269
  type: string;
1208
1270
  description?: string | null;
1271
+ /** @deprecated */
1209
1272
  destinationBucket?: string | null;
1273
+ /** @format uuid */
1274
+ loanDocumentFolderID?: string | null;
1210
1275
  status: string;
1211
1276
  }
1212
1277
  export interface CreateGroupMemberRequest {
1213
1278
  /** @format uuid */
1214
1279
  userId: string;
1215
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1280
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1216
1281
  }
1217
1282
  export interface CreateInviteRequest {
1218
1283
  firstName: string;
@@ -1220,7 +1285,7 @@ export interface CreateInviteRequest {
1220
1285
  emailAddress: string;
1221
1286
  phoneNumber?: string | null;
1222
1287
  /** @deprecated */
1223
- relationship: CreateInviteRequestRelationshipEnum;
1288
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1224
1289
  loanID: string;
1225
1290
  route?: string | null;
1226
1291
  /** @format uuid */
@@ -1240,7 +1305,7 @@ export interface CreateLoanImportRequest {
1240
1305
  endDate: string;
1241
1306
  /** @format date-time */
1242
1307
  startDate: string;
1243
- importMode: CreateLoanImportRequestImportModeEnum;
1308
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1244
1309
  }
1245
1310
  export interface CreateSession {
1246
1311
  sessionId: string;
@@ -1258,7 +1323,7 @@ export interface CreateUserDeviceRequest {
1258
1323
  token: string;
1259
1324
  }
1260
1325
  export interface CreateUserDraft {
1261
- loanRole: CreateUserDraftLoanRoleEnum;
1326
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1262
1327
  }
1263
1328
  export interface CreateUserGroupRequest {
1264
1329
  name: string;
@@ -1319,8 +1384,8 @@ export interface CustomFieldDefinition {
1319
1384
  name: string;
1320
1385
  defaultValue?: string | null;
1321
1386
  regexPattern?: string | null;
1322
- dataType: CustomFieldDefinitionDataTypeEnum;
1323
- entityType: CustomFieldDefinitionEntityTypeEnum;
1387
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1388
+ entityType: "Loan";
1324
1389
  options: CustomFieldOption[];
1325
1390
  permissions: CustomFieldPermission[];
1326
1391
  encompassMapping?: EncompassMapping | null;
@@ -1334,7 +1399,7 @@ export interface CustomFieldEntry {
1334
1399
  displayOrder: number;
1335
1400
  name: string;
1336
1401
  value: string;
1337
- dataType: CustomFieldEntryDataTypeEnum;
1402
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1338
1403
  }
1339
1404
  export interface CustomFieldOption {
1340
1405
  /** @format uuid */
@@ -1351,12 +1416,12 @@ export interface CustomFieldOptionRequest {
1351
1416
  export interface CustomFieldPermission {
1352
1417
  /** @format uuid */
1353
1418
  id: string;
1354
- role: CustomFieldPermissionRoleEnum;
1355
- accessLevel: CustomFieldPermissionAccessLevelEnum;
1419
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1420
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1356
1421
  }
1357
1422
  export interface CustomFieldPermissionRequest {
1358
- role: CustomFieldPermissionRequestRoleEnum;
1359
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1423
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1424
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1360
1425
  }
1361
1426
  export interface CustomFieldValue {
1362
1427
  /** @format uuid */
@@ -1367,7 +1432,7 @@ export interface CustomFieldValue {
1367
1432
  customFieldDefinitionID: string;
1368
1433
  value: string;
1369
1434
  definitionName: string;
1370
- dataType: CustomFieldValueDataTypeEnum;
1435
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1371
1436
  }
1372
1437
  export interface DetailedUser {
1373
1438
  /** @format date-time */
@@ -1513,7 +1578,9 @@ export interface DocumentTemplate {
1513
1578
  isDefault: boolean;
1514
1579
  type: string;
1515
1580
  description?: string | null;
1581
+ /** @deprecated */
1516
1582
  destinationBucket?: string | null;
1583
+ loanDocumentFolder?: LoanDocumentFolderSummary | null;
1517
1584
  isDestinationBucketConfigurable: boolean;
1518
1585
  status: string;
1519
1586
  versions: DocumentTemplateVersionBase[];
@@ -1533,7 +1600,9 @@ export interface DocumentTemplateBase {
1533
1600
  isDefault: boolean;
1534
1601
  type: string;
1535
1602
  description?: string | null;
1603
+ /** @deprecated */
1536
1604
  destinationBucket?: string | null;
1605
+ loanDocumentFolder?: LoanDocumentFolderSummary | null;
1537
1606
  isDestinationBucketConfigurable: boolean;
1538
1607
  status: string;
1539
1608
  }
@@ -1593,7 +1662,7 @@ export interface Draft {
1593
1662
  siteConfiguration: SiteConfigurationReduced;
1594
1663
  /** @format uuid */
1595
1664
  loanID?: string | null;
1596
- type: DraftTypeEnum;
1665
+ type: "NewLoan" | "EditLoan";
1597
1666
  isCoBorrower: boolean;
1598
1667
  }
1599
1668
  export interface DraftContent {
@@ -1611,7 +1680,7 @@ export interface DraftContent {
1611
1680
  siteConfiguration: SiteConfigurationReduced;
1612
1681
  /** @format uuid */
1613
1682
  loanID?: string | null;
1614
- type: DraftContentTypeEnum;
1683
+ type: "NewLoan" | "EditLoan";
1615
1684
  isCoBorrower: boolean;
1616
1685
  applicationPayload: any;
1617
1686
  }
@@ -1627,7 +1696,7 @@ export interface DraftLoanOfficerReassignRequest {
1627
1696
  }
1628
1697
  export interface DraftRequest {
1629
1698
  applicationPayload: any;
1630
- customData?: any | null;
1699
+ customData?: any;
1631
1700
  isCoBorrower: boolean;
1632
1701
  }
1633
1702
  export interface EconsentPendingSummary {
@@ -1697,9 +1766,9 @@ export interface EncompassCredentialsDetail {
1697
1766
  clearStateIfUnlicensed: boolean;
1698
1767
  /** @deprecated */
1699
1768
  baseUrl?: string | null;
1700
- encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1769
+ encompassEnvironment: "Production" | "UAT";
1701
1770
  consumerConnectWidgetHost?: string | null;
1702
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1771
+ signingMethod: "ConsumerConnect" | "POSF";
1703
1772
  subscriptionId?: string | null;
1704
1773
  environment?: string | null;
1705
1774
  /** @format uuid */
@@ -1715,9 +1784,9 @@ export interface EncompassCredentialsRequest {
1715
1784
  clearStateIfUnlicensed: boolean;
1716
1785
  /** @deprecated */
1717
1786
  baseUrl?: string | null;
1718
- encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1787
+ encompassEnvironment: "Production" | "UAT";
1719
1788
  consumerConnectWidgetHost?: string | null;
1720
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1789
+ signingMethod: "ConsumerConnect" | "POSF";
1721
1790
  subscriptionId?: string | null;
1722
1791
  environment?: string | null;
1723
1792
  clientID?: string | null;
@@ -1827,8 +1896,8 @@ export interface EncompassRequestLog {
1827
1896
  losId?: string | null;
1828
1897
  /** @format uuid */
1829
1898
  accountId: string;
1830
- operationType: EncompassRequestLogOperationTypeEnum;
1831
- outcome: EncompassRequestLogOutcomeEnum;
1899
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
1900
+ outcome: "Success" | "Failure" | "PartialSuccess";
1832
1901
  message: string;
1833
1902
  endpoint?: string | null;
1834
1903
  httpMethod?: string | null;
@@ -1836,7 +1905,7 @@ export interface EncompassRequestLog {
1836
1905
  httpStatusCode?: number | null;
1837
1906
  /** @format int64 */
1838
1907
  durationMs?: number | null;
1839
- context?: any | null;
1908
+ context?: any;
1840
1909
  /** @format date-time */
1841
1910
  createdAt: string;
1842
1911
  }
@@ -1881,7 +1950,7 @@ export interface FileSearchCriteria {
1881
1950
  export interface FileWithBytes {
1882
1951
  name: string;
1883
1952
  /** @format byte */
1884
- data: Blob;
1953
+ data: string;
1885
1954
  fileName: string;
1886
1955
  mimeType?: string | null;
1887
1956
  extension?: string | null;
@@ -1957,7 +2026,7 @@ export interface FormSubmission {
1957
2026
  subjectPropertyAddressCounty?: string | null;
1958
2027
  subjectPropertyAddressState?: string | null;
1959
2028
  subjectPropertyAddressZip?: string | null;
1960
- data?: any | null;
2029
+ data?: any;
1961
2030
  /** @format uuid */
1962
2031
  listingID?: string | null;
1963
2032
  listing?: Listing | null;
@@ -1992,7 +2061,7 @@ export interface FormSubmissionRequest {
1992
2061
  subjectPropertyAddressCounty?: string | null;
1993
2062
  subjectPropertyAddressState?: string | null;
1994
2063
  subjectPropertyAddressZip?: string | null;
1995
- data?: any | null;
2064
+ data?: any;
1996
2065
  /** @format uuid */
1997
2066
  listingID?: string | null;
1998
2067
  }
@@ -2041,7 +2110,7 @@ export interface FusionFieldDisplay {
2041
2110
  fieldValue: string;
2042
2111
  }
2043
2112
  export interface FusionReportFilter {
2044
- filterType: FusionReportFilterFilterTypeEnum;
2113
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2045
2114
  targetField: string;
2046
2115
  targetValue: string;
2047
2116
  }
@@ -2061,7 +2130,7 @@ export interface GenerateSystemPrompt {
2061
2130
  }
2062
2131
  export interface GenerateSystemPromptRequest {
2063
2132
  description: string;
2064
- category: GenerateSystemPromptRequestCategoryEnum;
2133
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2065
2134
  }
2066
2135
  export interface GetApplications {
2067
2136
  applications: ApplicationRowData[];
@@ -2145,11 +2214,11 @@ export interface GetWorkflowRequest {
2145
2214
  export interface GuidPatchOperation {
2146
2215
  op: string;
2147
2216
  path: string;
2148
- value?: any | null;
2217
+ value?: any;
2149
2218
  from?: string | null;
2150
2219
  }
2151
2220
  export interface IPAddress {
2152
- addressFamily: IpAddressAddressFamilyEnum;
2221
+ 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";
2153
2222
  /** @format int64 */
2154
2223
  scopeId: number;
2155
2224
  isIPv6Multicast: boolean;
@@ -2398,7 +2467,7 @@ export interface Loan {
2398
2467
  contacts: LoanContact[];
2399
2468
  customFields: CustomFieldEntry[];
2400
2469
  milestones: LoanMilestone[];
2401
- signingMethod: LoanSigningMethodEnum;
2470
+ signingMethod: "ConsumerConnect" | "POSF";
2402
2471
  }
2403
2472
  export interface LoanApplication {
2404
2473
  /** @format uuid */
@@ -2436,7 +2505,7 @@ export interface LoanApplicationRequest {
2436
2505
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2437
2506
  /** @format uuid */
2438
2507
  draftId?: string | null;
2439
- additionalFields?: Record<string, any> | null;
2508
+ additionalFields?: Record<string, any>;
2440
2509
  /** @format uuid */
2441
2510
  existingLoanId?: string | null;
2442
2511
  }
@@ -2455,7 +2524,7 @@ export interface LoanBorrower {
2455
2524
  citizenship?: LoanCitizenship | null;
2456
2525
  maritalStatus?: LoanMaritalStatus | null;
2457
2526
  languagePreference?: LoanLanguagePreference | null;
2458
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2527
+ applicationStatus: "Draft" | "Complete";
2459
2528
  /** @format int32 */
2460
2529
  numberOfDependents?: number | null;
2461
2530
  /** @format int32 */
@@ -2829,10 +2898,16 @@ export interface LoanBorrowerGiftRequest {
2829
2898
  isDeposited?: boolean | null;
2830
2899
  source?: LoanGiftSource | null;
2831
2900
  assetType?: LoanGiftAssetType | null;
2901
+ grantorDonorName?: string | null;
2902
+ /** @format double */
2903
+ amountAppliedToDownPayment?: number | null;
2904
+ /** @format double */
2905
+ amountAppliedToClosingCosts?: number | null;
2832
2906
  }
2833
2907
  export interface LoanBorrowerHomeOwnership {
2834
2908
  /** @format uuid */
2835
2909
  id?: string | null;
2910
+ isCompleted?: boolean | null;
2836
2911
  /** @format date */
2837
2912
  dateCompleted?: string | null;
2838
2913
  type?: LoanHomeOwnershipType | null;
@@ -2844,14 +2919,17 @@ export interface LoanBorrowerHomeOwnershipProvider {
2844
2919
  id?: string | null;
2845
2920
  name?: string | null;
2846
2921
  phoneNumber?: string | null;
2922
+ hudAgencyId?: string | null;
2847
2923
  address?: AddressV3 | null;
2848
2924
  }
2849
2925
  export interface LoanBorrowerHomeOwnershipProviderRequest {
2850
2926
  name?: string | null;
2851
2927
  phoneNumber?: string | null;
2928
+ hudAgencyId?: string | null;
2852
2929
  address?: AddressRequest | null;
2853
2930
  }
2854
2931
  export interface LoanBorrowerHomeOwnershipRequest {
2932
+ isCompleted?: boolean | null;
2855
2933
  /** @format date */
2856
2934
  dateCompleted?: string | null;
2857
2935
  type?: LoanHomeOwnershipType | null;
@@ -2984,7 +3062,9 @@ export interface LoanBorrowerRealEstateAsset {
2984
3062
  /** @format uuid */
2985
3063
  id?: string | null;
2986
3064
  status?: LoanRealEstateStatus | null;
2987
- occupancy?: LoanOccupancyType | null;
3065
+ occupancy?: LoanRealEstateOccupancyType | null;
3066
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3067
+ intendedUsageOtherDescription?: string | null;
2988
3068
  /** @format double */
2989
3069
  marketValue?: number | null;
2990
3070
  /** @format double */
@@ -3039,7 +3119,9 @@ export interface LoanBorrowerRealEstateAssetMortgageRequest {
3039
3119
  }
3040
3120
  export interface LoanBorrowerRealEstateAssetRequest {
3041
3121
  status?: LoanRealEstateStatus | null;
3042
- occupancy?: LoanOccupancyType | null;
3122
+ occupancy?: LoanRealEstateOccupancyType | null;
3123
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3124
+ intendedUsageOtherDescription?: string | null;
3043
3125
  /** @format double */
3044
3126
  marketValue?: number | null;
3045
3127
  /** @format double */
@@ -3181,7 +3263,7 @@ export interface LoanConsentRequest {
3181
3263
  borrowerEConsent?: boolean | null;
3182
3264
  borrowerCreditAuth?: boolean | null;
3183
3265
  borrowerTCPAOptIn?: boolean | null;
3184
- additionalFields?: Record<string, string> | null;
3266
+ additionalFields?: Record<string, string>;
3185
3267
  }
3186
3268
  export interface LoanContact {
3187
3269
  /** @format date-time */
@@ -3199,7 +3281,7 @@ export interface LoanContact {
3199
3281
  email?: string | null;
3200
3282
  phone?: string | null;
3201
3283
  companyName?: string | null;
3202
- role: LoanContactRoleEnum;
3284
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3203
3285
  }
3204
3286
  export interface LoanContactList {
3205
3287
  email: string;
@@ -3221,7 +3303,7 @@ export interface LoanCostDetails {
3221
3303
  totalFinancing?: number | null;
3222
3304
  }
3223
3305
  export interface LoanCustomFieldsRequest {
3224
- additionalFields?: Record<string, string> | null;
3306
+ additionalFields?: Record<string, string>;
3225
3307
  }
3226
3308
  export interface LoanDocument {
3227
3309
  /** @format date-time */
@@ -3234,8 +3316,11 @@ export interface LoanDocument {
3234
3316
  id: string;
3235
3317
  name: string;
3236
3318
  loan: Loan;
3237
- user?: User | null;
3319
+ user?: UserSummary | null;
3320
+ /** @deprecated */
3238
3321
  initialBucket?: string | null;
3322
+ /** @format uuid */
3323
+ folderID?: string | null;
3239
3324
  losDocumentID?: string | null;
3240
3325
  losStatus: string;
3241
3326
  contents?: string | null;
@@ -3262,27 +3347,53 @@ export interface LoanDocumentFolder {
3262
3347
  createdAt: string;
3263
3348
  /** @format date-time */
3264
3349
  updatedAt?: string | null;
3265
- /** @format date-time */
3266
- deletedAt?: string | null;
3267
3350
  permissions: LoanDocumentFolderPermission[];
3268
3351
  }
3352
+ export interface LoanDocumentFolderPaginated {
3353
+ rows: LoanDocumentFolder[];
3354
+ pagination: Pagination;
3355
+ /** @format int64 */
3356
+ count: number;
3357
+ }
3269
3358
  export interface LoanDocumentFolderPermission {
3270
3359
  /** @format uuid */
3271
3360
  id: string;
3272
3361
  /** @format uuid */
3273
3362
  loanDocumentFolderID: string;
3274
- role: LoanDocumentFolderPermissionRoleEnum;
3275
- level: LoanDocumentFolderPermissionLevelEnum;
3363
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3364
+ level: "None" | "Read" | "Write" | "Manage";
3365
+ readScope: "Own" | "All";
3276
3366
  }
3277
3367
  export interface LoanDocumentFolderPermissionRequest {
3278
- role: LoanDocumentFolderPermissionRequestRoleEnum;
3279
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3368
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3369
+ level: "None" | "Read" | "Write" | "Manage";
3370
+ readScope: "Own" | "All";
3371
+ }
3372
+ export interface LoanDocumentFolderSearchCriteria {
3373
+ searchText?: string | null;
3374
+ isActive?: boolean | null;
3375
+ }
3376
+ export interface LoanDocumentFolderSummary {
3377
+ /** @format uuid */
3378
+ id: string;
3379
+ name: string;
3380
+ key?: string | null;
3381
+ isActive: boolean;
3280
3382
  }
3281
3383
  export interface LoanDocumentFolderUsage {
3282
3384
  /** @format uuid */
3283
3385
  folderID: string;
3284
3386
  hasEverBeenReferenced: boolean;
3285
3387
  }
3388
+ export interface LoanDocumentFolderWithCount {
3389
+ /** @format uuid */
3390
+ id: string;
3391
+ name: string;
3392
+ key?: string | null;
3393
+ isActive: boolean;
3394
+ /** @format int32 */
3395
+ documentCount: number;
3396
+ }
3286
3397
  export interface LoanDocumentPreviewsRequest {
3287
3398
  documentIds: string[];
3288
3399
  }
@@ -3298,7 +3409,10 @@ export interface LoanDocumentSearch {
3298
3409
  name: string;
3299
3410
  loanID?: string | null;
3300
3411
  userID?: string | null;
3412
+ user?: UserSummary | null;
3413
+ /** @deprecated */
3301
3414
  initialBucket?: string | null;
3415
+ folder?: LoanDocumentFolderSummary | null;
3302
3416
  losDocumentID?: string | null;
3303
3417
  losStatus: string;
3304
3418
  contents?: string | null;
@@ -3308,8 +3422,11 @@ export interface LoanDocumentSearch {
3308
3422
  }
3309
3423
  export interface LoanDocumentSearchCriteria {
3310
3424
  searchText?: string | null;
3425
+ /** @deprecated */
3311
3426
  bucket?: string | null;
3312
3427
  /** @format uuid */
3428
+ folderID?: string | null;
3429
+ /** @format uuid */
3313
3430
  userID?: string | null;
3314
3431
  documentIDs?: string[] | null;
3315
3432
  losStatuses?: LOSStatus[] | null;
@@ -3410,13 +3527,13 @@ export interface LoanImport {
3410
3527
  /** @format int32 */
3411
3528
  importedCount: number;
3412
3529
  statusMessage?: string | null;
3413
- status: LoanImportStatusEnum;
3414
- importMode: LoanImportImportModeEnum;
3530
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3531
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3415
3532
  /** @format date-time */
3416
3533
  createdAt?: string | null;
3417
3534
  }
3418
3535
  export interface LoanImportLog {
3419
- level: LoanImportLogLevelEnum;
3536
+ level: "None" | "Info" | "Warning" | "Error";
3420
3537
  message: string;
3421
3538
  /** @format date-time */
3422
3539
  createdAt: string;
@@ -3471,8 +3588,8 @@ export interface LoanListPaginated {
3471
3588
  export interface LoanLog {
3472
3589
  /** @format uuid */
3473
3590
  id: string;
3474
- level: LoanLogLevelEnum;
3475
- type: LoanLogTypeEnum;
3591
+ level: "None" | "Info" | "Warning" | "Error";
3592
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3476
3593
  message: string;
3477
3594
  /** @format date-time */
3478
3595
  createdAt: string;
@@ -3480,8 +3597,8 @@ export interface LoanLog {
3480
3597
  export interface LoanLogDetail {
3481
3598
  /** @format uuid */
3482
3599
  id: string;
3483
- level: LoanLogDetailLevelEnum;
3484
- type: LoanLogDetailTypeEnum;
3600
+ level: "None" | "Info" | "Warning" | "Error";
3601
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3485
3602
  message: string;
3486
3603
  /** @format date-time */
3487
3604
  createdAt: string;
@@ -3743,7 +3860,7 @@ export interface LoanQueueWithData {
3743
3860
  user: UserPublic;
3744
3861
  loanOfficer: LoanOfficerPublic;
3745
3862
  siteConfiguration: SiteConfigurationReduced;
3746
- data?: any | null;
3863
+ data?: any;
3747
3864
  }
3748
3865
  export interface LoanRecord {
3749
3866
  loanGuid: string;
@@ -3774,7 +3891,7 @@ export interface LoanTaskSearchRequest {
3774
3891
  loanStatus?: LoanTaskActivityFilter | null;
3775
3892
  }
3776
3893
  export interface LoanTaskStatusSummary {
3777
- status: LoanTaskStatusSummaryStatusEnum;
3894
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3778
3895
  /** @format int32 */
3779
3896
  count: number;
3780
3897
  }
@@ -3786,11 +3903,19 @@ export interface LoanUser {
3786
3903
  email: string;
3787
3904
  phone?: string | null;
3788
3905
  role: string;
3789
- loanRole: LoanUserLoanRoleEnum;
3906
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3790
3907
  isUser: boolean;
3791
3908
  /** @format date-time */
3792
3909
  createdAt: string;
3793
3910
  }
3911
+ export interface LosCredentialHealth {
3912
+ /** @format uuid */
3913
+ accountId: string;
3914
+ status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
3915
+ /** @format date-time */
3916
+ checkedAtUtc: string;
3917
+ message: string;
3918
+ }
3794
3919
  export interface LosCredentials {
3795
3920
  /** @format uuid */
3796
3921
  id: string;
@@ -3798,6 +3923,71 @@ export interface LosCredentials {
3798
3923
  accountID: string;
3799
3924
  instanceID: string;
3800
3925
  }
3926
+ export interface LosIntegration {
3927
+ /** @format uuid */
3928
+ accountId: string;
3929
+ accountName?: string | null;
3930
+ instanceID: string;
3931
+ encompassEnvironment: "Production" | "UAT";
3932
+ signingMethod: "ConsumerConnect" | "POSF";
3933
+ consumerConnectWidgetHost?: string | null;
3934
+ defaultLoanOfficerUserName?: string | null;
3935
+ loanTemplate?: string | null;
3936
+ loanAssignmentRole?: string | null;
3937
+ clearStateIfUnlicensed: boolean;
3938
+ subscriptionId?: string | null;
3939
+ environment?: string | null;
3940
+ hasSigningKey: boolean;
3941
+ health?: LosCredentialHealth | null;
3942
+ webhooks?: LosWebhookInventory | null;
3943
+ }
3944
+ export interface LosIntegrationCredentials {
3945
+ /** @format uuid */
3946
+ id: string;
3947
+ /** @format uuid */
3948
+ accountID: string;
3949
+ instanceID: string;
3950
+ encompassEnvironment: "Production" | "UAT";
3951
+ signingMethod: "ConsumerConnect" | "POSF";
3952
+ consumerConnectWidgetHost?: string | null;
3953
+ defaultLoanOfficerUserName?: string | null;
3954
+ loanTemplate?: string | null;
3955
+ loanAssignmentRole?: string | null;
3956
+ clearStateIfUnlicensed: boolean;
3957
+ subscriptionId?: string | null;
3958
+ environment?: string | null;
3959
+ clientID?: string | null;
3960
+ clientSecret?: string | null;
3961
+ signingKeyId?: string | null;
3962
+ signingKey?: string | null;
3963
+ secretsDecrypted: boolean;
3964
+ }
3965
+ export interface LosIntegrationPaginated {
3966
+ rows: LosIntegration[];
3967
+ pagination: Pagination;
3968
+ /** @format int64 */
3969
+ count: number;
3970
+ }
3971
+ export interface LosIntegrationsBatchRequest {
3972
+ accountIds: string[];
3973
+ }
3974
+ export interface LosIntegrationsSearchCriteria {
3975
+ searchText?: string | null;
3976
+ }
3977
+ export interface LosIntegrationsSummary {
3978
+ /** @format int32 */
3979
+ totalIntegrations: number;
3980
+ /** @format int32 */
3981
+ healthyCount: number;
3982
+ /** @format int32 */
3983
+ failingCount: number;
3984
+ /** @format int32 */
3985
+ unknownCount: number;
3986
+ /** @format int32 */
3987
+ accountsMissingExpectedWebhook: number;
3988
+ /** @format int32 */
3989
+ webhookUnknownCount: number;
3990
+ }
3801
3991
  export interface LosLoanCreationRequest {
3802
3992
  loanOfficerUserName?: string | null;
3803
3993
  loanTemplate?: string | null;
@@ -3820,7 +4010,7 @@ export interface LosOperationTracking {
3820
4010
  operationType: string;
3821
4011
  correlationKey: string;
3822
4012
  lastTriggerSource?: string | null;
3823
- status: LosOperationTrackingStatusEnum;
4013
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3824
4014
  /** @format date-time */
3825
4015
  createdAt: string;
3826
4016
  /** @format date-time */
@@ -3906,7 +4096,7 @@ export interface LosSyncStep {
3906
4096
  /** @format int32 */
3907
4097
  order: number;
3908
4098
  name: string;
3909
- severity: LosSyncStepSeverityEnum;
4099
+ severity: "Success" | "Info" | "Warning" | "Error";
3910
4100
  message: string;
3911
4101
  /** @format date-time */
3912
4102
  atUtc: string;
@@ -3919,8 +4109,29 @@ export interface LosWebhook {
3919
4109
  events: string[];
3920
4110
  enableSubscription: boolean;
3921
4111
  }
4112
+ export interface LosWebhookEntry {
4113
+ path: string;
4114
+ endpoint: string;
4115
+ resource: string;
4116
+ events: string[];
4117
+ /** @format uuid */
4118
+ subscriptionId?: string | null;
4119
+ enableSubscription?: boolean | null;
4120
+ status: "Registered" | "Disabled" | "Missing" | "Extra";
4121
+ }
4122
+ export interface LosWebhookInventory {
4123
+ /** @format uuid */
4124
+ accountId: string;
4125
+ overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
4126
+ entries: LosWebhookEntry[];
4127
+ /** @format int32 */
4128
+ missingCount: number;
4129
+ /** @format date-time */
4130
+ checkedAtUtc: string;
4131
+ message: string;
4132
+ }
3922
4133
  export interface ManualDocumentClassificationRequest {
3923
- documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4134
+ documentType: "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
3924
4135
  }
3925
4136
  export interface MdmUser {
3926
4137
  user_email?: string | null;
@@ -4003,7 +4214,7 @@ export interface ModuleParameterValue {
4003
4214
  parameterID: string;
4004
4215
  parameterName: string;
4005
4216
  parameterType: string;
4006
- value?: any | null;
4217
+ value?: any;
4007
4218
  isInherited: boolean;
4008
4219
  }
4009
4220
  export interface MonthlyPaymentCalculator {
@@ -4176,7 +4387,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4176
4387
  }
4177
4388
  export interface Operation {
4178
4389
  op?: string;
4179
- value?: object | null;
4390
+ value?: string | number | boolean | null | object;
4180
4391
  path?: string;
4181
4392
  }
4182
4393
  export interface OverridePasswordRequest {
@@ -4510,7 +4721,7 @@ export interface SiteConfiguration {
4510
4721
  deletedAt?: string | null;
4511
4722
  /** @format uuid */
4512
4723
  id: string;
4513
- type: SiteConfigurationTypeEnum;
4724
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4514
4725
  /** @format uuid */
4515
4726
  entityID: string;
4516
4727
  /** @format int32 */
@@ -4704,7 +4915,7 @@ export interface SiteConfigurationByUrl {
4704
4915
  deletedAt?: string | null;
4705
4916
  /** @format uuid */
4706
4917
  id: string;
4707
- type: SiteConfigurationByUrlTypeEnum;
4918
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4708
4919
  /** @format uuid */
4709
4920
  entityID: string;
4710
4921
  /** @format int32 */
@@ -4915,7 +5126,7 @@ export interface SiteConfigurationForm {
4915
5126
  export interface SiteConfigurationReduced {
4916
5127
  /** @format uuid */
4917
5128
  id: string;
4918
- type: SiteConfigurationReducedTypeEnum;
5129
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4919
5130
  url?: string | null;
4920
5131
  name: string;
4921
5132
  /** @format int64 */
@@ -4932,7 +5143,7 @@ export interface SiteConfigurationRequest {
4932
5143
  entityID: string;
4933
5144
  /** @format int32 */
4934
5145
  entityType: number;
4935
- type: SiteConfigurationRequestTypeEnum;
5146
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4936
5147
  url: string;
4937
5148
  name: string;
4938
5149
  introduction?: string | null;
@@ -5108,7 +5319,7 @@ export interface SiteConfigurationSearchCriteria {
5108
5319
  export interface SiteConfigurationSummary {
5109
5320
  /** @format uuid */
5110
5321
  id: string;
5111
- type: SiteConfigurationSummaryTypeEnum;
5322
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5112
5323
  url?: string | null;
5113
5324
  name: string;
5114
5325
  /** @format int64 */
@@ -5144,10 +5355,9 @@ export interface SiteTile {
5144
5355
  title: string;
5145
5356
  description: string;
5146
5357
  linkUrl: string;
5147
- linkTarget: SiteTileLinkTargetEnum;
5358
+ linkTarget: "Self" | "Blank";
5148
5359
  siteTypes: SiteConfigurationType[];
5149
- locations: SiteTileLocation[];
5150
- audience: UserRole[];
5360
+ locationAudiences: SiteTileLocationAudience[];
5151
5361
  /** @format int32 */
5152
5362
  weight: number;
5153
5363
  excludedSiteConfigurationIDs: string[];
@@ -5156,6 +5366,14 @@ export interface SiteTile {
5156
5366
  /** @format date-time */
5157
5367
  updatedAt?: string | null;
5158
5368
  }
5369
+ export interface SiteTileLocationAudience {
5370
+ location: "HomePage" | "Dashboard";
5371
+ audience: UserRole[];
5372
+ }
5373
+ export interface SiteTileLocationAudienceRequest {
5374
+ location: "HomePage" | "Dashboard";
5375
+ audience: UserRole[];
5376
+ }
5159
5377
  export interface SiteTilePaginated {
5160
5378
  rows: SiteTile[];
5161
5379
  pagination: Pagination;
@@ -5169,10 +5387,9 @@ export interface SiteTileRequest {
5169
5387
  title: string;
5170
5388
  description: string;
5171
5389
  linkUrl: string;
5172
- linkTarget: SiteTileRequestLinkTargetEnum;
5390
+ linkTarget: "Self" | "Blank";
5173
5391
  siteTypes: SiteConfigurationType[];
5174
- locations: SiteTileLocation[];
5175
- audience: UserRole[];
5392
+ locationAudiences: SiteTileLocationAudienceRequest[];
5176
5393
  /** @format int32 */
5177
5394
  weight: number;
5178
5395
  excludedSiteConfigurationIDs: string[];
@@ -5191,7 +5408,7 @@ export interface SiteTileView {
5191
5408
  title: string;
5192
5409
  description: string;
5193
5410
  linkUrl: string;
5194
- linkTarget: SiteTileViewLinkTargetEnum;
5411
+ linkTarget: "Self" | "Blank";
5195
5412
  /** @format int32 */
5196
5413
  weight: number;
5197
5414
  }
@@ -5422,7 +5639,7 @@ export interface UnregisteredBorrower {
5422
5639
  lastName?: string | null;
5423
5640
  fullName?: string | null;
5424
5641
  email?: string | null;
5425
- role: UnregisteredBorrowerRoleEnum;
5642
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5426
5643
  }
5427
5644
  export interface UpdateAccountRequest {
5428
5645
  name: string;
@@ -5446,7 +5663,7 @@ export interface UpdateAiCanonicalFieldRequest {
5446
5663
  }
5447
5664
  export interface UpdateAiGuardrailRequest {
5448
5665
  name: string;
5449
- category: UpdateAiGuardrailRequestCategoryEnum;
5666
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5450
5667
  description?: string | null;
5451
5668
  keywords: string[];
5452
5669
  responseTemplate: string;
@@ -5456,6 +5673,7 @@ export interface UpdateAiPromptRequest {
5456
5673
  description: string;
5457
5674
  documentTypes: string[];
5458
5675
  applicableUrlSourceIds: string[];
5676
+ knowledgeBaseFolderIds: string[];
5459
5677
  allowedRoles: string[];
5460
5678
  systemPrompt: string;
5461
5679
  /** @format int32 */
@@ -5479,8 +5697,18 @@ export interface UpdateAiUrlSourceRequest {
5479
5697
  name: string;
5480
5698
  url: string;
5481
5699
  description?: string | null;
5482
- category: UpdateAiUrlSourceRequestCategoryEnum;
5483
- scope: UpdateAiUrlSourceRequestScopeEnum;
5700
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5701
+ scope: "FullDomain" | "SpecificPath";
5702
+ }
5703
+ export interface UpdateCompanyDocumentFolderRequest {
5704
+ name: string;
5705
+ description?: string | null;
5706
+ }
5707
+ export interface UpdateCompanyDocumentRequest {
5708
+ name?: string | null;
5709
+ /** @format uuid */
5710
+ folderID?: string | null;
5711
+ content?: string | null;
5484
5712
  }
5485
5713
  export interface UpdateCustomFieldDefinitionRequest {
5486
5714
  isRequired: boolean;
@@ -5504,7 +5732,10 @@ export interface UpdateDocumentTemplateRequest {
5504
5732
  htmlBody: string;
5505
5733
  name: string;
5506
5734
  description?: string | null;
5735
+ /** @deprecated */
5507
5736
  destinationBucket?: string | null;
5737
+ /** @format uuid */
5738
+ loanDocumentFolderID?: string | null;
5508
5739
  status: string;
5509
5740
  }
5510
5741
  export interface UpdateListingFileRequest {
@@ -5753,6 +5984,10 @@ export interface UserBase {
5753
5984
  lastName: string;
5754
5985
  email: string;
5755
5986
  }
5987
+ export interface UserDeactivated {
5988
+ accountDeactivated: boolean;
5989
+ email: string;
5990
+ }
5756
5991
  export interface UserDevice {
5757
5992
  /** @format uuid */
5758
5993
  id: string;
@@ -5767,7 +6002,7 @@ export interface UserDevice {
5767
6002
  export interface UserDraft {
5768
6003
  /** @format uuid */
5769
6004
  draftID: string;
5770
- role: UserDraftRoleEnum;
6005
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5771
6006
  user: User;
5772
6007
  }
5773
6008
  export interface UserDraftPaginated {
@@ -5791,12 +6026,12 @@ export interface UserGroupAccessScope {
5791
6026
  id: string;
5792
6027
  /** @format uuid */
5793
6028
  groupId: string;
5794
- scopeType: UserGroupAccessScopeScopeTypeEnum;
6029
+ scopeType: "User" | "Branch";
5795
6030
  /** @format uuid */
5796
6031
  userId?: string | null;
5797
6032
  /** @format uuid */
5798
6033
  branchId?: string | null;
5799
- user?: UserSummary | null;
6034
+ user?: UserGroupMemberUserSummary | null;
5800
6035
  branch?: BranchSummary | null;
5801
6036
  }
5802
6037
  export interface UserGroupMember {
@@ -5807,7 +6042,14 @@ export interface UserGroupMember {
5807
6042
  /** @format uuid */
5808
6043
  userId: string;
5809
6044
  loanRole: string;
5810
- user: UserSummary;
6045
+ user: UserGroupMemberUserSummary;
6046
+ }
6047
+ export interface UserGroupMemberUserSummary {
6048
+ /** @format uuid */
6049
+ id: string;
6050
+ name?: string | null;
6051
+ email?: string | null;
6052
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5811
6053
  }
5812
6054
  export interface UserGroupPaginated {
5813
6055
  rows: UserGroup[];
@@ -5824,7 +6066,7 @@ export interface UserLoan {
5824
6066
  deletedAt?: string | null;
5825
6067
  loanID: string;
5826
6068
  user: User;
5827
- role: UserLoanRoleEnum;
6069
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5828
6070
  /** @format int32 */
5829
6071
  borrowerPair?: number | null;
5830
6072
  /** @format int32 */
@@ -5836,11 +6078,11 @@ export interface UserLoanConsent {
5836
6078
  id: string;
5837
6079
  /** @format uuid */
5838
6080
  userLoanID: string;
5839
- type: UserLoanConsentTypeEnum;
6081
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5840
6082
  providedConsent: boolean;
5841
6083
  source?: ConsentSource | null;
5842
6084
  ipAddress?: string | null;
5843
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6085
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5844
6086
  /** @format date-time */
5845
6087
  createdAt: string;
5846
6088
  /** @format date-time */
@@ -5916,6 +6158,21 @@ export interface UserPublic {
5916
6158
  phone?: string | null;
5917
6159
  title?: string | null;
5918
6160
  }
6161
+ export interface UserReactivationCompleteRequest {
6162
+ /** @format uuid */
6163
+ token: string;
6164
+ /** @minLength 8 */
6165
+ newPassword: string;
6166
+ }
6167
+ export interface UserReactivationRequest {
6168
+ /**
6169
+ * @format email
6170
+ * @minLength 1
6171
+ */
6172
+ email: string;
6173
+ /** @format uuid */
6174
+ siteConfigurationId: string;
6175
+ }
5919
6176
  export interface UserRelation {
5920
6177
  /** @format uuid */
5921
6178
  userId1: string;
@@ -5968,9 +6225,8 @@ export interface UserSearchCriteria {
5968
6225
  export interface UserSummary {
5969
6226
  /** @format uuid */
5970
6227
  id: string;
5971
- name?: string | null;
5972
- email?: string | null;
5973
- role: UserSummaryRoleEnum;
6228
+ firstName: string;
6229
+ lastName: string;
5974
6230
  }
5975
6231
  export interface VerifyEmailRequest {
5976
6232
  token: string;
@@ -6000,92 +6256,6 @@ export interface Workflow {
6000
6256
  tileSubtitle: string;
6001
6257
  icon: string;
6002
6258
  }
6003
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6004
- export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
6005
- export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
6006
- export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
6007
- export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6008
- export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6009
- export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6010
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
6011
- export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6012
- export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6013
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6014
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6015
- export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6016
- export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6017
- export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6018
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6019
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6020
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6021
- /** @deprecated */
6022
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6023
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6024
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6025
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6026
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6027
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6028
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6029
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6030
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6031
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6032
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6033
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
6034
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6035
- export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6036
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6037
- export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6038
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6039
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
6040
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6041
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6042
- export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6043
- export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
6044
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6045
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6046
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6047
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6048
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6049
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6050
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6051
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6052
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6053
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6054
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6055
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6056
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6057
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6058
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6059
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6060
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6061
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6062
- export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
6063
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6064
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6065
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6066
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6067
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6068
- export type SiteTileLinkTargetEnum = "Self" | "Blank";
6069
- export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6070
- export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6071
- export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6072
- export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6073
- export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6074
- export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6075
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6076
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6077
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6078
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6079
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6080
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6081
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6082
- /** @default "Realtor" */
6083
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6084
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6085
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6086
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6087
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6088
- export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6089
6259
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6090
6260
  export type QueryParamsType = Record<string | number, any>;
6091
6261
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6108,7 +6278,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6108
6278
  secure?: boolean;
6109
6279
  format?: ResponseType;
6110
6280
  }
6111
- export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6281
+ export declare enum ContentType {
6282
+ JsonPatch = "application/json-patch+json",
6283
+ Json = "application/json",
6284
+ JsonApi = "application/vnd.api+json",
6285
+ FormData = "multipart/form-data",
6286
+ UrlEncoded = "application/x-www-form-urlencoded",
6287
+ Text = "text/plain"
6288
+ }
6112
6289
  export declare class HttpClient<SecurityDataType = unknown> {
6113
6290
  instance: AxiosInstance;
6114
6291
  private securityData;
@@ -6124,7 +6301,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6124
6301
  }
6125
6302
  /**
6126
6303
  * @title The Big POS API
6127
- * @version v2.48.0
6304
+ * @version v2.49.3
6128
6305
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6129
6306
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6130
6307
  */
@@ -6198,29 +6375,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6198
6375
  * @response `422` `UnprocessableEntity` Unprocessable Content
6199
6376
  */
6200
6377
  updateSiteConfigurationForAccount: (data: SiteConfiguration, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
6201
- /**
6202
- * No description
6203
- *
6204
- * @tags AccountReactivation
6205
- * @name RequestAccountReactivation
6206
- * @summary Request account reactivation
6207
- * @request POST:/api/account/reactivation/request
6208
- * @secure
6209
- * @response `204` `void` No Content
6210
- */
6211
- requestAccountReactivation: (data: AccountReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6212
- /**
6213
- * No description
6214
- *
6215
- * @tags AccountReactivation
6216
- * @name CompleteAccountReactivation
6217
- * @summary Complete account reactivation with new password
6218
- * @request POST:/api/account/reactivation/complete
6219
- * @secure
6220
- * @response `204` `void` No Content
6221
- * @response `400` `ProblemDetails` Bad Request
6222
- */
6223
- completeAccountReactivation: (data: AccountReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6224
6378
  /**
6225
6379
  * No description
6226
6380
  *
@@ -7213,10 +7367,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7213
7367
  * @summary Get Token
7214
7368
  * @request POST:/api/token
7215
7369
  * @secure
7216
- * @response `200` `AccountDeactivated` OK
7370
+ * @response `200` `UserDeactivated` OK
7217
7371
  * @response `422` `UnprocessableEntity` Unprocessable Content
7218
7372
  */
7219
- getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
7373
+ getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
7220
7374
  /**
7221
7375
  * No description
7222
7376
  *
@@ -7225,10 +7379,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7225
7379
  * @summary Get Token From Challenge Code
7226
7380
  * @request POST:/api/token/code
7227
7381
  * @secure
7228
- * @response `200` `AccountDeactivated` OK
7382
+ * @response `200` `UserDeactivated` OK
7229
7383
  * @response `422` `UnprocessableEntity` Unprocessable Content
7230
7384
  */
7231
- getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
7385
+ getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
7232
7386
  /**
7233
7387
  * No description
7234
7388
  *
@@ -7489,6 +7643,201 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7489
7643
  * @response `200` `ClosedLoansReport` OK
7490
7644
  */
7491
7645
  getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
7646
+ /**
7647
+ * No description
7648
+ *
7649
+ * @tags CompanyDocumentFolders
7650
+ * @name GetCompanyDocumentFolders
7651
+ * @summary Get all company document folders
7652
+ * @request GET:/api/company-document-folders
7653
+ * @secure
7654
+ * @response `200` `(CompanyDocumentFolder)[]` OK
7655
+ */
7656
+ getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
7657
+ /**
7658
+ * No description
7659
+ *
7660
+ * @tags CompanyDocumentFolders
7661
+ * @name CreateCompanyDocumentFolder
7662
+ * @summary Create company document folder
7663
+ * @request POST:/api/company-document-folders
7664
+ * @secure
7665
+ * @response `201` `CompanyDocumentFolder` Created
7666
+ * @response `400` `ProblemDetails` Bad Request
7667
+ * @response `409` `ProblemDetails` Conflict
7668
+ */
7669
+ createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7670
+ /**
7671
+ * No description
7672
+ *
7673
+ * @tags CompanyDocumentFolders
7674
+ * @name GetCompanyDocumentFolder
7675
+ * @summary Get company document folder by ID
7676
+ * @request GET:/api/company-document-folders/{id}
7677
+ * @secure
7678
+ * @response `200` `CompanyDocumentFolder` OK
7679
+ * @response `404` `ProblemDetails` Not Found
7680
+ */
7681
+ getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7682
+ /**
7683
+ * No description
7684
+ *
7685
+ * @tags CompanyDocumentFolders
7686
+ * @name UpdateCompanyDocumentFolder
7687
+ * @summary Update company document folder
7688
+ * @request PUT:/api/company-document-folders/{id}
7689
+ * @secure
7690
+ * @response `200` `CompanyDocumentFolder` OK
7691
+ * @response `400` `ProblemDetails` Bad Request
7692
+ * @response `404` `ProblemDetails` Not Found
7693
+ * @response `409` `ProblemDetails` Conflict
7694
+ */
7695
+ updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
7696
+ /**
7697
+ * No description
7698
+ *
7699
+ * @tags CompanyDocumentFolders
7700
+ * @name DeleteCompanyDocumentFolder
7701
+ * @summary Delete company document folder
7702
+ * @request DELETE:/api/company-document-folders/{id}
7703
+ * @secure
7704
+ * @response `204` `void` No Content
7705
+ * @response `400` `ProblemDetails` Bad Request
7706
+ * @response `404` `ProblemDetails` Not Found
7707
+ * @response `409` `ProblemDetails` Conflict
7708
+ */
7709
+ deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7710
+ /**
7711
+ * No description
7712
+ *
7713
+ * @tags CompanyDocuments
7714
+ * @name SearchCompanyDocuments
7715
+ * @summary Search company documents
7716
+ * @request POST:/api/company-documents/search
7717
+ * @secure
7718
+ * @response `200` `CompanyDocumentPaginated` OK
7719
+ * @response `400` `ProblemDetails` Bad Request
7720
+ */
7721
+ searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
7722
+ /** @format int32 */
7723
+ pageSize?: number;
7724
+ /** @format int32 */
7725
+ pageNumber?: number;
7726
+ sortBy?: string;
7727
+ sortDirection?: string;
7728
+ }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
7729
+ /**
7730
+ * No description
7731
+ *
7732
+ * @tags CompanyDocuments
7733
+ * @name GetCompanyDocument
7734
+ * @summary Get company document by ID
7735
+ * @request GET:/api/company-documents/{id}
7736
+ * @secure
7737
+ * @response `200` `CompanyDocument` OK
7738
+ * @response `404` `ProblemDetails` Not Found
7739
+ */
7740
+ getCompanyDocument: (id: string, query?: {
7741
+ /** @default false */
7742
+ preview?: boolean;
7743
+ }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7744
+ /**
7745
+ * No description
7746
+ *
7747
+ * @tags CompanyDocuments
7748
+ * @name UpdateCompanyDocument
7749
+ * @summary Update company document
7750
+ * @request PUT:/api/company-documents/{id}
7751
+ * @secure
7752
+ * @response `200` `CompanyDocument` OK
7753
+ * @response `400` `ProblemDetails` Bad Request
7754
+ * @response `404` `ProblemDetails` Not Found
7755
+ * @response `409` `ProblemDetails` Conflict
7756
+ */
7757
+ updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7758
+ /**
7759
+ * No description
7760
+ *
7761
+ * @tags CompanyDocuments
7762
+ * @name DeleteCompanyDocument
7763
+ * @summary Delete company document
7764
+ * @request DELETE:/api/company-documents/{id}
7765
+ * @secure
7766
+ * @response `204` `void` No Content
7767
+ * @response `404` `ProblemDetails` Not Found
7768
+ */
7769
+ deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7770
+ /**
7771
+ * No description
7772
+ *
7773
+ * @tags CompanyDocuments
7774
+ * @name GetCompanyDocumentPreviews
7775
+ * @summary Get company document previews in batch
7776
+ * @request POST:/api/company-documents/previews
7777
+ * @secure
7778
+ * @response `200` `Record<string,string>` OK
7779
+ * @response `400` `ProblemDetails` Bad Request
7780
+ */
7781
+ getCompanyDocumentPreviews: (data: CompanyDocumentPreviewsRequest, params?: RequestParams) => Promise<AxiosResponse<Record<string, string>, any, {}>>;
7782
+ /**
7783
+ * No description
7784
+ *
7785
+ * @tags CompanyDocuments
7786
+ * @name DownloadCompanyDocument
7787
+ * @summary Download company document
7788
+ * @request GET:/api/company-documents/{id}/download
7789
+ * @secure
7790
+ * @response `200` `void` OK
7791
+ * @response `404` `ProblemDetails` Not Found
7792
+ */
7793
+ downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7794
+ /**
7795
+ * No description
7796
+ *
7797
+ * @tags CompanyDocuments
7798
+ * @name CreateCompanyDocument
7799
+ * @summary Upload company document
7800
+ * @request POST:/api/company-documents
7801
+ * @secure
7802
+ * @response `201` `CompanyDocument` Created
7803
+ * @response `400` `ProblemDetails` Bad Request
7804
+ * @response `404` `ProblemDetails` Not Found
7805
+ * @response `409` `ProblemDetails` Conflict
7806
+ */
7807
+ createCompanyDocument: (data: {
7808
+ /** @format binary */
7809
+ file?: File;
7810
+ /** @format uuid */
7811
+ folderID?: string;
7812
+ name?: string;
7813
+ }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7814
+ /**
7815
+ * No description
7816
+ *
7817
+ * @tags CompanyDocuments
7818
+ * @name CreateCompanyTextDocument
7819
+ * @summary Create free-form text company document
7820
+ * @request POST:/api/company-documents/text
7821
+ * @secure
7822
+ * @response `201` `CompanyDocument` Created
7823
+ * @response `400` `ProblemDetails` Bad Request
7824
+ * @response `404` `ProblemDetails` Not Found
7825
+ * @response `409` `ProblemDetails` Conflict
7826
+ */
7827
+ createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7828
+ /**
7829
+ * No description
7830
+ *
7831
+ * @tags CompanyDocuments
7832
+ * @name ReindexCompanyDocument
7833
+ * @summary Re-index a failed company document
7834
+ * @request POST:/api/company-documents/{id}/reindex
7835
+ * @secure
7836
+ * @response `200` `CompanyDocument` OK
7837
+ * @response `400` `ProblemDetails` Bad Request
7838
+ * @response `404` `ProblemDetails` Not Found
7839
+ */
7840
+ reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7492
7841
  /**
7493
7842
  * No description
7494
7843
  *
@@ -7678,7 +8027,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7678
8027
  * @response `200` `(CustomFieldDefinition)[]` OK
7679
8028
  */
7680
8029
  getCustomFieldDefinitions: (query?: {
7681
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8030
+ entityType?: "Loan";
7682
8031
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7683
8032
  /**
7684
8033
  * No description
@@ -7828,6 +8177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7828
8177
  * @name GetDocumentBuckets
7829
8178
  * @summary Get All
7830
8179
  * @request GET:/api/document-buckets
8180
+ * @deprecated
7831
8181
  * @secure
7832
8182
  * @response `200` `(string)[]` OK
7833
8183
  */
@@ -8144,6 +8494,155 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8144
8494
  * @response `500` `EncompassError` Internal Server Error
8145
8495
  */
8146
8496
  createEncompassSession: (data: CreateSessionRequest, params?: RequestParams) => Promise<AxiosResponse<CreateSession, any, {}>>;
8497
+ /**
8498
+ * No description
8499
+ *
8500
+ * @tags EncompassIntegrations
8501
+ * @name SearchEncompassIntegrations
8502
+ * @summary Search registered Encompass integrations across accounts (SuperAdmin)
8503
+ * @request POST:/api/monitoring/encompass-integrations/search
8504
+ * @secure
8505
+ * @response `200` `LosIntegrationPaginated` OK
8506
+ * @response `400` `ProblemDetails` Bad Request
8507
+ * @response `401` `ProblemDetails` Unauthorized
8508
+ * @response `403` `ProblemDetails` Forbidden
8509
+ */
8510
+ searchEncompassIntegrations: (data: LosIntegrationsSearchCriteria, query?: {
8511
+ /** @format int32 */
8512
+ pageSize?: number;
8513
+ /** @format int32 */
8514
+ pageNumber?: number;
8515
+ sortBy?: string;
8516
+ sortDirection?: string;
8517
+ /** @format uuid */
8518
+ accountId?: string;
8519
+ }, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationPaginated, any, {}>>;
8520
+ /**
8521
+ * No description
8522
+ *
8523
+ * @tags EncompassIntegrations
8524
+ * @name GetEncompassIntegrationsSummary
8525
+ * @summary Summarize registered Encompass integration health across accounts (SuperAdmin)
8526
+ * @request POST:/api/monitoring/encompass-integrations/summary
8527
+ * @secure
8528
+ * @response `200` `LosIntegrationsSummary` OK
8529
+ * @response `401` `ProblemDetails` Unauthorized
8530
+ * @response `403` `ProblemDetails` Forbidden
8531
+ */
8532
+ getEncompassIntegrationsSummary: (data: LosIntegrationsSearchCriteria, query?: {
8533
+ /** @format uuid */
8534
+ accountId?: string;
8535
+ }, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationsSummary, any, {}>>;
8536
+ /**
8537
+ * No description
8538
+ *
8539
+ * @tags EncompassIntegrations
8540
+ * @name GetEncompassIntegrationsHealth
8541
+ * @summary Get Encompass login health for a set of accounts (SuperAdmin)
8542
+ * @request POST:/api/monitoring/encompass-integrations/health
8543
+ * @secure
8544
+ * @response `200` `(LosCredentialHealth)[]` OK
8545
+ * @response `400` `ProblemDetails` Bad Request
8546
+ * @response `401` `ProblemDetails` Unauthorized
8547
+ * @response `403` `ProblemDetails` Forbidden
8548
+ */
8549
+ getEncompassIntegrationsHealth: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth[], any, {}>>;
8550
+ /**
8551
+ * No description
8552
+ *
8553
+ * @tags EncompassIntegrations
8554
+ * @name RecheckEncompassIntegrationHealth
8555
+ * @summary Force a fresh Encompass login health check for one account (SuperAdmin)
8556
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/health/recheck
8557
+ * @secure
8558
+ * @response `200` `LosCredentialHealth` OK
8559
+ * @response `401` `ProblemDetails` Unauthorized
8560
+ * @response `403` `ProblemDetails` Forbidden
8561
+ */
8562
+ recheckEncompassIntegrationHealth: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth, any, {}>>;
8563
+ /**
8564
+ * No description
8565
+ *
8566
+ * @tags EncompassIntegrations
8567
+ * @name GetEncompassIntegrationsWebhooks
8568
+ * @summary Get registered-versus-expected Encompass webhooks for a set of accounts (SuperAdmin)
8569
+ * @request POST:/api/monitoring/encompass-integrations/webhooks
8570
+ * @secure
8571
+ * @response `200` `(LosWebhookInventory)[]` OK
8572
+ * @response `400` `ProblemDetails` Bad Request
8573
+ * @response `401` `ProblemDetails` Unauthorized
8574
+ * @response `403` `ProblemDetails` Forbidden
8575
+ */
8576
+ getEncompassIntegrationsWebhooks: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory[], any, {}>>;
8577
+ /**
8578
+ * No description
8579
+ *
8580
+ * @tags EncompassIntegrations
8581
+ * @name RecheckEncompassIntegrationWebhooks
8582
+ * @summary Force a fresh Encompass webhook inventory read for one account (SuperAdmin)
8583
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/recheck
8584
+ * @secure
8585
+ * @response `200` `LosWebhookInventory` OK
8586
+ * @response `401` `ProblemDetails` Unauthorized
8587
+ * @response `403` `ProblemDetails` Forbidden
8588
+ */
8589
+ recheckEncompassIntegrationWebhooks: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory, any, {}>>;
8590
+ /**
8591
+ * No description
8592
+ *
8593
+ * @tags EncompassIntegrations
8594
+ * @name GetEncompassIntegrationCredentials
8595
+ * @summary Get Encompass credentials including secrets for a specific account (SuperAdmin)
8596
+ * @request GET:/api/monitoring/encompass-integrations/{accountId}/credentials
8597
+ * @secure
8598
+ * @response `200` `LosIntegrationCredentials` OK
8599
+ * @response `401` `ProblemDetails` Unauthorized
8600
+ * @response `403` `ProblemDetails` Forbidden
8601
+ * @response `404` `ProblemDetails` Not Found
8602
+ */
8603
+ getEncompassIntegrationCredentials: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationCredentials, any, {}>>;
8604
+ /**
8605
+ * No description
8606
+ *
8607
+ * @tags EncompassIntegrations
8608
+ * @name UpdateEncompassIntegrationCredentials
8609
+ * @summary Update Encompass credentials for a specific account (SuperAdmin)
8610
+ * @request PUT:/api/monitoring/encompass-integrations/{accountId}/credentials
8611
+ * @secure
8612
+ * @response `200` `EncompassCredentialsDetail` OK
8613
+ * @response `401` `ProblemDetails` Unauthorized
8614
+ * @response `403` `ProblemDetails` Forbidden
8615
+ * @response `404` `ProblemDetails` Not Found
8616
+ */
8617
+ updateEncompassIntegrationCredentials: (accountId: string, data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any, {}>>;
8618
+ /**
8619
+ * No description
8620
+ *
8621
+ * @tags EncompassIntegrations
8622
+ * @name RegisterEncompassIntegrationWebhook
8623
+ * @summary Register an expected Encompass webhook for a specific account (SuperAdmin)
8624
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks
8625
+ * @secure
8626
+ * @response `201` `LosWebhook` Created
8627
+ * @response `400` `ProblemDetails` Bad Request
8628
+ * @response `401` `ProblemDetails` Unauthorized
8629
+ * @response `403` `ProblemDetails` Forbidden
8630
+ */
8631
+ registerEncompassIntegrationWebhook: (accountId: string, data: CreateWebhookRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhook, any, {}>>;
8632
+ /**
8633
+ * No description
8634
+ *
8635
+ * @tags EncompassIntegrations
8636
+ * @name DeleteEncompassIntegrationWebhook
8637
+ * @summary Delete an Encompass webhook for a specific account (SuperAdmin)
8638
+ * @request DELETE:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookId}
8639
+ * @secure
8640
+ * @response `204` `void` No Content
8641
+ * @response `401` `ProblemDetails` Unauthorized
8642
+ * @response `403` `ProblemDetails` Forbidden
8643
+ * @response `404` `ProblemDetails` Not Found
8644
+ */
8645
+ deleteEncompassIntegrationWebhook: (accountId: string, webhookId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
8147
8646
  /**
8148
8647
  * No description
8149
8648
  *
@@ -9006,45 +9505,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9006
9505
  * @name GetLoanDocumentBuckets
9007
9506
  * @summary Get All
9008
9507
  * @request GET:/api/loans/{loanId}/documents/buckets
9508
+ * @deprecated
9009
9509
  * @secure
9010
9510
  * @response `200` `(string)[]` OK
9011
9511
  */
9012
9512
  getLoanDocumentBuckets: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<string[], any, {}>>;
9013
- /**
9014
- * No description
9015
- *
9016
- * @tags LoanDocumentBuckets
9017
- * @name CreateLoanDocumentBuckets
9018
- * @summary Create
9019
- * @request POST:/api/loans/{loanId}/documents/buckets
9020
- * @secure
9021
- * @response `201` `(string)[]` Created
9022
- */
9023
- createLoanDocumentBuckets: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<string[], any, {}>>;
9024
9513
  /**
9025
9514
  * No description
9026
9515
  *
9027
9516
  * @tags LoanDocumentFolders
9028
- * @name GetAllLoanDocumentFolders
9029
- * @summary Get all loan document folders for the current account
9030
- * @request GET:/api/loan-document-folders
9517
+ * @name SearchLoanDocumentFolders
9518
+ * @summary Search loan document folders for the current account
9519
+ * @request POST:/api/loan-document-folders/search
9031
9520
  * @secure
9032
- * @response `200` `(LoanDocumentFolder)[]` OK
9521
+ * @response `200` `LoanDocumentFolderPaginated` OK
9033
9522
  */
9034
- getAllLoanDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder[], any, {}>>;
9035
- /**
9036
- * No description
9037
- *
9038
- * @tags LoanDocumentFolders
9039
- * @name CreateLoanDocumentFolder
9040
- * @summary Create a loan document folder
9041
- * @request POST:/api/loan-document-folders
9042
- * @secure
9043
- * @response `201` `LoanDocumentFolder` Created
9044
- * @response `409` `ProblemDetails` Conflict
9045
- * @response `422` `ProblemDetails` Unprocessable Content
9046
- */
9047
- createLoanDocumentFolder: (data: CreateLoanDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any, {}>>;
9523
+ searchLoanDocumentFolders: (data: LoanDocumentFolderSearchCriteria, query?: {
9524
+ /** @format int32 */
9525
+ pageSize?: number;
9526
+ /** @format int32 */
9527
+ pageNumber?: number;
9528
+ sortBy?: string;
9529
+ sortDirection?: string;
9530
+ }, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderPaginated, any, {}>>;
9048
9531
  /**
9049
9532
  * No description
9050
9533
  *
@@ -9086,6 +9569,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9086
9569
  * @response `409` `ProblemDetails` Conflict
9087
9570
  */
9088
9571
  deleteLoanDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
9572
+ /**
9573
+ * No description
9574
+ *
9575
+ * @tags LoanDocumentFolders
9576
+ * @name CreateLoanDocumentFolder
9577
+ * @summary Create a loan document folder
9578
+ * @request POST:/api/loan-document-folders
9579
+ * @secure
9580
+ * @response `201` `LoanDocumentFolder` Created
9581
+ * @response `409` `ProblemDetails` Conflict
9582
+ * @response `422` `ProblemDetails` Unprocessable Content
9583
+ */
9584
+ createLoanDocumentFolder: (data: CreateLoanDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any, {}>>;
9089
9585
  /**
9090
9586
  * No description
9091
9587
  *
@@ -9123,6 +9619,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9123
9619
  * @response `404` `ProblemDetails` Not Found
9124
9620
  */
9125
9621
  getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
9622
+ /**
9623
+ * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
9624
+ *
9625
+ * @tags LoanDocumentFoldersForSingleLoan
9626
+ * @name ListLoanDocumentFolders
9627
+ * @summary Get the loan's document folders
9628
+ * @request GET:/api/loans/{loanId}/document-folders
9629
+ * @secure
9630
+ * @response `200` `(LoanDocumentFolderWithCount)[]` OK
9631
+ */
9632
+ listLoanDocumentFolders: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderWithCount[], any, {}>>;
9633
+ /**
9634
+ * @description Deprecated — use GET documents/folders. Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get a simplified response with folder names and counts for mobile (Files array will be empty).
9635
+ *
9636
+ * @tags LoanDocumentFoldersForSingleLoan
9637
+ * @name GetLoanDocumentFolders
9638
+ * @summary [Deprecated] Get document folder hierarchy
9639
+ * @request POST:/api/loans/{loanId}/documents/folders
9640
+ * @deprecated
9641
+ * @secure
9642
+ * @response `200` `(DocumentFolder)[]` OK
9643
+ */
9644
+ getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
9645
+ /** @default false */
9646
+ folderNamesOnly?: boolean;
9647
+ }, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
9126
9648
  /**
9127
9649
  * No description
9128
9650
  *
@@ -9168,20 +9690,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9168
9690
  sortBy?: string;
9169
9691
  sortDirection?: string;
9170
9692
  }, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentSearchPaginated, any, {}>>;
9171
- /**
9172
- * @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
9173
- *
9174
- * @tags LoanDocuments
9175
- * @name GetLoanDocumentFolders
9176
- * @summary Get document folder hierarchy
9177
- * @request POST:/api/loans/{loanId}/documents/folders
9178
- * @secure
9179
- * @response `200` `(DocumentFolder)[]` OK
9180
- */
9181
- getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
9182
- /** @default false */
9183
- folderNamesOnly?: boolean;
9184
- }, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
9185
9693
  /**
9186
9694
  * No description
9187
9695
  *
@@ -9190,10 +9698,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9190
9698
  * @summary Download By ID
9191
9699
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9192
9700
  * @secure
9193
- * @response `200` `Blob` OK
9701
+ * @response `200` `string` OK
9194
9702
  * @response `404` `ProblemDetails` Not Found
9195
9703
  */
9196
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9704
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
9197
9705
  /**
9198
9706
  * No description
9199
9707
  *
@@ -9210,6 +9718,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9210
9718
  name?: string;
9211
9719
  /** @format binary */
9212
9720
  file?: File;
9721
+ /** @deprecated */
9213
9722
  bucket?: string;
9214
9723
  /** @format uuid */
9215
9724
  folderID?: string;
@@ -9891,6 +10400,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9891
10400
  name?: string;
9892
10401
  /** @format binary */
9893
10402
  file?: File;
10403
+ /** @deprecated */
9894
10404
  bucket?: string;
9895
10405
  /** @format uuid */
9896
10406
  folderID?: string;
@@ -10456,7 +10966,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10456
10966
  getPartners: (query?: {
10457
10967
  showAll?: boolean;
10458
10968
  /** @default "Realtor" */
10459
- role?: GetPartnersParamsRoleEnum;
10969
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
10460
10970
  /** @format int32 */
10461
10971
  pageSize?: number;
10462
10972
  /** @format int32 */
@@ -10634,7 +11144,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10634
11144
  * @response `200` `File` OK
10635
11145
  * @response `404` `ProblemDetails` Not Found
10636
11146
  */
10637
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11147
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10638
11148
  /**
10639
11149
  * No description
10640
11150
  *
@@ -10645,7 +11155,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10645
11155
  * @secure
10646
11156
  * @response `200` `File` OK
10647
11157
  */
10648
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11158
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10649
11159
  /**
10650
11160
  * No description
10651
11161
  *
@@ -10738,7 +11248,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10738
11248
  getSiteTilesBySiteConfiguration: (query?: {
10739
11249
  /** @format uuid */
10740
11250
  siteConfigurationId?: string;
10741
- location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
11251
+ location?: "HomePage" | "Dashboard";
10742
11252
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
10743
11253
  /**
10744
11254
  * No description
@@ -11164,6 +11674,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11164
11674
  * @request POST:/api/loans/drafts/{draftId}/users/{userId}
11165
11675
  * @secure
11166
11676
  * @response `200` `UserDraft` OK
11677
+ * @response `404` `ProblemDetails` Not Found
11678
+ * @response `409` `ProblemDetails` Conflict
11167
11679
  */
11168
11680
  addDraftUsers: (draftId: string, userId: string, data: CreateUserDraft, params?: RequestParams) => Promise<AxiosResponse<UserDraft, any, {}>>;
11169
11681
  /**
@@ -11434,6 +11946,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11434
11946
  * @response `422` `UnprocessableEntity` Unprocessable Content
11435
11947
  */
11436
11948
  verifyUserInvite: (token: string, params?: RequestParams) => Promise<AxiosResponse<Invite, any, {}>>;
11949
+ /**
11950
+ * No description
11951
+ *
11952
+ * @tags UserReactivation
11953
+ * @name RequestUserReactivation
11954
+ * @summary Request user reactivation
11955
+ * @request POST:/api/users/reactivation/request
11956
+ * @secure
11957
+ * @response `204` `void` No Content
11958
+ */
11959
+ requestUserReactivation: (data: UserReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11960
+ /**
11961
+ * No description
11962
+ *
11963
+ * @tags UserReactivation
11964
+ * @name CompleteUserReactivation
11965
+ * @summary Complete user reactivation with new password
11966
+ * @request POST:/api/users/reactivation/complete
11967
+ * @secure
11968
+ * @response `204` `void` No Content
11969
+ * @response `400` `ProblemDetails` Bad Request
11970
+ */
11971
+ completeUserReactivation: (data: UserReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11437
11972
  /**
11438
11973
  * No description
11439
11974
  *
@@ -11505,6 +12040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11505
12040
  * @request POST:/api/users
11506
12041
  * @secure
11507
12042
  * @response `200` `DetailedUser` OK
12043
+ * @response `409` `ProblemDetails` Conflict
11508
12044
  * @response `422` `UnprocessableEntity` Unprocessable Content
11509
12045
  */
11510
12046
  createUser: (data: CreateUserRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
@@ -11681,6 +12217,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11681
12217
  * @request PUT:/api/users/me
11682
12218
  * @secure
11683
12219
  * @response `200` `DetailedUser` OK
12220
+ * @response `403` `ProblemDetails` Forbidden
12221
+ * @response `409` `ProblemDetails` Conflict
11684
12222
  */
11685
12223
  replaceMe: (data: UpdateMeRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
11686
12224
  /**