@matech/thebigpos-sdk 2.45.1-rc8 → 2.46.4-rc1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/dist/index.d.ts +358 -480
- package/dist/index.js +352 -351
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1244 -1597
- package/tsconfig.json +27 -27
- package/.claude/settings.local.json +0 -52
package/dist/index.d.ts
CHANGED
|
@@ -27,8 +27,8 @@ export type LoanOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProper
|
|
|
27
27
|
export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "VII";
|
|
28
28
|
export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
|
|
29
29
|
export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
|
|
30
|
-
export type LoanMaritalStatus = "Married" | "Separated" | "
|
|
31
|
-
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
30
|
+
export type LoanMaritalStatus = "Married" | "Separated" | "Single";
|
|
31
|
+
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
32
32
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
33
33
|
export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
|
|
34
34
|
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
|
|
@@ -38,7 +38,7 @@ export type LoanHousingType = "NoExpense" | "Own" | "Rent";
|
|
|
38
38
|
export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
|
|
39
39
|
export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
|
|
40
40
|
export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
|
|
41
|
-
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
|
|
41
|
+
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
|
|
42
42
|
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
|
|
43
43
|
export type LoanGenderType = "Male" | "Female";
|
|
44
44
|
export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
|
|
@@ -73,15 +73,13 @@ export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDele
|
|
|
73
73
|
export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
|
|
74
74
|
export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
75
75
|
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
76
|
-
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";
|
|
76
|
+
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";
|
|
77
77
|
export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
78
78
|
export type AiOutputType = "Text" | "Document";
|
|
79
79
|
export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
80
80
|
export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
81
81
|
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
82
|
-
export type
|
|
83
|
-
export type AiConfigChangeAction = "Created" | "Updated" | "Deleted" | "Toggled";
|
|
84
|
-
export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
|
|
82
|
+
export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied";
|
|
85
83
|
export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
|
|
86
84
|
export interface ASOSettings {
|
|
87
85
|
enabled: boolean;
|
|
@@ -132,7 +130,7 @@ export interface AccountBilling {
|
|
|
132
130
|
contractedRate: number;
|
|
133
131
|
}
|
|
134
132
|
export interface AccountBillingRequest {
|
|
135
|
-
billingType:
|
|
133
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
136
134
|
/** @format double */
|
|
137
135
|
contractedRate: number;
|
|
138
136
|
}
|
|
@@ -161,13 +159,11 @@ export interface AccountSettings {
|
|
|
161
159
|
smsNumber?: string | null;
|
|
162
160
|
ssoHostOverride?: string | null;
|
|
163
161
|
isEarlyAdopter: boolean;
|
|
164
|
-
isAIEnabled: boolean;
|
|
165
162
|
}
|
|
166
163
|
export interface AccountSettingsRequest {
|
|
167
164
|
isSmsEnabled: boolean;
|
|
168
165
|
smsNumber?: string | null;
|
|
169
166
|
isEarlyAdopter: boolean;
|
|
170
|
-
isAIEnabled: boolean;
|
|
171
167
|
}
|
|
172
168
|
export interface Action {
|
|
173
169
|
/** @format uuid */
|
|
@@ -176,7 +172,7 @@ export interface Action {
|
|
|
176
172
|
comments?: string | null;
|
|
177
173
|
/** @format uuid */
|
|
178
174
|
siteConfigurationID: string;
|
|
179
|
-
applicationSettings?: any
|
|
175
|
+
applicationSettings?: any;
|
|
180
176
|
surveysToken?: string | null;
|
|
181
177
|
}
|
|
182
178
|
export interface Address {
|
|
@@ -397,7 +393,7 @@ export interface AiAuditLog {
|
|
|
397
393
|
conversationId?: string | null;
|
|
398
394
|
/** @format uuid */
|
|
399
395
|
messageId?: string | null;
|
|
400
|
-
eventType:
|
|
396
|
+
eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied";
|
|
401
397
|
modelId?: string | null;
|
|
402
398
|
/** @format int32 */
|
|
403
399
|
inputTokens?: number | null;
|
|
@@ -410,7 +406,7 @@ export interface AiAuditLog {
|
|
|
410
406
|
guardrailCategory?: string | null;
|
|
411
407
|
rawRequest?: string | null;
|
|
412
408
|
rawResponse?: string | null;
|
|
413
|
-
details?: any
|
|
409
|
+
details?: any;
|
|
414
410
|
/** @format date-time */
|
|
415
411
|
createdAt: string;
|
|
416
412
|
}
|
|
@@ -472,7 +468,7 @@ export interface AiChatMessagePaginated {
|
|
|
472
468
|
count: number;
|
|
473
469
|
}
|
|
474
470
|
export interface AiChatMetadata {
|
|
475
|
-
intent:
|
|
471
|
+
intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
476
472
|
fieldsAccessed: string[];
|
|
477
473
|
/** @format int64 */
|
|
478
474
|
queryTimeMs: number;
|
|
@@ -498,7 +494,7 @@ export interface AiChatRequest {
|
|
|
498
494
|
promptId?: string | null;
|
|
499
495
|
}
|
|
500
496
|
export interface AiChatStructuredData {
|
|
501
|
-
type:
|
|
497
|
+
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
502
498
|
displayHint?: AiDisplayHint | null;
|
|
503
499
|
detectedDocumentType?: string | null;
|
|
504
500
|
columns: string[];
|
|
@@ -507,28 +503,6 @@ export interface AiChatStructuredData {
|
|
|
507
503
|
generatedDocumentId?: string | null;
|
|
508
504
|
generatedFileName?: string | null;
|
|
509
505
|
}
|
|
510
|
-
export interface AiConfigChangeLog {
|
|
511
|
-
/** @format uuid */
|
|
512
|
-
id: string;
|
|
513
|
-
/** @format uuid */
|
|
514
|
-
accountId?: string | null;
|
|
515
|
-
/** @format uuid */
|
|
516
|
-
actorUserId: string;
|
|
517
|
-
entityType: AiConfigChangeLogEntityTypeEnum;
|
|
518
|
-
/** @format uuid */
|
|
519
|
-
entityId?: string | null;
|
|
520
|
-
action: AiConfigChangeLogActionEnum;
|
|
521
|
-
before?: any | null;
|
|
522
|
-
after?: any | null;
|
|
523
|
-
/** @format date-time */
|
|
524
|
-
createdAt: string;
|
|
525
|
-
}
|
|
526
|
-
export interface AiConfigChangeLogPaginated {
|
|
527
|
-
rows: AiConfigChangeLog[];
|
|
528
|
-
pagination: Pagination;
|
|
529
|
-
/** @format int64 */
|
|
530
|
-
count: number;
|
|
531
|
-
}
|
|
532
506
|
export interface AiConversationAuditSummary {
|
|
533
507
|
/** @format uuid */
|
|
534
508
|
conversationId: string;
|
|
@@ -573,6 +547,8 @@ export interface AiConversationListItem {
|
|
|
573
547
|
id: string;
|
|
574
548
|
/** @format uuid */
|
|
575
549
|
userId: string;
|
|
550
|
+
/** @format uuid */
|
|
551
|
+
loanId?: string | null;
|
|
576
552
|
name?: string | null;
|
|
577
553
|
preview: string;
|
|
578
554
|
/** @format int32 */
|
|
@@ -589,16 +565,19 @@ export interface AiConversationListItemPaginated {
|
|
|
589
565
|
/** @format int64 */
|
|
590
566
|
count: number;
|
|
591
567
|
}
|
|
568
|
+
export interface AiEnabled {
|
|
569
|
+
isEnabled: boolean;
|
|
570
|
+
}
|
|
592
571
|
export interface AiGuardrail {
|
|
593
572
|
/** @format uuid */
|
|
594
573
|
id: string;
|
|
595
574
|
name: string;
|
|
596
|
-
category:
|
|
575
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
597
576
|
description?: string | null;
|
|
598
577
|
keywords: string[];
|
|
599
578
|
responseTemplate: string;
|
|
600
579
|
isDefault: boolean;
|
|
601
|
-
|
|
580
|
+
isActive: boolean;
|
|
602
581
|
hasAccountOverride: boolean;
|
|
603
582
|
/** @format date-time */
|
|
604
583
|
createdAt: string;
|
|
@@ -699,8 +678,8 @@ export interface AiUrlSource {
|
|
|
699
678
|
name: string;
|
|
700
679
|
url: string;
|
|
701
680
|
description?: string | null;
|
|
702
|
-
category:
|
|
703
|
-
scope:
|
|
681
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
682
|
+
scope: "FullDomain" | "SpecificPath";
|
|
704
683
|
isActive: boolean;
|
|
705
684
|
isDefault: boolean;
|
|
706
685
|
hasAccountOverride: boolean;
|
|
@@ -807,14 +786,14 @@ export interface AuditLogEntry {
|
|
|
807
786
|
/** @format uuid */
|
|
808
787
|
id: string;
|
|
809
788
|
entityType: string;
|
|
810
|
-
changeType:
|
|
789
|
+
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
811
790
|
/** @format uuid */
|
|
812
791
|
entityId: string;
|
|
813
792
|
performedBy?: AuditLogUser | null;
|
|
814
793
|
rootEntityType?: string | null;
|
|
815
794
|
/** @format uuid */
|
|
816
795
|
rootEntityId?: string | null;
|
|
817
|
-
changes?: any
|
|
796
|
+
changes?: any;
|
|
818
797
|
/** @format date-time */
|
|
819
798
|
createdAt: string;
|
|
820
799
|
}
|
|
@@ -854,7 +833,7 @@ export interface BorrowerCount {
|
|
|
854
833
|
firstName: string;
|
|
855
834
|
lastName: string;
|
|
856
835
|
email: string;
|
|
857
|
-
role:
|
|
836
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
858
837
|
/** @format int32 */
|
|
859
838
|
count: number;
|
|
860
839
|
}
|
|
@@ -864,7 +843,7 @@ export interface BorrowerIdentity {
|
|
|
864
843
|
firstName: string;
|
|
865
844
|
lastName: string;
|
|
866
845
|
email: string;
|
|
867
|
-
role:
|
|
846
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
868
847
|
}
|
|
869
848
|
export interface BorrowersNotUsingPosSummary {
|
|
870
849
|
/** @format int32 */
|
|
@@ -1053,6 +1032,7 @@ export interface ConsumerConnectStatus {
|
|
|
1053
1032
|
/** @format date-time */
|
|
1054
1033
|
nextRetryAt?: string | null;
|
|
1055
1034
|
lastTriggerSource?: string | null;
|
|
1035
|
+
lastError?: string | null;
|
|
1056
1036
|
}
|
|
1057
1037
|
export interface ContactInfo {
|
|
1058
1038
|
phone: string;
|
|
@@ -1098,7 +1078,7 @@ export interface CorporateSearchCriteria {
|
|
|
1098
1078
|
isActive?: boolean | null;
|
|
1099
1079
|
}
|
|
1100
1080
|
export interface CreateAccessScopeRequest {
|
|
1101
|
-
scopeType:
|
|
1081
|
+
scopeType: "User" | "Branch";
|
|
1102
1082
|
/** @format uuid */
|
|
1103
1083
|
userId?: string | null;
|
|
1104
1084
|
/** @format uuid */
|
|
@@ -1116,7 +1096,7 @@ export interface CreateAccountRequest {
|
|
|
1116
1096
|
/** @format int64 */
|
|
1117
1097
|
nlmsid: number;
|
|
1118
1098
|
settings: AccountSettingsRequest;
|
|
1119
|
-
environment:
|
|
1099
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1120
1100
|
losIntegration: LOSIntegration;
|
|
1121
1101
|
billingSettings: AccountBillingRequest;
|
|
1122
1102
|
}
|
|
@@ -1130,7 +1110,7 @@ export interface CreateAiCanonicalFieldRequest {
|
|
|
1130
1110
|
}
|
|
1131
1111
|
export interface CreateAiGuardrailRequest {
|
|
1132
1112
|
name: string;
|
|
1133
|
-
category:
|
|
1113
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
1134
1114
|
description?: string | null;
|
|
1135
1115
|
keywords: string[];
|
|
1136
1116
|
responseTemplate: string;
|
|
@@ -1156,8 +1136,8 @@ export interface CreateAiUrlSourceRequest {
|
|
|
1156
1136
|
name: string;
|
|
1157
1137
|
url: string;
|
|
1158
1138
|
description?: string | null;
|
|
1159
|
-
category:
|
|
1160
|
-
scope:
|
|
1139
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
1140
|
+
scope: "FullDomain" | "SpecificPath";
|
|
1161
1141
|
}
|
|
1162
1142
|
export interface CreateBranchRequest {
|
|
1163
1143
|
name: string;
|
|
@@ -1180,8 +1160,8 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
1180
1160
|
name: string;
|
|
1181
1161
|
defaultValue?: string | null;
|
|
1182
1162
|
regexPattern?: string | null;
|
|
1183
|
-
dataType:
|
|
1184
|
-
entityType:
|
|
1163
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1164
|
+
entityType: "Loan";
|
|
1185
1165
|
options?: CustomFieldOptionRequest[] | null;
|
|
1186
1166
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
1187
1167
|
}
|
|
@@ -1196,7 +1176,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1196
1176
|
export interface CreateGroupMemberRequest {
|
|
1197
1177
|
/** @format uuid */
|
|
1198
1178
|
userId: string;
|
|
1199
|
-
loanRole:
|
|
1179
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1200
1180
|
}
|
|
1201
1181
|
export interface CreateInviteRequest {
|
|
1202
1182
|
firstName: string;
|
|
@@ -1204,7 +1184,7 @@ export interface CreateInviteRequest {
|
|
|
1204
1184
|
emailAddress: string;
|
|
1205
1185
|
phoneNumber?: string | null;
|
|
1206
1186
|
/** @deprecated */
|
|
1207
|
-
relationship:
|
|
1187
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1208
1188
|
loanID: string;
|
|
1209
1189
|
route?: string | null;
|
|
1210
1190
|
/** @format uuid */
|
|
@@ -1224,7 +1204,7 @@ export interface CreateLoanImportRequest {
|
|
|
1224
1204
|
endDate: string;
|
|
1225
1205
|
/** @format date-time */
|
|
1226
1206
|
startDate: string;
|
|
1227
|
-
importMode:
|
|
1207
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1228
1208
|
}
|
|
1229
1209
|
export interface CreateSession {
|
|
1230
1210
|
sessionId: string;
|
|
@@ -1242,7 +1222,7 @@ export interface CreateUserDeviceRequest {
|
|
|
1242
1222
|
token: string;
|
|
1243
1223
|
}
|
|
1244
1224
|
export interface CreateUserDraft {
|
|
1245
|
-
loanRole:
|
|
1225
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
1246
1226
|
}
|
|
1247
1227
|
export interface CreateUserGroupRequest {
|
|
1248
1228
|
name: string;
|
|
@@ -1303,8 +1283,8 @@ export interface CustomFieldDefinition {
|
|
|
1303
1283
|
name: string;
|
|
1304
1284
|
defaultValue?: string | null;
|
|
1305
1285
|
regexPattern?: string | null;
|
|
1306
|
-
dataType:
|
|
1307
|
-
entityType:
|
|
1286
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1287
|
+
entityType: "Loan";
|
|
1308
1288
|
options: CustomFieldOption[];
|
|
1309
1289
|
permissions: CustomFieldPermission[];
|
|
1310
1290
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1318,7 +1298,7 @@ export interface CustomFieldEntry {
|
|
|
1318
1298
|
displayOrder: number;
|
|
1319
1299
|
name: string;
|
|
1320
1300
|
value: string;
|
|
1321
|
-
dataType:
|
|
1301
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1322
1302
|
}
|
|
1323
1303
|
export interface CustomFieldOption {
|
|
1324
1304
|
/** @format uuid */
|
|
@@ -1335,12 +1315,12 @@ export interface CustomFieldOptionRequest {
|
|
|
1335
1315
|
export interface CustomFieldPermission {
|
|
1336
1316
|
/** @format uuid */
|
|
1337
1317
|
id: string;
|
|
1338
|
-
role:
|
|
1339
|
-
accessLevel:
|
|
1318
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1319
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1340
1320
|
}
|
|
1341
1321
|
export interface CustomFieldPermissionRequest {
|
|
1342
|
-
role:
|
|
1343
|
-
accessLevel:
|
|
1322
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
1323
|
+
accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
1344
1324
|
}
|
|
1345
1325
|
export interface CustomFieldValue {
|
|
1346
1326
|
/** @format uuid */
|
|
@@ -1351,7 +1331,7 @@ export interface CustomFieldValue {
|
|
|
1351
1331
|
customFieldDefinitionID: string;
|
|
1352
1332
|
value: string;
|
|
1353
1333
|
definitionName: string;
|
|
1354
|
-
dataType:
|
|
1334
|
+
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1355
1335
|
}
|
|
1356
1336
|
export interface DetailedUser {
|
|
1357
1337
|
/** @format date-time */
|
|
@@ -1445,18 +1425,6 @@ export interface DeviceRequest {
|
|
|
1445
1425
|
name?: string | null;
|
|
1446
1426
|
comments?: string | null;
|
|
1447
1427
|
}
|
|
1448
|
-
export interface DocumentData {
|
|
1449
|
-
documentID: string;
|
|
1450
|
-
/** @format uuid */
|
|
1451
|
-
eSignRecordID: string;
|
|
1452
|
-
documentBucketTitle?: string | null;
|
|
1453
|
-
documentName?: string | null;
|
|
1454
|
-
/** @format date-time */
|
|
1455
|
-
createdAt: string;
|
|
1456
|
-
extension?: string | null;
|
|
1457
|
-
password: string;
|
|
1458
|
-
systemGenerated: boolean;
|
|
1459
|
-
}
|
|
1460
1428
|
export interface DocumentDataRequest {
|
|
1461
1429
|
documentID?: string | null;
|
|
1462
1430
|
/** @format uuid */
|
|
@@ -1589,7 +1557,7 @@ export interface Draft {
|
|
|
1589
1557
|
siteConfiguration: SiteConfigurationReduced;
|
|
1590
1558
|
/** @format uuid */
|
|
1591
1559
|
loanID?: string | null;
|
|
1592
|
-
type:
|
|
1560
|
+
type: "NewLoan" | "EditLoan";
|
|
1593
1561
|
isCoBorrower: boolean;
|
|
1594
1562
|
}
|
|
1595
1563
|
export interface DraftContent {
|
|
@@ -1607,7 +1575,7 @@ export interface DraftContent {
|
|
|
1607
1575
|
siteConfiguration: SiteConfigurationReduced;
|
|
1608
1576
|
/** @format uuid */
|
|
1609
1577
|
loanID?: string | null;
|
|
1610
|
-
type:
|
|
1578
|
+
type: "NewLoan" | "EditLoan";
|
|
1611
1579
|
isCoBorrower: boolean;
|
|
1612
1580
|
applicationPayload: any;
|
|
1613
1581
|
}
|
|
@@ -1623,7 +1591,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1623
1591
|
}
|
|
1624
1592
|
export interface DraftRequest {
|
|
1625
1593
|
applicationPayload: any;
|
|
1626
|
-
customData?: any
|
|
1594
|
+
customData?: any;
|
|
1627
1595
|
isCoBorrower: boolean;
|
|
1628
1596
|
}
|
|
1629
1597
|
export interface EconsentPendingSummary {
|
|
@@ -1697,9 +1665,9 @@ export interface EncompassCredentialsDetail {
|
|
|
1697
1665
|
clearStateIfUnlicensed: boolean;
|
|
1698
1666
|
/** @deprecated */
|
|
1699
1667
|
baseUrl?: string | null;
|
|
1700
|
-
encompassEnvironment:
|
|
1668
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1701
1669
|
consumerConnectWidgetHost?: string | null;
|
|
1702
|
-
signingMethod:
|
|
1670
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1703
1671
|
subscriptionId?: string | null;
|
|
1704
1672
|
environment?: string | null;
|
|
1705
1673
|
}
|
|
@@ -1715,9 +1683,9 @@ export interface EncompassCredentialsRequest {
|
|
|
1715
1683
|
clearStateIfUnlicensed: boolean;
|
|
1716
1684
|
/** @deprecated */
|
|
1717
1685
|
baseUrl?: string | null;
|
|
1718
|
-
encompassEnvironment:
|
|
1686
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1719
1687
|
consumerConnectWidgetHost?: string | null;
|
|
1720
|
-
signingMethod:
|
|
1688
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1721
1689
|
subscriptionId?: string | null;
|
|
1722
1690
|
environment?: string | null;
|
|
1723
1691
|
clientID?: string | null;
|
|
@@ -1788,6 +1756,7 @@ export interface EncompassPackageItem {
|
|
|
1788
1756
|
/** @format date-time */
|
|
1789
1757
|
createdAt: string;
|
|
1790
1758
|
recipientId: string;
|
|
1759
|
+
borrowerName?: string | null;
|
|
1791
1760
|
title?: string | null;
|
|
1792
1761
|
/** @format date-time */
|
|
1793
1762
|
issuedAt?: string | null;
|
|
@@ -1826,8 +1795,8 @@ export interface EncompassRequestLog {
|
|
|
1826
1795
|
losId?: string | null;
|
|
1827
1796
|
/** @format uuid */
|
|
1828
1797
|
accountId: string;
|
|
1829
|
-
operationType:
|
|
1830
|
-
outcome:
|
|
1798
|
+
operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
1799
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1831
1800
|
message: string;
|
|
1832
1801
|
endpoint?: string | null;
|
|
1833
1802
|
httpMethod?: string | null;
|
|
@@ -1835,7 +1804,7 @@ export interface EncompassRequestLog {
|
|
|
1835
1804
|
httpStatusCode?: number | null;
|
|
1836
1805
|
/** @format int64 */
|
|
1837
1806
|
durationMs?: number | null;
|
|
1838
|
-
context?: any
|
|
1807
|
+
context?: any;
|
|
1839
1808
|
/** @format date-time */
|
|
1840
1809
|
createdAt: string;
|
|
1841
1810
|
}
|
|
@@ -1874,7 +1843,7 @@ export interface FileSearchCriteria {
|
|
|
1874
1843
|
export interface FileWithBytes {
|
|
1875
1844
|
name: string;
|
|
1876
1845
|
/** @format byte */
|
|
1877
|
-
data:
|
|
1846
|
+
data: string;
|
|
1878
1847
|
fileName: string;
|
|
1879
1848
|
mimeType?: string | null;
|
|
1880
1849
|
extension?: string | null;
|
|
@@ -1950,7 +1919,7 @@ export interface FormSubmission {
|
|
|
1950
1919
|
subjectPropertyAddressCounty?: string | null;
|
|
1951
1920
|
subjectPropertyAddressState?: string | null;
|
|
1952
1921
|
subjectPropertyAddressZip?: string | null;
|
|
1953
|
-
data?: any
|
|
1922
|
+
data?: any;
|
|
1954
1923
|
/** @format uuid */
|
|
1955
1924
|
listingID?: string | null;
|
|
1956
1925
|
listing?: Listing | null;
|
|
@@ -1985,7 +1954,7 @@ export interface FormSubmissionRequest {
|
|
|
1985
1954
|
subjectPropertyAddressCounty?: string | null;
|
|
1986
1955
|
subjectPropertyAddressState?: string | null;
|
|
1987
1956
|
subjectPropertyAddressZip?: string | null;
|
|
1988
|
-
data?: any
|
|
1957
|
+
data?: any;
|
|
1989
1958
|
/** @format uuid */
|
|
1990
1959
|
listingID?: string | null;
|
|
1991
1960
|
}
|
|
@@ -2034,7 +2003,7 @@ export interface FusionFieldDisplay {
|
|
|
2034
2003
|
fieldValue: string;
|
|
2035
2004
|
}
|
|
2036
2005
|
export interface FusionReportFilter {
|
|
2037
|
-
filterType:
|
|
2006
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
2038
2007
|
targetField: string;
|
|
2039
2008
|
targetValue: string;
|
|
2040
2009
|
}
|
|
@@ -2054,7 +2023,7 @@ export interface GenerateSystemPrompt {
|
|
|
2054
2023
|
}
|
|
2055
2024
|
export interface GenerateSystemPromptRequest {
|
|
2056
2025
|
description: string;
|
|
2057
|
-
category:
|
|
2026
|
+
category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
2058
2027
|
}
|
|
2059
2028
|
export interface GetApplications {
|
|
2060
2029
|
applications: ApplicationRowData[];
|
|
@@ -2138,11 +2107,11 @@ export interface GetWorkflowRequest {
|
|
|
2138
2107
|
export interface GuidPatchOperation {
|
|
2139
2108
|
op: string;
|
|
2140
2109
|
path: string;
|
|
2141
|
-
value?: any
|
|
2110
|
+
value?: any;
|
|
2142
2111
|
from?: string | null;
|
|
2143
2112
|
}
|
|
2144
2113
|
export interface IPAddress {
|
|
2145
|
-
addressFamily:
|
|
2114
|
+
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";
|
|
2146
2115
|
/** @format int64 */
|
|
2147
2116
|
scopeId: number;
|
|
2148
2117
|
isIPv6Multicast: boolean;
|
|
@@ -2391,7 +2360,7 @@ export interface Loan {
|
|
|
2391
2360
|
contacts: LoanContact[];
|
|
2392
2361
|
customFields: CustomFieldEntry[];
|
|
2393
2362
|
milestones: LoanMilestone[];
|
|
2394
|
-
signingMethod:
|
|
2363
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
2395
2364
|
}
|
|
2396
2365
|
export interface LoanApplication {
|
|
2397
2366
|
/** @format uuid */
|
|
@@ -2429,7 +2398,7 @@ export interface LoanApplicationRequest {
|
|
|
2429
2398
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2430
2399
|
/** @format uuid */
|
|
2431
2400
|
draftId?: string | null;
|
|
2432
|
-
additionalFields?: Record<string, any
|
|
2401
|
+
additionalFields?: Record<string, any>;
|
|
2433
2402
|
/** @format uuid */
|
|
2434
2403
|
existingLoanId?: string | null;
|
|
2435
2404
|
}
|
|
@@ -2448,7 +2417,7 @@ export interface LoanBorrower {
|
|
|
2448
2417
|
citizenship?: LoanCitizenship | null;
|
|
2449
2418
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2450
2419
|
languagePreference?: LoanLanguagePreference | null;
|
|
2451
|
-
applicationStatus:
|
|
2420
|
+
applicationStatus: "Draft" | "Complete";
|
|
2452
2421
|
/** @format int32 */
|
|
2453
2422
|
numberOfDependents?: number | null;
|
|
2454
2423
|
/** @format int32 */
|
|
@@ -2810,6 +2779,11 @@ export interface LoanBorrowerGift {
|
|
|
2810
2779
|
isDeposited?: boolean | null;
|
|
2811
2780
|
source?: LoanGiftSource | null;
|
|
2812
2781
|
assetType?: LoanGiftAssetType | null;
|
|
2782
|
+
grantorDonorName?: string | null;
|
|
2783
|
+
/** @format double */
|
|
2784
|
+
amountAppliedToDownPayment?: number | null;
|
|
2785
|
+
/** @format double */
|
|
2786
|
+
amountAppliedToClosingCosts?: number | null;
|
|
2813
2787
|
}
|
|
2814
2788
|
export interface LoanBorrowerGiftRequest {
|
|
2815
2789
|
/** @format double */
|
|
@@ -2986,7 +2960,15 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
2986
2960
|
/** @format double */
|
|
2987
2961
|
monthlyRentalIncome?: number | null;
|
|
2988
2962
|
/** @format double */
|
|
2963
|
+
rentalIncomeNetAmount?: number | null;
|
|
2964
|
+
/** @format double */
|
|
2989
2965
|
maintenanceExpense?: number | null;
|
|
2966
|
+
/** @format double */
|
|
2967
|
+
percentageOfRental?: number | null;
|
|
2968
|
+
/** @format double */
|
|
2969
|
+
participationPercentage?: number | null;
|
|
2970
|
+
/** @format date */
|
|
2971
|
+
acquiredDate?: string | null;
|
|
2990
2972
|
dispositionStatus?: string | null;
|
|
2991
2973
|
address?: AddressV3 | null;
|
|
2992
2974
|
mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
|
|
@@ -3033,7 +3015,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
|
|
|
3033
3015
|
/** @format double */
|
|
3034
3016
|
maintenanceExpense?: number | null;
|
|
3035
3017
|
address?: AddressRequest | null;
|
|
3036
|
-
|
|
3018
|
+
mortgage?: LoanBorrowerRealEstateAssetMortgageRequest | null;
|
|
3037
3019
|
}
|
|
3038
3020
|
export interface LoanBorrowerRequest {
|
|
3039
3021
|
ssn?: string | null;
|
|
@@ -3161,7 +3143,7 @@ export interface LoanConsentRequest {
|
|
|
3161
3143
|
borrowerEConsent?: boolean | null;
|
|
3162
3144
|
borrowerCreditAuth?: boolean | null;
|
|
3163
3145
|
borrowerTCPAOptIn?: boolean | null;
|
|
3164
|
-
additionalFields?: Record<string, string
|
|
3146
|
+
additionalFields?: Record<string, string>;
|
|
3165
3147
|
}
|
|
3166
3148
|
export interface LoanContact {
|
|
3167
3149
|
/** @format date-time */
|
|
@@ -3179,7 +3161,7 @@ export interface LoanContact {
|
|
|
3179
3161
|
email?: string | null;
|
|
3180
3162
|
phone?: string | null;
|
|
3181
3163
|
companyName?: string | null;
|
|
3182
|
-
role:
|
|
3164
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3183
3165
|
}
|
|
3184
3166
|
export interface LoanContactList {
|
|
3185
3167
|
email: string;
|
|
@@ -3201,7 +3183,7 @@ export interface LoanCostDetails {
|
|
|
3201
3183
|
totalFinancing?: number | null;
|
|
3202
3184
|
}
|
|
3203
3185
|
export interface LoanCustomFieldsRequest {
|
|
3204
|
-
additionalFields?: Record<string, string
|
|
3186
|
+
additionalFields?: Record<string, string>;
|
|
3205
3187
|
}
|
|
3206
3188
|
export interface LoanDocument {
|
|
3207
3189
|
/** @format date-time */
|
|
@@ -3251,12 +3233,12 @@ export interface LoanDocumentFolderPermission {
|
|
|
3251
3233
|
id: string;
|
|
3252
3234
|
/** @format uuid */
|
|
3253
3235
|
loanDocumentFolderID: string;
|
|
3254
|
-
role:
|
|
3255
|
-
level:
|
|
3236
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3237
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3256
3238
|
}
|
|
3257
3239
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3258
|
-
role:
|
|
3259
|
-
level:
|
|
3240
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3241
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
3260
3242
|
}
|
|
3261
3243
|
export interface LoanDocumentFolderUsage {
|
|
3262
3244
|
/** @format uuid */
|
|
@@ -3390,13 +3372,13 @@ export interface LoanImport {
|
|
|
3390
3372
|
/** @format int32 */
|
|
3391
3373
|
importedCount: number;
|
|
3392
3374
|
statusMessage?: string | null;
|
|
3393
|
-
status:
|
|
3394
|
-
importMode:
|
|
3375
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
3376
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3395
3377
|
/** @format date-time */
|
|
3396
3378
|
createdAt?: string | null;
|
|
3397
3379
|
}
|
|
3398
3380
|
export interface LoanImportLog {
|
|
3399
|
-
level:
|
|
3381
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3400
3382
|
message: string;
|
|
3401
3383
|
/** @format date-time */
|
|
3402
3384
|
createdAt: string;
|
|
@@ -3451,8 +3433,8 @@ export interface LoanListPaginated {
|
|
|
3451
3433
|
export interface LoanLog {
|
|
3452
3434
|
/** @format uuid */
|
|
3453
3435
|
id: string;
|
|
3454
|
-
level:
|
|
3455
|
-
type:
|
|
3436
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3437
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
3456
3438
|
message: string;
|
|
3457
3439
|
/** @format date-time */
|
|
3458
3440
|
createdAt: string;
|
|
@@ -3460,8 +3442,8 @@ export interface LoanLog {
|
|
|
3460
3442
|
export interface LoanLogDetail {
|
|
3461
3443
|
/** @format uuid */
|
|
3462
3444
|
id: string;
|
|
3463
|
-
level:
|
|
3464
|
-
type:
|
|
3445
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3446
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
|
|
3465
3447
|
message: string;
|
|
3466
3448
|
/** @format date-time */
|
|
3467
3449
|
createdAt: string;
|
|
@@ -3723,7 +3705,7 @@ export interface LoanQueueWithData {
|
|
|
3723
3705
|
user: UserPublic;
|
|
3724
3706
|
loanOfficer: LoanOfficerPublic;
|
|
3725
3707
|
siteConfiguration: SiteConfigurationReduced;
|
|
3726
|
-
data?: any
|
|
3708
|
+
data?: any;
|
|
3727
3709
|
}
|
|
3728
3710
|
export interface LoanRecord {
|
|
3729
3711
|
loanGuid: string;
|
|
@@ -3754,7 +3736,7 @@ export interface LoanTaskSearchRequest {
|
|
|
3754
3736
|
loanStatus?: LoanTaskActivityFilter | null;
|
|
3755
3737
|
}
|
|
3756
3738
|
export interface LoanTaskStatusSummary {
|
|
3757
|
-
status:
|
|
3739
|
+
status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
3758
3740
|
/** @format int32 */
|
|
3759
3741
|
count: number;
|
|
3760
3742
|
}
|
|
@@ -3766,7 +3748,7 @@ export interface LoanUser {
|
|
|
3766
3748
|
email: string;
|
|
3767
3749
|
phone?: string | null;
|
|
3768
3750
|
role: string;
|
|
3769
|
-
loanRole:
|
|
3751
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3770
3752
|
isUser: boolean;
|
|
3771
3753
|
/** @format date-time */
|
|
3772
3754
|
createdAt: string;
|
|
@@ -3799,7 +3781,7 @@ export interface LosOperationTracking {
|
|
|
3799
3781
|
operationType: string;
|
|
3800
3782
|
correlationKey: string;
|
|
3801
3783
|
lastTriggerSource?: string | null;
|
|
3802
|
-
status:
|
|
3784
|
+
status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
3803
3785
|
/** @format date-time */
|
|
3804
3786
|
createdAt: string;
|
|
3805
3787
|
/** @format date-time */
|
|
@@ -3860,7 +3842,7 @@ export interface LosSyncStep {
|
|
|
3860
3842
|
/** @format int32 */
|
|
3861
3843
|
order: number;
|
|
3862
3844
|
name: string;
|
|
3863
|
-
severity:
|
|
3845
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
3864
3846
|
message: string;
|
|
3865
3847
|
/** @format date-time */
|
|
3866
3848
|
atUtc: string;
|
|
@@ -3874,7 +3856,7 @@ export interface LosWebhook {
|
|
|
3874
3856
|
enableSubscription: boolean;
|
|
3875
3857
|
}
|
|
3876
3858
|
export interface ManualDocumentClassificationRequest {
|
|
3877
|
-
documentType:
|
|
3859
|
+
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";
|
|
3878
3860
|
}
|
|
3879
3861
|
export interface MdmUser {
|
|
3880
3862
|
user_email?: string | null;
|
|
@@ -3953,7 +3935,7 @@ export interface ModuleParameterValue {
|
|
|
3953
3935
|
parameterID: string;
|
|
3954
3936
|
parameterName: string;
|
|
3955
3937
|
parameterType: string;
|
|
3956
|
-
value?: any
|
|
3938
|
+
value?: any;
|
|
3957
3939
|
isInherited: boolean;
|
|
3958
3940
|
}
|
|
3959
3941
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4126,7 +4108,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4126
4108
|
}
|
|
4127
4109
|
export interface Operation {
|
|
4128
4110
|
op?: string;
|
|
4129
|
-
value?:
|
|
4111
|
+
value?: string | number | boolean | null | object;
|
|
4130
4112
|
path?: string;
|
|
4131
4113
|
}
|
|
4132
4114
|
export interface OverridePasswordRequest {
|
|
@@ -4432,6 +4414,9 @@ export interface SendLoanTaskReminderRequest {
|
|
|
4432
4414
|
export interface SendOutstandingTaskReminderRequest {
|
|
4433
4415
|
userIds?: string[] | null;
|
|
4434
4416
|
}
|
|
4417
|
+
export interface SetAiEnabledRequest {
|
|
4418
|
+
isEnabled: boolean;
|
|
4419
|
+
}
|
|
4435
4420
|
export interface SetCustomFieldValueRequest {
|
|
4436
4421
|
/** @format uuid */
|
|
4437
4422
|
definitionId: string;
|
|
@@ -4449,7 +4434,7 @@ export interface SiteConfiguration {
|
|
|
4449
4434
|
deletedAt?: string | null;
|
|
4450
4435
|
/** @format uuid */
|
|
4451
4436
|
id: string;
|
|
4452
|
-
type:
|
|
4437
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4453
4438
|
/** @format uuid */
|
|
4454
4439
|
entityID: string;
|
|
4455
4440
|
/** @format int32 */
|
|
@@ -4642,7 +4627,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4642
4627
|
deletedAt?: string | null;
|
|
4643
4628
|
/** @format uuid */
|
|
4644
4629
|
id: string;
|
|
4645
|
-
type:
|
|
4630
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4646
4631
|
/** @format uuid */
|
|
4647
4632
|
entityID: string;
|
|
4648
4633
|
/** @format int32 */
|
|
@@ -4852,7 +4837,7 @@ export interface SiteConfigurationForm {
|
|
|
4852
4837
|
export interface SiteConfigurationReduced {
|
|
4853
4838
|
/** @format uuid */
|
|
4854
4839
|
id: string;
|
|
4855
|
-
type:
|
|
4840
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4856
4841
|
url?: string | null;
|
|
4857
4842
|
name: string;
|
|
4858
4843
|
/** @format int64 */
|
|
@@ -4869,7 +4854,7 @@ export interface SiteConfigurationRequest {
|
|
|
4869
4854
|
entityID: string;
|
|
4870
4855
|
/** @format int32 */
|
|
4871
4856
|
entityType: number;
|
|
4872
|
-
type:
|
|
4857
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4873
4858
|
url: string;
|
|
4874
4859
|
name: string;
|
|
4875
4860
|
introduction?: string | null;
|
|
@@ -5044,7 +5029,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5044
5029
|
export interface SiteConfigurationSummary {
|
|
5045
5030
|
/** @format uuid */
|
|
5046
5031
|
id: string;
|
|
5047
|
-
type:
|
|
5032
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5048
5033
|
url?: string | null;
|
|
5049
5034
|
name: string;
|
|
5050
5035
|
/** @format int64 */
|
|
@@ -5298,7 +5283,7 @@ export interface UnregisteredBorrower {
|
|
|
5298
5283
|
lastName?: string | null;
|
|
5299
5284
|
fullName?: string | null;
|
|
5300
5285
|
email?: string | null;
|
|
5301
|
-
role:
|
|
5286
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5302
5287
|
}
|
|
5303
5288
|
export interface UpdateAccountRequest {
|
|
5304
5289
|
name: string;
|
|
@@ -5322,7 +5307,7 @@ export interface UpdateAiCanonicalFieldRequest {
|
|
|
5322
5307
|
}
|
|
5323
5308
|
export interface UpdateAiGuardrailRequest {
|
|
5324
5309
|
name: string;
|
|
5325
|
-
category:
|
|
5310
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5326
5311
|
description?: string | null;
|
|
5327
5312
|
keywords: string[];
|
|
5328
5313
|
responseTemplate: string;
|
|
@@ -5347,8 +5332,8 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5347
5332
|
name: string;
|
|
5348
5333
|
url: string;
|
|
5349
5334
|
description?: string | null;
|
|
5350
|
-
category:
|
|
5351
|
-
scope:
|
|
5335
|
+
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5336
|
+
scope: "FullDomain" | "SpecificPath";
|
|
5352
5337
|
}
|
|
5353
5338
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5354
5339
|
isRequired: boolean;
|
|
@@ -5635,7 +5620,7 @@ export interface UserDevice {
|
|
|
5635
5620
|
export interface UserDraft {
|
|
5636
5621
|
/** @format uuid */
|
|
5637
5622
|
draftID: string;
|
|
5638
|
-
role:
|
|
5623
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5639
5624
|
user: User;
|
|
5640
5625
|
}
|
|
5641
5626
|
export interface UserDraftPaginated {
|
|
@@ -5659,7 +5644,7 @@ export interface UserGroupAccessScope {
|
|
|
5659
5644
|
id: string;
|
|
5660
5645
|
/** @format uuid */
|
|
5661
5646
|
groupId: string;
|
|
5662
|
-
scopeType:
|
|
5647
|
+
scopeType: "User" | "Branch";
|
|
5663
5648
|
/** @format uuid */
|
|
5664
5649
|
userId?: string | null;
|
|
5665
5650
|
/** @format uuid */
|
|
@@ -5692,7 +5677,7 @@ export interface UserLoan {
|
|
|
5692
5677
|
deletedAt?: string | null;
|
|
5693
5678
|
loanID: string;
|
|
5694
5679
|
user: User;
|
|
5695
|
-
role:
|
|
5680
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5696
5681
|
/** @format int32 */
|
|
5697
5682
|
borrowerPair?: number | null;
|
|
5698
5683
|
/** @format int32 */
|
|
@@ -5704,11 +5689,11 @@ export interface UserLoanConsent {
|
|
|
5704
5689
|
id: string;
|
|
5705
5690
|
/** @format uuid */
|
|
5706
5691
|
userLoanID: string;
|
|
5707
|
-
type:
|
|
5692
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5708
5693
|
providedConsent: boolean;
|
|
5709
5694
|
source?: ConsentSource | null;
|
|
5710
5695
|
ipAddress?: string | null;
|
|
5711
|
-
losSyncStatus:
|
|
5696
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
5712
5697
|
/** @format date-time */
|
|
5713
5698
|
createdAt: string;
|
|
5714
5699
|
/** @format date-time */
|
|
@@ -5838,7 +5823,7 @@ export interface UserSummary {
|
|
|
5838
5823
|
id: string;
|
|
5839
5824
|
name?: string | null;
|
|
5840
5825
|
email?: string | null;
|
|
5841
|
-
role:
|
|
5826
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5842
5827
|
}
|
|
5843
5828
|
export interface VerifyPasswordRequest {
|
|
5844
5829
|
email: string;
|
|
@@ -5865,90 +5850,6 @@ export interface Workflow {
|
|
|
5865
5850
|
tileSubtitle: string;
|
|
5866
5851
|
icon: string;
|
|
5867
5852
|
}
|
|
5868
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5869
|
-
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";
|
|
5870
|
-
export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
5871
|
-
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
5872
|
-
export type AiConfigChangeLogEntityTypeEnum = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
|
|
5873
|
-
export type AiConfigChangeLogActionEnum = "Created" | "Updated" | "Deleted" | "Toggled";
|
|
5874
|
-
export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5875
|
-
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5876
|
-
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
5877
|
-
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
5878
|
-
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5879
|
-
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5880
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5881
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5882
|
-
export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5883
|
-
export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5884
|
-
export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
5885
|
-
export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5886
|
-
export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
|
|
5887
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5888
|
-
/** @deprecated */
|
|
5889
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5890
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5891
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5892
|
-
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5893
|
-
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
5894
|
-
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5895
|
-
export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5896
|
-
export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5897
|
-
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5898
|
-
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
5899
|
-
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
5900
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5901
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5902
|
-
export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
|
|
5903
|
-
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5904
|
-
export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
|
|
5905
|
-
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5906
|
-
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
5907
|
-
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
5908
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5909
|
-
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
5910
|
-
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";
|
|
5911
|
-
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5912
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
5913
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5914
|
-
export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5915
|
-
export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5916
|
-
export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5917
|
-
export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
5918
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5919
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5920
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5921
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5922
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
5923
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5924
|
-
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
|
|
5925
|
-
export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
5926
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5927
|
-
export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
5928
|
-
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
5929
|
-
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";
|
|
5930
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5931
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5932
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5933
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5934
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5935
|
-
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5936
|
-
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5937
|
-
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5938
|
-
export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
5939
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5940
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5941
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5942
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5943
|
-
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
5944
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5945
|
-
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
5946
|
-
/** @default "Realtor" */
|
|
5947
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5948
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5949
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5950
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5951
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5952
5853
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5953
5854
|
export type QueryParamsType = Record<string | number, any>;
|
|
5954
5855
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5971,7 +5872,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
5971
5872
|
secure?: boolean;
|
|
5972
5873
|
format?: ResponseType;
|
|
5973
5874
|
}
|
|
5974
|
-
export
|
|
5875
|
+
export declare enum ContentType {
|
|
5876
|
+
JsonPatch = "application/json-patch+json",
|
|
5877
|
+
Json = "application/json",
|
|
5878
|
+
JsonApi = "application/vnd.api+json",
|
|
5879
|
+
FormData = "multipart/form-data",
|
|
5880
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
5881
|
+
Text = "text/plain"
|
|
5882
|
+
}
|
|
5975
5883
|
export declare class HttpClient<SecurityDataType = unknown> {
|
|
5976
5884
|
instance: AxiosInstance;
|
|
5977
5885
|
private securityData;
|
|
@@ -5987,7 +5895,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5987
5895
|
}
|
|
5988
5896
|
/**
|
|
5989
5897
|
* @title The Big POS API
|
|
5990
|
-
* @version v2.
|
|
5898
|
+
* @version v2.46.4
|
|
5991
5899
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5992
5900
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5993
5901
|
*/
|
|
@@ -6151,141 +6059,66 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6151
6059
|
/**
|
|
6152
6060
|
* No description
|
|
6153
6061
|
*
|
|
6154
|
-
* @tags
|
|
6155
|
-
* @name
|
|
6156
|
-
* @summary Get
|
|
6157
|
-
* @request GET:/api/ai/
|
|
6062
|
+
* @tags AiAccess
|
|
6063
|
+
* @name GetAiAccess
|
|
6064
|
+
* @summary Get whether AI is enabled for the current user's account
|
|
6065
|
+
* @request GET:/api/ai/access
|
|
6158
6066
|
* @secure
|
|
6159
|
-
* @response `200` `
|
|
6067
|
+
* @response `200` `AiEnabled` OK
|
|
6160
6068
|
*/
|
|
6161
|
-
|
|
6069
|
+
getAiAccess: (params?: RequestParams) => Promise<AxiosResponse<AiEnabled, any, {}>>;
|
|
6162
6070
|
/**
|
|
6163
6071
|
* No description
|
|
6164
6072
|
*
|
|
6165
|
-
* @tags
|
|
6166
|
-
* @name
|
|
6167
|
-
* @summary
|
|
6168
|
-
* @request
|
|
6073
|
+
* @tags AiAccount
|
|
6074
|
+
* @name GetAccountAiEnabled
|
|
6075
|
+
* @summary Get whether AI is enabled for an account (SuperAdmin only)
|
|
6076
|
+
* @request GET:/api/ai/accounts/{accountId}/ai-enabled
|
|
6169
6077
|
* @secure
|
|
6170
|
-
* @response `200` `
|
|
6171
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6078
|
+
* @response `200` `AiEnabled` OK
|
|
6172
6079
|
*/
|
|
6173
|
-
|
|
6080
|
+
getAccountAiEnabled: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<AiEnabled, any, {}>>;
|
|
6174
6081
|
/**
|
|
6175
6082
|
* No description
|
|
6176
6083
|
*
|
|
6177
|
-
* @tags
|
|
6178
|
-
* @name
|
|
6179
|
-
* @summary
|
|
6180
|
-
* @request
|
|
6181
|
-
* @secure
|
|
6182
|
-
* @response `200` `AiAuditLogPaginated` OK
|
|
6183
|
-
*/
|
|
6184
|
-
getAiAuditLogs: (query?: {
|
|
6185
|
-
eventType?: AiAuditEventType;
|
|
6186
|
-
/** @format uuid */
|
|
6187
|
-
requestId?: string;
|
|
6188
|
-
/** @format uuid */
|
|
6189
|
-
userId?: string;
|
|
6190
|
-
/** @format uuid */
|
|
6191
|
-
conversationId?: string;
|
|
6192
|
-
blockedOnly?: boolean;
|
|
6193
|
-
/** @format date-time */
|
|
6194
|
-
startDate?: string;
|
|
6195
|
-
/** @format date-time */
|
|
6196
|
-
endDate?: string;
|
|
6197
|
-
/** @format int32 */
|
|
6198
|
-
pageSize?: number;
|
|
6199
|
-
/** @format int32 */
|
|
6200
|
-
pageNumber?: number;
|
|
6201
|
-
sortBy?: string;
|
|
6202
|
-
sortDirection?: string;
|
|
6203
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
|
|
6204
|
-
/**
|
|
6205
|
-
* No description
|
|
6206
|
-
*
|
|
6207
|
-
* @tags AiAdmin
|
|
6208
|
-
* @name GetAiRequestLifecycle
|
|
6209
|
-
* @summary Get the full event lifecycle of a single AI request
|
|
6210
|
-
* @request GET:/api/ai/admin/audit-logs/request/{requestId}
|
|
6211
|
-
* @secure
|
|
6212
|
-
* @response `200` `(AiAuditLog)[]` OK
|
|
6213
|
-
*/
|
|
6214
|
-
getAiRequestLifecycle: (requestId: string, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
|
|
6215
|
-
/**
|
|
6216
|
-
* No description
|
|
6217
|
-
*
|
|
6218
|
-
* @tags AiAdmin
|
|
6219
|
-
* @name GetAiAuditConversations
|
|
6220
|
-
* @summary List conversations with their audit roll-up — origin user, turns, status, tokens
|
|
6221
|
-
* @request GET:/api/ai/admin/audit-conversations
|
|
6084
|
+
* @tags AiAccount
|
|
6085
|
+
* @name SetAccountAiEnabled
|
|
6086
|
+
* @summary Enable or disable AI for an account (SuperAdmin only)
|
|
6087
|
+
* @request PUT:/api/ai/accounts/{accountId}/ai-enabled
|
|
6222
6088
|
* @secure
|
|
6223
|
-
* @response `
|
|
6089
|
+
* @response `204` `void` No Content
|
|
6224
6090
|
*/
|
|
6225
|
-
|
|
6226
|
-
searchText?: string;
|
|
6227
|
-
/** @format date-time */
|
|
6228
|
-
startDate?: string;
|
|
6229
|
-
/** @format date-time */
|
|
6230
|
-
endDate?: string;
|
|
6231
|
-
/** @format int32 */
|
|
6232
|
-
pageSize?: number;
|
|
6233
|
-
/** @format int32 */
|
|
6234
|
-
pageNumber?: number;
|
|
6235
|
-
sortBy?: string;
|
|
6236
|
-
sortDirection?: string;
|
|
6237
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
|
|
6091
|
+
setAccountAiEnabled: (accountId: string, data: SetAiEnabledRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6238
6092
|
/**
|
|
6239
6093
|
* No description
|
|
6240
6094
|
*
|
|
6241
|
-
* @tags
|
|
6242
|
-
* @name
|
|
6243
|
-
* @summary Get AI
|
|
6244
|
-
* @request GET:/api/ai/
|
|
6095
|
+
* @tags AiAccountSettings
|
|
6096
|
+
* @name GetAiAccountSettings
|
|
6097
|
+
* @summary Get account AI settings
|
|
6098
|
+
* @request GET:/api/ai/account-settings
|
|
6245
6099
|
* @secure
|
|
6246
|
-
* @response `200` `
|
|
6100
|
+
* @response `200` `AiAccountSettings` OK
|
|
6247
6101
|
*/
|
|
6248
|
-
|
|
6249
|
-
/** @format date-time */
|
|
6250
|
-
startDate?: string;
|
|
6251
|
-
/** @format date-time */
|
|
6252
|
-
endDate?: string;
|
|
6253
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
|
|
6102
|
+
getAiAccountSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
|
|
6254
6103
|
/**
|
|
6255
6104
|
* No description
|
|
6256
6105
|
*
|
|
6257
|
-
* @tags
|
|
6258
|
-
* @name
|
|
6259
|
-
* @summary
|
|
6260
|
-
* @request
|
|
6106
|
+
* @tags AiAccountSettings
|
|
6107
|
+
* @name UpdateAiAccountSettings
|
|
6108
|
+
* @summary Update account AI settings
|
|
6109
|
+
* @request PUT:/api/ai/account-settings
|
|
6261
6110
|
* @secure
|
|
6262
|
-
* @response `200` `
|
|
6111
|
+
* @response `200` `AiAccountSettings` OK
|
|
6112
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
6263
6113
|
*/
|
|
6264
|
-
|
|
6265
|
-
entityType?: AiConfigEntityType;
|
|
6266
|
-
/** @format uuid */
|
|
6267
|
-
entityId?: string;
|
|
6268
|
-
/** @format uuid */
|
|
6269
|
-
actorUserId?: string;
|
|
6270
|
-
action?: AiConfigChangeAction;
|
|
6271
|
-
/** @format date-time */
|
|
6272
|
-
startDate?: string;
|
|
6273
|
-
/** @format date-time */
|
|
6274
|
-
endDate?: string;
|
|
6275
|
-
/** @format int32 */
|
|
6276
|
-
pageSize?: number;
|
|
6277
|
-
/** @format int32 */
|
|
6278
|
-
pageNumber?: number;
|
|
6279
|
-
sortBy?: string;
|
|
6280
|
-
sortDirection?: string;
|
|
6281
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
|
|
6114
|
+
updateAiAccountSettings: (data: AiAccountSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAccountSettings, any, {}>>;
|
|
6282
6115
|
/**
|
|
6283
6116
|
* No description
|
|
6284
6117
|
*
|
|
6285
6118
|
* @tags AiAdminPrompt
|
|
6286
6119
|
* @name GetAiPrompts
|
|
6287
6120
|
* @summary Get all prompts
|
|
6288
|
-
* @request GET:/api/ai/
|
|
6121
|
+
* @request GET:/api/ai/prompts
|
|
6289
6122
|
* @secure
|
|
6290
6123
|
* @response `200` `(AiPrompt)[]` OK
|
|
6291
6124
|
*/
|
|
@@ -6296,7 +6129,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6296
6129
|
* @tags AiAdminPrompt
|
|
6297
6130
|
* @name CreateAiPrompt
|
|
6298
6131
|
* @summary Create custom prompt
|
|
6299
|
-
* @request POST:/api/ai/
|
|
6132
|
+
* @request POST:/api/ai/prompts
|
|
6300
6133
|
* @secure
|
|
6301
6134
|
* @response `201` `AiPrompt` Created
|
|
6302
6135
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6308,7 +6141,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6308
6141
|
* @tags AiAdminPrompt
|
|
6309
6142
|
* @name GetAiPrompt
|
|
6310
6143
|
* @summary Get prompt by ID
|
|
6311
|
-
* @request GET:/api/ai/
|
|
6144
|
+
* @request GET:/api/ai/prompts/{id}
|
|
6312
6145
|
* @secure
|
|
6313
6146
|
* @response `200` `AiPrompt` OK
|
|
6314
6147
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6320,7 +6153,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6320
6153
|
* @tags AiAdminPrompt
|
|
6321
6154
|
* @name UpdateAiPrompt
|
|
6322
6155
|
* @summary Update prompt
|
|
6323
|
-
* @request PUT:/api/ai/
|
|
6156
|
+
* @request PUT:/api/ai/prompts/{id}
|
|
6324
6157
|
* @secure
|
|
6325
6158
|
* @response `200` `AiPrompt` OK
|
|
6326
6159
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6333,7 +6166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6333
6166
|
* @tags AiAdminPrompt
|
|
6334
6167
|
* @name DeleteAiPrompt
|
|
6335
6168
|
* @summary Delete prompt
|
|
6336
|
-
* @request DELETE:/api/ai/
|
|
6169
|
+
* @request DELETE:/api/ai/prompts/{id}
|
|
6337
6170
|
* @secure
|
|
6338
6171
|
* @response `204` `void` No Content
|
|
6339
6172
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6346,7 +6179,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6346
6179
|
* @tags AiAdminPrompt
|
|
6347
6180
|
* @name ToggleAiPrompt
|
|
6348
6181
|
* @summary Toggle prompt active/inactive
|
|
6349
|
-
* @request PATCH:/api/ai/
|
|
6182
|
+
* @request PATCH:/api/ai/prompts/{id}/toggle
|
|
6350
6183
|
* @secure
|
|
6351
6184
|
* @response `200` `AiPrompt` OK
|
|
6352
6185
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6358,7 +6191,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6358
6191
|
* @tags AiAdminPrompt
|
|
6359
6192
|
* @name GenerateAiSystemPrompt
|
|
6360
6193
|
* @summary Generate a system prompt from description
|
|
6361
|
-
* @request POST:/api/ai/
|
|
6194
|
+
* @request POST:/api/ai/prompts/generate
|
|
6362
6195
|
* @secure
|
|
6363
6196
|
* @response `200` `GenerateSystemPrompt` OK
|
|
6364
6197
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6368,20 +6201,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6368
6201
|
* No description
|
|
6369
6202
|
*
|
|
6370
6203
|
* @tags AiAdminPrompt
|
|
6371
|
-
* @name
|
|
6204
|
+
* @name GetAiSupportedModels
|
|
6372
6205
|
* @summary Get supported LLM models
|
|
6373
|
-
* @request GET:/api/ai/
|
|
6206
|
+
* @request GET:/api/ai/prompts/supported-models
|
|
6374
6207
|
* @secure
|
|
6375
6208
|
* @response `200` `(SupportedModel)[]` OK
|
|
6376
6209
|
*/
|
|
6377
|
-
|
|
6210
|
+
getAiSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
|
|
6378
6211
|
/**
|
|
6379
6212
|
* No description
|
|
6380
6213
|
*
|
|
6381
6214
|
* @tags AiAdminSettings
|
|
6382
6215
|
* @name GetAiAdminSettings
|
|
6383
6216
|
* @summary Get global AI settings
|
|
6384
|
-
* @request GET:/api/ai/
|
|
6217
|
+
* @request GET:/api/ai/settings
|
|
6385
6218
|
* @secure
|
|
6386
6219
|
* @response `200` `AiAdminSettings` OK
|
|
6387
6220
|
*/
|
|
@@ -6392,19 +6225,136 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6392
6225
|
* @tags AiAdminSettings
|
|
6393
6226
|
* @name UpdateAiAdminSettings
|
|
6394
6227
|
* @summary Update global AI settings
|
|
6395
|
-
* @request PUT:/api/ai/
|
|
6228
|
+
* @request PUT:/api/ai/settings
|
|
6396
6229
|
* @secure
|
|
6397
6230
|
* @response `200` `AiAdminSettings` OK
|
|
6398
6231
|
* @response `400` `ProblemDetails` Bad Request
|
|
6399
6232
|
*/
|
|
6400
6233
|
updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
|
|
6234
|
+
/**
|
|
6235
|
+
* No description
|
|
6236
|
+
*
|
|
6237
|
+
* @tags AiAudit
|
|
6238
|
+
* @name GetAiAuditLogs
|
|
6239
|
+
* @summary Get paginated AI audit logs (own account, or any/all accounts for SuperAdmin)
|
|
6240
|
+
* @request GET:/api/ai/audit-logs
|
|
6241
|
+
* @secure
|
|
6242
|
+
* @response `200` `AiAuditLogPaginated` OK
|
|
6243
|
+
*/
|
|
6244
|
+
getAiAuditLogs: (query?: {
|
|
6245
|
+
/** @format uuid */
|
|
6246
|
+
accountId?: string;
|
|
6247
|
+
eventType?: AiAuditEventType;
|
|
6248
|
+
/** @format uuid */
|
|
6249
|
+
requestId?: string;
|
|
6250
|
+
/** @format uuid */
|
|
6251
|
+
userId?: string;
|
|
6252
|
+
/** @format uuid */
|
|
6253
|
+
conversationId?: string;
|
|
6254
|
+
blockedOnly?: boolean;
|
|
6255
|
+
/** @format date-time */
|
|
6256
|
+
startDate?: string;
|
|
6257
|
+
/** @format date-time */
|
|
6258
|
+
endDate?: string;
|
|
6259
|
+
/** @format int32 */
|
|
6260
|
+
pageSize?: number;
|
|
6261
|
+
/** @format int32 */
|
|
6262
|
+
pageNumber?: number;
|
|
6263
|
+
sortBy?: string;
|
|
6264
|
+
sortDirection?: string;
|
|
6265
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
|
|
6266
|
+
/**
|
|
6267
|
+
* No description
|
|
6268
|
+
*
|
|
6269
|
+
* @tags AiAudit
|
|
6270
|
+
* @name GetAiRequestLifecycle
|
|
6271
|
+
* @summary Get the full event lifecycle of a single AI request
|
|
6272
|
+
* @request GET:/api/ai/audit-logs/request/{requestId}
|
|
6273
|
+
* @secure
|
|
6274
|
+
* @response `200` `(AiAuditLog)[]` OK
|
|
6275
|
+
*/
|
|
6276
|
+
getAiRequestLifecycle: (requestId: string, query?: {
|
|
6277
|
+
/** @format uuid */
|
|
6278
|
+
accountId?: string;
|
|
6279
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
|
|
6280
|
+
/**
|
|
6281
|
+
* No description
|
|
6282
|
+
*
|
|
6283
|
+
* @tags AiAudit
|
|
6284
|
+
* @name GetAiAuditConversations
|
|
6285
|
+
* @summary List conversations with their audit roll-up — origin user, turns, status, tokens
|
|
6286
|
+
* @request GET:/api/ai/audit-conversations
|
|
6287
|
+
* @secure
|
|
6288
|
+
* @response `200` `AiConversationAuditSummaryPaginated` OK
|
|
6289
|
+
*/
|
|
6290
|
+
getAiAuditConversations: (query?: {
|
|
6291
|
+
/** @format uuid */
|
|
6292
|
+
accountId?: string;
|
|
6293
|
+
searchText?: string;
|
|
6294
|
+
/** @format date-time */
|
|
6295
|
+
startDate?: string;
|
|
6296
|
+
/** @format date-time */
|
|
6297
|
+
endDate?: string;
|
|
6298
|
+
/** @format int32 */
|
|
6299
|
+
pageSize?: number;
|
|
6300
|
+
/** @format int32 */
|
|
6301
|
+
pageNumber?: number;
|
|
6302
|
+
sortBy?: string;
|
|
6303
|
+
sortDirection?: string;
|
|
6304
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
|
|
6305
|
+
/**
|
|
6306
|
+
* No description
|
|
6307
|
+
*
|
|
6308
|
+
* @tags AiAudit
|
|
6309
|
+
* @name GetAiStats
|
|
6310
|
+
* @summary Get AI dashboard stats (own account, or any/all accounts for SuperAdmin)
|
|
6311
|
+
* @request GET:/api/ai/stats
|
|
6312
|
+
* @secure
|
|
6313
|
+
* @response `200` `AiAdminStats` OK
|
|
6314
|
+
*/
|
|
6315
|
+
getAiStats: (query?: {
|
|
6316
|
+
/** @format uuid */
|
|
6317
|
+
accountId?: string;
|
|
6318
|
+
/** @format date-time */
|
|
6319
|
+
startDate?: string;
|
|
6320
|
+
/** @format date-time */
|
|
6321
|
+
endDate?: string;
|
|
6322
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
|
|
6323
|
+
/**
|
|
6324
|
+
* No description
|
|
6325
|
+
*
|
|
6326
|
+
* @tags AiAudit
|
|
6327
|
+
* @name GetAiConfigChanges
|
|
6328
|
+
* @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
|
|
6329
|
+
* @request GET:/api/ai/config-changes
|
|
6330
|
+
* @secure
|
|
6331
|
+
* @response `200` `AuditLogEntryPaginated` OK
|
|
6332
|
+
*/
|
|
6333
|
+
getAiConfigChanges: (query?: {
|
|
6334
|
+
/** @format uuid */
|
|
6335
|
+
accountId?: string;
|
|
6336
|
+
/** @format uuid */
|
|
6337
|
+
entityId?: string;
|
|
6338
|
+
/** @format uuid */
|
|
6339
|
+
actorUserId?: string;
|
|
6340
|
+
/** @format date-time */
|
|
6341
|
+
startDate?: string;
|
|
6342
|
+
/** @format date-time */
|
|
6343
|
+
endDate?: string;
|
|
6344
|
+
/** @format int32 */
|
|
6345
|
+
pageSize?: number;
|
|
6346
|
+
/** @format int32 */
|
|
6347
|
+
pageNumber?: number;
|
|
6348
|
+
sortBy?: string;
|
|
6349
|
+
sortDirection?: string;
|
|
6350
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntryPaginated, any, {}>>;
|
|
6401
6351
|
/**
|
|
6402
6352
|
* No description
|
|
6403
6353
|
*
|
|
6404
6354
|
* @tags AiCanonicalField
|
|
6405
6355
|
* @name GetAiCanonicalFields
|
|
6406
6356
|
* @summary Get all canonical fields
|
|
6407
|
-
* @request GET:/api/ai/
|
|
6357
|
+
* @request GET:/api/ai/canonical-fields
|
|
6408
6358
|
* @secure
|
|
6409
6359
|
* @response `200` `(AiCanonicalField)[]` OK
|
|
6410
6360
|
*/
|
|
@@ -6415,7 +6365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6415
6365
|
* @tags AiCanonicalField
|
|
6416
6366
|
* @name CreateAiCanonicalField
|
|
6417
6367
|
* @summary Create canonical field
|
|
6418
|
-
* @request POST:/api/ai/
|
|
6368
|
+
* @request POST:/api/ai/canonical-fields
|
|
6419
6369
|
* @secure
|
|
6420
6370
|
* @response `201` `AiCanonicalField` Created
|
|
6421
6371
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6427,7 +6377,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6427
6377
|
* @tags AiCanonicalField
|
|
6428
6378
|
* @name GetAiCanonicalField
|
|
6429
6379
|
* @summary Get canonical field by ID
|
|
6430
|
-
* @request GET:/api/ai/
|
|
6380
|
+
* @request GET:/api/ai/canonical-fields/{id}
|
|
6431
6381
|
* @secure
|
|
6432
6382
|
* @response `200` `AiCanonicalField` OK
|
|
6433
6383
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6439,7 +6389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6439
6389
|
* @tags AiCanonicalField
|
|
6440
6390
|
* @name UpdateAiCanonicalField
|
|
6441
6391
|
* @summary Update canonical field
|
|
6442
|
-
* @request PUT:/api/ai/
|
|
6392
|
+
* @request PUT:/api/ai/canonical-fields/{id}
|
|
6443
6393
|
* @secure
|
|
6444
6394
|
* @response `200` `AiCanonicalField` OK
|
|
6445
6395
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6452,7 +6402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6452
6402
|
* @tags AiCanonicalField
|
|
6453
6403
|
* @name DeleteAiCanonicalField
|
|
6454
6404
|
* @summary Delete canonical field
|
|
6455
|
-
* @request DELETE:/api/ai/
|
|
6405
|
+
* @request DELETE:/api/ai/canonical-fields/{id}
|
|
6456
6406
|
* @secure
|
|
6457
6407
|
* @response `204` `void` No Content
|
|
6458
6408
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6464,7 +6414,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6464
6414
|
* @tags AiCanonicalField
|
|
6465
6415
|
* @name ToggleAiCanonicalField
|
|
6466
6416
|
* @summary Toggle canonical field active/inactive
|
|
6467
|
-
* @request PATCH:/api/ai/
|
|
6417
|
+
* @request PATCH:/api/ai/canonical-fields/{id}/toggle
|
|
6468
6418
|
* @secure
|
|
6469
6419
|
* @response `200` `AiCanonicalField` OK
|
|
6470
6420
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6476,7 +6426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6476
6426
|
* @tags AiChat
|
|
6477
6427
|
* @name AiChat
|
|
6478
6428
|
* @summary Send AI chat message
|
|
6479
|
-
* @request POST:/api/ai/
|
|
6429
|
+
* @request POST:/api/ai/chats
|
|
6480
6430
|
* @secure
|
|
6481
6431
|
* @response `200` `AiChat` OK
|
|
6482
6432
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6500,6 +6450,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6500
6450
|
pageNumber?: number;
|
|
6501
6451
|
sortBy?: string;
|
|
6502
6452
|
sortDirection?: string;
|
|
6453
|
+
/** @format uuid */
|
|
6454
|
+
loanId?: string;
|
|
6503
6455
|
}, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
|
|
6504
6456
|
/**
|
|
6505
6457
|
* No description
|
|
@@ -6593,7 +6545,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6593
6545
|
* @tags AiConversationAdmin
|
|
6594
6546
|
* @name GetAiAccountConversations
|
|
6595
6547
|
* @summary List AI conversations across the account, optionally filtered by user (admin supervision)
|
|
6596
|
-
* @request GET:/api/ai/
|
|
6548
|
+
* @request GET:/api/ai/conversations/all
|
|
6597
6549
|
* @secure
|
|
6598
6550
|
* @response `200` `AiConversationListItemPaginated` OK
|
|
6599
6551
|
*/
|
|
@@ -6613,7 +6565,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6613
6565
|
* @tags AiConversationAdmin
|
|
6614
6566
|
* @name GetAiAccountConversation
|
|
6615
6567
|
* @summary Get an account conversation's detail (admin supervision)
|
|
6616
|
-
* @request GET:/api/ai/
|
|
6568
|
+
* @request GET:/api/ai/conversations/all/{id}
|
|
6617
6569
|
* @secure
|
|
6618
6570
|
* @response `200` `AiConversationDetail` OK
|
|
6619
6571
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6625,7 +6577,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6625
6577
|
* @tags AiConversationAdmin
|
|
6626
6578
|
* @name GetAiAccountConversationMessages
|
|
6627
6579
|
* @summary Get an account conversation's messages (admin supervision)
|
|
6628
|
-
* @request GET:/api/ai/
|
|
6580
|
+
* @request GET:/api/ai/conversations/all/{id}/messages
|
|
6629
6581
|
* @secure
|
|
6630
6582
|
* @response `200` `AiChatMessagePaginated` OK
|
|
6631
6583
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6644,7 +6596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6644
6596
|
* @tags AiGuardrail
|
|
6645
6597
|
* @name GetAiGuardrails
|
|
6646
6598
|
* @summary Get all guardrails
|
|
6647
|
-
* @request GET:/api/ai/
|
|
6599
|
+
* @request GET:/api/ai/guardrails
|
|
6648
6600
|
* @secure
|
|
6649
6601
|
* @response `200` `(AiGuardrail)[]` OK
|
|
6650
6602
|
*/
|
|
@@ -6655,7 +6607,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6655
6607
|
* @tags AiGuardrail
|
|
6656
6608
|
* @name CreateAiGuardrail
|
|
6657
6609
|
* @summary Create custom guardrail
|
|
6658
|
-
* @request POST:/api/ai/
|
|
6610
|
+
* @request POST:/api/ai/guardrails
|
|
6659
6611
|
* @secure
|
|
6660
6612
|
* @response `201` `AiGuardrail` Created
|
|
6661
6613
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6667,7 +6619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6667
6619
|
* @tags AiGuardrail
|
|
6668
6620
|
* @name GetAiGuardrail
|
|
6669
6621
|
* @summary Get guardrail by ID
|
|
6670
|
-
* @request GET:/api/ai/
|
|
6622
|
+
* @request GET:/api/ai/guardrails/{id}
|
|
6671
6623
|
* @secure
|
|
6672
6624
|
* @response `200` `AiGuardrail` OK
|
|
6673
6625
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6679,7 +6631,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6679
6631
|
* @tags AiGuardrail
|
|
6680
6632
|
* @name UpdateAiGuardrail
|
|
6681
6633
|
* @summary Update guardrail
|
|
6682
|
-
* @request PUT:/api/ai/
|
|
6634
|
+
* @request PUT:/api/ai/guardrails/{id}
|
|
6683
6635
|
* @secure
|
|
6684
6636
|
* @response `200` `AiGuardrail` OK
|
|
6685
6637
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6692,7 +6644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6692
6644
|
* @tags AiGuardrail
|
|
6693
6645
|
* @name DeleteAiGuardrail
|
|
6694
6646
|
* @summary Delete guardrail
|
|
6695
|
-
* @request DELETE:/api/ai/
|
|
6647
|
+
* @request DELETE:/api/ai/guardrails/{id}
|
|
6696
6648
|
* @secure
|
|
6697
6649
|
* @response `204` `void` No Content
|
|
6698
6650
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6705,7 +6657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6705
6657
|
* @tags AiGuardrail
|
|
6706
6658
|
* @name ToggleAiGuardrail
|
|
6707
6659
|
* @summary Toggle guardrail enabled/disabled
|
|
6708
|
-
* @request PATCH:/api/ai/
|
|
6660
|
+
* @request PATCH:/api/ai/guardrails/{id}/toggle
|
|
6709
6661
|
* @secure
|
|
6710
6662
|
* @response `200` `AiGuardrail` OK
|
|
6711
6663
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6715,116 +6667,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6715
6667
|
* No description
|
|
6716
6668
|
*
|
|
6717
6669
|
* @tags AiPrompt
|
|
6718
|
-
* @name
|
|
6670
|
+
* @name GetAiAvailablePrompts
|
|
6719
6671
|
* @summary Get available prompts for current user
|
|
6720
|
-
* @request GET:/api/ai/prompts
|
|
6672
|
+
* @request GET:/api/ai/prompts/available
|
|
6721
6673
|
* @secure
|
|
6722
6674
|
* @response `200` `(AiPromptSummary)[]` OK
|
|
6723
6675
|
*/
|
|
6724
|
-
|
|
6676
|
+
getAiAvailablePrompts: (query?: {
|
|
6725
6677
|
documentType?: string;
|
|
6726
6678
|
}, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
|
|
6727
|
-
/**
|
|
6728
|
-
* No description
|
|
6729
|
-
*
|
|
6730
|
-
* @tags AiSuperAdmin
|
|
6731
|
-
* @name GetAiAuditLogsCrossAccount
|
|
6732
|
-
* @summary Get AI audit logs for a specific account or across all accounts
|
|
6733
|
-
* @request GET:/api/ai/superadmin/audit-logs
|
|
6734
|
-
* @secure
|
|
6735
|
-
* @response `200` `AiAuditLogPaginated` OK
|
|
6736
|
-
*/
|
|
6737
|
-
getAiAuditLogsCrossAccount: (query?: {
|
|
6738
|
-
/** @format uuid */
|
|
6739
|
-
accountId?: string;
|
|
6740
|
-
eventType?: AiAuditEventType;
|
|
6741
|
-
/** @format uuid */
|
|
6742
|
-
requestId?: string;
|
|
6743
|
-
/** @format uuid */
|
|
6744
|
-
userId?: string;
|
|
6745
|
-
/** @format uuid */
|
|
6746
|
-
conversationId?: string;
|
|
6747
|
-
blockedOnly?: boolean;
|
|
6748
|
-
/** @format date-time */
|
|
6749
|
-
startDate?: string;
|
|
6750
|
-
/** @format date-time */
|
|
6751
|
-
endDate?: string;
|
|
6752
|
-
/** @format int32 */
|
|
6753
|
-
pageSize?: number;
|
|
6754
|
-
/** @format int32 */
|
|
6755
|
-
pageNumber?: number;
|
|
6756
|
-
sortBy?: string;
|
|
6757
|
-
sortDirection?: string;
|
|
6758
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
|
|
6759
|
-
/**
|
|
6760
|
-
* No description
|
|
6761
|
-
*
|
|
6762
|
-
* @tags AiSuperAdmin
|
|
6763
|
-
* @name GetAiRequestLifecycleCrossAccount
|
|
6764
|
-
* @summary Get the full event lifecycle of a single AI request from any account
|
|
6765
|
-
* @request GET:/api/ai/superadmin/audit-logs/request/{requestId}
|
|
6766
|
-
* @secure
|
|
6767
|
-
* @response `200` `(AiAuditLog)[]` OK
|
|
6768
|
-
*/
|
|
6769
|
-
getAiRequestLifecycleCrossAccount: (requestId: string, query?: {
|
|
6770
|
-
/** @format uuid */
|
|
6771
|
-
accountId?: string;
|
|
6772
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
|
|
6773
|
-
/**
|
|
6774
|
-
* No description
|
|
6775
|
-
*
|
|
6776
|
-
* @tags AiSuperAdmin
|
|
6777
|
-
* @name GetAiStatsCrossAccount
|
|
6778
|
-
* @summary Get AI stats for a specific account or platform-wide
|
|
6779
|
-
* @request GET:/api/ai/superadmin/stats
|
|
6780
|
-
* @secure
|
|
6781
|
-
* @response `200` `AiAdminStats` OK
|
|
6782
|
-
*/
|
|
6783
|
-
getAiStatsCrossAccount: (query?: {
|
|
6784
|
-
/** @format uuid */
|
|
6785
|
-
accountId?: string;
|
|
6786
|
-
/** @format date-time */
|
|
6787
|
-
startDate?: string;
|
|
6788
|
-
/** @format date-time */
|
|
6789
|
-
endDate?: string;
|
|
6790
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
|
|
6791
|
-
/**
|
|
6792
|
-
* No description
|
|
6793
|
-
*
|
|
6794
|
-
* @tags AiSuperAdmin
|
|
6795
|
-
* @name GetAiConfigChangesCrossAccount
|
|
6796
|
-
* @summary Get AI configuration change history for a specific account or across all accounts (incl. global defaults)
|
|
6797
|
-
* @request GET:/api/ai/superadmin/config-changes
|
|
6798
|
-
* @secure
|
|
6799
|
-
* @response `200` `AiConfigChangeLogPaginated` OK
|
|
6800
|
-
*/
|
|
6801
|
-
getAiConfigChangesCrossAccount: (query?: {
|
|
6802
|
-
/** @format uuid */
|
|
6803
|
-
accountId?: string;
|
|
6804
|
-
entityType?: AiConfigEntityType;
|
|
6805
|
-
/** @format uuid */
|
|
6806
|
-
entityId?: string;
|
|
6807
|
-
/** @format uuid */
|
|
6808
|
-
actorUserId?: string;
|
|
6809
|
-
action?: AiConfigChangeAction;
|
|
6810
|
-
/** @format date-time */
|
|
6811
|
-
startDate?: string;
|
|
6812
|
-
/** @format date-time */
|
|
6813
|
-
endDate?: string;
|
|
6814
|
-
/** @format int32 */
|
|
6815
|
-
pageSize?: number;
|
|
6816
|
-
/** @format int32 */
|
|
6817
|
-
pageNumber?: number;
|
|
6818
|
-
sortBy?: string;
|
|
6819
|
-
sortDirection?: string;
|
|
6820
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
|
|
6821
6679
|
/**
|
|
6822
6680
|
* No description
|
|
6823
6681
|
*
|
|
6824
6682
|
* @tags AiTokenUsageAdmin
|
|
6825
6683
|
* @name SearchAiAccountTokenUsage
|
|
6826
6684
|
* @summary Search accounts by current-month AI token usage and classification
|
|
6827
|
-
* @request POST:/api/ai/
|
|
6685
|
+
* @request POST:/api/ai/token-usage/search
|
|
6828
6686
|
* @secure
|
|
6829
6687
|
* @response `200` `AiAccountUsageOverviewPaginated` OK
|
|
6830
6688
|
*/
|
|
@@ -6842,7 +6700,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6842
6700
|
* @tags AiTokenUsageAdmin
|
|
6843
6701
|
* @name GetAiAccountTokenUsage
|
|
6844
6702
|
* @summary Get an account's current-month AI token usage
|
|
6845
|
-
* @request GET:/api/ai/
|
|
6703
|
+
* @request GET:/api/ai/token-usage/{accountId}
|
|
6846
6704
|
* @secure
|
|
6847
6705
|
* @response `200` `AiTokenBudgetStatus` OK
|
|
6848
6706
|
*/
|
|
@@ -6853,7 +6711,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6853
6711
|
* @tags AiTokenUsageAdmin
|
|
6854
6712
|
* @name GetAiAccountTokenUsageHistory
|
|
6855
6713
|
* @summary Get an account's monthly AI token usage history
|
|
6856
|
-
* @request GET:/api/ai/
|
|
6714
|
+
* @request GET:/api/ai/token-usage/{accountId}/history
|
|
6857
6715
|
* @secure
|
|
6858
6716
|
* @response `200` `AiTokenUsageWindowPaginated` OK
|
|
6859
6717
|
*/
|
|
@@ -6871,7 +6729,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6871
6729
|
* @tags AiTokenUsageAdmin
|
|
6872
6730
|
* @name SetAiAccountTokenLimit
|
|
6873
6731
|
* @summary Set or raise an account's monthly AI token limit
|
|
6874
|
-
* @request PUT:/api/ai/
|
|
6732
|
+
* @request PUT:/api/ai/token-usage/{accountId}/limit
|
|
6875
6733
|
* @secure
|
|
6876
6734
|
* @response `200` `AiTokenBudgetStatus` OK
|
|
6877
6735
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6883,7 +6741,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6883
6741
|
* @tags AiUrlSource
|
|
6884
6742
|
* @name GetAiUrlSources
|
|
6885
6743
|
* @summary Get all URL sources
|
|
6886
|
-
* @request GET:/api/ai/
|
|
6744
|
+
* @request GET:/api/ai/url-sources
|
|
6887
6745
|
* @secure
|
|
6888
6746
|
* @response `200` `(AiUrlSource)[]` OK
|
|
6889
6747
|
*/
|
|
@@ -6894,7 +6752,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6894
6752
|
* @tags AiUrlSource
|
|
6895
6753
|
* @name CreateAiUrlSource
|
|
6896
6754
|
* @summary Create URL source
|
|
6897
|
-
* @request POST:/api/ai/
|
|
6755
|
+
* @request POST:/api/ai/url-sources
|
|
6898
6756
|
* @secure
|
|
6899
6757
|
* @response `201` `AiUrlSource` Created
|
|
6900
6758
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6907,7 +6765,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6907
6765
|
* @tags AiUrlSource
|
|
6908
6766
|
* @name GetAiUrlSource
|
|
6909
6767
|
* @summary Get URL source by ID
|
|
6910
|
-
* @request GET:/api/ai/
|
|
6768
|
+
* @request GET:/api/ai/url-sources/{id}
|
|
6911
6769
|
* @secure
|
|
6912
6770
|
* @response `200` `AiUrlSource` OK
|
|
6913
6771
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6919,7 +6777,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6919
6777
|
* @tags AiUrlSource
|
|
6920
6778
|
* @name UpdateAiUrlSource
|
|
6921
6779
|
* @summary Update URL source
|
|
6922
|
-
* @request PUT:/api/ai/
|
|
6780
|
+
* @request PUT:/api/ai/url-sources/{id}
|
|
6923
6781
|
* @secure
|
|
6924
6782
|
* @response `200` `AiUrlSource` OK
|
|
6925
6783
|
* @response `400` `ProblemDetails` Bad Request
|
|
@@ -6933,7 +6791,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6933
6791
|
* @tags AiUrlSource
|
|
6934
6792
|
* @name DeleteAiUrlSource
|
|
6935
6793
|
* @summary Delete URL source
|
|
6936
|
-
* @request DELETE:/api/ai/
|
|
6794
|
+
* @request DELETE:/api/ai/url-sources/{id}
|
|
6937
6795
|
* @secure
|
|
6938
6796
|
* @response `204` `void` No Content
|
|
6939
6797
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -6945,7 +6803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6945
6803
|
* @tags AiUrlSource
|
|
6946
6804
|
* @name ToggleAiUrlSource
|
|
6947
6805
|
* @summary Toggle URL source active/inactive
|
|
6948
|
-
* @request PATCH:/api/ai/
|
|
6806
|
+
* @request PATCH:/api/ai/url-sources/{id}/toggle
|
|
6949
6807
|
* @secure
|
|
6950
6808
|
* @response `200` `AiUrlSource` OK
|
|
6951
6809
|
* @response `404` `ProblemDetails` Not Found
|
|
@@ -7334,12 +7192,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7334
7192
|
*
|
|
7335
7193
|
* @tags ConsumerConnect
|
|
7336
7194
|
* @name RetryConsumerConnectAssociation
|
|
7337
|
-
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
|
|
7195
|
+
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Set force=true to also re-run borrowers already marked Success. Returns per-borrower results; check individual Success fields for partial failures.
|
|
7338
7196
|
* @request POST:/api/loans/{loanId}/consumer-connect/retry
|
|
7339
7197
|
* @secure
|
|
7340
7198
|
* @response `200` `(ConsumerConnectRetry)[]` OK
|
|
7341
7199
|
*/
|
|
7342
|
-
retryConsumerConnectAssociation: (loanId: string,
|
|
7200
|
+
retryConsumerConnectAssociation: (loanId: string, query?: {
|
|
7201
|
+
/** @default false */
|
|
7202
|
+
force?: boolean;
|
|
7203
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ConsumerConnectRetry[], any, {}>>;
|
|
7343
7204
|
/**
|
|
7344
7205
|
* No description
|
|
7345
7206
|
*
|
|
@@ -7504,7 +7365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7504
7365
|
* @response `200` `(CustomFieldDefinition)[]` OK
|
|
7505
7366
|
*/
|
|
7506
7367
|
getCustomFieldDefinitions: (query?: {
|
|
7507
|
-
entityType?:
|
|
7368
|
+
entityType?: "Loan";
|
|
7508
7369
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
|
|
7509
7370
|
/**
|
|
7510
7371
|
* No description
|
|
@@ -7915,6 +7776,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7915
7776
|
sortBy?: string;
|
|
7916
7777
|
sortDirection?: string;
|
|
7917
7778
|
}, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
|
|
7779
|
+
/**
|
|
7780
|
+
* No description
|
|
7781
|
+
*
|
|
7782
|
+
* @tags Encompass Packages
|
|
7783
|
+
* @name GetLoanPackages
|
|
7784
|
+
* @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
|
|
7785
|
+
* @secure
|
|
7786
|
+
* @response `200` `EncompassPackageList` OK
|
|
7787
|
+
* @response `400` `EncompassError` Bad Request
|
|
7788
|
+
* @response `401` `EncompassError` Unauthorized
|
|
7789
|
+
* @response `403` `EncompassError` Forbidden
|
|
7790
|
+
* @response `500` `EncompassError` Internal Server Error
|
|
7791
|
+
*/
|
|
7792
|
+
getLoanPackages: (loanId: string, query?: {
|
|
7793
|
+
status?: string;
|
|
7794
|
+
/**
|
|
7795
|
+
* @format int32
|
|
7796
|
+
* @default 1
|
|
7797
|
+
*/
|
|
7798
|
+
page?: number;
|
|
7799
|
+
/**
|
|
7800
|
+
* @format int32
|
|
7801
|
+
* @default 20
|
|
7802
|
+
*/
|
|
7803
|
+
pageSize?: number;
|
|
7804
|
+
sortBy?: string;
|
|
7805
|
+
sortDirection?: string;
|
|
7806
|
+
}, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
|
|
7918
7807
|
/**
|
|
7919
7808
|
* No description
|
|
7920
7809
|
*
|
|
@@ -8383,17 +8272,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8383
8272
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
8384
8273
|
*/
|
|
8385
8274
|
updateLoanConsent: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
8386
|
-
/**
|
|
8387
|
-
* No description
|
|
8388
|
-
*
|
|
8389
|
-
* @tags LegacyLoan
|
|
8390
|
-
* @name GetTaskDocumentsByLoan
|
|
8391
|
-
* @summary Get Documents
|
|
8392
|
-
* @request GET:/api/los/loan/tasks/documents/{loanID}
|
|
8393
|
-
* @secure
|
|
8394
|
-
* @response `200` `(DocumentData)[]` OK
|
|
8395
|
-
*/
|
|
8396
|
-
getTaskDocumentsByLoan: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentData[], any, {}>>;
|
|
8397
8275
|
/**
|
|
8398
8276
|
* No description
|
|
8399
8277
|
*
|
|
@@ -8999,10 +8877,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8999
8877
|
* @summary Download By ID
|
|
9000
8878
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
9001
8879
|
* @secure
|
|
9002
|
-
* @response `200` `
|
|
8880
|
+
* @response `200` `string` OK
|
|
9003
8881
|
* @response `404` `ProblemDetails` Not Found
|
|
9004
8882
|
*/
|
|
9005
|
-
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<
|
|
8883
|
+
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
9006
8884
|
/**
|
|
9007
8885
|
* No description
|
|
9008
8886
|
*
|
|
@@ -10210,7 +10088,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10210
10088
|
getPartners: (query?: {
|
|
10211
10089
|
showAll?: boolean;
|
|
10212
10090
|
/** @default "Realtor" */
|
|
10213
|
-
role?:
|
|
10091
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
10214
10092
|
/** @format int32 */
|
|
10215
10093
|
pageSize?: number;
|
|
10216
10094
|
/** @format int32 */
|
|
@@ -10388,7 +10266,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10388
10266
|
* @response `200` `File` OK
|
|
10389
10267
|
* @response `404` `ProblemDetails` Not Found
|
|
10390
10268
|
*/
|
|
10391
|
-
getSamlMetadata: (sSoIntegration:
|
|
10269
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10392
10270
|
/**
|
|
10393
10271
|
* No description
|
|
10394
10272
|
*
|
|
@@ -10399,7 +10277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10399
10277
|
* @secure
|
|
10400
10278
|
* @response `200` `File` OK
|
|
10401
10279
|
*/
|
|
10402
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
10280
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10403
10281
|
/**
|
|
10404
10282
|
* No description
|
|
10405
10283
|
*
|