@matech/thebigpos-sdk 2.44.1-rc1 → 2.44.2-ai-bi

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
@@ -28,7 +28,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
28
28
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
29
29
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
30
30
  export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
31
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
31
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
32
32
  export type LoanLienPosition = "First" | "Subordinate";
33
33
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
34
34
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
@@ -41,6 +41,7 @@ export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other
41
41
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
42
42
  export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
43
43
  export type LoanGenderType = "Male" | "Female";
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" | "HoaStatement" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other";
44
45
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
45
46
  export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
46
47
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
@@ -62,12 +63,25 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
62
63
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
63
64
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
64
65
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
66
+ export type ClassificationSource = "Textract" | "Llm" | "Manual";
65
67
  export type BranchType = "Mortgage" | "RealEstate";
66
68
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
67
69
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
68
70
  export type BorrowerApplicationStatus = "Draft" | "Complete";
69
71
  export type BillingType = "ClosedLoan" | "LoanOfficer";
70
72
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
73
+ export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
74
+ export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
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";
77
+ export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
78
+ export type AiOutputType = "Text" | "Document";
79
+ export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
80
+ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
81
+ export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
82
+ export type AiConfigEntityType = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings";
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";
71
85
  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";
72
86
  export interface ASOSettings {
73
87
  enabled: boolean;
@@ -118,7 +132,7 @@ export interface AccountBilling {
118
132
  contractedRate: number;
119
133
  }
120
134
  export interface AccountBillingRequest {
121
- billingType: AccountBillingRequestBillingTypeEnum;
135
+ billingType: "ClosedLoan" | "LoanOfficer";
122
136
  /** @format double */
123
137
  contractedRate: number;
124
138
  }
@@ -147,11 +161,13 @@ export interface AccountSettings {
147
161
  smsNumber?: string | null;
148
162
  ssoHostOverride?: string | null;
149
163
  isEarlyAdopter: boolean;
164
+ isAIEnabled: boolean;
150
165
  }
151
166
  export interface AccountSettingsRequest {
152
167
  isSmsEnabled: boolean;
153
168
  smsNumber?: string | null;
154
169
  isEarlyAdopter: boolean;
170
+ isAIEnabled: boolean;
155
171
  }
156
172
  export interface Action {
157
173
  /** @format uuid */
@@ -160,7 +176,7 @@ export interface Action {
160
176
  comments?: string | null;
161
177
  /** @format uuid */
162
178
  siteConfigurationID: string;
163
- applicationSettings?: any | null;
179
+ applicationSettings?: any;
164
180
  surveysToken?: string | null;
165
181
  }
166
182
  export interface Address {
@@ -295,6 +311,397 @@ export interface AffordabilityCalculatorRequest {
295
311
  /** @format double */
296
312
  annualInsurance: number;
297
313
  }
314
+ export interface AiAccountUsageOverview {
315
+ /** @format uuid */
316
+ accountId: string;
317
+ accountName: string;
318
+ /** @format int32 */
319
+ limit: number;
320
+ /** @format int64 */
321
+ used: number;
322
+ /** @format int64 */
323
+ remaining: number;
324
+ /** @format double */
325
+ percentUsed: number;
326
+ limitReached: boolean;
327
+ /** @format date-time */
328
+ windowStart: string;
329
+ /** @format date-time */
330
+ windowEnd: string;
331
+ }
332
+ export interface AiAccountUsageOverviewPaginated {
333
+ rows: AiAccountUsageOverview[];
334
+ pagination: Pagination;
335
+ /** @format int64 */
336
+ count: number;
337
+ }
338
+ export interface AiAdminSettings {
339
+ bedrockModelId: string;
340
+ /** @format int32 */
341
+ maxTokens: number;
342
+ /** @format double */
343
+ temperature: number;
344
+ /** @format int32 */
345
+ conversationContextTurns: number;
346
+ /** @format int32 */
347
+ requestTimeoutSeconds: number;
348
+ /** @format int32 */
349
+ defaultTokenLimit: number;
350
+ bedrockRegion: string;
351
+ }
352
+ export interface AiAdminSettingsRequest {
353
+ bedrockModelId?: string | null;
354
+ /** @format int32 */
355
+ maxTokens?: number | null;
356
+ /** @format double */
357
+ temperature?: number | null;
358
+ /** @format int32 */
359
+ conversationContextTurns?: number | null;
360
+ /** @format int32 */
361
+ requestTimeoutSeconds?: number | null;
362
+ /** @format int32 */
363
+ defaultTokenLimit?: number | null;
364
+ }
365
+ export interface AiAdminStats {
366
+ /** @format int32 */
367
+ totalRequests: number;
368
+ /** @format int32 */
369
+ blockedRequests: number;
370
+ /** @format double */
371
+ averageResponseTimeMs: number;
372
+ /** @format int32 */
373
+ totalInputTokens: number;
374
+ /** @format int32 */
375
+ totalOutputTokens: number;
376
+ /** @format int32 */
377
+ totalTokens: number;
378
+ intentDistribution: Record<string, number>;
379
+ topQueryTemplates: Record<string, number>;
380
+ period: string;
381
+ }
382
+ export interface AiAuditLog {
383
+ /** @format uuid */
384
+ id: string;
385
+ /** @format uuid */
386
+ requestId: string;
387
+ /** @format uuid */
388
+ userId: string;
389
+ /** @format uuid */
390
+ conversationId?: string | null;
391
+ /** @format uuid */
392
+ messageId?: string | null;
393
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
394
+ modelId?: string | null;
395
+ /** @format int32 */
396
+ inputTokens?: number | null;
397
+ /** @format int32 */
398
+ outputTokens?: number | null;
399
+ /** @format int32 */
400
+ latencyMs?: number | null;
401
+ bedrockRequestId?: string | null;
402
+ guardrailName?: string | null;
403
+ guardrailCategory?: string | null;
404
+ rawRequest?: string | null;
405
+ rawResponse?: string | null;
406
+ details?: any;
407
+ /** @format date-time */
408
+ createdAt: string;
409
+ }
410
+ export interface AiAuditLogPaginated {
411
+ rows: AiAuditLog[];
412
+ pagination: Pagination;
413
+ /** @format int64 */
414
+ count: number;
415
+ }
416
+ export interface AiCanonicalField {
417
+ /** @format uuid */
418
+ id: string;
419
+ canonicalName: string;
420
+ displayName: string;
421
+ description: string;
422
+ allowedRoles: string[];
423
+ efPath?: string | null;
424
+ isPii: boolean;
425
+ isActive: boolean;
426
+ dataSource: string;
427
+ isDefault: boolean;
428
+ category?: string | null;
429
+ jsonPropertyName?: string | null;
430
+ textractKey?: string | null;
431
+ textractKeyAliases: string[];
432
+ hasAccountOverride: boolean;
433
+ /** @format date-time */
434
+ createdAt: string;
435
+ /** @format date-time */
436
+ updatedAt?: string | null;
437
+ }
438
+ export interface AiChat {
439
+ /** @format uuid */
440
+ conversationId: string;
441
+ /** @format uuid */
442
+ messageId: string;
443
+ response: AiChatBody;
444
+ metadata: AiChatMetadata;
445
+ }
446
+ export interface AiChatBody {
447
+ text: string;
448
+ data?: AiChatStructuredData | null;
449
+ }
450
+ export interface AiChatMessage {
451
+ /** @format uuid */
452
+ id: string;
453
+ userMessage: string;
454
+ assistantResponse: string;
455
+ intent?: AiIntent | null;
456
+ fieldsAccessed?: string[] | null;
457
+ data?: AiChatStructuredData | null;
458
+ /** @format date-time */
459
+ createdAt: string;
460
+ }
461
+ export interface AiChatMessagePaginated {
462
+ rows: AiChatMessage[];
463
+ pagination: Pagination;
464
+ /** @format int64 */
465
+ count: number;
466
+ }
467
+ export interface AiChatMetadata {
468
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
469
+ fieldsAccessed: string[];
470
+ /** @format int64 */
471
+ queryTimeMs: number;
472
+ /** @format int64 */
473
+ llmTimeMs: number;
474
+ /** @format int32 */
475
+ inputTokens: number;
476
+ /** @format int32 */
477
+ outputTokens: number;
478
+ modelId?: string | null;
479
+ wasBlocked: boolean;
480
+ blockedReason?: string | null;
481
+ tokenBudget?: AiTokenBudgetStatus | null;
482
+ }
483
+ export interface AiChatRequest {
484
+ message: string;
485
+ /** @format uuid */
486
+ conversationId?: string | null;
487
+ /** @format uuid */
488
+ loanId?: string | null;
489
+ documentIds?: string[] | null;
490
+ /** @format uuid */
491
+ promptId?: string | null;
492
+ }
493
+ export interface AiChatStructuredData {
494
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
495
+ displayHint?: AiDisplayHint | null;
496
+ detectedDocumentType?: string | null;
497
+ columns: string[];
498
+ rows: string[][];
499
+ /** @format uuid */
500
+ generatedDocumentId?: string | null;
501
+ generatedFileName?: string | null;
502
+ }
503
+ export interface AiConfigChangeLog {
504
+ /** @format uuid */
505
+ id: string;
506
+ /** @format uuid */
507
+ accountId?: string | null;
508
+ /** @format uuid */
509
+ actorUserId: string;
510
+ entityType: "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings";
511
+ /** @format uuid */
512
+ entityId?: string | null;
513
+ action: "Created" | "Updated" | "Deleted" | "Toggled";
514
+ before?: any;
515
+ after?: any;
516
+ /** @format date-time */
517
+ createdAt: string;
518
+ }
519
+ export interface AiConfigChangeLogPaginated {
520
+ rows: AiConfigChangeLog[];
521
+ pagination: Pagination;
522
+ /** @format int64 */
523
+ count: number;
524
+ }
525
+ export interface AiConversationAuditSummary {
526
+ /** @format uuid */
527
+ conversationId: string;
528
+ /** @format uuid */
529
+ userId: string;
530
+ userName?: string | null;
531
+ userRole?: string | null;
532
+ name?: string | null;
533
+ /** @format int32 */
534
+ turnCount: number;
535
+ /** @format int32 */
536
+ completedCount: number;
537
+ /** @format int32 */
538
+ blockedCount: number;
539
+ /** @format int32 */
540
+ errorCount: number;
541
+ /** @format int32 */
542
+ totalTokens: number;
543
+ /** @format date-time */
544
+ lastActivityAt: string;
545
+ }
546
+ export interface AiConversationAuditSummaryPaginated {
547
+ rows: AiConversationAuditSummary[];
548
+ pagination: Pagination;
549
+ /** @format int64 */
550
+ count: number;
551
+ }
552
+ export interface AiConversationDetail {
553
+ /** @format uuid */
554
+ id: string;
555
+ name?: string | null;
556
+ isPinned: boolean;
557
+ /** @format date-time */
558
+ createdAt: string;
559
+ /** @format date-time */
560
+ updatedAt?: string | null;
561
+ /** @format int32 */
562
+ messageCount: number;
563
+ }
564
+ export interface AiConversationListItem {
565
+ /** @format uuid */
566
+ id: string;
567
+ /** @format uuid */
568
+ userId: string;
569
+ name?: string | null;
570
+ preview: string;
571
+ /** @format int32 */
572
+ messageCount: number;
573
+ isPinned: boolean;
574
+ /** @format date-time */
575
+ createdAt: string;
576
+ /** @format date-time */
577
+ updatedAt?: string | null;
578
+ }
579
+ export interface AiConversationListItemPaginated {
580
+ rows: AiConversationListItem[];
581
+ pagination: Pagination;
582
+ /** @format int64 */
583
+ count: number;
584
+ }
585
+ export interface AiGuardrail {
586
+ /** @format uuid */
587
+ id: string;
588
+ name: string;
589
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
590
+ description?: string | null;
591
+ keywords: string[];
592
+ responseTemplate: string;
593
+ isDefault: boolean;
594
+ isEnabled: boolean;
595
+ hasAccountOverride: boolean;
596
+ /** @format date-time */
597
+ createdAt: string;
598
+ /** @format date-time */
599
+ updatedAt?: string | null;
600
+ }
601
+ export interface AiPrompt {
602
+ /** @format uuid */
603
+ id: string;
604
+ title: string;
605
+ slug?: string | null;
606
+ description: string;
607
+ documentTypes: string[];
608
+ applicableUrlSourceIds: string[];
609
+ allowedRoles: string[];
610
+ systemPrompt: string;
611
+ /** @format int32 */
612
+ sortOrder: number;
613
+ isDefault: boolean;
614
+ /** @format uuid */
615
+ accountId?: string | null;
616
+ isActive: boolean;
617
+ category?: AiPromptCategory | null;
618
+ queryTemplateName?: AiQueryTemplateName | null;
619
+ displayHint?: AiDisplayHint | null;
620
+ bedrockModelId?: string | null;
621
+ requiredDataSources?: string[] | null;
622
+ outputType?: AiOutputType | null;
623
+ hasAccountOverride: boolean;
624
+ /** @format date-time */
625
+ createdAt: string;
626
+ /** @format date-time */
627
+ updatedAt?: string | null;
628
+ }
629
+ export interface AiPromptSummary {
630
+ /** @format uuid */
631
+ id: string;
632
+ title: string;
633
+ slug?: string | null;
634
+ description: string;
635
+ documentTypes: string[];
636
+ applicableUrlSourceIds: string[];
637
+ /** @format int32 */
638
+ sortOrder: number;
639
+ category?: AiPromptCategory | null;
640
+ queryTemplateName?: AiQueryTemplateName | null;
641
+ displayHint?: AiDisplayHint | null;
642
+ bedrockModelId?: string | null;
643
+ requiredDataSources?: string[] | null;
644
+ outputType?: AiOutputType | null;
645
+ }
646
+ export interface AiTokenBudgetStatus {
647
+ /** @format int32 */
648
+ limit: number;
649
+ /** @format int64 */
650
+ used: number;
651
+ /** @format int64 */
652
+ inputTokens: number;
653
+ /** @format int64 */
654
+ outputTokens: number;
655
+ /** @format int64 */
656
+ remaining: number;
657
+ /** @format double */
658
+ percentUsed: number;
659
+ /** @format date-time */
660
+ windowStart: string;
661
+ /** @format date-time */
662
+ windowEnd: string;
663
+ limitReached: boolean;
664
+ }
665
+ export interface AiTokenUsageWindow {
666
+ /** @format date-time */
667
+ windowStart: string;
668
+ /** @format date-time */
669
+ windowEnd: string;
670
+ /** @format int32 */
671
+ limit: number;
672
+ /** @format int64 */
673
+ used: number;
674
+ /** @format int64 */
675
+ inputTokens: number;
676
+ /** @format int64 */
677
+ outputTokens: number;
678
+ /** @format double */
679
+ percentUsed: number;
680
+ limitReached: boolean;
681
+ }
682
+ export interface AiTokenUsageWindowPaginated {
683
+ rows: AiTokenUsageWindow[];
684
+ pagination: Pagination;
685
+ /** @format int64 */
686
+ count: number;
687
+ }
688
+ export interface AiUrlSource {
689
+ /** @format uuid */
690
+ id: string;
691
+ slug?: string | null;
692
+ name: string;
693
+ url: string;
694
+ description?: string | null;
695
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
696
+ scope: "FullDomain" | "SpecificPath";
697
+ isActive: boolean;
698
+ isDefault: boolean;
699
+ hasAccountOverride: boolean;
700
+ /** @format date-time */
701
+ createdAt: string;
702
+ /** @format date-time */
703
+ updatedAt?: string | null;
704
+ }
298
705
  export interface AllowImpersonationRequest {
299
706
  email: string;
300
707
  }
@@ -397,14 +804,14 @@ export interface AuditLogEntry {
397
804
  /** @format uuid */
398
805
  id: string;
399
806
  entityType: string;
400
- changeType: AuditLogEntryChangeTypeEnum;
807
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
401
808
  /** @format uuid */
402
809
  entityId: string;
403
810
  performedBy?: AuditLogUser | null;
404
811
  rootEntityType?: string | null;
405
812
  /** @format uuid */
406
813
  rootEntityId?: string | null;
407
- changes?: any | null;
814
+ changes?: any;
408
815
  /** @format date-time */
409
816
  createdAt: string;
410
817
  }
@@ -444,7 +851,7 @@ export interface BorrowerCount {
444
851
  firstName: string;
445
852
  lastName: string;
446
853
  email: string;
447
- role: BorrowerCountRoleEnum;
854
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
448
855
  /** @format int32 */
449
856
  count: number;
450
857
  }
@@ -454,7 +861,7 @@ export interface BorrowerIdentity {
454
861
  firstName: string;
455
862
  lastName: string;
456
863
  email: string;
457
- role: BorrowerIdentityRoleEnum;
864
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
458
865
  }
459
866
  export interface BorrowersNotUsingPosSummary {
460
867
  /** @format int32 */
@@ -688,7 +1095,7 @@ export interface CorporateSearchCriteria {
688
1095
  isActive?: boolean | null;
689
1096
  }
690
1097
  export interface CreateAccessScopeRequest {
691
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1098
+ scopeType: "User" | "Branch";
692
1099
  /** @format uuid */
693
1100
  userId?: string | null;
694
1101
  /** @format uuid */
@@ -706,10 +1113,49 @@ export interface CreateAccountRequest {
706
1113
  /** @format int64 */
707
1114
  nlmsid: number;
708
1115
  settings: AccountSettingsRequest;
709
- environment: CreateAccountRequestEnvironmentEnum;
1116
+ environment: "Development" | "Staging" | "UAT" | "Production";
710
1117
  losIntegration: LOSIntegration;
711
1118
  billingSettings: AccountBillingRequest;
712
1119
  }
1120
+ export interface CreateAiCanonicalFieldRequest {
1121
+ displayName: string;
1122
+ description: string;
1123
+ allowedRoles: string[];
1124
+ isPii: boolean;
1125
+ dataSource: string;
1126
+ category?: string | null;
1127
+ }
1128
+ export interface CreateAiGuardrailRequest {
1129
+ name: string;
1130
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1131
+ description?: string | null;
1132
+ keywords: string[];
1133
+ responseTemplate: string;
1134
+ }
1135
+ export interface CreateAiPromptRequest {
1136
+ title: string;
1137
+ slug?: string | null;
1138
+ description: string;
1139
+ documentTypes: string[];
1140
+ applicableUrlSourceIds: string[];
1141
+ allowedRoles: string[];
1142
+ systemPrompt: string;
1143
+ /** @format int32 */
1144
+ sortOrder: number;
1145
+ category?: AiPromptCategory | null;
1146
+ queryTemplateName?: AiQueryTemplateName | null;
1147
+ displayHint?: AiDisplayHint | null;
1148
+ bedrockModelId?: string | null;
1149
+ requiredDataSources?: string[] | null;
1150
+ outputType?: AiOutputType | null;
1151
+ }
1152
+ export interface CreateAiUrlSourceRequest {
1153
+ name: string;
1154
+ url: string;
1155
+ description?: string | null;
1156
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1157
+ scope: "FullDomain" | "SpecificPath";
1158
+ }
713
1159
  export interface CreateBranchRequest {
714
1160
  name: string;
715
1161
  /** @format uuid */
@@ -731,8 +1177,8 @@ export interface CreateCustomFieldDefinitionRequest {
731
1177
  name: string;
732
1178
  defaultValue?: string | null;
733
1179
  regexPattern?: string | null;
734
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
735
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1180
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1181
+ entityType: "Loan";
736
1182
  options?: CustomFieldOptionRequest[] | null;
737
1183
  permissions?: CustomFieldPermissionRequest[] | null;
738
1184
  }
@@ -747,7 +1193,7 @@ export interface CreateDocumentTemplateRequest {
747
1193
  export interface CreateGroupMemberRequest {
748
1194
  /** @format uuid */
749
1195
  userId: string;
750
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1196
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
751
1197
  }
752
1198
  export interface CreateInviteRequest {
753
1199
  firstName: string;
@@ -755,7 +1201,7 @@ export interface CreateInviteRequest {
755
1201
  emailAddress: string;
756
1202
  phoneNumber?: string | null;
757
1203
  /** @deprecated */
758
- relationship: CreateInviteRequestRelationshipEnum;
1204
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
759
1205
  loanID: string;
760
1206
  route?: string | null;
761
1207
  /** @format uuid */
@@ -775,7 +1221,7 @@ export interface CreateLoanImportRequest {
775
1221
  endDate: string;
776
1222
  /** @format date-time */
777
1223
  startDate: string;
778
- importMode: CreateLoanImportRequestImportModeEnum;
1224
+ importMode: "All" | "NewOnly" | "UpdateOnly";
779
1225
  }
780
1226
  export interface CreateSession {
781
1227
  sessionId: string;
@@ -793,7 +1239,7 @@ export interface CreateUserDeviceRequest {
793
1239
  token: string;
794
1240
  }
795
1241
  export interface CreateUserDraft {
796
- loanRole: CreateUserDraftLoanRoleEnum;
1242
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
797
1243
  }
798
1244
  export interface CreateUserGroupRequest {
799
1245
  name: string;
@@ -854,8 +1300,8 @@ export interface CustomFieldDefinition {
854
1300
  name: string;
855
1301
  defaultValue?: string | null;
856
1302
  regexPattern?: string | null;
857
- dataType: CustomFieldDefinitionDataTypeEnum;
858
- entityType: CustomFieldDefinitionEntityTypeEnum;
1303
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1304
+ entityType: "Loan";
859
1305
  options: CustomFieldOption[];
860
1306
  permissions: CustomFieldPermission[];
861
1307
  encompassMapping?: EncompassMapping | null;
@@ -869,7 +1315,7 @@ export interface CustomFieldEntry {
869
1315
  displayOrder: number;
870
1316
  name: string;
871
1317
  value: string;
872
- dataType: CustomFieldEntryDataTypeEnum;
1318
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
873
1319
  }
874
1320
  export interface CustomFieldOption {
875
1321
  /** @format uuid */
@@ -886,12 +1332,12 @@ export interface CustomFieldOptionRequest {
886
1332
  export interface CustomFieldPermission {
887
1333
  /** @format uuid */
888
1334
  id: string;
889
- role: CustomFieldPermissionRoleEnum;
890
- accessLevel: CustomFieldPermissionAccessLevelEnum;
1335
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1336
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
891
1337
  }
892
1338
  export interface CustomFieldPermissionRequest {
893
- role: CustomFieldPermissionRequestRoleEnum;
894
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1339
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1340
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
895
1341
  }
896
1342
  export interface CustomFieldValue {
897
1343
  /** @format uuid */
@@ -902,7 +1348,7 @@ export interface CustomFieldValue {
902
1348
  customFieldDefinitionID: string;
903
1349
  value: string;
904
1350
  definitionName: string;
905
- dataType: CustomFieldValueDataTypeEnum;
1351
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
906
1352
  }
907
1353
  export interface DetailedUser {
908
1354
  /** @format date-time */
@@ -1140,7 +1586,7 @@ export interface Draft {
1140
1586
  siteConfiguration: SiteConfigurationReduced;
1141
1587
  /** @format uuid */
1142
1588
  loanID?: string | null;
1143
- type: DraftTypeEnum;
1589
+ type: "NewLoan" | "EditLoan";
1144
1590
  isCoBorrower: boolean;
1145
1591
  }
1146
1592
  export interface DraftContent {
@@ -1158,7 +1604,7 @@ export interface DraftContent {
1158
1604
  siteConfiguration: SiteConfigurationReduced;
1159
1605
  /** @format uuid */
1160
1606
  loanID?: string | null;
1161
- type: DraftContentTypeEnum;
1607
+ type: "NewLoan" | "EditLoan";
1162
1608
  isCoBorrower: boolean;
1163
1609
  applicationPayload: any;
1164
1610
  }
@@ -1174,7 +1620,7 @@ export interface DraftLoanOfficerReassignRequest {
1174
1620
  }
1175
1621
  export interface DraftRequest {
1176
1622
  applicationPayload: any;
1177
- customData?: any | null;
1623
+ customData?: any;
1178
1624
  isCoBorrower: boolean;
1179
1625
  }
1180
1626
  export interface EconsentPendingSummary {
@@ -1248,9 +1694,9 @@ export interface EncompassCredentialsDetail {
1248
1694
  clearStateIfUnlicensed: boolean;
1249
1695
  /** @deprecated */
1250
1696
  baseUrl?: string | null;
1251
- encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1697
+ encompassEnvironment: "Production" | "UAT";
1252
1698
  consumerConnectWidgetHost?: string | null;
1253
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1699
+ signingMethod: "ConsumerConnect" | "POSF";
1254
1700
  subscriptionId?: string | null;
1255
1701
  environment?: string | null;
1256
1702
  }
@@ -1266,9 +1712,9 @@ export interface EncompassCredentialsRequest {
1266
1712
  clearStateIfUnlicensed: boolean;
1267
1713
  /** @deprecated */
1268
1714
  baseUrl?: string | null;
1269
- encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1715
+ encompassEnvironment: "Production" | "UAT";
1270
1716
  consumerConnectWidgetHost?: string | null;
1271
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1717
+ signingMethod: "ConsumerConnect" | "POSF";
1272
1718
  subscriptionId?: string | null;
1273
1719
  environment?: string | null;
1274
1720
  clientID?: string | null;
@@ -1377,8 +1823,8 @@ export interface EncompassRequestLog {
1377
1823
  losId?: string | null;
1378
1824
  /** @format uuid */
1379
1825
  accountId: string;
1380
- operationType: EncompassRequestLogOperationTypeEnum;
1381
- outcome: EncompassRequestLogOutcomeEnum;
1826
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1827
+ outcome: "Success" | "Failure" | "PartialSuccess";
1382
1828
  message: string;
1383
1829
  endpoint?: string | null;
1384
1830
  httpMethod?: string | null;
@@ -1386,7 +1832,7 @@ export interface EncompassRequestLog {
1386
1832
  httpStatusCode?: number | null;
1387
1833
  /** @format int64 */
1388
1834
  durationMs?: number | null;
1389
- context?: any | null;
1835
+ context?: any;
1390
1836
  /** @format date-time */
1391
1837
  createdAt: string;
1392
1838
  }
@@ -1425,7 +1871,7 @@ export interface FileSearchCriteria {
1425
1871
  export interface FileWithBytes {
1426
1872
  name: string;
1427
1873
  /** @format byte */
1428
- data: Blob;
1874
+ data: string;
1429
1875
  fileName: string;
1430
1876
  mimeType?: string | null;
1431
1877
  extension?: string | null;
@@ -1501,7 +1947,7 @@ export interface FormSubmission {
1501
1947
  subjectPropertyAddressCounty?: string | null;
1502
1948
  subjectPropertyAddressState?: string | null;
1503
1949
  subjectPropertyAddressZip?: string | null;
1504
- data?: any | null;
1950
+ data?: any;
1505
1951
  /** @format uuid */
1506
1952
  listingID?: string | null;
1507
1953
  listing?: Listing | null;
@@ -1536,7 +1982,7 @@ export interface FormSubmissionRequest {
1536
1982
  subjectPropertyAddressCounty?: string | null;
1537
1983
  subjectPropertyAddressState?: string | null;
1538
1984
  subjectPropertyAddressZip?: string | null;
1539
- data?: any | null;
1985
+ data?: any;
1540
1986
  /** @format uuid */
1541
1987
  listingID?: string | null;
1542
1988
  }
@@ -1585,7 +2031,7 @@ export interface FusionFieldDisplay {
1585
2031
  fieldValue: string;
1586
2032
  }
1587
2033
  export interface FusionReportFilter {
1588
- filterType: FusionReportFilterFilterTypeEnum;
2034
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1589
2035
  targetField: string;
1590
2036
  targetValue: string;
1591
2037
  }
@@ -1602,6 +2048,13 @@ export interface GenerateDocumentRequest {
1602
2048
  preview: boolean;
1603
2049
  recipients: string[];
1604
2050
  }
2051
+ export interface GenerateSystemPrompt {
2052
+ systemPrompt: string;
2053
+ }
2054
+ export interface GenerateSystemPromptRequest {
2055
+ description: string;
2056
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2057
+ }
1605
2058
  export interface GetApplications {
1606
2059
  applications: ApplicationRowData[];
1607
2060
  }
@@ -1684,11 +2137,11 @@ export interface GetWorkflowRequest {
1684
2137
  export interface GuidPatchOperation {
1685
2138
  op: string;
1686
2139
  path: string;
1687
- value?: any | null;
2140
+ value?: any;
1688
2141
  from?: string | null;
1689
2142
  }
1690
2143
  export interface IPAddress {
1691
- addressFamily: IpAddressAddressFamilyEnum;
2144
+ 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";
1692
2145
  /** @format int64 */
1693
2146
  scopeId: number;
1694
2147
  isIPv6Multicast: boolean;
@@ -1935,7 +2388,7 @@ export interface Loan {
1935
2388
  contacts: LoanContact[];
1936
2389
  customFields: CustomFieldEntry[];
1937
2390
  milestones: LoanMilestone[];
1938
- signingMethod: LoanSigningMethodEnum;
2391
+ signingMethod: "ConsumerConnect" | "POSF";
1939
2392
  }
1940
2393
  export interface LoanApplication {
1941
2394
  /** @format uuid */
@@ -1971,7 +2424,7 @@ export interface LoanApplicationRequest {
1971
2424
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
1972
2425
  /** @format uuid */
1973
2426
  draftId?: string | null;
1974
- additionalFields?: Record<string, any> | null;
2427
+ additionalFields?: Record<string, any>;
1975
2428
  /** @format uuid */
1976
2429
  existingLoanId?: string | null;
1977
2430
  }
@@ -1990,7 +2443,7 @@ export interface LoanBorrower {
1990
2443
  citizenship?: LoanCitizenship | null;
1991
2444
  maritalStatus?: LoanMaritalStatus | null;
1992
2445
  languagePreference?: LoanLanguagePreference | null;
1993
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2446
+ applicationStatus: "Draft" | "Complete";
1994
2447
  /** @format int32 */
1995
2448
  numberOfDependents?: number | null;
1996
2449
  isPrimaryBorrower: boolean;
@@ -2692,7 +3145,7 @@ export interface LoanConsentRequest {
2692
3145
  borrowerEConsent?: boolean | null;
2693
3146
  borrowerCreditAuth?: boolean | null;
2694
3147
  borrowerTCPAOptIn?: boolean | null;
2695
- additionalFields?: Record<string, string> | null;
3148
+ additionalFields?: Record<string, string>;
2696
3149
  }
2697
3150
  export interface LoanContact {
2698
3151
  /** @format date-time */
@@ -2710,13 +3163,13 @@ export interface LoanContact {
2710
3163
  email?: string | null;
2711
3164
  phone?: string | null;
2712
3165
  companyName?: string | null;
2713
- role: LoanContactRoleEnum;
3166
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2714
3167
  }
2715
3168
  export interface LoanContactList {
2716
3169
  email: string;
2717
3170
  }
2718
3171
  export interface LoanCustomFieldsRequest {
2719
- additionalFields?: Record<string, string> | null;
3172
+ additionalFields?: Record<string, string>;
2720
3173
  }
2721
3174
  export interface LoanDocument {
2722
3175
  /** @format date-time */
@@ -2737,6 +3190,13 @@ export interface LoanDocument {
2737
3190
  failoverDocumentPath?: string | null;
2738
3191
  /** @format date-time */
2739
3192
  sensitiveDataPurgedOn?: string | null;
3193
+ observedDocumentType?: LoanDocumentType | null;
3194
+ classificationSource?: ClassificationSource | null;
3195
+ verified: boolean;
3196
+ /** @format date-time */
3197
+ classifiedAt?: string | null;
3198
+ classificationMismatch: boolean;
3199
+ classificationMismatchReason?: string | null;
2740
3200
  }
2741
3201
  export interface LoanDocumentFolder {
2742
3202
  /** @format uuid */
@@ -2759,12 +3219,12 @@ export interface LoanDocumentFolderPermission {
2759
3219
  id: string;
2760
3220
  /** @format uuid */
2761
3221
  loanDocumentFolderID: string;
2762
- role: LoanDocumentFolderPermissionRoleEnum;
2763
- level: LoanDocumentFolderPermissionLevelEnum;
3222
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3223
+ level: "None" | "Read" | "Write" | "Manage";
2764
3224
  }
2765
3225
  export interface LoanDocumentFolderPermissionRequest {
2766
- role: LoanDocumentFolderPermissionRequestRoleEnum;
2767
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3226
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3227
+ level: "None" | "Read" | "Write" | "Manage";
2768
3228
  }
2769
3229
  export interface LoanDocumentFolderUsage {
2770
3230
  /** @format uuid */
@@ -2880,13 +3340,13 @@ export interface LoanImport {
2880
3340
  /** @format int32 */
2881
3341
  importedCount: number;
2882
3342
  statusMessage?: string | null;
2883
- status: LoanImportStatusEnum;
2884
- importMode: LoanImportImportModeEnum;
3343
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3344
+ importMode: "All" | "NewOnly" | "UpdateOnly";
2885
3345
  /** @format date-time */
2886
3346
  createdAt?: string | null;
2887
3347
  }
2888
3348
  export interface LoanImportLog {
2889
- level: LoanImportLogLevelEnum;
3349
+ level: "None" | "Info" | "Warning" | "Error";
2890
3350
  message: string;
2891
3351
  /** @format date-time */
2892
3352
  createdAt: string;
@@ -2941,8 +3401,8 @@ export interface LoanListPaginated {
2941
3401
  export interface LoanLog {
2942
3402
  /** @format uuid */
2943
3403
  id: string;
2944
- level: LoanLogLevelEnum;
2945
- type: LoanLogTypeEnum;
3404
+ level: "None" | "Info" | "Warning" | "Error";
3405
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
2946
3406
  message: string;
2947
3407
  /** @format date-time */
2948
3408
  createdAt: string;
@@ -2950,8 +3410,8 @@ export interface LoanLog {
2950
3410
  export interface LoanLogDetail {
2951
3411
  /** @format uuid */
2952
3412
  id: string;
2953
- level: LoanLogDetailLevelEnum;
2954
- type: LoanLogDetailTypeEnum;
3413
+ level: "None" | "Info" | "Warning" | "Error";
3414
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
2955
3415
  message: string;
2956
3416
  /** @format date-time */
2957
3417
  createdAt: string;
@@ -3185,7 +3645,7 @@ export interface LoanQueueWithData {
3185
3645
  user: UserPublic;
3186
3646
  loanOfficer: LoanOfficerPublic;
3187
3647
  siteConfiguration: SiteConfigurationReduced;
3188
- data?: any | null;
3648
+ data?: any;
3189
3649
  }
3190
3650
  export interface LoanRecord {
3191
3651
  loanGuid: string;
@@ -3216,7 +3676,7 @@ export interface LoanTaskSearchRequest {
3216
3676
  loanStatus?: LoanTaskActivityFilter | null;
3217
3677
  }
3218
3678
  export interface LoanTaskStatusSummary {
3219
- status: LoanTaskStatusSummaryStatusEnum;
3679
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3220
3680
  /** @format int32 */
3221
3681
  count: number;
3222
3682
  }
@@ -3228,7 +3688,7 @@ export interface LoanUser {
3228
3688
  email: string;
3229
3689
  phone?: string | null;
3230
3690
  role: string;
3231
- loanRole: LoanUserLoanRoleEnum;
3691
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3232
3692
  isUser: boolean;
3233
3693
  /** @format date-time */
3234
3694
  createdAt: string;
@@ -3261,7 +3721,7 @@ export interface LosOperationTracking {
3261
3721
  operationType: string;
3262
3722
  correlationKey: string;
3263
3723
  lastTriggerSource?: string | null;
3264
- status: LosOperationTrackingStatusEnum;
3724
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3265
3725
  /** @format date-time */
3266
3726
  createdAt: string;
3267
3727
  /** @format date-time */
@@ -3322,7 +3782,7 @@ export interface LosSyncStep {
3322
3782
  /** @format int32 */
3323
3783
  order: number;
3324
3784
  name: string;
3325
- severity: LosSyncStepSeverityEnum;
3785
+ severity: "Success" | "Info" | "Warning" | "Error";
3326
3786
  message: string;
3327
3787
  /** @format date-time */
3328
3788
  atUtc: string;
@@ -3335,6 +3795,9 @@ export interface LosWebhook {
3335
3795
  events: string[];
3336
3796
  enableSubscription: boolean;
3337
3797
  }
3798
+ export interface ManualDocumentClassificationRequest {
3799
+ 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" | "HoaStatement" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other";
3800
+ }
3338
3801
  export interface MdmUser {
3339
3802
  user_email?: string | null;
3340
3803
  user_id?: string | null;
@@ -3412,7 +3875,7 @@ export interface ModuleParameterValue {
3412
3875
  parameterID: string;
3413
3876
  parameterName: string;
3414
3877
  parameterType: string;
3415
- value?: any | null;
3878
+ value?: any;
3416
3879
  isInherited: boolean;
3417
3880
  }
3418
3881
  export interface MonthlyPaymentCalculator {
@@ -3585,7 +4048,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3585
4048
  }
3586
4049
  export interface Operation {
3587
4050
  op?: string;
3588
- value?: object | null;
4051
+ value?: string | number | boolean | null | object;
3589
4052
  path?: string;
3590
4053
  }
3591
4054
  export interface OverridePasswordRequest {
@@ -3630,6 +4093,9 @@ export interface PendingTasksSummary {
3630
4093
  total: number;
3631
4094
  borrowers: BorrowerCount[];
3632
4095
  }
4096
+ export interface PinAiConversationRequest {
4097
+ isPinned: boolean;
4098
+ }
3633
4099
  export interface PostLoanComparisonPdfRequest {
3634
4100
  /** @format uuid */
3635
4101
  siteConfigurationID: string;
@@ -3779,6 +4245,9 @@ export interface RegisterUserRequest {
3779
4245
  /** @format uuid */
3780
4246
  inviteCode?: string | null;
3781
4247
  }
4248
+ export interface RenameAiConversationRequest {
4249
+ name: string;
4250
+ }
3782
4251
  export interface RequestImpersonationRequest {
3783
4252
  email: string;
3784
4253
  }
@@ -3858,9 +4327,8 @@ export interface SSOTokenRequest {
3858
4327
  email: string;
3859
4328
  redirectUri?: string | null;
3860
4329
  }
3861
- export interface SendESignatureReminderRequest {
3862
- /** @format uuid */
3863
- userId: string;
4330
+ export interface SearchCriteria {
4331
+ searchText?: string | null;
3864
4332
  }
3865
4333
  export interface SendForgotPasswordRequest {
3866
4334
  email: string;
@@ -3906,7 +4374,7 @@ export interface SiteConfiguration {
3906
4374
  deletedAt?: string | null;
3907
4375
  /** @format uuid */
3908
4376
  id: string;
3909
- type: SiteConfigurationTypeEnum;
4377
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3910
4378
  /** @format uuid */
3911
4379
  entityID: string;
3912
4380
  /** @format int32 */
@@ -4099,7 +4567,7 @@ export interface SiteConfigurationByUrl {
4099
4567
  deletedAt?: string | null;
4100
4568
  /** @format uuid */
4101
4569
  id: string;
4102
- type: SiteConfigurationByUrlTypeEnum;
4570
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4103
4571
  /** @format uuid */
4104
4572
  entityID: string;
4105
4573
  /** @format int32 */
@@ -4309,7 +4777,7 @@ export interface SiteConfigurationForm {
4309
4777
  export interface SiteConfigurationReduced {
4310
4778
  /** @format uuid */
4311
4779
  id: string;
4312
- type: SiteConfigurationReducedTypeEnum;
4780
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4313
4781
  url?: string | null;
4314
4782
  name: string;
4315
4783
  /** @format int64 */
@@ -4326,7 +4794,7 @@ export interface SiteConfigurationRequest {
4326
4794
  entityID: string;
4327
4795
  /** @format int32 */
4328
4796
  entityType: number;
4329
- type: SiteConfigurationRequestTypeEnum;
4797
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4330
4798
  url: string;
4331
4799
  name: string;
4332
4800
  introduction?: string | null;
@@ -4501,7 +4969,7 @@ export interface SiteConfigurationSearchCriteria {
4501
4969
  export interface SiteConfigurationSummary {
4502
4970
  /** @format uuid */
4503
4971
  id: string;
4504
- type: SiteConfigurationSummaryTypeEnum;
4972
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4505
4973
  url?: string | null;
4506
4974
  name: string;
4507
4975
  /** @format int64 */
@@ -4545,6 +5013,13 @@ export interface SocialSurveyRecord {
4545
5013
  /** @format date-time */
4546
5014
  reviewCompletedTimeStamp?: string | null;
4547
5015
  }
5016
+ export interface SupportedModel {
5017
+ modelId: string;
5018
+ displayName: string;
5019
+ provider: string;
5020
+ description?: string | null;
5021
+ isDefault: boolean;
5022
+ }
4548
5023
  export interface SurveyEmailRequest {
4549
5024
  loanOfficerEmailAddress: string;
4550
5025
  }
@@ -4757,7 +5232,7 @@ export interface UnregisteredBorrower {
4757
5232
  lastName?: string | null;
4758
5233
  fullName?: string | null;
4759
5234
  email?: string | null;
4760
- role: UnregisteredBorrowerRoleEnum;
5235
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
4761
5236
  }
4762
5237
  export interface UpdateAccountRequest {
4763
5238
  name: string;
@@ -4768,6 +5243,47 @@ export interface UpdateAccountRequest {
4768
5243
  asoSettings?: ASOSettings | null;
4769
5244
  settings: AccountSettingsRequest;
4770
5245
  }
5246
+ export interface UpdateAiAccountTokenLimitRequest {
5247
+ /** @format int32 */
5248
+ tokenLimit: number;
5249
+ }
5250
+ export interface UpdateAiCanonicalFieldRequest {
5251
+ displayName: string;
5252
+ description: string;
5253
+ allowedRoles: string[];
5254
+ isPii: boolean;
5255
+ category?: string | null;
5256
+ }
5257
+ export interface UpdateAiGuardrailRequest {
5258
+ name: string;
5259
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5260
+ description?: string | null;
5261
+ keywords: string[];
5262
+ responseTemplate: string;
5263
+ }
5264
+ export interface UpdateAiPromptRequest {
5265
+ title: string;
5266
+ description: string;
5267
+ documentTypes: string[];
5268
+ applicableUrlSourceIds: string[];
5269
+ allowedRoles: string[];
5270
+ systemPrompt: string;
5271
+ /** @format int32 */
5272
+ sortOrder: number;
5273
+ category?: AiPromptCategory | null;
5274
+ queryTemplateName?: AiQueryTemplateName | null;
5275
+ displayHint?: AiDisplayHint | null;
5276
+ bedrockModelId?: string | null;
5277
+ requiredDataSources?: string[] | null;
5278
+ outputType?: AiOutputType | null;
5279
+ }
5280
+ export interface UpdateAiUrlSourceRequest {
5281
+ name: string;
5282
+ url: string;
5283
+ description?: string | null;
5284
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5285
+ scope: "FullDomain" | "SpecificPath";
5286
+ }
4771
5287
  export interface UpdateCustomFieldDefinitionRequest {
4772
5288
  isRequired: boolean;
4773
5289
  /** @format int32 */
@@ -5053,7 +5569,7 @@ export interface UserDevice {
5053
5569
  export interface UserDraft {
5054
5570
  /** @format uuid */
5055
5571
  draftID: string;
5056
- role: UserDraftRoleEnum;
5572
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5057
5573
  user: User;
5058
5574
  }
5059
5575
  export interface UserDraftPaginated {
@@ -5077,7 +5593,7 @@ export interface UserGroupAccessScope {
5077
5593
  id: string;
5078
5594
  /** @format uuid */
5079
5595
  groupId: string;
5080
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5596
+ scopeType: "User" | "Branch";
5081
5597
  /** @format uuid */
5082
5598
  userId?: string | null;
5083
5599
  /** @format uuid */
@@ -5110,7 +5626,7 @@ export interface UserLoan {
5110
5626
  deletedAt?: string | null;
5111
5627
  loanID: string;
5112
5628
  user: User;
5113
- role: UserLoanRoleEnum;
5629
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5114
5630
  /** @format int32 */
5115
5631
  borrowerPair?: number | null;
5116
5632
  /** @format int32 */
@@ -5122,11 +5638,11 @@ export interface UserLoanConsent {
5122
5638
  id: string;
5123
5639
  /** @format uuid */
5124
5640
  userLoanID: string;
5125
- type: UserLoanConsentTypeEnum;
5641
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5126
5642
  providedConsent: boolean;
5127
5643
  source?: ConsentSource | null;
5128
5644
  ipAddress?: string | null;
5129
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5645
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5130
5646
  /** @format date-time */
5131
5647
  createdAt: string;
5132
5648
  /** @format date-time */
@@ -5256,7 +5772,7 @@ export interface UserSummary {
5256
5772
  id: string;
5257
5773
  name?: string | null;
5258
5774
  email?: string | null;
5259
- role: UserSummaryRoleEnum;
5775
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5260
5776
  }
5261
5777
  export interface VerifyPasswordRequest {
5262
5778
  email: string;
@@ -5283,74 +5799,6 @@ export interface Workflow {
5283
5799
  tileSubtitle: string;
5284
5800
  icon: string;
5285
5801
  }
5286
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5287
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5288
- export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5289
- export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5290
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5291
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5292
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5293
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5294
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5295
- /** @deprecated */
5296
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5297
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5298
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5299
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5300
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5301
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5302
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5303
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5304
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5305
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5306
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5307
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5308
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5309
- export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5310
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5311
- export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5312
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5313
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5314
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5315
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5316
- 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";
5317
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5318
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5319
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5320
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5321
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5322
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5323
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5324
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5325
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5326
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5327
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5328
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5329
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5330
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5331
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5332
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5333
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5334
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5335
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5336
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5337
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5338
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5339
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5340
- export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5341
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5342
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5343
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5344
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5345
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5346
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5347
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5348
- /** @default "Realtor" */
5349
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5350
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5351
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5352
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5353
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5354
5802
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5355
5803
  export type QueryParamsType = Record<string | number, any>;
5356
5804
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5373,7 +5821,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5373
5821
  secure?: boolean;
5374
5822
  format?: ResponseType;
5375
5823
  }
5376
- export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5824
+ export declare enum ContentType {
5825
+ JsonPatch = "application/json-patch+json",
5826
+ Json = "application/json",
5827
+ JsonApi = "application/vnd.api+json",
5828
+ FormData = "multipart/form-data",
5829
+ UrlEncoded = "application/x-www-form-urlencoded",
5830
+ Text = "text/plain"
5831
+ }
5377
5832
  export declare class HttpClient<SecurityDataType = unknown> {
5378
5833
  instance: AxiosInstance;
5379
5834
  private securityData;
@@ -5389,7 +5844,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5389
5844
  }
5390
5845
  /**
5391
5846
  * @title The Big POS API
5392
- * @version v2.44.1
5847
+ * @version v2.44.2
5393
5848
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5394
5849
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5395
5850
  */
@@ -5553,16 +6008,825 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5553
6008
  /**
5554
6009
  * No description
5555
6010
  *
5556
- * @tags AuditLog
5557
- * @name SearchAuditLogs
5558
- * @summary Search
5559
- * @request POST:/api/audit-logs/search
6011
+ * @tags AiAdmin
6012
+ * @name GetAiAuditLogs
6013
+ * @summary Get paginated audit logs
6014
+ * @request GET:/api/ai/admin/audit-logs
5560
6015
  * @secure
5561
- * @response `200` `AuditLogEntryPaginated` OK
6016
+ * @response `200` `AiAuditLogPaginated` OK
5562
6017
  */
5563
- searchAuditLogs: (data: AuditLogSearchCriteria, query?: {
5564
- /** @format int32 */
5565
- pageSize?: number;
6018
+ getAiAuditLogs: (query?: {
6019
+ eventType?: AiAuditEventType;
6020
+ /** @format uuid */
6021
+ requestId?: string;
6022
+ /** @format uuid */
6023
+ userId?: string;
6024
+ /** @format uuid */
6025
+ conversationId?: string;
6026
+ blockedOnly?: boolean;
6027
+ /** @format date-time */
6028
+ startDate?: string;
6029
+ /** @format date-time */
6030
+ endDate?: string;
6031
+ /** @format int32 */
6032
+ pageSize?: number;
6033
+ /** @format int32 */
6034
+ pageNumber?: number;
6035
+ sortBy?: string;
6036
+ sortDirection?: string;
6037
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
6038
+ /**
6039
+ * No description
6040
+ *
6041
+ * @tags AiAdmin
6042
+ * @name GetAiRequestLifecycle
6043
+ * @summary Get the full event lifecycle of a single AI request
6044
+ * @request GET:/api/ai/admin/audit-logs/request/{requestId}
6045
+ * @secure
6046
+ * @response `200` `(AiAuditLog)[]` OK
6047
+ */
6048
+ getAiRequestLifecycle: (requestId: string, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
6049
+ /**
6050
+ * No description
6051
+ *
6052
+ * @tags AiAdmin
6053
+ * @name GetAiAuditConversations
6054
+ * @summary List conversations with their audit roll-up — origin user, turns, status, tokens
6055
+ * @request GET:/api/ai/admin/audit-conversations
6056
+ * @secure
6057
+ * @response `200` `AiConversationAuditSummaryPaginated` OK
6058
+ */
6059
+ getAiAuditConversations: (query?: {
6060
+ searchText?: string;
6061
+ /** @format date-time */
6062
+ startDate?: string;
6063
+ /** @format date-time */
6064
+ endDate?: string;
6065
+ /** @format int32 */
6066
+ pageSize?: number;
6067
+ /** @format int32 */
6068
+ pageNumber?: number;
6069
+ sortBy?: string;
6070
+ sortDirection?: string;
6071
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
6072
+ /**
6073
+ * No description
6074
+ *
6075
+ * @tags AiAdmin
6076
+ * @name GetAiAdminStats
6077
+ * @summary Get AI admin dashboard stats
6078
+ * @request GET:/api/ai/admin/stats
6079
+ * @secure
6080
+ * @response `200` `AiAdminStats` OK
6081
+ */
6082
+ getAiAdminStats: (query?: {
6083
+ /** @format date-time */
6084
+ startDate?: string;
6085
+ /** @format date-time */
6086
+ endDate?: string;
6087
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
6088
+ /**
6089
+ * No description
6090
+ *
6091
+ * @tags AiAdmin
6092
+ * @name GetAiConfigChanges
6093
+ * @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
6094
+ * @request GET:/api/ai/admin/config-changes
6095
+ * @secure
6096
+ * @response `200` `AiConfigChangeLogPaginated` OK
6097
+ */
6098
+ getAiConfigChanges: (query?: {
6099
+ entityType?: AiConfigEntityType;
6100
+ /** @format uuid */
6101
+ entityId?: string;
6102
+ /** @format uuid */
6103
+ actorUserId?: string;
6104
+ action?: AiConfigChangeAction;
6105
+ /** @format date-time */
6106
+ startDate?: string;
6107
+ /** @format date-time */
6108
+ endDate?: string;
6109
+ /** @format int32 */
6110
+ pageSize?: number;
6111
+ /** @format int32 */
6112
+ pageNumber?: number;
6113
+ sortBy?: string;
6114
+ sortDirection?: string;
6115
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
6116
+ /**
6117
+ * No description
6118
+ *
6119
+ * @tags AiAdminPrompt
6120
+ * @name GetAiPrompts
6121
+ * @summary Get all prompts
6122
+ * @request GET:/api/ai/admin/prompts
6123
+ * @secure
6124
+ * @response `200` `(AiPrompt)[]` OK
6125
+ */
6126
+ getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
6127
+ /**
6128
+ * No description
6129
+ *
6130
+ * @tags AiAdminPrompt
6131
+ * @name CreateAiPrompt
6132
+ * @summary Create custom prompt
6133
+ * @request POST:/api/ai/admin/prompts
6134
+ * @secure
6135
+ * @response `201` `AiPrompt` Created
6136
+ * @response `400` `ProblemDetails` Bad Request
6137
+ */
6138
+ createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
6139
+ /**
6140
+ * No description
6141
+ *
6142
+ * @tags AiAdminPrompt
6143
+ * @name GetAiPrompt
6144
+ * @summary Get prompt by ID
6145
+ * @request GET:/api/ai/admin/prompts/{id}
6146
+ * @secure
6147
+ * @response `200` `AiPrompt` OK
6148
+ * @response `404` `ProblemDetails` Not Found
6149
+ */
6150
+ getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
6151
+ /**
6152
+ * No description
6153
+ *
6154
+ * @tags AiAdminPrompt
6155
+ * @name UpdateAiPrompt
6156
+ * @summary Update prompt
6157
+ * @request PUT:/api/ai/admin/prompts/{id}
6158
+ * @secure
6159
+ * @response `200` `AiPrompt` OK
6160
+ * @response `400` `ProblemDetails` Bad Request
6161
+ * @response `404` `ProblemDetails` Not Found
6162
+ */
6163
+ updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
6164
+ /**
6165
+ * No description
6166
+ *
6167
+ * @tags AiAdminPrompt
6168
+ * @name DeleteAiPrompt
6169
+ * @summary Delete prompt
6170
+ * @request DELETE:/api/ai/admin/prompts/{id}
6171
+ * @secure
6172
+ * @response `204` `void` No Content
6173
+ * @response `400` `ProblemDetails` Bad Request
6174
+ * @response `404` `ProblemDetails` Not Found
6175
+ */
6176
+ deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6177
+ /**
6178
+ * No description
6179
+ *
6180
+ * @tags AiAdminPrompt
6181
+ * @name ToggleAiPrompt
6182
+ * @summary Toggle prompt active/inactive
6183
+ * @request PATCH:/api/ai/admin/prompts/{id}/toggle
6184
+ * @secure
6185
+ * @response `200` `AiPrompt` OK
6186
+ * @response `404` `ProblemDetails` Not Found
6187
+ */
6188
+ toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
6189
+ /**
6190
+ * No description
6191
+ *
6192
+ * @tags AiAdminPrompt
6193
+ * @name GenerateAiSystemPrompt
6194
+ * @summary Generate a system prompt from description
6195
+ * @request POST:/api/ai/admin/prompts/generate
6196
+ * @secure
6197
+ * @response `200` `GenerateSystemPrompt` OK
6198
+ * @response `400` `ProblemDetails` Bad Request
6199
+ */
6200
+ generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
6201
+ /**
6202
+ * No description
6203
+ *
6204
+ * @tags AiAdminPrompt
6205
+ * @name GetSupportedModels
6206
+ * @summary Get supported LLM models
6207
+ * @request GET:/api/ai/admin/prompts/supported-models
6208
+ * @secure
6209
+ * @response `200` `(SupportedModel)[]` OK
6210
+ */
6211
+ getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
6212
+ /**
6213
+ * No description
6214
+ *
6215
+ * @tags AiAdminSettings
6216
+ * @name GetAiAdminSettings
6217
+ * @summary Get global AI settings
6218
+ * @request GET:/api/ai/admin/settings
6219
+ * @secure
6220
+ * @response `200` `AiAdminSettings` OK
6221
+ */
6222
+ getAiAdminSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
6223
+ /**
6224
+ * No description
6225
+ *
6226
+ * @tags AiAdminSettings
6227
+ * @name UpdateAiAdminSettings
6228
+ * @summary Update global AI settings
6229
+ * @request PUT:/api/ai/admin/settings
6230
+ * @secure
6231
+ * @response `200` `AiAdminSettings` OK
6232
+ * @response `400` `ProblemDetails` Bad Request
6233
+ */
6234
+ updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
6235
+ /**
6236
+ * No description
6237
+ *
6238
+ * @tags AiCanonicalField
6239
+ * @name GetAiCanonicalFields
6240
+ * @summary Get all canonical fields
6241
+ * @request GET:/api/ai/admin/fields
6242
+ * @secure
6243
+ * @response `200` `(AiCanonicalField)[]` OK
6244
+ */
6245
+ getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
6246
+ /**
6247
+ * No description
6248
+ *
6249
+ * @tags AiCanonicalField
6250
+ * @name CreateAiCanonicalField
6251
+ * @summary Create canonical field
6252
+ * @request POST:/api/ai/admin/fields
6253
+ * @secure
6254
+ * @response `201` `AiCanonicalField` Created
6255
+ * @response `400` `ProblemDetails` Bad Request
6256
+ */
6257
+ createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
6258
+ /**
6259
+ * No description
6260
+ *
6261
+ * @tags AiCanonicalField
6262
+ * @name GetAiCanonicalField
6263
+ * @summary Get canonical field by ID
6264
+ * @request GET:/api/ai/admin/fields/{id}
6265
+ * @secure
6266
+ * @response `200` `AiCanonicalField` OK
6267
+ * @response `404` `ProblemDetails` Not Found
6268
+ */
6269
+ getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
6270
+ /**
6271
+ * No description
6272
+ *
6273
+ * @tags AiCanonicalField
6274
+ * @name UpdateAiCanonicalField
6275
+ * @summary Update canonical field
6276
+ * @request PUT:/api/ai/admin/fields/{id}
6277
+ * @secure
6278
+ * @response `200` `AiCanonicalField` OK
6279
+ * @response `400` `ProblemDetails` Bad Request
6280
+ * @response `404` `ProblemDetails` Not Found
6281
+ */
6282
+ updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
6283
+ /**
6284
+ * No description
6285
+ *
6286
+ * @tags AiCanonicalField
6287
+ * @name DeleteAiCanonicalField
6288
+ * @summary Delete canonical field
6289
+ * @request DELETE:/api/ai/admin/fields/{id}
6290
+ * @secure
6291
+ * @response `204` `void` No Content
6292
+ * @response `404` `ProblemDetails` Not Found
6293
+ */
6294
+ deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6295
+ /**
6296
+ * No description
6297
+ *
6298
+ * @tags AiCanonicalField
6299
+ * @name ToggleAiCanonicalField
6300
+ * @summary Toggle canonical field active/inactive
6301
+ * @request PATCH:/api/ai/admin/fields/{id}/toggle
6302
+ * @secure
6303
+ * @response `200` `AiCanonicalField` OK
6304
+ * @response `404` `ProblemDetails` Not Found
6305
+ */
6306
+ toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
6307
+ /**
6308
+ * No description
6309
+ *
6310
+ * @tags AiChat
6311
+ * @name AiChat
6312
+ * @summary Send AI chat message
6313
+ * @request POST:/api/ai/chat
6314
+ * @secure
6315
+ * @response `200` `AiChat` OK
6316
+ * @response `400` `ProblemDetails` Bad Request
6317
+ * @response `401` `ProblemDetails` Unauthorized
6318
+ */
6319
+ aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
6320
+ /**
6321
+ * No description
6322
+ *
6323
+ * @tags AiConversation
6324
+ * @name GetAiConversations
6325
+ * @summary Get user conversations
6326
+ * @request GET:/api/ai/conversations
6327
+ * @secure
6328
+ * @response `200` `AiConversationListItemPaginated` OK
6329
+ */
6330
+ getAiConversations: (query?: {
6331
+ /** @format int32 */
6332
+ pageSize?: number;
6333
+ /** @format int32 */
6334
+ pageNumber?: number;
6335
+ sortBy?: string;
6336
+ sortDirection?: string;
6337
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
6338
+ /**
6339
+ * No description
6340
+ *
6341
+ * @tags AiConversation
6342
+ * @name GetAiConversation
6343
+ * @summary Get conversation metadata
6344
+ * @request GET:/api/ai/conversations/{id}
6345
+ * @secure
6346
+ * @response `200` `AiConversationDetail` OK
6347
+ * @response `403` `ProblemDetails` Forbidden
6348
+ * @response `404` `ProblemDetails` Not Found
6349
+ */
6350
+ getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
6351
+ /**
6352
+ * No description
6353
+ *
6354
+ * @tags AiConversation
6355
+ * @name RenameAiConversation
6356
+ * @summary Rename conversation
6357
+ * @request PATCH:/api/ai/conversations/{id}
6358
+ * @secure
6359
+ * @response `200` `AiConversationDetail` OK
6360
+ * @response `400` `ProblemDetails` Bad Request
6361
+ * @response `403` `ProblemDetails` Forbidden
6362
+ * @response `404` `ProblemDetails` Not Found
6363
+ */
6364
+ renameAiConversation: (id: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
6365
+ /**
6366
+ * No description
6367
+ *
6368
+ * @tags AiConversation
6369
+ * @name DeleteAiConversation
6370
+ * @summary Delete conversation
6371
+ * @request DELETE:/api/ai/conversations/{id}
6372
+ * @secure
6373
+ * @response `204` `void` No Content
6374
+ * @response `403` `ProblemDetails` Forbidden
6375
+ * @response `404` `ProblemDetails` Not Found
6376
+ */
6377
+ deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6378
+ /**
6379
+ * No description
6380
+ *
6381
+ * @tags AiConversation
6382
+ * @name GetAiConversationMessages
6383
+ * @summary Get conversation messages
6384
+ * @request GET:/api/ai/conversations/{id}/messages
6385
+ * @secure
6386
+ * @response `200` `AiChatMessagePaginated` OK
6387
+ * @response `403` `ProblemDetails` Forbidden
6388
+ * @response `404` `ProblemDetails` Not Found
6389
+ */
6390
+ getAiConversationMessages: (id: string, query?: {
6391
+ /** @format int32 */
6392
+ pageSize?: number;
6393
+ /** @format int32 */
6394
+ pageNumber?: number;
6395
+ sortBy?: string;
6396
+ sortDirection?: string;
6397
+ }, params?: RequestParams) => Promise<AxiosResponse<AiChatMessagePaginated, any, {}>>;
6398
+ /**
6399
+ * No description
6400
+ *
6401
+ * @tags AiConversation
6402
+ * @name ClearAiConversationHistory
6403
+ * @summary Clear conversation history
6404
+ * @request DELETE:/api/ai/conversations/{id}/messages
6405
+ * @secure
6406
+ * @response `204` `void` No Content
6407
+ * @response `403` `ProblemDetails` Forbidden
6408
+ * @response `404` `ProblemDetails` Not Found
6409
+ */
6410
+ clearAiConversationHistory: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6411
+ /**
6412
+ * No description
6413
+ *
6414
+ * @tags AiConversation
6415
+ * @name PinAiConversation
6416
+ * @summary Pin or unpin conversation
6417
+ * @request PUT:/api/ai/conversations/{id}/pin
6418
+ * @secure
6419
+ * @response `200` `AiConversationDetail` OK
6420
+ * @response `403` `ProblemDetails` Forbidden
6421
+ * @response `404` `ProblemDetails` Not Found
6422
+ */
6423
+ pinAiConversation: (id: string, data: PinAiConversationRequest, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
6424
+ /**
6425
+ * No description
6426
+ *
6427
+ * @tags AiConversationAdmin
6428
+ * @name GetAiAccountConversations
6429
+ * @summary List AI conversations across the account, optionally filtered by user (admin supervision)
6430
+ * @request GET:/api/ai/admin/conversations
6431
+ * @secure
6432
+ * @response `200` `AiConversationListItemPaginated` OK
6433
+ */
6434
+ getAiAccountConversations: (query?: {
6435
+ /** @format uuid */
6436
+ userId?: string;
6437
+ /** @format int32 */
6438
+ pageSize?: number;
6439
+ /** @format int32 */
6440
+ pageNumber?: number;
6441
+ sortBy?: string;
6442
+ sortDirection?: string;
6443
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
6444
+ /**
6445
+ * No description
6446
+ *
6447
+ * @tags AiConversationAdmin
6448
+ * @name GetAiAccountConversation
6449
+ * @summary Get an account conversation's detail (admin supervision)
6450
+ * @request GET:/api/ai/admin/conversations/{id}
6451
+ * @secure
6452
+ * @response `200` `AiConversationDetail` OK
6453
+ * @response `404` `ProblemDetails` Not Found
6454
+ */
6455
+ getAiAccountConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
6456
+ /**
6457
+ * No description
6458
+ *
6459
+ * @tags AiConversationAdmin
6460
+ * @name GetAiAccountConversationMessages
6461
+ * @summary Get an account conversation's messages (admin supervision)
6462
+ * @request GET:/api/ai/admin/conversations/{id}/messages
6463
+ * @secure
6464
+ * @response `200` `AiChatMessagePaginated` OK
6465
+ * @response `404` `ProblemDetails` Not Found
6466
+ */
6467
+ getAiAccountConversationMessages: (id: string, query?: {
6468
+ /** @format int32 */
6469
+ pageSize?: number;
6470
+ /** @format int32 */
6471
+ pageNumber?: number;
6472
+ sortBy?: string;
6473
+ sortDirection?: string;
6474
+ }, params?: RequestParams) => Promise<AxiosResponse<AiChatMessagePaginated, any, {}>>;
6475
+ /**
6476
+ * No description
6477
+ *
6478
+ * @tags AiGuardrail
6479
+ * @name GetAiGuardrails
6480
+ * @summary Get all guardrails
6481
+ * @request GET:/api/ai/admin/guardrails
6482
+ * @secure
6483
+ * @response `200` `(AiGuardrail)[]` OK
6484
+ */
6485
+ getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
6486
+ /**
6487
+ * No description
6488
+ *
6489
+ * @tags AiGuardrail
6490
+ * @name CreateAiGuardrail
6491
+ * @summary Create custom guardrail
6492
+ * @request POST:/api/ai/admin/guardrails
6493
+ * @secure
6494
+ * @response `201` `AiGuardrail` Created
6495
+ * @response `400` `ProblemDetails` Bad Request
6496
+ */
6497
+ createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6498
+ /**
6499
+ * No description
6500
+ *
6501
+ * @tags AiGuardrail
6502
+ * @name GetAiGuardrail
6503
+ * @summary Get guardrail by ID
6504
+ * @request GET:/api/ai/admin/guardrails/{id}
6505
+ * @secure
6506
+ * @response `200` `AiGuardrail` OK
6507
+ * @response `404` `ProblemDetails` Not Found
6508
+ */
6509
+ getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6510
+ /**
6511
+ * No description
6512
+ *
6513
+ * @tags AiGuardrail
6514
+ * @name UpdateAiGuardrail
6515
+ * @summary Update guardrail
6516
+ * @request PUT:/api/ai/admin/guardrails/{id}
6517
+ * @secure
6518
+ * @response `200` `AiGuardrail` OK
6519
+ * @response `400` `ProblemDetails` Bad Request
6520
+ * @response `404` `ProblemDetails` Not Found
6521
+ */
6522
+ updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6523
+ /**
6524
+ * No description
6525
+ *
6526
+ * @tags AiGuardrail
6527
+ * @name DeleteAiGuardrail
6528
+ * @summary Delete guardrail
6529
+ * @request DELETE:/api/ai/admin/guardrails/{id}
6530
+ * @secure
6531
+ * @response `204` `void` No Content
6532
+ * @response `400` `ProblemDetails` Bad Request
6533
+ * @response `404` `ProblemDetails` Not Found
6534
+ */
6535
+ deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6536
+ /**
6537
+ * No description
6538
+ *
6539
+ * @tags AiGuardrail
6540
+ * @name ToggleAiGuardrail
6541
+ * @summary Toggle guardrail enabled/disabled
6542
+ * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6543
+ * @secure
6544
+ * @response `200` `AiGuardrail` OK
6545
+ * @response `404` `ProblemDetails` Not Found
6546
+ */
6547
+ toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6548
+ /**
6549
+ * No description
6550
+ *
6551
+ * @tags AiPrompt
6552
+ * @name GetAvailablePrompts
6553
+ * @summary Get available prompts for current user
6554
+ * @request GET:/api/ai/prompts
6555
+ * @secure
6556
+ * @response `200` `(AiPromptSummary)[]` OK
6557
+ */
6558
+ getAvailablePrompts: (query?: {
6559
+ documentType?: string;
6560
+ }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
6561
+ /**
6562
+ * No description
6563
+ *
6564
+ * @tags AiSuperAdmin
6565
+ * @name GetAiAuditLogsCrossAccount
6566
+ * @summary Get AI audit logs for a specific account or across all accounts
6567
+ * @request GET:/api/ai/superadmin/audit-logs
6568
+ * @secure
6569
+ * @response `200` `AiAuditLogPaginated` OK
6570
+ */
6571
+ getAiAuditLogsCrossAccount: (query?: {
6572
+ /** @format uuid */
6573
+ accountId?: string;
6574
+ eventType?: AiAuditEventType;
6575
+ /** @format uuid */
6576
+ requestId?: string;
6577
+ /** @format uuid */
6578
+ userId?: string;
6579
+ /** @format uuid */
6580
+ conversationId?: string;
6581
+ blockedOnly?: boolean;
6582
+ /** @format date-time */
6583
+ startDate?: string;
6584
+ /** @format date-time */
6585
+ endDate?: string;
6586
+ /** @format int32 */
6587
+ pageSize?: number;
6588
+ /** @format int32 */
6589
+ pageNumber?: number;
6590
+ sortBy?: string;
6591
+ sortDirection?: string;
6592
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
6593
+ /**
6594
+ * No description
6595
+ *
6596
+ * @tags AiSuperAdmin
6597
+ * @name GetAiRequestLifecycleCrossAccount
6598
+ * @summary Get the full event lifecycle of a single AI request from any account
6599
+ * @request GET:/api/ai/superadmin/audit-logs/request/{requestId}
6600
+ * @secure
6601
+ * @response `200` `(AiAuditLog)[]` OK
6602
+ */
6603
+ getAiRequestLifecycleCrossAccount: (requestId: string, query?: {
6604
+ /** @format uuid */
6605
+ accountId?: string;
6606
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
6607
+ /**
6608
+ * No description
6609
+ *
6610
+ * @tags AiSuperAdmin
6611
+ * @name GetAiStatsCrossAccount
6612
+ * @summary Get AI stats for a specific account or platform-wide
6613
+ * @request GET:/api/ai/superadmin/stats
6614
+ * @secure
6615
+ * @response `200` `AiAdminStats` OK
6616
+ */
6617
+ getAiStatsCrossAccount: (query?: {
6618
+ /** @format uuid */
6619
+ accountId?: string;
6620
+ /** @format date-time */
6621
+ startDate?: string;
6622
+ /** @format date-time */
6623
+ endDate?: string;
6624
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
6625
+ /**
6626
+ * No description
6627
+ *
6628
+ * @tags AiSuperAdmin
6629
+ * @name GetAiConfigChangesCrossAccount
6630
+ * @summary Get AI configuration change history for a specific account or across all accounts (incl. global defaults)
6631
+ * @request GET:/api/ai/superadmin/config-changes
6632
+ * @secure
6633
+ * @response `200` `AiConfigChangeLogPaginated` OK
6634
+ */
6635
+ getAiConfigChangesCrossAccount: (query?: {
6636
+ /** @format uuid */
6637
+ accountId?: string;
6638
+ entityType?: AiConfigEntityType;
6639
+ /** @format uuid */
6640
+ entityId?: string;
6641
+ /** @format uuid */
6642
+ actorUserId?: string;
6643
+ action?: AiConfigChangeAction;
6644
+ /** @format date-time */
6645
+ startDate?: string;
6646
+ /** @format date-time */
6647
+ endDate?: string;
6648
+ /** @format int32 */
6649
+ pageSize?: number;
6650
+ /** @format int32 */
6651
+ pageNumber?: number;
6652
+ sortBy?: string;
6653
+ sortDirection?: string;
6654
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
6655
+ /**
6656
+ * No description
6657
+ *
6658
+ * @tags AiTokenUsageAdmin
6659
+ * @name SearchAiAccountTokenUsage
6660
+ * @summary Search accounts by current-month AI token usage and classification
6661
+ * @request POST:/api/ai/admin/token-usage/search
6662
+ * @secure
6663
+ * @response `200` `AiAccountUsageOverviewPaginated` OK
6664
+ */
6665
+ searchAiAccountTokenUsage: (data: SearchCriteria, query?: {
6666
+ /** @format int32 */
6667
+ pageSize?: number;
6668
+ /** @format int32 */
6669
+ pageNumber?: number;
6670
+ sortBy?: string;
6671
+ sortDirection?: string;
6672
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAccountUsageOverviewPaginated, any, {}>>;
6673
+ /**
6674
+ * No description
6675
+ *
6676
+ * @tags AiTokenUsageAdmin
6677
+ * @name GetAiAccountTokenUsage
6678
+ * @summary Get an account's current-month AI token usage
6679
+ * @request GET:/api/ai/admin/token-usage/{accountId}
6680
+ * @secure
6681
+ * @response `200` `AiTokenBudgetStatus` OK
6682
+ */
6683
+ getAiAccountTokenUsage: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<AiTokenBudgetStatus, any, {}>>;
6684
+ /**
6685
+ * No description
6686
+ *
6687
+ * @tags AiTokenUsageAdmin
6688
+ * @name GetAiAccountTokenUsageHistory
6689
+ * @summary Get an account's monthly AI token usage history
6690
+ * @request GET:/api/ai/admin/token-usage/{accountId}/history
6691
+ * @secure
6692
+ * @response `200` `AiTokenUsageWindowPaginated` OK
6693
+ */
6694
+ getAiAccountTokenUsageHistory: (accountId: string, query?: {
6695
+ /** @format int32 */
6696
+ pageSize?: number;
6697
+ /** @format int32 */
6698
+ pageNumber?: number;
6699
+ sortBy?: string;
6700
+ sortDirection?: string;
6701
+ }, params?: RequestParams) => Promise<AxiosResponse<AiTokenUsageWindowPaginated, any, {}>>;
6702
+ /**
6703
+ * No description
6704
+ *
6705
+ * @tags AiTokenUsageAdmin
6706
+ * @name SetAiAccountTokenLimit
6707
+ * @summary Set or raise an account's monthly AI token limit
6708
+ * @request PUT:/api/ai/admin/token-usage/{accountId}/limit
6709
+ * @secure
6710
+ * @response `200` `AiTokenBudgetStatus` OK
6711
+ * @response `400` `ProblemDetails` Bad Request
6712
+ */
6713
+ setAiAccountTokenLimit: (accountId: string, data: UpdateAiAccountTokenLimitRequest, params?: RequestParams) => Promise<AxiosResponse<AiTokenBudgetStatus, any, {}>>;
6714
+ /**
6715
+ * No description
6716
+ *
6717
+ * @tags AiUrlSource
6718
+ * @name GetAiUrlSources
6719
+ * @summary Get all URL sources
6720
+ * @request GET:/api/ai/admin/url-sources
6721
+ * @secure
6722
+ * @response `200` `(AiUrlSource)[]` OK
6723
+ */
6724
+ getAiUrlSources: (params?: RequestParams) => Promise<AxiosResponse<AiUrlSource[], any, {}>>;
6725
+ /**
6726
+ * No description
6727
+ *
6728
+ * @tags AiUrlSource
6729
+ * @name CreateAiUrlSource
6730
+ * @summary Create URL source
6731
+ * @request POST:/api/ai/admin/url-sources
6732
+ * @secure
6733
+ * @response `201` `AiUrlSource` Created
6734
+ * @response `400` `ProblemDetails` Bad Request
6735
+ * @response `409` `ProblemDetails` Conflict
6736
+ */
6737
+ createAiUrlSource: (data: CreateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6738
+ /**
6739
+ * No description
6740
+ *
6741
+ * @tags AiUrlSource
6742
+ * @name GetAiUrlSource
6743
+ * @summary Get URL source by ID
6744
+ * @request GET:/api/ai/admin/url-sources/{id}
6745
+ * @secure
6746
+ * @response `200` `AiUrlSource` OK
6747
+ * @response `404` `ProblemDetails` Not Found
6748
+ */
6749
+ getAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6750
+ /**
6751
+ * No description
6752
+ *
6753
+ * @tags AiUrlSource
6754
+ * @name UpdateAiUrlSource
6755
+ * @summary Update URL source
6756
+ * @request PUT:/api/ai/admin/url-sources/{id}
6757
+ * @secure
6758
+ * @response `200` `AiUrlSource` OK
6759
+ * @response `400` `ProblemDetails` Bad Request
6760
+ * @response `404` `ProblemDetails` Not Found
6761
+ * @response `409` `ProblemDetails` Conflict
6762
+ */
6763
+ updateAiUrlSource: (id: string, data: UpdateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6764
+ /**
6765
+ * No description
6766
+ *
6767
+ * @tags AiUrlSource
6768
+ * @name DeleteAiUrlSource
6769
+ * @summary Delete URL source
6770
+ * @request DELETE:/api/ai/admin/url-sources/{id}
6771
+ * @secure
6772
+ * @response `204` `void` No Content
6773
+ * @response `404` `ProblemDetails` Not Found
6774
+ */
6775
+ deleteAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6776
+ /**
6777
+ * No description
6778
+ *
6779
+ * @tags AiUrlSource
6780
+ * @name ToggleAiUrlSource
6781
+ * @summary Toggle URL source active/inactive
6782
+ * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
6783
+ * @secure
6784
+ * @response `200` `AiUrlSource` OK
6785
+ * @response `404` `ProblemDetails` Not Found
6786
+ */
6787
+ toggleAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6788
+ /**
6789
+ * No description
6790
+ *
6791
+ * @tags AiUsage
6792
+ * @name GetAiUsage
6793
+ * @summary Get the current account's AI token usage for the active monthly window
6794
+ * @request GET:/api/ai/usage
6795
+ * @secure
6796
+ * @response `200` `AiTokenBudgetStatus` OK
6797
+ */
6798
+ getAiUsage: (params?: RequestParams) => Promise<AxiosResponse<AiTokenBudgetStatus, any, {}>>;
6799
+ /**
6800
+ * No description
6801
+ *
6802
+ * @tags AiUsage
6803
+ * @name GetAiUsageHistory
6804
+ * @summary Get the current account's monthly AI token usage history
6805
+ * @request GET:/api/ai/usage/history
6806
+ * @secure
6807
+ * @response `200` `AiTokenUsageWindowPaginated` OK
6808
+ */
6809
+ getAiUsageHistory: (query?: {
6810
+ /** @format int32 */
6811
+ pageSize?: number;
6812
+ /** @format int32 */
6813
+ pageNumber?: number;
6814
+ sortBy?: string;
6815
+ sortDirection?: string;
6816
+ }, params?: RequestParams) => Promise<AxiosResponse<AiTokenUsageWindowPaginated, any, {}>>;
6817
+ /**
6818
+ * No description
6819
+ *
6820
+ * @tags AuditLog
6821
+ * @name SearchAuditLogs
6822
+ * @summary Search
6823
+ * @request POST:/api/audit-logs/search
6824
+ * @secure
6825
+ * @response `200` `AuditLogEntryPaginated` OK
6826
+ */
6827
+ searchAuditLogs: (data: AuditLogSearchCriteria, query?: {
6828
+ /** @format int32 */
6829
+ pageSize?: number;
5566
6830
  /** @format int32 */
5567
6831
  pageNumber?: number;
5568
6832
  sortBy?: string;
@@ -6074,7 +7338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6074
7338
  * @response `200` `(CustomFieldDefinition)[]` OK
6075
7339
  */
6076
7340
  getCustomFieldDefinitions: (query?: {
6077
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7341
+ entityType?: "Loan";
6078
7342
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
6079
7343
  /**
6080
7344
  * No description
@@ -7581,10 +8845,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7581
8845
  * @summary Download By ID
7582
8846
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
7583
8847
  * @secure
7584
- * @response `200` `Blob` OK
8848
+ * @response `200` `string` OK
7585
8849
  * @response `404` `ProblemDetails` Not Found
7586
8850
  */
7587
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8851
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
7588
8852
  /**
7589
8853
  * No description
7590
8854
  *
@@ -7654,6 +8918,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7654
8918
  * @response `404` `ProblemDetails` Not Found
7655
8919
  */
7656
8920
  syncLoanDocumentsFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any, {}>>;
8921
+ /**
8922
+ * No description
8923
+ *
8924
+ * @tags LoanDocuments
8925
+ * @name ClassifyLoanDocumentManually
8926
+ * @summary Manually classify a loan document
8927
+ * @request POST:/api/loans/{loanId}/documents/{documentId}/classify-manual
8928
+ * @secure
8929
+ * @response `200` `LoanDocument` OK
8930
+ * @response `404` `ProblemDetails` Not Found
8931
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8932
+ */
8933
+ classifyLoanDocumentManually: (loanId: string, documentId: string, data: ManualDocumentClassificationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocument, any, {}>>;
7657
8934
  /**
7658
8935
  * @description Re-attempts to push a failed document to LOS
7659
8936
  *
@@ -7889,19 +9166,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7889
9166
  * @response `404` `ProblemDetails` Not Found
7890
9167
  */
7891
9168
  sendLoanOptInReminder: (loanId: string, data: SendLoanOptInReminderRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7892
- /**
7893
- * No description
7894
- *
7895
- * @tags LoanNotification
7896
- * @name SendESignatureReminder
7897
- * @summary Send eSignature Reminder
7898
- * @request POST:/api/loans/{loanID}/notifications/esignature-reminders
7899
- * @secure
7900
- * @response `204` `void` No Content
7901
- * @response `400` `ProblemDetails` Bad Request
7902
- * @response `404` `ProblemDetails` Not Found
7903
- */
7904
- sendESignatureReminder: (loanId: string, data: SendESignatureReminderRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7905
9169
  /**
7906
9170
  * No description
7907
9171
  *
@@ -8815,7 +10079,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8815
10079
  getPartners: (query?: {
8816
10080
  showAll?: boolean;
8817
10081
  /** @default "Realtor" */
8818
- role?: GetPartnersParamsRoleEnum;
10082
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8819
10083
  /** @format int32 */
8820
10084
  pageSize?: number;
8821
10085
  /** @format int32 */
@@ -8993,7 +10257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8993
10257
  * @response `200` `File` OK
8994
10258
  * @response `404` `ProblemDetails` Not Found
8995
10259
  */
8996
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10260
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8997
10261
  /**
8998
10262
  * No description
8999
10263
  *
@@ -9004,7 +10268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9004
10268
  * @secure
9005
10269
  * @response `200` `File` OK
9006
10270
  */
9007
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10271
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9008
10272
  /**
9009
10273
  * No description
9010
10274
  *