@matech/thebigpos-sdk 2.44.2-ai-bi → 2.44.4-rc0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/.claude/settings.local.json +52 -0
  2. package/.husky/pre-commit +2 -2
  3. package/LICENSE +21 -21
  4. package/dist/index.d.ts +155 -1436
  5. package/dist/index.js +162 -837
  6. package/dist/index.js.map +1 -1
  7. package/package.json +6 -5
  8. package/src/index.ts +1038 -3024
  9. package/tsconfig.json +27 -27
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" | "DocumentClassified";
31
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
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,7 +41,6 @@ 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";
45
44
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
46
45
  export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
47
46
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
@@ -63,25 +62,12 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
63
62
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
64
63
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
65
64
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
66
- export type ClassificationSource = "Textract" | "Llm" | "Manual";
67
65
  export type BranchType = "Mortgage" | "RealEstate";
68
66
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
69
67
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
70
68
  export type BorrowerApplicationStatus = "Draft" | "Complete";
71
69
  export type BillingType = "ClosedLoan" | "LoanOfficer";
72
70
  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";
85
71
  export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
86
72
  export interface ASOSettings {
87
73
  enabled: boolean;
@@ -132,7 +118,7 @@ export interface AccountBilling {
132
118
  contractedRate: number;
133
119
  }
134
120
  export interface AccountBillingRequest {
135
- billingType: "ClosedLoan" | "LoanOfficer";
121
+ billingType: AccountBillingRequestBillingTypeEnum;
136
122
  /** @format double */
137
123
  contractedRate: number;
138
124
  }
@@ -161,13 +147,11 @@ export interface AccountSettings {
161
147
  smsNumber?: string | null;
162
148
  ssoHostOverride?: string | null;
163
149
  isEarlyAdopter: boolean;
164
- isAIEnabled: boolean;
165
150
  }
166
151
  export interface AccountSettingsRequest {
167
152
  isSmsEnabled: boolean;
168
153
  smsNumber?: string | null;
169
154
  isEarlyAdopter: boolean;
170
- isAIEnabled: boolean;
171
155
  }
172
156
  export interface Action {
173
157
  /** @format uuid */
@@ -176,7 +160,7 @@ export interface Action {
176
160
  comments?: string | null;
177
161
  /** @format uuid */
178
162
  siteConfigurationID: string;
179
- applicationSettings?: any;
163
+ applicationSettings?: any | null;
180
164
  surveysToken?: string | null;
181
165
  }
182
166
  export interface Address {
@@ -311,397 +295,6 @@ export interface AffordabilityCalculatorRequest {
311
295
  /** @format double */
312
296
  annualInsurance: number;
313
297
  }
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
- }
705
298
  export interface AllowImpersonationRequest {
706
299
  email: string;
707
300
  }
@@ -804,14 +397,14 @@ export interface AuditLogEntry {
804
397
  /** @format uuid */
805
398
  id: string;
806
399
  entityType: string;
807
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
400
+ changeType: AuditLogEntryChangeTypeEnum;
808
401
  /** @format uuid */
809
402
  entityId: string;
810
403
  performedBy?: AuditLogUser | null;
811
404
  rootEntityType?: string | null;
812
405
  /** @format uuid */
813
406
  rootEntityId?: string | null;
814
- changes?: any;
407
+ changes?: any | null;
815
408
  /** @format date-time */
816
409
  createdAt: string;
817
410
  }
@@ -851,7 +444,7 @@ export interface BorrowerCount {
851
444
  firstName: string;
852
445
  lastName: string;
853
446
  email: string;
854
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
447
+ role: BorrowerCountRoleEnum;
855
448
  /** @format int32 */
856
449
  count: number;
857
450
  }
@@ -861,7 +454,7 @@ export interface BorrowerIdentity {
861
454
  firstName: string;
862
455
  lastName: string;
863
456
  email: string;
864
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
457
+ role: BorrowerIdentityRoleEnum;
865
458
  }
866
459
  export interface BorrowersNotUsingPosSummary {
867
460
  /** @format int32 */
@@ -1095,7 +688,7 @@ export interface CorporateSearchCriteria {
1095
688
  isActive?: boolean | null;
1096
689
  }
1097
690
  export interface CreateAccessScopeRequest {
1098
- scopeType: "User" | "Branch";
691
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1099
692
  /** @format uuid */
1100
693
  userId?: string | null;
1101
694
  /** @format uuid */
@@ -1113,49 +706,10 @@ export interface CreateAccountRequest {
1113
706
  /** @format int64 */
1114
707
  nlmsid: number;
1115
708
  settings: AccountSettingsRequest;
1116
- environment: "Development" | "Staging" | "UAT" | "Production";
709
+ environment: CreateAccountRequestEnvironmentEnum;
1117
710
  losIntegration: LOSIntegration;
1118
711
  billingSettings: AccountBillingRequest;
1119
712
  }
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
- }
1159
713
  export interface CreateBranchRequest {
1160
714
  name: string;
1161
715
  /** @format uuid */
@@ -1177,8 +731,8 @@ export interface CreateCustomFieldDefinitionRequest {
1177
731
  name: string;
1178
732
  defaultValue?: string | null;
1179
733
  regexPattern?: string | null;
1180
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1181
- entityType: "Loan";
734
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
735
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1182
736
  options?: CustomFieldOptionRequest[] | null;
1183
737
  permissions?: CustomFieldPermissionRequest[] | null;
1184
738
  }
@@ -1193,7 +747,7 @@ export interface CreateDocumentTemplateRequest {
1193
747
  export interface CreateGroupMemberRequest {
1194
748
  /** @format uuid */
1195
749
  userId: string;
1196
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
750
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1197
751
  }
1198
752
  export interface CreateInviteRequest {
1199
753
  firstName: string;
@@ -1201,7 +755,7 @@ export interface CreateInviteRequest {
1201
755
  emailAddress: string;
1202
756
  phoneNumber?: string | null;
1203
757
  /** @deprecated */
1204
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
758
+ relationship: CreateInviteRequestRelationshipEnum;
1205
759
  loanID: string;
1206
760
  route?: string | null;
1207
761
  /** @format uuid */
@@ -1221,7 +775,7 @@ export interface CreateLoanImportRequest {
1221
775
  endDate: string;
1222
776
  /** @format date-time */
1223
777
  startDate: string;
1224
- importMode: "All" | "NewOnly" | "UpdateOnly";
778
+ importMode: CreateLoanImportRequestImportModeEnum;
1225
779
  }
1226
780
  export interface CreateSession {
1227
781
  sessionId: string;
@@ -1239,7 +793,7 @@ export interface CreateUserDeviceRequest {
1239
793
  token: string;
1240
794
  }
1241
795
  export interface CreateUserDraft {
1242
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
796
+ loanRole: CreateUserDraftLoanRoleEnum;
1243
797
  }
1244
798
  export interface CreateUserGroupRequest {
1245
799
  name: string;
@@ -1300,8 +854,8 @@ export interface CustomFieldDefinition {
1300
854
  name: string;
1301
855
  defaultValue?: string | null;
1302
856
  regexPattern?: string | null;
1303
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1304
- entityType: "Loan";
857
+ dataType: CustomFieldDefinitionDataTypeEnum;
858
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1305
859
  options: CustomFieldOption[];
1306
860
  permissions: CustomFieldPermission[];
1307
861
  encompassMapping?: EncompassMapping | null;
@@ -1315,7 +869,7 @@ export interface CustomFieldEntry {
1315
869
  displayOrder: number;
1316
870
  name: string;
1317
871
  value: string;
1318
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
872
+ dataType: CustomFieldEntryDataTypeEnum;
1319
873
  }
1320
874
  export interface CustomFieldOption {
1321
875
  /** @format uuid */
@@ -1332,12 +886,12 @@ export interface CustomFieldOptionRequest {
1332
886
  export interface CustomFieldPermission {
1333
887
  /** @format uuid */
1334
888
  id: string;
1335
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1336
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
889
+ role: CustomFieldPermissionRoleEnum;
890
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1337
891
  }
1338
892
  export interface CustomFieldPermissionRequest {
1339
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1340
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
893
+ role: CustomFieldPermissionRequestRoleEnum;
894
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1341
895
  }
1342
896
  export interface CustomFieldValue {
1343
897
  /** @format uuid */
@@ -1348,7 +902,7 @@ export interface CustomFieldValue {
1348
902
  customFieldDefinitionID: string;
1349
903
  value: string;
1350
904
  definitionName: string;
1351
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
905
+ dataType: CustomFieldValueDataTypeEnum;
1352
906
  }
1353
907
  export interface DetailedUser {
1354
908
  /** @format date-time */
@@ -1586,7 +1140,7 @@ export interface Draft {
1586
1140
  siteConfiguration: SiteConfigurationReduced;
1587
1141
  /** @format uuid */
1588
1142
  loanID?: string | null;
1589
- type: "NewLoan" | "EditLoan";
1143
+ type: DraftTypeEnum;
1590
1144
  isCoBorrower: boolean;
1591
1145
  }
1592
1146
  export interface DraftContent {
@@ -1604,7 +1158,7 @@ export interface DraftContent {
1604
1158
  siteConfiguration: SiteConfigurationReduced;
1605
1159
  /** @format uuid */
1606
1160
  loanID?: string | null;
1607
- type: "NewLoan" | "EditLoan";
1161
+ type: DraftContentTypeEnum;
1608
1162
  isCoBorrower: boolean;
1609
1163
  applicationPayload: any;
1610
1164
  }
@@ -1620,7 +1174,7 @@ export interface DraftLoanOfficerReassignRequest {
1620
1174
  }
1621
1175
  export interface DraftRequest {
1622
1176
  applicationPayload: any;
1623
- customData?: any;
1177
+ customData?: any | null;
1624
1178
  isCoBorrower: boolean;
1625
1179
  }
1626
1180
  export interface EconsentPendingSummary {
@@ -1694,9 +1248,9 @@ export interface EncompassCredentialsDetail {
1694
1248
  clearStateIfUnlicensed: boolean;
1695
1249
  /** @deprecated */
1696
1250
  baseUrl?: string | null;
1697
- encompassEnvironment: "Production" | "UAT";
1251
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1698
1252
  consumerConnectWidgetHost?: string | null;
1699
- signingMethod: "ConsumerConnect" | "POSF";
1253
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1700
1254
  subscriptionId?: string | null;
1701
1255
  environment?: string | null;
1702
1256
  }
@@ -1712,9 +1266,9 @@ export interface EncompassCredentialsRequest {
1712
1266
  clearStateIfUnlicensed: boolean;
1713
1267
  /** @deprecated */
1714
1268
  baseUrl?: string | null;
1715
- encompassEnvironment: "Production" | "UAT";
1269
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1716
1270
  consumerConnectWidgetHost?: string | null;
1717
- signingMethod: "ConsumerConnect" | "POSF";
1271
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1718
1272
  subscriptionId?: string | null;
1719
1273
  environment?: string | null;
1720
1274
  clientID?: string | null;
@@ -1823,8 +1377,8 @@ export interface EncompassRequestLog {
1823
1377
  losId?: string | null;
1824
1378
  /** @format uuid */
1825
1379
  accountId: string;
1826
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1827
- outcome: "Success" | "Failure" | "PartialSuccess";
1380
+ operationType: EncompassRequestLogOperationTypeEnum;
1381
+ outcome: EncompassRequestLogOutcomeEnum;
1828
1382
  message: string;
1829
1383
  endpoint?: string | null;
1830
1384
  httpMethod?: string | null;
@@ -1832,7 +1386,7 @@ export interface EncompassRequestLog {
1832
1386
  httpStatusCode?: number | null;
1833
1387
  /** @format int64 */
1834
1388
  durationMs?: number | null;
1835
- context?: any;
1389
+ context?: any | null;
1836
1390
  /** @format date-time */
1837
1391
  createdAt: string;
1838
1392
  }
@@ -1871,7 +1425,7 @@ export interface FileSearchCriteria {
1871
1425
  export interface FileWithBytes {
1872
1426
  name: string;
1873
1427
  /** @format byte */
1874
- data: string;
1428
+ data: Blob;
1875
1429
  fileName: string;
1876
1430
  mimeType?: string | null;
1877
1431
  extension?: string | null;
@@ -1947,7 +1501,7 @@ export interface FormSubmission {
1947
1501
  subjectPropertyAddressCounty?: string | null;
1948
1502
  subjectPropertyAddressState?: string | null;
1949
1503
  subjectPropertyAddressZip?: string | null;
1950
- data?: any;
1504
+ data?: any | null;
1951
1505
  /** @format uuid */
1952
1506
  listingID?: string | null;
1953
1507
  listing?: Listing | null;
@@ -1982,7 +1536,7 @@ export interface FormSubmissionRequest {
1982
1536
  subjectPropertyAddressCounty?: string | null;
1983
1537
  subjectPropertyAddressState?: string | null;
1984
1538
  subjectPropertyAddressZip?: string | null;
1985
- data?: any;
1539
+ data?: any | null;
1986
1540
  /** @format uuid */
1987
1541
  listingID?: string | null;
1988
1542
  }
@@ -2031,7 +1585,7 @@ export interface FusionFieldDisplay {
2031
1585
  fieldValue: string;
2032
1586
  }
2033
1587
  export interface FusionReportFilter {
2034
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1588
+ filterType: FusionReportFilterFilterTypeEnum;
2035
1589
  targetField: string;
2036
1590
  targetValue: string;
2037
1591
  }
@@ -2048,13 +1602,6 @@ export interface GenerateDocumentRequest {
2048
1602
  preview: boolean;
2049
1603
  recipients: string[];
2050
1604
  }
2051
- export interface GenerateSystemPrompt {
2052
- systemPrompt: string;
2053
- }
2054
- export interface GenerateSystemPromptRequest {
2055
- description: string;
2056
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2057
- }
2058
1605
  export interface GetApplications {
2059
1606
  applications: ApplicationRowData[];
2060
1607
  }
@@ -2137,11 +1684,11 @@ export interface GetWorkflowRequest {
2137
1684
  export interface GuidPatchOperation {
2138
1685
  op: string;
2139
1686
  path: string;
2140
- value?: any;
1687
+ value?: any | null;
2141
1688
  from?: string | null;
2142
1689
  }
2143
1690
  export interface IPAddress {
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";
1691
+ addressFamily: IpAddressAddressFamilyEnum;
2145
1692
  /** @format int64 */
2146
1693
  scopeId: number;
2147
1694
  isIPv6Multicast: boolean;
@@ -2388,7 +1935,7 @@ export interface Loan {
2388
1935
  contacts: LoanContact[];
2389
1936
  customFields: CustomFieldEntry[];
2390
1937
  milestones: LoanMilestone[];
2391
- signingMethod: "ConsumerConnect" | "POSF";
1938
+ signingMethod: LoanSigningMethodEnum;
2392
1939
  }
2393
1940
  export interface LoanApplication {
2394
1941
  /** @format uuid */
@@ -2424,7 +1971,7 @@ export interface LoanApplicationRequest {
2424
1971
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2425
1972
  /** @format uuid */
2426
1973
  draftId?: string | null;
2427
- additionalFields?: Record<string, any>;
1974
+ additionalFields?: Record<string, any> | null;
2428
1975
  /** @format uuid */
2429
1976
  existingLoanId?: string | null;
2430
1977
  }
@@ -2443,7 +1990,7 @@ export interface LoanBorrower {
2443
1990
  citizenship?: LoanCitizenship | null;
2444
1991
  maritalStatus?: LoanMaritalStatus | null;
2445
1992
  languagePreference?: LoanLanguagePreference | null;
2446
- applicationStatus: "Draft" | "Complete";
1993
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2447
1994
  /** @format int32 */
2448
1995
  numberOfDependents?: number | null;
2449
1996
  isPrimaryBorrower: boolean;
@@ -3145,7 +2692,7 @@ export interface LoanConsentRequest {
3145
2692
  borrowerEConsent?: boolean | null;
3146
2693
  borrowerCreditAuth?: boolean | null;
3147
2694
  borrowerTCPAOptIn?: boolean | null;
3148
- additionalFields?: Record<string, string>;
2695
+ additionalFields?: Record<string, string> | null;
3149
2696
  }
3150
2697
  export interface LoanContact {
3151
2698
  /** @format date-time */
@@ -3163,13 +2710,13 @@ export interface LoanContact {
3163
2710
  email?: string | null;
3164
2711
  phone?: string | null;
3165
2712
  companyName?: string | null;
3166
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2713
+ role: LoanContactRoleEnum;
3167
2714
  }
3168
2715
  export interface LoanContactList {
3169
2716
  email: string;
3170
2717
  }
3171
2718
  export interface LoanCustomFieldsRequest {
3172
- additionalFields?: Record<string, string>;
2719
+ additionalFields?: Record<string, string> | null;
3173
2720
  }
3174
2721
  export interface LoanDocument {
3175
2722
  /** @format date-time */
@@ -3190,13 +2737,6 @@ export interface LoanDocument {
3190
2737
  failoverDocumentPath?: string | null;
3191
2738
  /** @format date-time */
3192
2739
  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;
3200
2740
  }
3201
2741
  export interface LoanDocumentFolder {
3202
2742
  /** @format uuid */
@@ -3219,12 +2759,12 @@ export interface LoanDocumentFolderPermission {
3219
2759
  id: string;
3220
2760
  /** @format uuid */
3221
2761
  loanDocumentFolderID: string;
3222
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3223
- level: "None" | "Read" | "Write" | "Manage";
2762
+ role: LoanDocumentFolderPermissionRoleEnum;
2763
+ level: LoanDocumentFolderPermissionLevelEnum;
3224
2764
  }
3225
2765
  export interface LoanDocumentFolderPermissionRequest {
3226
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3227
- level: "None" | "Read" | "Write" | "Manage";
2766
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
2767
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3228
2768
  }
3229
2769
  export interface LoanDocumentFolderUsage {
3230
2770
  /** @format uuid */
@@ -3340,13 +2880,13 @@ export interface LoanImport {
3340
2880
  /** @format int32 */
3341
2881
  importedCount: number;
3342
2882
  statusMessage?: string | null;
3343
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3344
- importMode: "All" | "NewOnly" | "UpdateOnly";
2883
+ status: LoanImportStatusEnum;
2884
+ importMode: LoanImportImportModeEnum;
3345
2885
  /** @format date-time */
3346
2886
  createdAt?: string | null;
3347
2887
  }
3348
2888
  export interface LoanImportLog {
3349
- level: "None" | "Info" | "Warning" | "Error";
2889
+ level: LoanImportLogLevelEnum;
3350
2890
  message: string;
3351
2891
  /** @format date-time */
3352
2892
  createdAt: string;
@@ -3401,8 +2941,8 @@ export interface LoanListPaginated {
3401
2941
  export interface LoanLog {
3402
2942
  /** @format uuid */
3403
2943
  id: string;
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";
2944
+ level: LoanLogLevelEnum;
2945
+ type: LoanLogTypeEnum;
3406
2946
  message: string;
3407
2947
  /** @format date-time */
3408
2948
  createdAt: string;
@@ -3410,8 +2950,8 @@ export interface LoanLog {
3410
2950
  export interface LoanLogDetail {
3411
2951
  /** @format uuid */
3412
2952
  id: string;
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";
2953
+ level: LoanLogDetailLevelEnum;
2954
+ type: LoanLogDetailTypeEnum;
3415
2955
  message: string;
3416
2956
  /** @format date-time */
3417
2957
  createdAt: string;
@@ -3645,7 +3185,7 @@ export interface LoanQueueWithData {
3645
3185
  user: UserPublic;
3646
3186
  loanOfficer: LoanOfficerPublic;
3647
3187
  siteConfiguration: SiteConfigurationReduced;
3648
- data?: any;
3188
+ data?: any | null;
3649
3189
  }
3650
3190
  export interface LoanRecord {
3651
3191
  loanGuid: string;
@@ -3676,7 +3216,7 @@ export interface LoanTaskSearchRequest {
3676
3216
  loanStatus?: LoanTaskActivityFilter | null;
3677
3217
  }
3678
3218
  export interface LoanTaskStatusSummary {
3679
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3219
+ status: LoanTaskStatusSummaryStatusEnum;
3680
3220
  /** @format int32 */
3681
3221
  count: number;
3682
3222
  }
@@ -3688,7 +3228,7 @@ export interface LoanUser {
3688
3228
  email: string;
3689
3229
  phone?: string | null;
3690
3230
  role: string;
3691
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3231
+ loanRole: LoanUserLoanRoleEnum;
3692
3232
  isUser: boolean;
3693
3233
  /** @format date-time */
3694
3234
  createdAt: string;
@@ -3721,7 +3261,7 @@ export interface LosOperationTracking {
3721
3261
  operationType: string;
3722
3262
  correlationKey: string;
3723
3263
  lastTriggerSource?: string | null;
3724
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3264
+ status: LosOperationTrackingStatusEnum;
3725
3265
  /** @format date-time */
3726
3266
  createdAt: string;
3727
3267
  /** @format date-time */
@@ -3782,7 +3322,7 @@ export interface LosSyncStep {
3782
3322
  /** @format int32 */
3783
3323
  order: number;
3784
3324
  name: string;
3785
- severity: "Success" | "Info" | "Warning" | "Error";
3325
+ severity: LosSyncStepSeverityEnum;
3786
3326
  message: string;
3787
3327
  /** @format date-time */
3788
3328
  atUtc: string;
@@ -3795,9 +3335,6 @@ export interface LosWebhook {
3795
3335
  events: string[];
3796
3336
  enableSubscription: boolean;
3797
3337
  }
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
- }
3801
3338
  export interface MdmUser {
3802
3339
  user_email?: string | null;
3803
3340
  user_id?: string | null;
@@ -3875,7 +3412,7 @@ export interface ModuleParameterValue {
3875
3412
  parameterID: string;
3876
3413
  parameterName: string;
3877
3414
  parameterType: string;
3878
- value?: any;
3415
+ value?: any | null;
3879
3416
  isInherited: boolean;
3880
3417
  }
3881
3418
  export interface MonthlyPaymentCalculator {
@@ -4048,7 +3585,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4048
3585
  }
4049
3586
  export interface Operation {
4050
3587
  op?: string;
4051
- value?: string | number | boolean | null | object;
3588
+ value?: object | null;
4052
3589
  path?: string;
4053
3590
  }
4054
3591
  export interface OverridePasswordRequest {
@@ -4093,9 +3630,6 @@ export interface PendingTasksSummary {
4093
3630
  total: number;
4094
3631
  borrowers: BorrowerCount[];
4095
3632
  }
4096
- export interface PinAiConversationRequest {
4097
- isPinned: boolean;
4098
- }
4099
3633
  export interface PostLoanComparisonPdfRequest {
4100
3634
  /** @format uuid */
4101
3635
  siteConfigurationID: string;
@@ -4245,9 +3779,6 @@ export interface RegisterUserRequest {
4245
3779
  /** @format uuid */
4246
3780
  inviteCode?: string | null;
4247
3781
  }
4248
- export interface RenameAiConversationRequest {
4249
- name: string;
4250
- }
4251
3782
  export interface RequestImpersonationRequest {
4252
3783
  email: string;
4253
3784
  }
@@ -4327,9 +3858,6 @@ export interface SSOTokenRequest {
4327
3858
  email: string;
4328
3859
  redirectUri?: string | null;
4329
3860
  }
4330
- export interface SearchCriteria {
4331
- searchText?: string | null;
4332
- }
4333
3861
  export interface SendForgotPasswordRequest {
4334
3862
  email: string;
4335
3863
  }
@@ -4374,7 +3902,7 @@ export interface SiteConfiguration {
4374
3902
  deletedAt?: string | null;
4375
3903
  /** @format uuid */
4376
3904
  id: string;
4377
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3905
+ type: SiteConfigurationTypeEnum;
4378
3906
  /** @format uuid */
4379
3907
  entityID: string;
4380
3908
  /** @format int32 */
@@ -4567,7 +4095,7 @@ export interface SiteConfigurationByUrl {
4567
4095
  deletedAt?: string | null;
4568
4096
  /** @format uuid */
4569
4097
  id: string;
4570
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4098
+ type: SiteConfigurationByUrlTypeEnum;
4571
4099
  /** @format uuid */
4572
4100
  entityID: string;
4573
4101
  /** @format int32 */
@@ -4777,7 +4305,7 @@ export interface SiteConfigurationForm {
4777
4305
  export interface SiteConfigurationReduced {
4778
4306
  /** @format uuid */
4779
4307
  id: string;
4780
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4308
+ type: SiteConfigurationReducedTypeEnum;
4781
4309
  url?: string | null;
4782
4310
  name: string;
4783
4311
  /** @format int64 */
@@ -4794,7 +4322,7 @@ export interface SiteConfigurationRequest {
4794
4322
  entityID: string;
4795
4323
  /** @format int32 */
4796
4324
  entityType: number;
4797
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4325
+ type: SiteConfigurationRequestTypeEnum;
4798
4326
  url: string;
4799
4327
  name: string;
4800
4328
  introduction?: string | null;
@@ -4969,7 +4497,7 @@ export interface SiteConfigurationSearchCriteria {
4969
4497
  export interface SiteConfigurationSummary {
4970
4498
  /** @format uuid */
4971
4499
  id: string;
4972
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4500
+ type: SiteConfigurationSummaryTypeEnum;
4973
4501
  url?: string | null;
4974
4502
  name: string;
4975
4503
  /** @format int64 */
@@ -5013,13 +4541,6 @@ export interface SocialSurveyRecord {
5013
4541
  /** @format date-time */
5014
4542
  reviewCompletedTimeStamp?: string | null;
5015
4543
  }
5016
- export interface SupportedModel {
5017
- modelId: string;
5018
- displayName: string;
5019
- provider: string;
5020
- description?: string | null;
5021
- isDefault: boolean;
5022
- }
5023
4544
  export interface SurveyEmailRequest {
5024
4545
  loanOfficerEmailAddress: string;
5025
4546
  }
@@ -5232,7 +4753,7 @@ export interface UnregisteredBorrower {
5232
4753
  lastName?: string | null;
5233
4754
  fullName?: string | null;
5234
4755
  email?: string | null;
5235
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
4756
+ role: UnregisteredBorrowerRoleEnum;
5236
4757
  }
5237
4758
  export interface UpdateAccountRequest {
5238
4759
  name: string;
@@ -5243,47 +4764,6 @@ export interface UpdateAccountRequest {
5243
4764
  asoSettings?: ASOSettings | null;
5244
4765
  settings: AccountSettingsRequest;
5245
4766
  }
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
- }
5287
4767
  export interface UpdateCustomFieldDefinitionRequest {
5288
4768
  isRequired: boolean;
5289
4769
  /** @format int32 */
@@ -5569,7 +5049,7 @@ export interface UserDevice {
5569
5049
  export interface UserDraft {
5570
5050
  /** @format uuid */
5571
5051
  draftID: string;
5572
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5052
+ role: UserDraftRoleEnum;
5573
5053
  user: User;
5574
5054
  }
5575
5055
  export interface UserDraftPaginated {
@@ -5593,7 +5073,7 @@ export interface UserGroupAccessScope {
5593
5073
  id: string;
5594
5074
  /** @format uuid */
5595
5075
  groupId: string;
5596
- scopeType: "User" | "Branch";
5076
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5597
5077
  /** @format uuid */
5598
5078
  userId?: string | null;
5599
5079
  /** @format uuid */
@@ -5626,7 +5106,7 @@ export interface UserLoan {
5626
5106
  deletedAt?: string | null;
5627
5107
  loanID: string;
5628
5108
  user: User;
5629
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5109
+ role: UserLoanRoleEnum;
5630
5110
  /** @format int32 */
5631
5111
  borrowerPair?: number | null;
5632
5112
  /** @format int32 */
@@ -5638,11 +5118,11 @@ export interface UserLoanConsent {
5638
5118
  id: string;
5639
5119
  /** @format uuid */
5640
5120
  userLoanID: string;
5641
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5121
+ type: UserLoanConsentTypeEnum;
5642
5122
  providedConsent: boolean;
5643
5123
  source?: ConsentSource | null;
5644
5124
  ipAddress?: string | null;
5645
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5125
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5646
5126
  /** @format date-time */
5647
5127
  createdAt: string;
5648
5128
  /** @format date-time */
@@ -5772,7 +5252,7 @@ export interface UserSummary {
5772
5252
  id: string;
5773
5253
  name?: string | null;
5774
5254
  email?: string | null;
5775
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5255
+ role: UserSummaryRoleEnum;
5776
5256
  }
5777
5257
  export interface VerifyPasswordRequest {
5778
5258
  email: string;
@@ -5799,6 +5279,74 @@ export interface Workflow {
5799
5279
  tileSubtitle: string;
5800
5280
  icon: string;
5801
5281
  }
5282
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5283
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5284
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5285
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5286
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5287
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5288
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5289
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5290
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5291
+ /** @deprecated */
5292
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5293
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5294
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5295
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5296
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5297
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5298
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5299
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5300
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5301
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5302
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5303
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
5304
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5305
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5306
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5307
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5308
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5309
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5310
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5311
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5312
+ 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";
5313
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5314
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5315
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5316
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5317
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5318
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5319
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5320
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5321
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5322
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5323
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5324
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5325
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5326
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5327
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5328
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5329
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5330
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5331
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5332
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5333
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5334
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5335
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5336
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5337
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5338
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5339
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5340
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5341
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5342
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5343
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5344
+ /** @default "Realtor" */
5345
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5346
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5347
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5348
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5349
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5802
5350
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5803
5351
  export type QueryParamsType = Record<string | number, any>;
5804
5352
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5821,14 +5369,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5821
5369
  secure?: boolean;
5822
5370
  format?: ResponseType;
5823
5371
  }
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
- }
5372
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5832
5373
  export declare class HttpClient<SecurityDataType = unknown> {
5833
5374
  instance: AxiosInstance;
5834
5375
  private securityData;
@@ -6008,821 +5549,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6008
5549
  /**
6009
5550
  * No description
6010
5551
  *
6011
- * @tags AiAdmin
6012
- * @name GetAiAuditLogs
6013
- * @summary Get paginated audit logs
6014
- * @request GET:/api/ai/admin/audit-logs
5552
+ * @tags AuditLog
5553
+ * @name SearchAuditLogs
5554
+ * @summary Search
5555
+ * @request POST:/api/audit-logs/search
6015
5556
  * @secure
6016
- * @response `200` `AiAuditLogPaginated` OK
6017
- */
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
5557
+ * @response `200` `AuditLogEntryPaginated` OK
6826
5558
  */
6827
5559
  searchAuditLogs: (data: AuditLogSearchCriteria, query?: {
6828
5560
  /** @format int32 */
@@ -7338,7 +6070,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7338
6070
  * @response `200` `(CustomFieldDefinition)[]` OK
7339
6071
  */
7340
6072
  getCustomFieldDefinitions: (query?: {
7341
- entityType?: "Loan";
6073
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7342
6074
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7343
6075
  /**
7344
6076
  * No description
@@ -8845,10 +7577,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8845
7577
  * @summary Download By ID
8846
7578
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
8847
7579
  * @secure
8848
- * @response `200` `string` OK
7580
+ * @response `200` `Blob` OK
8849
7581
  * @response `404` `ProblemDetails` Not Found
8850
7582
  */
8851
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
7583
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8852
7584
  /**
8853
7585
  * No description
8854
7586
  *
@@ -8918,19 +7650,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8918
7650
  * @response `404` `ProblemDetails` Not Found
8919
7651
  */
8920
7652
  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, {}>>;
8934
7653
  /**
8935
7654
  * @description Re-attempts to push a failed document to LOS
8936
7655
  *
@@ -10079,7 +8798,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10079
8798
  getPartners: (query?: {
10080
8799
  showAll?: boolean;
10081
8800
  /** @default "Realtor" */
10082
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8801
+ role?: GetPartnersParamsRoleEnum;
10083
8802
  /** @format int32 */
10084
8803
  pageSize?: number;
10085
8804
  /** @format int32 */
@@ -10257,7 +8976,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10257
8976
  * @response `200` `File` OK
10258
8977
  * @response `404` `ProblemDetails` Not Found
10259
8978
  */
10260
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8979
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10261
8980
  /**
10262
8981
  * No description
10263
8982
  *
@@ -10268,7 +8987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10268
8987
  * @secure
10269
8988
  * @response `200` `File` OK
10270
8989
  */
10271
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8990
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10272
8991
  /**
10273
8992
  * No description
10274
8993
  *