@matech/thebigpos-sdk 3.2.1 → 3.3.0-dev-1625

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  export type VersionStatusType = "Draft" | "Published";
2
2
  export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
3
3
  export type TaskStatus = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
4
+ export type TableKey = "Pipeline";
5
+ export type SortDirection = "Asc" | "Desc";
4
6
  export type SiteTileLocation = "HomePage" | "Dashboard";
5
7
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6
8
  export type SigningMethod = "ConsumerConnect" | "POSF";
@@ -10,7 +12,7 @@ export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
10
12
  export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
11
13
  export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
12
14
  export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
13
- export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
15
+ export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked" | "Skipped";
14
16
  export type LosCredentialHealthStatus = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
15
17
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
16
18
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
@@ -18,6 +20,7 @@ export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
18
20
  export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
19
21
  export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
20
22
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
23
+ export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
21
24
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
22
25
  export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
23
26
  export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
@@ -36,7 +39,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
36
39
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
37
40
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
38
41
  export type LoanMaritalStatus = "Married" | "Separated" | "Single";
39
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
42
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
40
43
  export type LoanLienPosition = "First" | "Subordinate";
41
44
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
42
45
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
@@ -77,6 +80,7 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
77
80
  export type CompanyDocumentSourceType = "File" | "FreeText";
78
81
  export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
79
82
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
83
+ export type BulkLoanTaskOperationType = "SetStatus";
80
84
  export type BranchType = "Mortgage" | "RealEstate";
81
85
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
82
86
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
@@ -92,7 +96,7 @@ export type AiPromptScope = "General" | "LoanSpecific";
92
96
  export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
93
97
  export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
94
98
  export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
95
- export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed";
99
+ export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted";
96
100
  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";
97
101
  export interface ASOSettings {
98
102
  enabled: boolean;
@@ -310,9 +314,11 @@ export interface AffordabilityCalculatorRequest {
310
314
  export interface AiAccountSettings {
311
315
  bedrockModelId: string;
312
316
  isUsingAppDefault: boolean;
317
+ enabledTriggers: string[];
313
318
  }
314
319
  export interface AiAccountSettingsRequest {
315
320
  bedrockModelId?: string | null;
321
+ enabledTriggers?: string[] | null;
316
322
  }
317
323
  export interface AiAccountUsageOverview {
318
324
  /** @format uuid */
@@ -619,6 +625,7 @@ export interface AiPrompt {
619
625
  applicableUrlSourceIds: string[];
620
626
  knowledgeBaseFolderIds: string[];
621
627
  allowedRoles: string[];
628
+ supportedTriggers: string[];
622
629
  systemPrompt: string;
623
630
  /** @format int32 */
624
631
  sortOrder: number;
@@ -640,6 +647,38 @@ export interface AiPrompt {
640
647
  /** @format date-time */
641
648
  updatedAt?: string | null;
642
649
  }
650
+ export interface AiPromptRun {
651
+ /** @format uuid */
652
+ id: string;
653
+ trigger: string;
654
+ /** @format uuid */
655
+ promptId: string;
656
+ promptTitle?: string | null;
657
+ /** @format uuid */
658
+ subjectEntityId?: string | null;
659
+ /** @format uuid */
660
+ loanId?: string | null;
661
+ documentIds: string[];
662
+ status: string;
663
+ errorType?: string | null;
664
+ errorMessage?: string | null;
665
+ result?: AiPromptRunResult | null;
666
+ /** @format date-time */
667
+ createdAt: string;
668
+ /** @format date-time */
669
+ updatedAt?: string | null;
670
+ }
671
+ export interface AiPromptRunFinding {
672
+ severity: string;
673
+ message: string;
674
+ }
675
+ export interface AiPromptRunResult {
676
+ verdict: string;
677
+ findings: AiPromptRunFinding[];
678
+ missingItems: string[];
679
+ /** @format double */
680
+ confidence?: number | null;
681
+ }
643
682
  export interface AiPromptSummary {
644
683
  /** @format uuid */
645
684
  id: string;
@@ -1002,6 +1041,23 @@ export interface BulkCompleteLoanTasks {
1002
1041
  export interface BulkCompleteLoanTasksRequest {
1003
1042
  userLoanTaskIDs: string[];
1004
1043
  }
1044
+ export interface BulkLoanTaskFailure {
1045
+ /** @format uuid */
1046
+ userLoanTaskID: string;
1047
+ taskName: string;
1048
+ errorMessage: string;
1049
+ }
1050
+ export interface BulkLoanTaskOperation {
1051
+ updated: string[];
1052
+ skipped: string[];
1053
+ failed: BulkLoanTaskFailure[];
1054
+ }
1055
+ export interface BulkLoanTaskOperationRequest {
1056
+ userLoanTaskIDs: string[];
1057
+ operation?: BulkLoanTaskOperationType | null;
1058
+ status?: TaskStatus | null;
1059
+ comment?: string | null;
1060
+ }
1005
1061
  export interface BusinessRule {
1006
1062
  /** @format date-time */
1007
1063
  createdAt: string;
@@ -1265,6 +1321,7 @@ export interface CreateAiPromptRequest {
1265
1321
  applicableUrlSourceIds: string[];
1266
1322
  knowledgeBaseFolderIds: string[];
1267
1323
  allowedRoles: string[];
1324
+ supportedTriggers?: string[] | null;
1268
1325
  systemPrompt: string;
1269
1326
  /** @format int32 */
1270
1327
  sortOrder: number;
@@ -1994,7 +2051,6 @@ export interface EncompassWebhookSubscription {
1994
2051
  subscriptionId?: string | null;
1995
2052
  endpoint?: string | null;
1996
2053
  hasSigningKey: boolean;
1997
- isSignatureValidationEnabled: boolean;
1998
2054
  /** @format date-time */
1999
2055
  updatedAt?: string | null;
2000
2056
  }
@@ -2516,6 +2572,7 @@ export interface Loan {
2516
2572
  totalLoanAmount?: number | null;
2517
2573
  fileStarter?: string | null;
2518
2574
  source?: string | null;
2575
+ referrer?: string | null;
2519
2576
  isPOSLoan?: boolean | null;
2520
2577
  /** @format date-time */
2521
2578
  removedFromPosAt?: string | null;
@@ -2547,6 +2604,7 @@ export interface Loan {
2547
2604
  propertyAddress?: Address | null;
2548
2605
  property?: LoanProperty | null;
2549
2606
  financial?: LoanFinancial | null;
2607
+ refinance?: LoanRefinance | null;
2550
2608
  financialTerms?: LoanFinancialTerms | null;
2551
2609
  monthlyPayment?: LoanMonthlyPayment | null;
2552
2610
  costDetails?: LoanCostDetails | null;
@@ -2573,6 +2631,7 @@ export interface LoanApplication {
2573
2631
  startDate?: string | null;
2574
2632
  property?: LoanProperty | null;
2575
2633
  financial?: LoanFinancial | null;
2634
+ refinance?: LoanRefinance | null;
2576
2635
  borrowers: LoanBorrower[];
2577
2636
  nonOwningBorrowers: LoanNonOwningBorrower[];
2578
2637
  }
@@ -2589,6 +2648,7 @@ export interface LoanApplicationRequest {
2589
2648
  companyName?: string | null;
2590
2649
  property?: LoanPropertyRequest | null;
2591
2650
  financial?: LoanFinancialRequest | null;
2651
+ refinance?: LoanRefinanceRequest | null;
2592
2652
  financialTerms?: LoanFinancialTermsRequest | null;
2593
2653
  monthlyPayment?: LoanMonthlyPaymentRequest | null;
2594
2654
  borrowers: LoanBorrowerRequest[];
@@ -2652,6 +2712,7 @@ export interface LoanBorrowerAccountAsset {
2652
2712
  type?: LoanAccountAssetType | null;
2653
2713
  }
2654
2714
  export interface LoanBorrowerAccountAssetRequest {
2715
+ name?: string | null;
2655
2716
  financialInstitution?: string | null;
2656
2717
  /** @format double */
2657
2718
  value?: number | null;
@@ -2870,6 +2931,12 @@ export interface LoanBorrowerEmploymentCurrentGrossIncome {
2870
2931
  /** @format double */
2871
2932
  base?: number | null;
2872
2933
  /** @format double */
2934
+ distributions?: number | null;
2935
+ /** @format int32 */
2936
+ hoursPerWeek?: number | null;
2937
+ /** @format double */
2938
+ hourlyRate?: number | null;
2939
+ /** @format double */
2873
2940
  other?: number | null;
2874
2941
  /** @format double */
2875
2942
  bonus?: number | null;
@@ -3967,6 +4034,48 @@ export interface LoanRecord {
3967
4034
  loanGuid: string;
3968
4035
  loanFields: Record<string, string>;
3969
4036
  }
4037
+ export interface LoanRefinance {
4038
+ /** @format uuid */
4039
+ id?: string | null;
4040
+ /** @format int32 */
4041
+ yearAcquired?: number | null;
4042
+ /** @format double */
4043
+ valueOfLot?: number | null;
4044
+ /** @format double */
4045
+ originalCost?: number | null;
4046
+ /** @format double */
4047
+ existingLiens?: number | null;
4048
+ /** @format double */
4049
+ costOfImprovements?: number | null;
4050
+ purpose?: LoanRefinancePurpose | null;
4051
+ currentLoan?: LoanRefinanceCurrentLoan | null;
4052
+ }
4053
+ export interface LoanRefinanceCurrentLoan {
4054
+ /** @format uuid */
4055
+ id?: string | null;
4056
+ lender?: string | null;
4057
+ /** @format double */
4058
+ interestRate?: number | null;
4059
+ /** @format double */
4060
+ monthlyPayment?: number | null;
4061
+ /** @format double */
4062
+ remainingBalance?: number | null;
4063
+ loanType?: LoanType | null;
4064
+ }
4065
+ export interface LoanRefinanceCurrentLoanRequest {
4066
+ lender?: string | null;
4067
+ /** @format double */
4068
+ interestRate?: number | null;
4069
+ loanType?: LoanType | null;
4070
+ }
4071
+ export interface LoanRefinanceRequest {
4072
+ /** @format double */
4073
+ originalCost?: number | null;
4074
+ /** @format double */
4075
+ existingLiens?: number | null;
4076
+ purpose?: LoanRefinancePurpose | null;
4077
+ currentLoan?: LoanRefinanceCurrentLoanRequest | null;
4078
+ }
3970
4079
  export interface LoanSearchCriteria {
3971
4080
  searchText?: string | null;
3972
4081
  /** @format uuid */
@@ -4863,9 +4972,6 @@ export interface SetPasswordRequest {
4863
4972
  export interface SetSingleCustomFieldValueRequest {
4864
4973
  value?: string | null;
4865
4974
  }
4866
- export interface SetWebhookSignatureValidationRequest {
4867
- enabled: boolean;
4868
- }
4869
4975
  export interface SiteConfiguration {
4870
4976
  /** @format date-time */
4871
4977
  createdAt: string;
@@ -5621,6 +5727,8 @@ export interface Task {
5621
5727
  usedInBusinessRule: boolean;
5622
5728
  willAutocompleteAfterResponse: boolean;
5623
5729
  hasAutoPropagationOnAdd: boolean;
5730
+ /** @format uuid */
5731
+ verificationPromptId?: string | null;
5624
5732
  }
5625
5733
  export interface TaskComment {
5626
5734
  /** @format uuid */
@@ -5661,6 +5769,8 @@ export interface TaskRequest {
5661
5769
  isGlobal: boolean;
5662
5770
  willAutocompleteAfterResponse: boolean;
5663
5771
  hasAutoPropagationOnAdd: boolean;
5772
+ /** @format uuid */
5773
+ verificationPromptId?: string | null;
5664
5774
  }
5665
5775
  export interface TaskSearchCriteria {
5666
5776
  searchText?: string | null;
@@ -5682,6 +5792,8 @@ export interface TaskUpdateRequest {
5682
5792
  willAutocompleteAfterResponse: boolean;
5683
5793
  hasAutoPropagationOnAdd: boolean;
5684
5794
  /** @format uuid */
5795
+ verificationPromptId?: string | null;
5796
+ /** @format uuid */
5685
5797
  id: string;
5686
5798
  }
5687
5799
  export interface TaxRatesRequest {
@@ -5829,6 +5941,7 @@ export interface UpdateAiPromptRequest {
5829
5941
  applicableUrlSourceIds: string[];
5830
5942
  knowledgeBaseFolderIds: string[];
5831
5943
  allowedRoles: string[];
5944
+ supportedTriggers?: string[] | null;
5832
5945
  systemPrompt: string;
5833
5946
  /** @format int32 */
5834
5947
  sortOrder: number;
@@ -6378,6 +6491,19 @@ export interface UserSummary {
6378
6491
  firstName: string;
6379
6492
  lastName: string;
6380
6493
  }
6494
+ export interface UserTableSettings {
6495
+ tableKey: UserTableSettingsTableKeyEnum;
6496
+ hiddenColumnIds: string[];
6497
+ columnOrder: string[];
6498
+ sortColumnId?: string | null;
6499
+ sortDirection?: SortDirection | null;
6500
+ }
6501
+ export interface UserTableSettingsRequest {
6502
+ hiddenColumnIds: string[];
6503
+ columnOrder: string[];
6504
+ sortColumnId?: string | null;
6505
+ sortDirection?: SortDirection | null;
6506
+ }
6381
6507
  export interface VerifyEmailRequest {
6382
6508
  token: string;
6383
6509
  }
@@ -6407,7 +6533,7 @@ export interface Workflow {
6407
6533
  icon: string;
6408
6534
  }
6409
6535
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6410
- export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed";
6536
+ export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted";
6411
6537
  export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
6412
6538
  export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
6413
6539
  export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
@@ -6466,9 +6592,9 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
6466
6592
  export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6467
6593
  export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6468
6594
  export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6469
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6595
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
6470
6596
  export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6471
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack";
6597
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
6472
6598
  export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6473
6599
  export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6474
6600
  export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
@@ -6476,7 +6602,7 @@ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6476
6602
  export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6477
6603
  export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6478
6604
  export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6479
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6605
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked" | "Skipped";
6480
6606
  export type LosSyncOutboundFailuresSearchCriteriaSeverityEnum = "All" | "Failed" | "CompletedWithErrors";
6481
6607
  export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6482
6608
  export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
@@ -6503,9 +6629,8 @@ export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "A
6503
6629
  export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6504
6630
  export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6505
6631
  export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6632
+ export type UserTableSettingsTableKeyEnum = "Pipeline";
6506
6633
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6507
- export type SetEncompassIntegrationWebhookSignatureValidationParamsWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6508
- export type SetEncompassIntegrationWebhookSignatureValidationParamsEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
6509
6634
  /** @default "Realtor" */
6510
6635
  export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6511
6636
  export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
@@ -6513,6 +6638,10 @@ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF"
6513
6638
  export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6514
6639
  export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6515
6640
  export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6641
+ export type GetMyTableSettingsParamsTableKeyEnum = "Pipeline";
6642
+ export type GetMyTableSettingsParamsEnum = "Pipeline";
6643
+ export type UpdateMyTableSettingsParamsTableKeyEnum = "Pipeline";
6644
+ export type UpdateMyTableSettingsParamsEnum = "Pipeline";
6516
6645
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6517
6646
  export type QueryParamsType = Record<string | number, any>;
6518
6647
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6551,7 +6680,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6551
6680
  }
6552
6681
  /**
6553
6682
  * @title The Big POS API
6554
- * @version v3.2.1
6683
+ * @version v3.3.0
6555
6684
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6556
6685
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6557
6686
  */
@@ -7353,14 +7482,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7353
7482
  *
7354
7483
  * @tags AiPrompt
7355
7484
  * @name GetAiAvailablePrompts
7356
- * @summary Get available prompts for current user
7485
+ * @summary Get available prompts for current user, optionally for one trigger surface
7357
7486
  * @request GET:/api/ai/prompts/available
7358
7487
  * @secure
7359
7488
  * @response `200` `(AiPromptSummary)[]` OK
7489
+ * @response `400` `ProblemDetails` Bad Request
7360
7490
  */
7361
7491
  getAiAvailablePrompts: (query?: {
7362
7492
  documentType?: string;
7493
+ trigger?: string;
7363
7494
  }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
7495
+ /**
7496
+ * No description
7497
+ *
7498
+ * @tags AiPromptRun
7499
+ * @name GetAiPromptRuns
7500
+ * @summary Get triggered prompt runs for a subject entity
7501
+ * @request GET:/api/ai/prompt-runs
7502
+ * @secure
7503
+ * @response `200` `(AiPromptRun)[]` OK
7504
+ * @response `400` `ProblemDetails` Bad Request
7505
+ */
7506
+ getAiPromptRuns: (query?: {
7507
+ /** @format uuid */
7508
+ subjectEntityId?: string;
7509
+ }, params?: RequestParams) => Promise<AxiosResponse<AiPromptRun[], any, {}>>;
7364
7510
  /**
7365
7511
  * No description
7366
7512
  *
@@ -9023,21 +9169,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9023
9169
  * @response `403` `ProblemDetails` Forbidden
9024
9170
  */
9025
9171
  getEncompassIntegrationWebhookSubscriptions: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription[], any, {}>>;
9026
- /**
9027
- * No description
9028
- *
9029
- * @tags EncompassIntegrations
9030
- * @name SetEncompassIntegrationWebhookSignatureValidation
9031
- * @summary Turn inbound signature validation on or off for one Encompass webhook subscription (SuperAdmin)
9032
- * @request PUT:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookType}/signature-validation
9033
- * @secure
9034
- * @response `200` `EncompassWebhookSubscription` OK
9035
- * @response `400` `ProblemDetails` Bad Request
9036
- * @response `401` `ProblemDetails` Unauthorized
9037
- * @response `403` `ProblemDetails` Forbidden
9038
- * @response `404` `ProblemDetails` Not Found
9039
- */
9040
- setEncompassIntegrationWebhookSignatureValidation: (accountId: string, webhookType: SetEncompassIntegrationWebhookSignatureValidationParamsEnum, data: SetWebhookSignatureValidationRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassWebhookSubscription, any, {}>>;
9041
9172
  /**
9042
9173
  * No description
9043
9174
  *
@@ -9715,6 +9846,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9715
9846
  * @request POST:/api/listings
9716
9847
  * @secure
9717
9848
  * @response `201` `Listing` Created
9849
+ * @response `403` `ProblemDetails` Forbidden
9718
9850
  */
9719
9851
  createListing: (data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
9720
9852
  /**
@@ -9748,6 +9880,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9748
9880
  * @request PUT:/api/listings/{id}
9749
9881
  * @secure
9750
9882
  * @response `200` `Listing` OK
9883
+ * @response `403` `ProblemDetails` Forbidden
9751
9884
  */
9752
9885
  replaceListing: (id: string, data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
9753
9886
  /**
@@ -10716,6 +10849,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10716
10849
  * @response `403` `ProblemDetails` Forbidden
10717
10850
  * @response `404` `ProblemDetails` Not Found
10718
10851
  * @response `409` `any` Conflict
10852
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10719
10853
  */
10720
10854
  updateLoan: (loanId: string, data: LoanPatchRequestGuidPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
10721
10855
  /**
@@ -10793,12 +10927,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10793
10927
  */
10794
10928
  triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}>>;
10795
10929
  /**
10796
- * No description
10930
+ * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
10797
10931
  *
10798
10932
  * @tags LoanTaskBulkCompletions
10799
10933
  * @name BulkCompleteLoanTasks
10800
- * @summary Bulk complete loan tasks
10934
+ * @summary [Deprecated] Bulk complete loan tasks
10801
10935
  * @request POST:/api/loans/{loanID}/tasks/bulk-complete
10936
+ * @deprecated
10802
10937
  * @secure
10803
10938
  * @response `200` `BulkCompleteLoanTasks` OK
10804
10939
  * @response `404` `ProblemDetails` Not Found
@@ -10950,6 +11085,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10950
11085
  * @response `422` `UnprocessableEntity` Unprocessable Content
10951
11086
  */
10952
11087
  searchLoanTasksSummary: (data: LoanTaskSearchRequest, params?: RequestParams) => Promise<AxiosResponse<LoanTaskStatusSummary[], any, {}>>;
11088
+ /**
11089
+ * @description Applies one operation to tasks that may span several loans, grouping them by loan server-side and returning flat per-task buckets
11090
+ *
11091
+ * @tags LoanTasks
11092
+ * @name BulkLoanTaskOperation
11093
+ * @summary Bulk task operation
11094
+ * @request POST:/api/loans/tasks/bulk
11095
+ * @secure
11096
+ * @response `200` `BulkLoanTaskOperation` OK
11097
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11098
+ */
11099
+ bulkLoanTaskOperation: (data: BulkLoanTaskOperationRequest, params?: RequestParams) => Promise<AxiosResponse<BulkLoanTaskOperation, any, {}>>;
10953
11100
  /**
10954
11101
  * No description
10955
11102
  *
@@ -12007,7 +12154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12007
12154
  *
12008
12155
  * @tags TheBigPOS
12009
12156
  * @name GetEncompassCredentials
12010
- * @summary Get Encompass Credentials for the current account
12157
+ * @summary Get Encompass Credentials for the active site's account
12011
12158
  * @request GET:/api/los/encompass/credentials
12012
12159
  * @secure
12013
12160
  * @response `200` `EncompassCredentialsDetail` OK
@@ -12019,7 +12166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12019
12166
  *
12020
12167
  * @tags TheBigPOS
12021
12168
  * @name CreateEncompassCredentials
12022
- * @summary Create Encompass Credentials for the current account
12169
+ * @summary Create Encompass Credentials for the active site's account
12023
12170
  * @request POST:/api/los/encompass/credentials
12024
12171
  * @secure
12025
12172
  * @response `201` `LosCredentials` Created
@@ -12030,7 +12177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12030
12177
  *
12031
12178
  * @tags TheBigPOS
12032
12179
  * @name UpdateEncompassCredentials
12033
- * @summary Update Encompass Credentials for the current account
12180
+ * @summary Update Encompass Credentials for the active site's account
12034
12181
  * @request PUT:/api/los/encompass/credentials
12035
12182
  * @secure
12036
12183
  * @response `200` `EncompassCredentialsDetail` OK
@@ -12796,6 +12943,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12796
12943
  * @response `401` `ProblemDetails` Unauthorized
12797
12944
  */
12798
12945
  getMyFeatureFlags: (params?: RequestParams) => Promise<AxiosResponse<Record<string, boolean>, any, {}>>;
12946
+ /**
12947
+ * No description
12948
+ *
12949
+ * @tags UsersMe
12950
+ * @name GetMyTableSettings
12951
+ * @summary Get Table Settings
12952
+ * @request GET:/api/users/me/table-settings/{tableKey}
12953
+ * @secure
12954
+ * @response `200` `UserTableSettings` OK
12955
+ * @response `401` `ProblemDetails` Unauthorized
12956
+ */
12957
+ getMyTableSettings: (tableKey: GetMyTableSettingsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<UserTableSettings, any, {}>>;
12958
+ /**
12959
+ * No description
12960
+ *
12961
+ * @tags UsersMe
12962
+ * @name UpdateMyTableSettings
12963
+ * @summary Update Table Settings
12964
+ * @request PUT:/api/users/me/table-settings/{tableKey}
12965
+ * @secure
12966
+ * @response `200` `UserTableSettings` OK
12967
+ * @response `401` `ProblemDetails` Unauthorized
12968
+ */
12969
+ updateMyTableSettings: (tableKey: UpdateMyTableSettingsParamsEnum, data: UserTableSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<UserTableSettings, any, {}>>;
12799
12970
  /**
12800
12971
  * @description Update the phone number If changed will send a verification code to the new number
12801
12972
  *