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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/dist/index.d.ts +1482 -152
  4. package/dist/index.js +840 -163
  5. package/dist/index.js.map +1 -1
  6. package/package.json +5 -6
  7. package/src/index.ts +3079 -1040
  8. 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";
31
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
32
32
  export type LoanLienPosition = "First" | "Subordinate";
33
33
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
34
34
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
@@ -41,10 +41,12 @@ export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other
41
41
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
42
42
  export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
43
43
  export type LoanGenderType = "Male" | "Female";
44
+ export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaStatement" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other";
44
45
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
45
46
  export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
46
47
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
47
48
  export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese" | "Korean" | "Vietnamese" | "Other";
49
+ export type LoanAmortizationType = "Fixed" | "Arm" | "Balloon" | "Other";
48
50
  export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
49
51
  export type LoanAccessScopeType = "User" | "Branch";
50
52
  export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
@@ -61,12 +63,25 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
61
63
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
62
64
  export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
63
65
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
66
+ export type ClassificationSource = "Textract" | "Llm" | "Manual";
64
67
  export type BranchType = "Mortgage" | "RealEstate";
65
68
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
66
69
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
67
70
  export type BorrowerApplicationStatus = "Draft" | "Complete";
68
71
  export type BillingType = "ClosedLoan" | "LoanOfficer";
69
72
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
73
+ export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
74
+ export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
75
+ export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
76
+ export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility";
77
+ export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
78
+ export type AiOutputType = "Text" | "Document";
79
+ export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
80
+ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
81
+ export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
82
+ export type AiConfigEntityType = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings";
83
+ export type AiConfigChangeAction = "Created" | "Updated" | "Deleted" | "Toggled";
84
+ export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
70
85
  export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
71
86
  export interface ASOSettings {
72
87
  enabled: boolean;
@@ -117,7 +132,7 @@ export interface AccountBilling {
117
132
  contractedRate: number;
118
133
  }
119
134
  export interface AccountBillingRequest {
120
- billingType: AccountBillingRequestBillingTypeEnum;
135
+ billingType: "ClosedLoan" | "LoanOfficer";
121
136
  /** @format double */
122
137
  contractedRate: number;
123
138
  }
@@ -146,11 +161,13 @@ export interface AccountSettings {
146
161
  smsNumber?: string | null;
147
162
  ssoHostOverride?: string | null;
148
163
  isEarlyAdopter: boolean;
164
+ isAIEnabled: boolean;
149
165
  }
150
166
  export interface AccountSettingsRequest {
151
167
  isSmsEnabled: boolean;
152
168
  smsNumber?: string | null;
153
169
  isEarlyAdopter: boolean;
170
+ isAIEnabled: boolean;
154
171
  }
155
172
  export interface Action {
156
173
  /** @format uuid */
@@ -159,7 +176,7 @@ export interface Action {
159
176
  comments?: string | null;
160
177
  /** @format uuid */
161
178
  siteConfigurationID: string;
162
- applicationSettings?: any | null;
179
+ applicationSettings?: any;
163
180
  surveysToken?: string | null;
164
181
  }
165
182
  export interface Address {
@@ -294,6 +311,397 @@ export interface AffordabilityCalculatorRequest {
294
311
  /** @format double */
295
312
  annualInsurance: number;
296
313
  }
314
+ export interface AiAccountUsageOverview {
315
+ /** @format uuid */
316
+ accountId: string;
317
+ accountName: string;
318
+ /** @format int32 */
319
+ limit: number;
320
+ /** @format int64 */
321
+ used: number;
322
+ /** @format int64 */
323
+ remaining: number;
324
+ /** @format double */
325
+ percentUsed: number;
326
+ limitReached: boolean;
327
+ /** @format date-time */
328
+ windowStart: string;
329
+ /** @format date-time */
330
+ windowEnd: string;
331
+ }
332
+ export interface AiAccountUsageOverviewPaginated {
333
+ rows: AiAccountUsageOverview[];
334
+ pagination: Pagination;
335
+ /** @format int64 */
336
+ count: number;
337
+ }
338
+ export interface AiAdminSettings {
339
+ bedrockModelId: string;
340
+ /** @format int32 */
341
+ maxTokens: number;
342
+ /** @format double */
343
+ temperature: number;
344
+ /** @format int32 */
345
+ conversationContextTurns: number;
346
+ /** @format int32 */
347
+ requestTimeoutSeconds: number;
348
+ /** @format int32 */
349
+ defaultTokenLimit: number;
350
+ bedrockRegion: string;
351
+ }
352
+ export interface AiAdminSettingsRequest {
353
+ bedrockModelId?: string | null;
354
+ /** @format int32 */
355
+ maxTokens?: number | null;
356
+ /** @format double */
357
+ temperature?: number | null;
358
+ /** @format int32 */
359
+ conversationContextTurns?: number | null;
360
+ /** @format int32 */
361
+ requestTimeoutSeconds?: number | null;
362
+ /** @format int32 */
363
+ defaultTokenLimit?: number | null;
364
+ }
365
+ export interface AiAdminStats {
366
+ /** @format int32 */
367
+ totalRequests: number;
368
+ /** @format int32 */
369
+ blockedRequests: number;
370
+ /** @format double */
371
+ averageResponseTimeMs: number;
372
+ /** @format int32 */
373
+ totalInputTokens: number;
374
+ /** @format int32 */
375
+ totalOutputTokens: number;
376
+ /** @format int32 */
377
+ totalTokens: number;
378
+ intentDistribution: Record<string, number>;
379
+ topQueryTemplates: Record<string, number>;
380
+ period: string;
381
+ }
382
+ export interface AiAuditLog {
383
+ /** @format uuid */
384
+ id: string;
385
+ /** @format uuid */
386
+ requestId: string;
387
+ /** @format uuid */
388
+ userId: string;
389
+ /** @format uuid */
390
+ conversationId?: string | null;
391
+ /** @format uuid */
392
+ messageId?: string | null;
393
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
394
+ modelId?: string | null;
395
+ /** @format int32 */
396
+ inputTokens?: number | null;
397
+ /** @format int32 */
398
+ outputTokens?: number | null;
399
+ /** @format int32 */
400
+ latencyMs?: number | null;
401
+ bedrockRequestId?: string | null;
402
+ guardrailName?: string | null;
403
+ guardrailCategory?: string | null;
404
+ rawRequest?: string | null;
405
+ rawResponse?: string | null;
406
+ details?: any;
407
+ /** @format date-time */
408
+ createdAt: string;
409
+ }
410
+ export interface AiAuditLogPaginated {
411
+ rows: AiAuditLog[];
412
+ pagination: Pagination;
413
+ /** @format int64 */
414
+ count: number;
415
+ }
416
+ export interface AiCanonicalField {
417
+ /** @format uuid */
418
+ id: string;
419
+ canonicalName: string;
420
+ displayName: string;
421
+ description: string;
422
+ allowedRoles: string[];
423
+ efPath?: string | null;
424
+ isPii: boolean;
425
+ isActive: boolean;
426
+ dataSource: string;
427
+ isDefault: boolean;
428
+ category?: string | null;
429
+ jsonPropertyName?: string | null;
430
+ textractKey?: string | null;
431
+ textractKeyAliases: string[];
432
+ hasAccountOverride: boolean;
433
+ /** @format date-time */
434
+ createdAt: string;
435
+ /** @format date-time */
436
+ updatedAt?: string | null;
437
+ }
438
+ export interface AiChat {
439
+ /** @format uuid */
440
+ conversationId: string;
441
+ /** @format uuid */
442
+ messageId: string;
443
+ response: AiChatBody;
444
+ metadata: AiChatMetadata;
445
+ }
446
+ export interface AiChatBody {
447
+ text: string;
448
+ data?: AiChatStructuredData | null;
449
+ }
450
+ export interface AiChatMessage {
451
+ /** @format uuid */
452
+ id: string;
453
+ userMessage: string;
454
+ assistantResponse: string;
455
+ intent?: AiIntent | null;
456
+ fieldsAccessed?: string[] | null;
457
+ data?: AiChatStructuredData | null;
458
+ /** @format date-time */
459
+ createdAt: string;
460
+ }
461
+ export interface AiChatMessagePaginated {
462
+ rows: AiChatMessage[];
463
+ pagination: Pagination;
464
+ /** @format int64 */
465
+ count: number;
466
+ }
467
+ export interface AiChatMetadata {
468
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
469
+ fieldsAccessed: string[];
470
+ /** @format int64 */
471
+ queryTimeMs: number;
472
+ /** @format int64 */
473
+ llmTimeMs: number;
474
+ /** @format int32 */
475
+ inputTokens: number;
476
+ /** @format int32 */
477
+ outputTokens: number;
478
+ modelId?: string | null;
479
+ wasBlocked: boolean;
480
+ blockedReason?: string | null;
481
+ tokenBudget?: AiTokenBudgetStatus | null;
482
+ }
483
+ export interface AiChatRequest {
484
+ message: string;
485
+ /** @format uuid */
486
+ conversationId?: string | null;
487
+ /** @format uuid */
488
+ loanId?: string | null;
489
+ documentIds?: string[] | null;
490
+ /** @format uuid */
491
+ promptId?: string | null;
492
+ }
493
+ export interface AiChatStructuredData {
494
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
495
+ displayHint?: AiDisplayHint | null;
496
+ detectedDocumentType?: string | null;
497
+ columns: string[];
498
+ rows: string[][];
499
+ /** @format uuid */
500
+ generatedDocumentId?: string | null;
501
+ generatedFileName?: string | null;
502
+ }
503
+ export interface AiConfigChangeLog {
504
+ /** @format uuid */
505
+ id: string;
506
+ /** @format uuid */
507
+ accountId?: string | null;
508
+ /** @format uuid */
509
+ actorUserId: string;
510
+ entityType: "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings";
511
+ /** @format uuid */
512
+ entityId?: string | null;
513
+ action: "Created" | "Updated" | "Deleted" | "Toggled";
514
+ before?: any;
515
+ after?: any;
516
+ /** @format date-time */
517
+ createdAt: string;
518
+ }
519
+ export interface AiConfigChangeLogPaginated {
520
+ rows: AiConfigChangeLog[];
521
+ pagination: Pagination;
522
+ /** @format int64 */
523
+ count: number;
524
+ }
525
+ export interface AiConversationAuditSummary {
526
+ /** @format uuid */
527
+ conversationId: string;
528
+ /** @format uuid */
529
+ userId: string;
530
+ userName?: string | null;
531
+ userRole?: string | null;
532
+ name?: string | null;
533
+ /** @format int32 */
534
+ turnCount: number;
535
+ /** @format int32 */
536
+ completedCount: number;
537
+ /** @format int32 */
538
+ blockedCount: number;
539
+ /** @format int32 */
540
+ errorCount: number;
541
+ /** @format int32 */
542
+ totalTokens: number;
543
+ /** @format date-time */
544
+ lastActivityAt: string;
545
+ }
546
+ export interface AiConversationAuditSummaryPaginated {
547
+ rows: AiConversationAuditSummary[];
548
+ pagination: Pagination;
549
+ /** @format int64 */
550
+ count: number;
551
+ }
552
+ export interface AiConversationDetail {
553
+ /** @format uuid */
554
+ id: string;
555
+ name?: string | null;
556
+ isPinned: boolean;
557
+ /** @format date-time */
558
+ createdAt: string;
559
+ /** @format date-time */
560
+ updatedAt?: string | null;
561
+ /** @format int32 */
562
+ messageCount: number;
563
+ }
564
+ export interface AiConversationListItem {
565
+ /** @format uuid */
566
+ id: string;
567
+ /** @format uuid */
568
+ userId: string;
569
+ name?: string | null;
570
+ preview: string;
571
+ /** @format int32 */
572
+ messageCount: number;
573
+ isPinned: boolean;
574
+ /** @format date-time */
575
+ createdAt: string;
576
+ /** @format date-time */
577
+ updatedAt?: string | null;
578
+ }
579
+ export interface AiConversationListItemPaginated {
580
+ rows: AiConversationListItem[];
581
+ pagination: Pagination;
582
+ /** @format int64 */
583
+ count: number;
584
+ }
585
+ export interface AiGuardrail {
586
+ /** @format uuid */
587
+ id: string;
588
+ name: string;
589
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
590
+ description?: string | null;
591
+ keywords: string[];
592
+ responseTemplate: string;
593
+ isDefault: boolean;
594
+ isEnabled: boolean;
595
+ hasAccountOverride: boolean;
596
+ /** @format date-time */
597
+ createdAt: string;
598
+ /** @format date-time */
599
+ updatedAt?: string | null;
600
+ }
601
+ export interface AiPrompt {
602
+ /** @format uuid */
603
+ id: string;
604
+ title: string;
605
+ slug?: string | null;
606
+ description: string;
607
+ documentTypes: string[];
608
+ applicableUrlSourceIds: string[];
609
+ allowedRoles: string[];
610
+ systemPrompt: string;
611
+ /** @format int32 */
612
+ sortOrder: number;
613
+ isDefault: boolean;
614
+ /** @format uuid */
615
+ accountId?: string | null;
616
+ isActive: boolean;
617
+ category?: AiPromptCategory | null;
618
+ queryTemplateName?: AiQueryTemplateName | null;
619
+ displayHint?: AiDisplayHint | null;
620
+ bedrockModelId?: string | null;
621
+ requiredDataSources?: string[] | null;
622
+ outputType?: AiOutputType | null;
623
+ hasAccountOverride: boolean;
624
+ /** @format date-time */
625
+ createdAt: string;
626
+ /** @format date-time */
627
+ updatedAt?: string | null;
628
+ }
629
+ export interface AiPromptSummary {
630
+ /** @format uuid */
631
+ id: string;
632
+ title: string;
633
+ slug?: string | null;
634
+ description: string;
635
+ documentTypes: string[];
636
+ applicableUrlSourceIds: string[];
637
+ /** @format int32 */
638
+ sortOrder: number;
639
+ category?: AiPromptCategory | null;
640
+ queryTemplateName?: AiQueryTemplateName | null;
641
+ displayHint?: AiDisplayHint | null;
642
+ bedrockModelId?: string | null;
643
+ requiredDataSources?: string[] | null;
644
+ outputType?: AiOutputType | null;
645
+ }
646
+ export interface AiTokenBudgetStatus {
647
+ /** @format int32 */
648
+ limit: number;
649
+ /** @format int64 */
650
+ used: number;
651
+ /** @format int64 */
652
+ inputTokens: number;
653
+ /** @format int64 */
654
+ outputTokens: number;
655
+ /** @format int64 */
656
+ remaining: number;
657
+ /** @format double */
658
+ percentUsed: number;
659
+ /** @format date-time */
660
+ windowStart: string;
661
+ /** @format date-time */
662
+ windowEnd: string;
663
+ limitReached: boolean;
664
+ }
665
+ export interface AiTokenUsageWindow {
666
+ /** @format date-time */
667
+ windowStart: string;
668
+ /** @format date-time */
669
+ windowEnd: string;
670
+ /** @format int32 */
671
+ limit: number;
672
+ /** @format int64 */
673
+ used: number;
674
+ /** @format int64 */
675
+ inputTokens: number;
676
+ /** @format int64 */
677
+ outputTokens: number;
678
+ /** @format double */
679
+ percentUsed: number;
680
+ limitReached: boolean;
681
+ }
682
+ export interface AiTokenUsageWindowPaginated {
683
+ rows: AiTokenUsageWindow[];
684
+ pagination: Pagination;
685
+ /** @format int64 */
686
+ count: number;
687
+ }
688
+ export interface AiUrlSource {
689
+ /** @format uuid */
690
+ id: string;
691
+ slug?: string | null;
692
+ name: string;
693
+ url: string;
694
+ description?: string | null;
695
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
696
+ scope: "FullDomain" | "SpecificPath";
697
+ isActive: boolean;
698
+ isDefault: boolean;
699
+ hasAccountOverride: boolean;
700
+ /** @format date-time */
701
+ createdAt: string;
702
+ /** @format date-time */
703
+ updatedAt?: string | null;
704
+ }
297
705
  export interface AllowImpersonationRequest {
298
706
  email: string;
299
707
  }
@@ -396,14 +804,14 @@ export interface AuditLogEntry {
396
804
  /** @format uuid */
397
805
  id: string;
398
806
  entityType: string;
399
- changeType: AuditLogEntryChangeTypeEnum;
807
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
400
808
  /** @format uuid */
401
809
  entityId: string;
402
810
  performedBy?: AuditLogUser | null;
403
811
  rootEntityType?: string | null;
404
812
  /** @format uuid */
405
813
  rootEntityId?: string | null;
406
- changes?: any | null;
814
+ changes?: any;
407
815
  /** @format date-time */
408
816
  createdAt: string;
409
817
  }
@@ -443,7 +851,7 @@ export interface BorrowerCount {
443
851
  firstName: string;
444
852
  lastName: string;
445
853
  email: string;
446
- role: BorrowerCountRoleEnum;
854
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
447
855
  /** @format int32 */
448
856
  count: number;
449
857
  }
@@ -453,7 +861,7 @@ export interface BorrowerIdentity {
453
861
  firstName: string;
454
862
  lastName: string;
455
863
  email: string;
456
- role: BorrowerIdentityRoleEnum;
864
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
457
865
  }
458
866
  export interface BorrowersNotUsingPosSummary {
459
867
  /** @format int32 */
@@ -687,7 +1095,7 @@ export interface CorporateSearchCriteria {
687
1095
  isActive?: boolean | null;
688
1096
  }
689
1097
  export interface CreateAccessScopeRequest {
690
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1098
+ scopeType: "User" | "Branch";
691
1099
  /** @format uuid */
692
1100
  userId?: string | null;
693
1101
  /** @format uuid */
@@ -705,10 +1113,49 @@ export interface CreateAccountRequest {
705
1113
  /** @format int64 */
706
1114
  nlmsid: number;
707
1115
  settings: AccountSettingsRequest;
708
- environment: CreateAccountRequestEnvironmentEnum;
1116
+ environment: "Development" | "Staging" | "UAT" | "Production";
709
1117
  losIntegration: LOSIntegration;
710
1118
  billingSettings: AccountBillingRequest;
711
1119
  }
1120
+ export interface CreateAiCanonicalFieldRequest {
1121
+ displayName: string;
1122
+ description: string;
1123
+ allowedRoles: string[];
1124
+ isPii: boolean;
1125
+ dataSource: string;
1126
+ category?: string | null;
1127
+ }
1128
+ export interface CreateAiGuardrailRequest {
1129
+ name: string;
1130
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1131
+ description?: string | null;
1132
+ keywords: string[];
1133
+ responseTemplate: string;
1134
+ }
1135
+ export interface CreateAiPromptRequest {
1136
+ title: string;
1137
+ slug?: string | null;
1138
+ description: string;
1139
+ documentTypes: string[];
1140
+ applicableUrlSourceIds: string[];
1141
+ allowedRoles: string[];
1142
+ systemPrompt: string;
1143
+ /** @format int32 */
1144
+ sortOrder: number;
1145
+ category?: AiPromptCategory | null;
1146
+ queryTemplateName?: AiQueryTemplateName | null;
1147
+ displayHint?: AiDisplayHint | null;
1148
+ bedrockModelId?: string | null;
1149
+ requiredDataSources?: string[] | null;
1150
+ outputType?: AiOutputType | null;
1151
+ }
1152
+ export interface CreateAiUrlSourceRequest {
1153
+ name: string;
1154
+ url: string;
1155
+ description?: string | null;
1156
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1157
+ scope: "FullDomain" | "SpecificPath";
1158
+ }
712
1159
  export interface CreateBranchRequest {
713
1160
  name: string;
714
1161
  /** @format uuid */
@@ -730,8 +1177,8 @@ export interface CreateCustomFieldDefinitionRequest {
730
1177
  name: string;
731
1178
  defaultValue?: string | null;
732
1179
  regexPattern?: string | null;
733
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
734
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1180
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1181
+ entityType: "Loan";
735
1182
  options?: CustomFieldOptionRequest[] | null;
736
1183
  permissions?: CustomFieldPermissionRequest[] | null;
737
1184
  }
@@ -746,7 +1193,7 @@ export interface CreateDocumentTemplateRequest {
746
1193
  export interface CreateGroupMemberRequest {
747
1194
  /** @format uuid */
748
1195
  userId: string;
749
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1196
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
750
1197
  }
751
1198
  export interface CreateInviteRequest {
752
1199
  firstName: string;
@@ -754,7 +1201,7 @@ export interface CreateInviteRequest {
754
1201
  emailAddress: string;
755
1202
  phoneNumber?: string | null;
756
1203
  /** @deprecated */
757
- relationship: CreateInviteRequestRelationshipEnum;
1204
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
758
1205
  loanID: string;
759
1206
  route?: string | null;
760
1207
  /** @format uuid */
@@ -774,7 +1221,7 @@ export interface CreateLoanImportRequest {
774
1221
  endDate: string;
775
1222
  /** @format date-time */
776
1223
  startDate: string;
777
- importMode: CreateLoanImportRequestImportModeEnum;
1224
+ importMode: "All" | "NewOnly" | "UpdateOnly";
778
1225
  }
779
1226
  export interface CreateSession {
780
1227
  sessionId: string;
@@ -792,7 +1239,7 @@ export interface CreateUserDeviceRequest {
792
1239
  token: string;
793
1240
  }
794
1241
  export interface CreateUserDraft {
795
- loanRole: CreateUserDraftLoanRoleEnum;
1242
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
796
1243
  }
797
1244
  export interface CreateUserGroupRequest {
798
1245
  name: string;
@@ -853,8 +1300,8 @@ export interface CustomFieldDefinition {
853
1300
  name: string;
854
1301
  defaultValue?: string | null;
855
1302
  regexPattern?: string | null;
856
- dataType: CustomFieldDefinitionDataTypeEnum;
857
- entityType: CustomFieldDefinitionEntityTypeEnum;
1303
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1304
+ entityType: "Loan";
858
1305
  options: CustomFieldOption[];
859
1306
  permissions: CustomFieldPermission[];
860
1307
  encompassMapping?: EncompassMapping | null;
@@ -868,7 +1315,7 @@ export interface CustomFieldEntry {
868
1315
  displayOrder: number;
869
1316
  name: string;
870
1317
  value: string;
871
- dataType: CustomFieldEntryDataTypeEnum;
1318
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
872
1319
  }
873
1320
  export interface CustomFieldOption {
874
1321
  /** @format uuid */
@@ -885,12 +1332,12 @@ export interface CustomFieldOptionRequest {
885
1332
  export interface CustomFieldPermission {
886
1333
  /** @format uuid */
887
1334
  id: string;
888
- role: CustomFieldPermissionRoleEnum;
889
- accessLevel: CustomFieldPermissionAccessLevelEnum;
1335
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1336
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
890
1337
  }
891
1338
  export interface CustomFieldPermissionRequest {
892
- role: CustomFieldPermissionRequestRoleEnum;
893
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1339
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1340
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
894
1341
  }
895
1342
  export interface CustomFieldValue {
896
1343
  /** @format uuid */
@@ -901,7 +1348,7 @@ export interface CustomFieldValue {
901
1348
  customFieldDefinitionID: string;
902
1349
  value: string;
903
1350
  definitionName: string;
904
- dataType: CustomFieldValueDataTypeEnum;
1351
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
905
1352
  }
906
1353
  export interface DetailedUser {
907
1354
  /** @format date-time */
@@ -1139,7 +1586,7 @@ export interface Draft {
1139
1586
  siteConfiguration: SiteConfigurationReduced;
1140
1587
  /** @format uuid */
1141
1588
  loanID?: string | null;
1142
- type: DraftTypeEnum;
1589
+ type: "NewLoan" | "EditLoan";
1143
1590
  isCoBorrower: boolean;
1144
1591
  }
1145
1592
  export interface DraftContent {
@@ -1157,7 +1604,7 @@ export interface DraftContent {
1157
1604
  siteConfiguration: SiteConfigurationReduced;
1158
1605
  /** @format uuid */
1159
1606
  loanID?: string | null;
1160
- type: DraftContentTypeEnum;
1607
+ type: "NewLoan" | "EditLoan";
1161
1608
  isCoBorrower: boolean;
1162
1609
  applicationPayload: any;
1163
1610
  }
@@ -1173,7 +1620,7 @@ export interface DraftLoanOfficerReassignRequest {
1173
1620
  }
1174
1621
  export interface DraftRequest {
1175
1622
  applicationPayload: any;
1176
- customData?: any | null;
1623
+ customData?: any;
1177
1624
  isCoBorrower: boolean;
1178
1625
  }
1179
1626
  export interface EconsentPendingSummary {
@@ -1247,9 +1694,9 @@ export interface EncompassCredentialsDetail {
1247
1694
  clearStateIfUnlicensed: boolean;
1248
1695
  /** @deprecated */
1249
1696
  baseUrl?: string | null;
1250
- encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1697
+ encompassEnvironment: "Production" | "UAT";
1251
1698
  consumerConnectWidgetHost?: string | null;
1252
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1699
+ signingMethod: "ConsumerConnect" | "POSF";
1253
1700
  subscriptionId?: string | null;
1254
1701
  environment?: string | null;
1255
1702
  }
@@ -1265,9 +1712,9 @@ export interface EncompassCredentialsRequest {
1265
1712
  clearStateIfUnlicensed: boolean;
1266
1713
  /** @deprecated */
1267
1714
  baseUrl?: string | null;
1268
- encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1715
+ encompassEnvironment: "Production" | "UAT";
1269
1716
  consumerConnectWidgetHost?: string | null;
1270
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1717
+ signingMethod: "ConsumerConnect" | "POSF";
1271
1718
  subscriptionId?: string | null;
1272
1719
  environment?: string | null;
1273
1720
  clientID?: string | null;
@@ -1376,8 +1823,8 @@ export interface EncompassRequestLog {
1376
1823
  losId?: string | null;
1377
1824
  /** @format uuid */
1378
1825
  accountId: string;
1379
- operationType: EncompassRequestLogOperationTypeEnum;
1380
- outcome: EncompassRequestLogOutcomeEnum;
1826
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1827
+ outcome: "Success" | "Failure" | "PartialSuccess";
1381
1828
  message: string;
1382
1829
  endpoint?: string | null;
1383
1830
  httpMethod?: string | null;
@@ -1385,7 +1832,7 @@ export interface EncompassRequestLog {
1385
1832
  httpStatusCode?: number | null;
1386
1833
  /** @format int64 */
1387
1834
  durationMs?: number | null;
1388
- context?: any | null;
1835
+ context?: any;
1389
1836
  /** @format date-time */
1390
1837
  createdAt: string;
1391
1838
  }
@@ -1424,7 +1871,7 @@ export interface FileSearchCriteria {
1424
1871
  export interface FileWithBytes {
1425
1872
  name: string;
1426
1873
  /** @format byte */
1427
- data: Blob;
1874
+ data: string;
1428
1875
  fileName: string;
1429
1876
  mimeType?: string | null;
1430
1877
  extension?: string | null;
@@ -1500,7 +1947,7 @@ export interface FormSubmission {
1500
1947
  subjectPropertyAddressCounty?: string | null;
1501
1948
  subjectPropertyAddressState?: string | null;
1502
1949
  subjectPropertyAddressZip?: string | null;
1503
- data?: any | null;
1950
+ data?: any;
1504
1951
  /** @format uuid */
1505
1952
  listingID?: string | null;
1506
1953
  listing?: Listing | null;
@@ -1535,7 +1982,7 @@ export interface FormSubmissionRequest {
1535
1982
  subjectPropertyAddressCounty?: string | null;
1536
1983
  subjectPropertyAddressState?: string | null;
1537
1984
  subjectPropertyAddressZip?: string | null;
1538
- data?: any | null;
1985
+ data?: any;
1539
1986
  /** @format uuid */
1540
1987
  listingID?: string | null;
1541
1988
  }
@@ -1584,7 +2031,7 @@ export interface FusionFieldDisplay {
1584
2031
  fieldValue: string;
1585
2032
  }
1586
2033
  export interface FusionReportFilter {
1587
- filterType: FusionReportFilterFilterTypeEnum;
2034
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1588
2035
  targetField: string;
1589
2036
  targetValue: string;
1590
2037
  }
@@ -1601,6 +2048,13 @@ export interface GenerateDocumentRequest {
1601
2048
  preview: boolean;
1602
2049
  recipients: string[];
1603
2050
  }
2051
+ export interface GenerateSystemPrompt {
2052
+ systemPrompt: string;
2053
+ }
2054
+ export interface GenerateSystemPromptRequest {
2055
+ description: string;
2056
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2057
+ }
1604
2058
  export interface GetApplications {
1605
2059
  applications: ApplicationRowData[];
1606
2060
  }
@@ -1683,11 +2137,11 @@ export interface GetWorkflowRequest {
1683
2137
  export interface GuidPatchOperation {
1684
2138
  op: string;
1685
2139
  path: string;
1686
- value?: any | null;
2140
+ value?: any;
1687
2141
  from?: string | null;
1688
2142
  }
1689
2143
  export interface IPAddress {
1690
- addressFamily: IpAddressAddressFamilyEnum;
2144
+ addressFamily: "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
1691
2145
  /** @format int64 */
1692
2146
  scopeId: number;
1693
2147
  isIPv6Multicast: boolean;
@@ -1926,12 +2380,15 @@ export interface Loan {
1926
2380
  propertyAddress?: Address | null;
1927
2381
  property?: LoanProperty | null;
1928
2382
  financial?: LoanFinancial | null;
2383
+ financialTerms?: LoanFinancialTerms | null;
2384
+ monthlyPayment?: LoanMonthlyPayment | null;
1929
2385
  borrowers: LoanBorrower[];
1930
2386
  nonOwningBorrowers: LoanNonOwningBorrower[];
1931
2387
  userLoans: UserLoan[];
1932
2388
  contacts: LoanContact[];
1933
2389
  customFields: CustomFieldEntry[];
1934
- signingMethod: LoanSigningMethodEnum;
2390
+ milestones: LoanMilestone[];
2391
+ signingMethod: "ConsumerConnect" | "POSF";
1935
2392
  }
1936
2393
  export interface LoanApplication {
1937
2394
  /** @format uuid */
@@ -1967,7 +2424,7 @@ export interface LoanApplicationRequest {
1967
2424
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
1968
2425
  /** @format uuid */
1969
2426
  draftId?: string | null;
1970
- additionalFields?: Record<string, any> | null;
2427
+ additionalFields?: Record<string, any>;
1971
2428
  /** @format uuid */
1972
2429
  existingLoanId?: string | null;
1973
2430
  }
@@ -1986,7 +2443,7 @@ export interface LoanBorrower {
1986
2443
  citizenship?: LoanCitizenship | null;
1987
2444
  maritalStatus?: LoanMaritalStatus | null;
1988
2445
  languagePreference?: LoanLanguagePreference | null;
1989
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2446
+ applicationStatus: "Draft" | "Complete";
1990
2447
  /** @format int32 */
1991
2448
  numberOfDependents?: number | null;
1992
2449
  isPrimaryBorrower: boolean;
@@ -2688,7 +3145,7 @@ export interface LoanConsentRequest {
2688
3145
  borrowerEConsent?: boolean | null;
2689
3146
  borrowerCreditAuth?: boolean | null;
2690
3147
  borrowerTCPAOptIn?: boolean | null;
2691
- additionalFields?: Record<string, string> | null;
3148
+ additionalFields?: Record<string, string>;
2692
3149
  }
2693
3150
  export interface LoanContact {
2694
3151
  /** @format date-time */
@@ -2706,13 +3163,13 @@ export interface LoanContact {
2706
3163
  email?: string | null;
2707
3164
  phone?: string | null;
2708
3165
  companyName?: string | null;
2709
- role: LoanContactRoleEnum;
3166
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2710
3167
  }
2711
3168
  export interface LoanContactList {
2712
3169
  email: string;
2713
3170
  }
2714
3171
  export interface LoanCustomFieldsRequest {
2715
- additionalFields?: Record<string, string> | null;
3172
+ additionalFields?: Record<string, string>;
2716
3173
  }
2717
3174
  export interface LoanDocument {
2718
3175
  /** @format date-time */
@@ -2733,6 +3190,13 @@ export interface LoanDocument {
2733
3190
  failoverDocumentPath?: string | null;
2734
3191
  /** @format date-time */
2735
3192
  sensitiveDataPurgedOn?: string | null;
3193
+ observedDocumentType?: LoanDocumentType | null;
3194
+ classificationSource?: ClassificationSource | null;
3195
+ verified: boolean;
3196
+ /** @format date-time */
3197
+ classifiedAt?: string | null;
3198
+ classificationMismatch: boolean;
3199
+ classificationMismatchReason?: string | null;
2736
3200
  }
2737
3201
  export interface LoanDocumentFolder {
2738
3202
  /** @format uuid */
@@ -2755,12 +3219,12 @@ export interface LoanDocumentFolderPermission {
2755
3219
  id: string;
2756
3220
  /** @format uuid */
2757
3221
  loanDocumentFolderID: string;
2758
- role: LoanDocumentFolderPermissionRoleEnum;
2759
- level: LoanDocumentFolderPermissionLevelEnum;
3222
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3223
+ level: "None" | "Read" | "Write" | "Manage";
2760
3224
  }
2761
3225
  export interface LoanDocumentFolderPermissionRequest {
2762
- role: LoanDocumentFolderPermissionRequestRoleEnum;
2763
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3226
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3227
+ level: "None" | "Read" | "Write" | "Manage";
2764
3228
  }
2765
3229
  export interface LoanDocumentFolderUsage {
2766
3230
  /** @format uuid */
@@ -2840,6 +3304,23 @@ export interface LoanFinancialRequest {
2840
3304
  /** @format int32 */
2841
3305
  loanTermYears?: number | null;
2842
3306
  }
3307
+ export interface LoanFinancialTerms {
3308
+ /** @format uuid */
3309
+ id?: string | null;
3310
+ /** @format int32 */
3311
+ loanTermMonths?: number | null;
3312
+ amortizationType?: LoanAmortizationType | null;
3313
+ /** @format double */
3314
+ apr?: number | null;
3315
+ /** @format double */
3316
+ interestRate?: number | null;
3317
+ /** @format double */
3318
+ downPayment?: number | null;
3319
+ /** @format double */
3320
+ baseLoanAmount?: number | null;
3321
+ /** @format double */
3322
+ totalLoanAmount?: number | null;
3323
+ }
2843
3324
  export interface LoanIdentifier {
2844
3325
  /** @format uuid */
2845
3326
  id: string;
@@ -2859,13 +3340,13 @@ export interface LoanImport {
2859
3340
  /** @format int32 */
2860
3341
  importedCount: number;
2861
3342
  statusMessage?: string | null;
2862
- status: LoanImportStatusEnum;
2863
- importMode: LoanImportImportModeEnum;
3343
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3344
+ importMode: "All" | "NewOnly" | "UpdateOnly";
2864
3345
  /** @format date-time */
2865
3346
  createdAt?: string | null;
2866
3347
  }
2867
3348
  export interface LoanImportLog {
2868
- level: LoanImportLogLevelEnum;
3349
+ level: "None" | "Info" | "Warning" | "Error";
2869
3350
  message: string;
2870
3351
  /** @format date-time */
2871
3352
  createdAt: string;
@@ -2920,8 +3401,8 @@ export interface LoanListPaginated {
2920
3401
  export interface LoanLog {
2921
3402
  /** @format uuid */
2922
3403
  id: string;
2923
- level: LoanLogLevelEnum;
2924
- type: LoanLogTypeEnum;
3404
+ level: "None" | "Info" | "Warning" | "Error";
3405
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
2925
3406
  message: string;
2926
3407
  /** @format date-time */
2927
3408
  createdAt: string;
@@ -2929,8 +3410,8 @@ export interface LoanLog {
2929
3410
  export interface LoanLogDetail {
2930
3411
  /** @format uuid */
2931
3412
  id: string;
2932
- level: LoanLogDetailLevelEnum;
2933
- type: LoanLogDetailTypeEnum;
3413
+ level: "None" | "Info" | "Warning" | "Error";
3414
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
2934
3415
  message: string;
2935
3416
  /** @format date-time */
2936
3417
  createdAt: string;
@@ -2947,6 +3428,32 @@ export interface LoanLogSearchCriteria {
2947
3428
  types?: LoanLogType[] | null;
2948
3429
  levels?: LogLevel[] | null;
2949
3430
  }
3431
+ export interface LoanMilestone {
3432
+ /** @format uuid */
3433
+ id: string;
3434
+ name: string;
3435
+ /** @format date */
3436
+ date?: string | null;
3437
+ isCompleted: boolean;
3438
+ }
3439
+ export interface LoanMonthlyPayment {
3440
+ /** @format uuid */
3441
+ id?: string | null;
3442
+ /** @format double */
3443
+ principalAndInterest?: number | null;
3444
+ /** @format double */
3445
+ taxes?: number | null;
3446
+ /** @format double */
3447
+ insurance?: number | null;
3448
+ /** @format double */
3449
+ mortgageInsurance?: number | null;
3450
+ /** @format double */
3451
+ floodInsurance?: number | null;
3452
+ /** @format double */
3453
+ hoa?: number | null;
3454
+ /** @format double */
3455
+ other?: number | null;
3456
+ }
2950
3457
  export interface LoanNonOwningBorrower {
2951
3458
  /** @format uuid */
2952
3459
  id?: string | null;
@@ -3138,7 +3645,7 @@ export interface LoanQueueWithData {
3138
3645
  user: UserPublic;
3139
3646
  loanOfficer: LoanOfficerPublic;
3140
3647
  siteConfiguration: SiteConfigurationReduced;
3141
- data?: any | null;
3648
+ data?: any;
3142
3649
  }
3143
3650
  export interface LoanRecord {
3144
3651
  loanGuid: string;
@@ -3169,7 +3676,7 @@ export interface LoanTaskSearchRequest {
3169
3676
  loanStatus?: LoanTaskActivityFilter | null;
3170
3677
  }
3171
3678
  export interface LoanTaskStatusSummary {
3172
- status: LoanTaskStatusSummaryStatusEnum;
3679
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3173
3680
  /** @format int32 */
3174
3681
  count: number;
3175
3682
  }
@@ -3181,7 +3688,7 @@ export interface LoanUser {
3181
3688
  email: string;
3182
3689
  phone?: string | null;
3183
3690
  role: string;
3184
- loanRole: LoanUserLoanRoleEnum;
3691
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3185
3692
  isUser: boolean;
3186
3693
  /** @format date-time */
3187
3694
  createdAt: string;
@@ -3214,7 +3721,7 @@ export interface LosOperationTracking {
3214
3721
  operationType: string;
3215
3722
  correlationKey: string;
3216
3723
  lastTriggerSource?: string | null;
3217
- status: LosOperationTrackingStatusEnum;
3724
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3218
3725
  /** @format date-time */
3219
3726
  createdAt: string;
3220
3727
  /** @format date-time */
@@ -3275,7 +3782,7 @@ export interface LosSyncStep {
3275
3782
  /** @format int32 */
3276
3783
  order: number;
3277
3784
  name: string;
3278
- severity: LosSyncStepSeverityEnum;
3785
+ severity: "Success" | "Info" | "Warning" | "Error";
3279
3786
  message: string;
3280
3787
  /** @format date-time */
3281
3788
  atUtc: string;
@@ -3288,6 +3795,9 @@ export interface LosWebhook {
3288
3795
  events: string[];
3289
3796
  enableSubscription: boolean;
3290
3797
  }
3798
+ export interface ManualDocumentClassificationRequest {
3799
+ documentType: "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaStatement" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other";
3800
+ }
3291
3801
  export interface MdmUser {
3292
3802
  user_email?: string | null;
3293
3803
  user_id?: string | null;
@@ -3365,7 +3875,7 @@ export interface ModuleParameterValue {
3365
3875
  parameterID: string;
3366
3876
  parameterName: string;
3367
3877
  parameterType: string;
3368
- value?: any | null;
3878
+ value?: any;
3369
3879
  isInherited: boolean;
3370
3880
  }
3371
3881
  export interface MonthlyPaymentCalculator {
@@ -3538,7 +4048,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3538
4048
  }
3539
4049
  export interface Operation {
3540
4050
  op?: string;
3541
- value?: object | null;
4051
+ value?: string | number | boolean | null | object;
3542
4052
  path?: string;
3543
4053
  }
3544
4054
  export interface OverridePasswordRequest {
@@ -3583,6 +4093,9 @@ export interface PendingTasksSummary {
3583
4093
  total: number;
3584
4094
  borrowers: BorrowerCount[];
3585
4095
  }
4096
+ export interface PinAiConversationRequest {
4097
+ isPinned: boolean;
4098
+ }
3586
4099
  export interface PostLoanComparisonPdfRequest {
3587
4100
  /** @format uuid */
3588
4101
  siteConfigurationID: string;
@@ -3732,6 +4245,9 @@ export interface RegisterUserRequest {
3732
4245
  /** @format uuid */
3733
4246
  inviteCode?: string | null;
3734
4247
  }
4248
+ export interface RenameAiConversationRequest {
4249
+ name: string;
4250
+ }
3735
4251
  export interface RequestImpersonationRequest {
3736
4252
  email: string;
3737
4253
  }
@@ -3811,6 +4327,9 @@ export interface SSOTokenRequest {
3811
4327
  email: string;
3812
4328
  redirectUri?: string | null;
3813
4329
  }
4330
+ export interface SearchCriteria {
4331
+ searchText?: string | null;
4332
+ }
3814
4333
  export interface SendForgotPasswordRequest {
3815
4334
  email: string;
3816
4335
  }
@@ -3855,7 +4374,7 @@ export interface SiteConfiguration {
3855
4374
  deletedAt?: string | null;
3856
4375
  /** @format uuid */
3857
4376
  id: string;
3858
- type: SiteConfigurationTypeEnum;
4377
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3859
4378
  /** @format uuid */
3860
4379
  entityID: string;
3861
4380
  /** @format int32 */
@@ -4048,7 +4567,7 @@ export interface SiteConfigurationByUrl {
4048
4567
  deletedAt?: string | null;
4049
4568
  /** @format uuid */
4050
4569
  id: string;
4051
- type: SiteConfigurationByUrlTypeEnum;
4570
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4052
4571
  /** @format uuid */
4053
4572
  entityID: string;
4054
4573
  /** @format int32 */
@@ -4258,7 +4777,7 @@ export interface SiteConfigurationForm {
4258
4777
  export interface SiteConfigurationReduced {
4259
4778
  /** @format uuid */
4260
4779
  id: string;
4261
- type: SiteConfigurationReducedTypeEnum;
4780
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4262
4781
  url?: string | null;
4263
4782
  name: string;
4264
4783
  /** @format int64 */
@@ -4275,7 +4794,7 @@ export interface SiteConfigurationRequest {
4275
4794
  entityID: string;
4276
4795
  /** @format int32 */
4277
4796
  entityType: number;
4278
- type: SiteConfigurationRequestTypeEnum;
4797
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4279
4798
  url: string;
4280
4799
  name: string;
4281
4800
  introduction?: string | null;
@@ -4450,7 +4969,7 @@ export interface SiteConfigurationSearchCriteria {
4450
4969
  export interface SiteConfigurationSummary {
4451
4970
  /** @format uuid */
4452
4971
  id: string;
4453
- type: SiteConfigurationSummaryTypeEnum;
4972
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4454
4973
  url?: string | null;
4455
4974
  name: string;
4456
4975
  /** @format int64 */
@@ -4494,7 +5013,14 @@ export interface SocialSurveyRecord {
4494
5013
  /** @format date-time */
4495
5014
  reviewCompletedTimeStamp?: string | null;
4496
5015
  }
4497
- export interface SurveyEmailRequest {
5016
+ export interface SupportedModel {
5017
+ modelId: string;
5018
+ displayName: string;
5019
+ provider: string;
5020
+ description?: string | null;
5021
+ isDefault: boolean;
5022
+ }
5023
+ export interface SurveyEmailRequest {
4498
5024
  loanOfficerEmailAddress: string;
4499
5025
  }
4500
5026
  export interface SystemTokenRequest {
@@ -4706,7 +5232,7 @@ export interface UnregisteredBorrower {
4706
5232
  lastName?: string | null;
4707
5233
  fullName?: string | null;
4708
5234
  email?: string | null;
4709
- role: UnregisteredBorrowerRoleEnum;
5235
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
4710
5236
  }
4711
5237
  export interface UpdateAccountRequest {
4712
5238
  name: string;
@@ -4717,6 +5243,47 @@ export interface UpdateAccountRequest {
4717
5243
  asoSettings?: ASOSettings | null;
4718
5244
  settings: AccountSettingsRequest;
4719
5245
  }
5246
+ export interface UpdateAiAccountTokenLimitRequest {
5247
+ /** @format int32 */
5248
+ tokenLimit: number;
5249
+ }
5250
+ export interface UpdateAiCanonicalFieldRequest {
5251
+ displayName: string;
5252
+ description: string;
5253
+ allowedRoles: string[];
5254
+ isPii: boolean;
5255
+ category?: string | null;
5256
+ }
5257
+ export interface UpdateAiGuardrailRequest {
5258
+ name: string;
5259
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5260
+ description?: string | null;
5261
+ keywords: string[];
5262
+ responseTemplate: string;
5263
+ }
5264
+ export interface UpdateAiPromptRequest {
5265
+ title: string;
5266
+ description: string;
5267
+ documentTypes: string[];
5268
+ applicableUrlSourceIds: string[];
5269
+ allowedRoles: string[];
5270
+ systemPrompt: string;
5271
+ /** @format int32 */
5272
+ sortOrder: number;
5273
+ category?: AiPromptCategory | null;
5274
+ queryTemplateName?: AiQueryTemplateName | null;
5275
+ displayHint?: AiDisplayHint | null;
5276
+ bedrockModelId?: string | null;
5277
+ requiredDataSources?: string[] | null;
5278
+ outputType?: AiOutputType | null;
5279
+ }
5280
+ export interface UpdateAiUrlSourceRequest {
5281
+ name: string;
5282
+ url: string;
5283
+ description?: string | null;
5284
+ category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5285
+ scope: "FullDomain" | "SpecificPath";
5286
+ }
4720
5287
  export interface UpdateCustomFieldDefinitionRequest {
4721
5288
  isRequired: boolean;
4722
5289
  /** @format int32 */
@@ -5002,7 +5569,7 @@ export interface UserDevice {
5002
5569
  export interface UserDraft {
5003
5570
  /** @format uuid */
5004
5571
  draftID: string;
5005
- role: UserDraftRoleEnum;
5572
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5006
5573
  user: User;
5007
5574
  }
5008
5575
  export interface UserDraftPaginated {
@@ -5026,7 +5593,7 @@ export interface UserGroupAccessScope {
5026
5593
  id: string;
5027
5594
  /** @format uuid */
5028
5595
  groupId: string;
5029
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5596
+ scopeType: "User" | "Branch";
5030
5597
  /** @format uuid */
5031
5598
  userId?: string | null;
5032
5599
  /** @format uuid */
@@ -5059,7 +5626,7 @@ export interface UserLoan {
5059
5626
  deletedAt?: string | null;
5060
5627
  loanID: string;
5061
5628
  user: User;
5062
- role: UserLoanRoleEnum;
5629
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5063
5630
  /** @format int32 */
5064
5631
  borrowerPair?: number | null;
5065
5632
  /** @format int32 */
@@ -5071,11 +5638,11 @@ export interface UserLoanConsent {
5071
5638
  id: string;
5072
5639
  /** @format uuid */
5073
5640
  userLoanID: string;
5074
- type: UserLoanConsentTypeEnum;
5641
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5075
5642
  providedConsent: boolean;
5076
5643
  source?: ConsentSource | null;
5077
5644
  ipAddress?: string | null;
5078
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5645
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5079
5646
  /** @format date-time */
5080
5647
  createdAt: string;
5081
5648
  /** @format date-time */
@@ -5205,7 +5772,7 @@ export interface UserSummary {
5205
5772
  id: string;
5206
5773
  name?: string | null;
5207
5774
  email?: string | null;
5208
- role: UserSummaryRoleEnum;
5775
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5209
5776
  }
5210
5777
  export interface VerifyPasswordRequest {
5211
5778
  email: string;
@@ -5232,74 +5799,6 @@ export interface Workflow {
5232
5799
  tileSubtitle: string;
5233
5800
  icon: string;
5234
5801
  }
5235
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5236
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5237
- export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5238
- export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5239
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5240
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5241
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5242
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5243
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5244
- /** @deprecated */
5245
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5246
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5247
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5248
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5249
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5250
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5251
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5252
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5253
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5254
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5255
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5256
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5257
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5258
- export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5259
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5260
- export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5261
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5262
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5263
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5264
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5265
- 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";
5266
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5267
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5268
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5269
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5270
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5271
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5272
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5273
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5274
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5275
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5276
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5277
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5278
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5279
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5280
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5281
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5282
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5283
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5284
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5285
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5286
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5287
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5288
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5289
- export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5290
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5291
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5292
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5293
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5294
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5295
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5296
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5297
- /** @default "Realtor" */
5298
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5299
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5300
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5301
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5302
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5303
5802
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5304
5803
  export type QueryParamsType = Record<string | number, any>;
5305
5804
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5322,7 +5821,14 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5322
5821
  secure?: boolean;
5323
5822
  format?: ResponseType;
5324
5823
  }
5325
- export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5824
+ export declare enum ContentType {
5825
+ JsonPatch = "application/json-patch+json",
5826
+ Json = "application/json",
5827
+ JsonApi = "application/vnd.api+json",
5828
+ FormData = "multipart/form-data",
5829
+ UrlEncoded = "application/x-www-form-urlencoded",
5830
+ Text = "text/plain"
5831
+ }
5326
5832
  export declare class HttpClient<SecurityDataType = unknown> {
5327
5833
  instance: AxiosInstance;
5328
5834
  private securityData;
@@ -5338,7 +5844,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5338
5844
  }
5339
5845
  /**
5340
5846
  * @title The Big POS API
5341
- * @version v2.44.0
5847
+ * @version v2.44.2
5342
5848
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5343
5849
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5344
5850
  */
@@ -5499,6 +6005,815 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5499
6005
  * @response `422` `ProblemDetails` Unprocessable Content
5500
6006
  */
5501
6007
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
6008
+ /**
6009
+ * No description
6010
+ *
6011
+ * @tags AiAdmin
6012
+ * @name GetAiAuditLogs
6013
+ * @summary Get paginated audit logs
6014
+ * @request GET:/api/ai/admin/audit-logs
6015
+ * @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, {}>>;
5502
6817
  /**
5503
6818
  * No description
5504
6819
  *
@@ -6023,7 +7338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6023
7338
  * @response `200` `(CustomFieldDefinition)[]` OK
6024
7339
  */
6025
7340
  getCustomFieldDefinitions: (query?: {
6026
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7341
+ entityType?: "Loan";
6027
7342
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
6028
7343
  /**
6029
7344
  * No description
@@ -7530,10 +8845,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7530
8845
  * @summary Download By ID
7531
8846
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
7532
8847
  * @secure
7533
- * @response `200` `Blob` OK
8848
+ * @response `200` `string` OK
7534
8849
  * @response `404` `ProblemDetails` Not Found
7535
8850
  */
7536
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8851
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
7537
8852
  /**
7538
8853
  * No description
7539
8854
  *
@@ -7603,6 +8918,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7603
8918
  * @response `404` `ProblemDetails` Not Found
7604
8919
  */
7605
8920
  syncLoanDocumentsFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any, {}>>;
8921
+ /**
8922
+ * No description
8923
+ *
8924
+ * @tags LoanDocuments
8925
+ * @name ClassifyLoanDocumentManually
8926
+ * @summary Manually classify a loan document
8927
+ * @request POST:/api/loans/{loanId}/documents/{documentId}/classify-manual
8928
+ * @secure
8929
+ * @response `200` `LoanDocument` OK
8930
+ * @response `404` `ProblemDetails` Not Found
8931
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8932
+ */
8933
+ classifyLoanDocumentManually: (loanId: string, documentId: string, data: ManualDocumentClassificationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocument, any, {}>>;
7606
8934
  /**
7607
8935
  * @description Re-attempts to push a failed document to LOS
7608
8936
  *
@@ -8576,6 +9904,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8576
9904
  * @name SendNotificationForLoan
8577
9905
  * @summary Send Notification for Loan
8578
9906
  * @request POST:/api/notifications
9907
+ * @deprecated
8579
9908
  * @secure
8580
9909
  * @response `200` `void` OK
8581
9910
  * @response `422` `UnprocessableEntity` Unprocessable Content
@@ -8588,6 +9917,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8588
9917
  * @name SendTestNotificationForLoan
8589
9918
  * @summary Send Test Notification for Loan
8590
9919
  * @request POST:/api/notifications/test
9920
+ * @deprecated
8591
9921
  * @secure
8592
9922
  * @response `200` `void` OK
8593
9923
  * @response `422` `UnprocessableEntity` Unprocessable Content
@@ -8749,7 +10079,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8749
10079
  getPartners: (query?: {
8750
10080
  showAll?: boolean;
8751
10081
  /** @default "Realtor" */
8752
- role?: GetPartnersParamsRoleEnum;
10082
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8753
10083
  /** @format int32 */
8754
10084
  pageSize?: number;
8755
10085
  /** @format int32 */
@@ -8927,7 +10257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8927
10257
  * @response `200` `File` OK
8928
10258
  * @response `404` `ProblemDetails` Not Found
8929
10259
  */
8930
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10260
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8931
10261
  /**
8932
10262
  * No description
8933
10263
  *
@@ -8938,7 +10268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8938
10268
  * @secure
8939
10269
  * @response `200` `File` OK
8940
10270
  */
8941
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10271
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8942
10272
  /**
8943
10273
  * No description
8944
10274
  *