@matech/thebigpos-sdk 2.36.16-rc3 → 2.37.6-aibi-11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -54,6 +54,15 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
54
54
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
55
55
  export type BorrowerApplicationStatus = "Draft" | "Complete";
56
56
  export type BillingType = "ClosedLoan" | "LoanOfficer";
57
+ export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
58
+ export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
59
+ export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans";
60
+ export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
61
+ export type AiOutputType = "Text" | "Document";
62
+ export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
63
+ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
64
+ export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
65
+ export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
57
66
  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";
58
67
  export interface ASOSettings {
59
68
  enabled: boolean;
@@ -104,7 +113,7 @@ export interface AccountBilling {
104
113
  contractedRate: number;
105
114
  }
106
115
  export interface AccountBillingRequest {
107
- billingType: AccountBillingRequestBillingTypeEnum;
116
+ billingType: "ClosedLoan" | "LoanOfficer";
108
117
  /**
109
118
  * @format double
110
119
  * @min 0
@@ -118,6 +127,7 @@ export interface AccountSettings {
118
127
  smsNumber?: string | null;
119
128
  ssoHostOverride?: string | null;
120
129
  isEarlyAdopter: boolean;
130
+ isAIEnabled: boolean;
121
131
  }
122
132
  export interface AccountSettingsRequest {
123
133
  isSmsEnabled: boolean;
@@ -179,7 +189,7 @@ export interface AddressV3 {
179
189
  }
180
190
  export interface AdminAccessGetForms {
181
191
  /** @format date-time */
182
- createdAt?: string | null;
192
+ createdAt: string;
183
193
  /** @format date-time */
184
194
  updatedAt?: string | null;
185
195
  /** @format date-time */
@@ -200,7 +210,7 @@ export interface AdminAccessGetForms {
200
210
  }
201
211
  export interface AdminAccessUser {
202
212
  /** @format date-time */
203
- createdAt?: string | null;
213
+ createdAt: string;
204
214
  /** @format date-time */
205
215
  updatedAt?: string | null;
206
216
  /** @format date-time */
@@ -317,6 +327,206 @@ export interface AffordabilityCalculatorRequest {
317
327
  */
318
328
  annualInsurance: number;
319
329
  }
330
+ export interface AiAdminStats {
331
+ /** @format int32 */
332
+ totalRequests: number;
333
+ /** @format int32 */
334
+ blockedRequests: number;
335
+ /** @format double */
336
+ averageResponseTimeMs: number;
337
+ intentDistribution: Record<string, number>;
338
+ topQueryTemplates: Record<string, number>;
339
+ period: string;
340
+ }
341
+ export interface AiAuditLog {
342
+ /** @format uuid */
343
+ id: string;
344
+ /** @format uuid */
345
+ requestId: string;
346
+ /** @format uuid */
347
+ userId: string;
348
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
349
+ details?: any;
350
+ /** @format date-time */
351
+ createdAt: string;
352
+ }
353
+ export interface AiAuditLogPaginated {
354
+ rows: AiAuditLog[];
355
+ pagination: Pagination;
356
+ /** @format int64 */
357
+ count: number;
358
+ }
359
+ export interface AiCanonicalField {
360
+ /** @format uuid */
361
+ id: string;
362
+ canonicalName: string;
363
+ displayName: string;
364
+ description: string;
365
+ allowedRoles: string[];
366
+ efPath?: string | null;
367
+ isPii: boolean;
368
+ isActive: boolean;
369
+ dataSource: string;
370
+ isDefault: boolean;
371
+ category?: string | null;
372
+ jsonPropertyName?: string | null;
373
+ textractKey?: string | null;
374
+ textractKeyAliases?: string | null;
375
+ hasAccountOverride: boolean;
376
+ /** @format date-time */
377
+ createdAt: string;
378
+ /** @format date-time */
379
+ updatedAt?: string | null;
380
+ }
381
+ export interface AiChat {
382
+ /** @format uuid */
383
+ conversationId: string;
384
+ /** @format uuid */
385
+ messageId: string;
386
+ response: AiChatBody;
387
+ metadata: AiChatMetadata;
388
+ }
389
+ export interface AiChatBody {
390
+ text: string;
391
+ data?: AiChatStructuredData | null;
392
+ suggestedFollowUps: string[];
393
+ }
394
+ export interface AiChatMessage {
395
+ /** @format uuid */
396
+ id: string;
397
+ userMessage: string;
398
+ assistantResponse: string;
399
+ intent?: AiIntent | null;
400
+ fieldsAccessed?: string[] | null;
401
+ /** @format date-time */
402
+ createdAt: string;
403
+ }
404
+ export interface AiChatMetadata {
405
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
406
+ fieldsAccessed: string[];
407
+ /** @format int64 */
408
+ queryTimeMs: number;
409
+ /** @format int64 */
410
+ llmTimeMs: number;
411
+ wasBlocked: boolean;
412
+ blockedReason?: string | null;
413
+ }
414
+ export interface AiChatRequest {
415
+ /**
416
+ * @minLength 1
417
+ * @maxLength 2000
418
+ */
419
+ message: string;
420
+ /** @format uuid */
421
+ conversationId?: string | null;
422
+ /** @format uuid */
423
+ loanId?: string | null;
424
+ documentIds?: string[] | null;
425
+ /** @format uuid */
426
+ promptId?: string | null;
427
+ }
428
+ export interface AiChatStructuredData {
429
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
430
+ displayHint?: AiDisplayHint | null;
431
+ detectedDocumentType?: string | null;
432
+ columns: string[];
433
+ rows: string[][];
434
+ /** @format uuid */
435
+ generatedDocumentId?: string | null;
436
+ generatedFileName?: string | null;
437
+ }
438
+ export interface AiConversationDetail {
439
+ /** @format uuid */
440
+ id: string;
441
+ /** @format date-time */
442
+ createdAt: string;
443
+ /** @format date-time */
444
+ updatedAt?: string | null;
445
+ messages: AiChatMessage[];
446
+ }
447
+ export interface AiConversationListItem {
448
+ /** @format uuid */
449
+ id: string;
450
+ preview: string;
451
+ /** @format int32 */
452
+ messageCount: number;
453
+ /** @format date-time */
454
+ createdAt: string;
455
+ /** @format date-time */
456
+ updatedAt?: string | null;
457
+ }
458
+ export interface AiConversationListItemPaginated {
459
+ rows: AiConversationListItem[];
460
+ pagination: Pagination;
461
+ /** @format int64 */
462
+ count: number;
463
+ }
464
+ export interface AiGuardrail {
465
+ /** @format uuid */
466
+ id: string;
467
+ name: string;
468
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
469
+ description?: string | null;
470
+ keywords: string[];
471
+ responseTemplate: string;
472
+ isDefault: boolean;
473
+ isEnabled: boolean;
474
+ hasAccountOverride: boolean;
475
+ /** @format date-time */
476
+ createdAt: string;
477
+ /** @format date-time */
478
+ updatedAt?: string | null;
479
+ }
480
+ export interface AiPrompt {
481
+ /** @format uuid */
482
+ id: string;
483
+ title: string;
484
+ icon: string;
485
+ slug: string;
486
+ description: string;
487
+ documentTypes: string[];
488
+ applicableGuidelines: string[];
489
+ allowedRoles: string[];
490
+ systemPrompt: string;
491
+ userPromptTemplate: string;
492
+ followUpPrompts: string[];
493
+ /** @format int32 */
494
+ sortOrder: number;
495
+ isDefault: boolean;
496
+ /** @format uuid */
497
+ accountId?: string | null;
498
+ isActive: boolean;
499
+ category?: AiPromptCategory | null;
500
+ queryTemplateName?: AiQueryTemplateName | null;
501
+ displayHint?: AiDisplayHint | null;
502
+ bedrockModelId?: string | null;
503
+ requiredDataSources?: string[] | null;
504
+ outputType?: AiOutputType | null;
505
+ hasAccountOverride: boolean;
506
+ /** @format date-time */
507
+ createdAt: string;
508
+ /** @format date-time */
509
+ updatedAt?: string | null;
510
+ }
511
+ export interface AiPromptSummary {
512
+ /** @format uuid */
513
+ id: string;
514
+ title: string;
515
+ icon: string;
516
+ slug: string;
517
+ description: string;
518
+ documentTypes: string[];
519
+ applicableGuidelines: string[];
520
+ followUpPrompts: string[];
521
+ /** @format int32 */
522
+ sortOrder: number;
523
+ category?: AiPromptCategory | null;
524
+ queryTemplateName?: AiQueryTemplateName | null;
525
+ displayHint?: AiDisplayHint | null;
526
+ bedrockModelId?: string | null;
527
+ requiredDataSources?: string[] | null;
528
+ outputType?: AiOutputType | null;
529
+ }
320
530
  export interface AllowImpersonationRequest {
321
531
  /**
322
532
  * @format email
@@ -415,6 +625,43 @@ export interface Attachment {
415
625
  fileName: string;
416
626
  base64Data: string;
417
627
  }
628
+ export interface AuditLogEntry {
629
+ /** @format uuid */
630
+ id: string;
631
+ entityType: string;
632
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
633
+ /** @format uuid */
634
+ entityId: string;
635
+ performedBy?: AuditLogUser | null;
636
+ changes?: any;
637
+ /** @format date-time */
638
+ createdAt: string;
639
+ }
640
+ export interface AuditLogEntryPaginated {
641
+ rows: AuditLogEntry[];
642
+ pagination: Pagination;
643
+ /** @format int64 */
644
+ count: number;
645
+ }
646
+ export interface AuditLogSearchCriteria {
647
+ entityType?: string | null;
648
+ changeType?: AuditChangeType | null;
649
+ /** @format uuid */
650
+ entityId?: string | null;
651
+ /** @format uuid */
652
+ performedById?: string | null;
653
+ /** @format date-time */
654
+ startDate?: string | null;
655
+ /** @format date-time */
656
+ endDate?: string | null;
657
+ }
658
+ export interface AuditLogUser {
659
+ /** @format uuid */
660
+ id: string;
661
+ firstName: string;
662
+ lastName: string;
663
+ email: string;
664
+ }
418
665
  export interface BranchBase {
419
666
  /** @format date-time */
420
667
  createdAt: string;
@@ -448,7 +695,7 @@ export interface BranchSummary {
448
695
  }
449
696
  export interface BranchUser {
450
697
  /** @format date-time */
451
- createdAt?: string | null;
698
+ createdAt: string;
452
699
  /** @format date-time */
453
700
  updatedAt?: string | null;
454
701
  /** @format date-time */
@@ -598,7 +845,7 @@ export interface ContactInfo {
598
845
  }
599
846
  export interface Corporate {
600
847
  /** @format date-time */
601
- createdAt?: string | null;
848
+ createdAt: string;
602
849
  /** @format date-time */
603
850
  updatedAt?: string | null;
604
851
  /** @format date-time */
@@ -639,7 +886,7 @@ export interface CorporateSearchCriteria {
639
886
  isActive?: boolean | null;
640
887
  }
641
888
  export interface CreateAccessScopeRequest {
642
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
889
+ scopeType: "User" | "Branch";
643
890
  /** @format uuid */
644
891
  userId?: string | null;
645
892
  /** @format uuid */
@@ -662,10 +909,72 @@ export interface CreateAccountRequest {
662
909
  */
663
910
  nlmsid: number;
664
911
  settings: AccountSettingsRequest;
665
- environment: CreateAccountRequestEnvironmentEnum;
912
+ environment: "Development" | "Staging" | "UAT" | "Production";
666
913
  losIntegration: LOSIntegration;
667
914
  billingSettings: AccountBillingRequest;
668
915
  }
916
+ export interface CreateAiCanonicalFieldRequest {
917
+ /**
918
+ * @minLength 1
919
+ * @maxLength 200
920
+ */
921
+ displayName: string;
922
+ /** @minLength 1 */
923
+ description: string;
924
+ /** @minItems 1 */
925
+ allowedRoles: string[];
926
+ isPii: boolean;
927
+ /** @minLength 1 */
928
+ dataSource: string;
929
+ category?: string | null;
930
+ }
931
+ export interface CreateAiGuardrailRequest {
932
+ /**
933
+ * @minLength 1
934
+ * @maxLength 200
935
+ */
936
+ name: string;
937
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
938
+ description?: string | null;
939
+ /** @minItems 1 */
940
+ keywords: string[];
941
+ /** @minLength 1 */
942
+ responseTemplate: string;
943
+ }
944
+ export interface CreateAiPromptRequest {
945
+ /**
946
+ * @minLength 1
947
+ * @maxLength 200
948
+ */
949
+ title: string;
950
+ icon: string;
951
+ /**
952
+ * @minLength 1
953
+ * @maxLength 100
954
+ */
955
+ slug: string;
956
+ /**
957
+ * @minLength 1
958
+ * @maxLength 500
959
+ */
960
+ description: string;
961
+ documentTypes: string[];
962
+ applicableGuidelines: string[];
963
+ allowedRoles: string[];
964
+ /** @minLength 1 */
965
+ systemPrompt: string;
966
+ /** @minLength 1 */
967
+ userPromptTemplate: string;
968
+ followUpPrompts: string[];
969
+ /** @format int32 */
970
+ sortOrder: number;
971
+ category?: AiPromptCategory | null;
972
+ queryTemplateName?: AiQueryTemplateName | null;
973
+ displayHint?: AiDisplayHint | null;
974
+ bedrockModelId?: string | null;
975
+ requiredDataSources?: string[] | null;
976
+ outputType?: AiOutputType | null;
977
+ }
669
978
  export interface CreateBranchRequest {
670
979
  /**
671
980
  * @minLength 1
@@ -692,7 +1001,7 @@ export interface CreateDocumentTemplateRequest {
692
1001
  export interface CreateGroupMemberRequest {
693
1002
  /** @format uuid */
694
1003
  userId: string;
695
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1004
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
696
1005
  }
697
1006
  export interface CreateInviteRequest {
698
1007
  /** @minLength 1 */
@@ -703,7 +1012,7 @@ export interface CreateInviteRequest {
703
1012
  emailAddress: string;
704
1013
  phoneNumber?: string | null;
705
1014
  /** @deprecated */
706
- relationship: CreateInviteRequestRelationshipEnum;
1015
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
707
1016
  loanID: string;
708
1017
  route?: string | null;
709
1018
  /** @format uuid */
@@ -725,7 +1034,7 @@ export interface CreateLoanImportRequest {
725
1034
  * @minLength 1
726
1035
  */
727
1036
  startDate: string;
728
- importMode: CreateLoanImportRequestImportModeEnum;
1037
+ importMode: "All" | "NewOnly" | "UpdateOnly";
729
1038
  }
730
1039
  export interface CreateSession {
731
1040
  sessionId: string;
@@ -743,7 +1052,7 @@ export interface CreateUserDeviceRequest {
743
1052
  token: string;
744
1053
  }
745
1054
  export interface CreateUserDraft {
746
- loanRole: CreateUserDraftLoanRoleEnum;
1055
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
747
1056
  }
748
1057
  export interface CreateUserGroupRequest {
749
1058
  /**
@@ -799,7 +1108,7 @@ export interface CustomLoanData {
799
1108
  }
800
1109
  export interface DetailedUser {
801
1110
  /** @format date-time */
802
- createdAt?: string | null;
1111
+ createdAt: string;
803
1112
  /** @format date-time */
804
1113
  updatedAt?: string | null;
805
1114
  /** @format date-time */
@@ -939,7 +1248,7 @@ export interface DocumentSync {
939
1248
  }
940
1249
  export interface DocumentTemplate {
941
1250
  /** @format date-time */
942
- createdAt?: string | null;
1251
+ createdAt: string;
943
1252
  /** @format date-time */
944
1253
  updatedAt?: string | null;
945
1254
  /** @format date-time */
@@ -959,7 +1268,7 @@ export interface DocumentTemplate {
959
1268
  }
960
1269
  export interface DocumentTemplateBase {
961
1270
  /** @format date-time */
962
- createdAt?: string | null;
1271
+ createdAt: string;
963
1272
  /** @format date-time */
964
1273
  updatedAt?: string | null;
965
1274
  /** @format date-time */
@@ -1035,7 +1344,7 @@ export interface Draft {
1035
1344
  siteConfiguration: SiteConfigurationReduced;
1036
1345
  /** @format uuid */
1037
1346
  loanID?: string | null;
1038
- type: DraftTypeEnum;
1347
+ type: "NewLoan" | "EditLoan";
1039
1348
  isCoBorrower: boolean;
1040
1349
  }
1041
1350
  export interface DraftContent {
@@ -1053,7 +1362,7 @@ export interface DraftContent {
1053
1362
  siteConfiguration: SiteConfigurationReduced;
1054
1363
  /** @format uuid */
1055
1364
  loanID?: string | null;
1056
- type: DraftContentTypeEnum;
1365
+ type: "NewLoan" | "EditLoan";
1057
1366
  isCoBorrower: boolean;
1058
1367
  applicationPayload: any;
1059
1368
  }
@@ -1080,7 +1389,7 @@ export interface EConsentInformation {
1080
1389
  }
1081
1390
  export interface EnabledServices {
1082
1391
  /** @format date-time */
1083
- createdAt?: string | null;
1392
+ createdAt: string;
1084
1393
  /** @format date-time */
1085
1394
  updatedAt?: string | null;
1086
1395
  /** @format date-time */
@@ -1172,8 +1481,8 @@ export interface EncompassRequestLog {
1172
1481
  losId?: string | null;
1173
1482
  /** @format uuid */
1174
1483
  accountId: string;
1175
- operationType: EncompassRequestLogOperationTypeEnum;
1176
- outcome: EncompassRequestLogOutcomeEnum;
1484
+ operationType: "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1485
+ outcome: "Success" | "Failure" | "PartialSuccess";
1177
1486
  message: string;
1178
1487
  endpoint?: string | null;
1179
1488
  httpMethod?: string | null;
@@ -1235,7 +1544,7 @@ export interface ForcePasswordReset {
1235
1544
  }
1236
1545
  export interface Form {
1237
1546
  /** @format date-time */
1238
- createdAt?: string | null;
1547
+ createdAt: string;
1239
1548
  /** @format date-time */
1240
1549
  updatedAt?: string | null;
1241
1550
  /** @format date-time */
@@ -1390,7 +1699,7 @@ export interface FusionFieldDisplay {
1390
1699
  fieldValue: string;
1391
1700
  }
1392
1701
  export interface FusionReportFilter {
1393
- filterType: FusionReportFilterFilterTypeEnum;
1702
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1394
1703
  targetField: string;
1395
1704
  targetValue: string;
1396
1705
  }
@@ -1410,12 +1719,23 @@ export interface GenerateDocumentRequest {
1410
1719
  preview: boolean;
1411
1720
  recipients: string[];
1412
1721
  }
1722
+ export interface GenerateSystemPrompt {
1723
+ systemPrompt: string;
1724
+ }
1725
+ export interface GenerateSystemPromptRequest {
1726
+ /**
1727
+ * @minLength 1
1728
+ * @maxLength 2000
1729
+ */
1730
+ description: string;
1731
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
1732
+ }
1413
1733
  export interface GetApplications {
1414
1734
  applications: ApplicationRowData[];
1415
1735
  }
1416
1736
  export interface GetBranch {
1417
1737
  /** @format date-time */
1418
- createdAt?: string | null;
1738
+ createdAt: string;
1419
1739
  /** @format date-time */
1420
1740
  updatedAt?: string | null;
1421
1741
  /** @format date-time */
@@ -1504,7 +1824,7 @@ export interface GuidPatchOperation {
1504
1824
  from?: string | null;
1505
1825
  }
1506
1826
  export interface IPAddress {
1507
- addressFamily: IpAddressAddressFamilyEnum;
1827
+ 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";
1508
1828
  /** @format int64 */
1509
1829
  scopeId: number;
1510
1830
  isIPv6Multicast: boolean;
@@ -1521,7 +1841,7 @@ export interface IPAddress {
1521
1841
  }
1522
1842
  export interface ImpersonatedDetailedUser {
1523
1843
  /** @format date-time */
1524
- createdAt?: string | null;
1844
+ createdAt: string;
1525
1845
  /** @format date-time */
1526
1846
  updatedAt?: string | null;
1527
1847
  /** @format date-time */
@@ -1754,7 +2074,6 @@ export interface Loan {
1754
2074
  financial?: LoanFinancial | null;
1755
2075
  borrowers: LoanBorrower[];
1756
2076
  nonOwningBorrowers: LoanNonOwningBorrower[];
1757
- loanLogs: LoanLog[];
1758
2077
  userLoans: UserLoan[];
1759
2078
  contacts: LoanContact[];
1760
2079
  }
@@ -1811,7 +2130,7 @@ export interface LoanBorrower {
1811
2130
  citizenship?: LoanCitizenship | null;
1812
2131
  maritalStatus?: LoanMaritalStatus | null;
1813
2132
  languagePreference?: LoanLanguagePreference | null;
1814
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2133
+ applicationStatus: "Draft" | "Complete";
1815
2134
  /** @format int32 */
1816
2135
  numberOfDependents?: number | null;
1817
2136
  isPrimaryBorrower: boolean;
@@ -2668,7 +2987,7 @@ export interface LoanContact {
2668
2987
  email?: string | null;
2669
2988
  phone?: string | null;
2670
2989
  companyName?: string | null;
2671
- role: LoanContactRoleEnum;
2990
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
2672
2991
  }
2673
2992
  export interface LoanContactList {
2674
2993
  email: string;
@@ -2698,7 +3017,7 @@ export interface LoanDocument {
2698
3017
  }
2699
3018
  export interface LoanDocumentSearch {
2700
3019
  /** @format date-time */
2701
- createdAt?: string | null;
3020
+ createdAt: string;
2702
3021
  /** @format date-time */
2703
3022
  updatedAt?: string | null;
2704
3023
  /** @format date-time */
@@ -2793,13 +3112,13 @@ export interface LoanImport {
2793
3112
  /** @format int32 */
2794
3113
  importedCount: number;
2795
3114
  statusMessage?: string | null;
2796
- status: LoanImportStatusEnum;
2797
- importMode: LoanImportImportModeEnum;
3115
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3116
+ importMode: "All" | "NewOnly" | "UpdateOnly";
2798
3117
  /** @format date-time */
2799
3118
  createdAt?: string | null;
2800
3119
  }
2801
3120
  export interface LoanImportLog {
2802
- level: LoanImportLogLevelEnum;
3121
+ level: "None" | "Info" | "Warning" | "Error";
2803
3122
  message: string;
2804
3123
  /** @format date-time */
2805
3124
  createdAt: string;
@@ -2854,8 +3173,8 @@ export interface LoanListPaginated {
2854
3173
  export interface LoanLog {
2855
3174
  /** @format uuid */
2856
3175
  id: string;
2857
- level: LoanLogLevelEnum;
2858
- type: LoanLogTypeEnum;
3176
+ level: "None" | "Info" | "Warning" | "Error";
3177
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2859
3178
  message: string;
2860
3179
  /** @format date-time */
2861
3180
  createdAt: string;
@@ -2863,8 +3182,8 @@ export interface LoanLog {
2863
3182
  export interface LoanLogDetail {
2864
3183
  /** @format uuid */
2865
3184
  id: string;
2866
- level: LoanLogDetailLevelEnum;
2867
- type: LoanLogDetailTypeEnum;
3185
+ level: "None" | "Info" | "Warning" | "Error";
3186
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2868
3187
  message: string;
2869
3188
  /** @format date-time */
2870
3189
  createdAt: string;
@@ -3127,7 +3446,7 @@ export interface LoanUser {
3127
3446
  email: string;
3128
3447
  phone?: string | null;
3129
3448
  role: string;
3130
- loanRole: LoanUserLoanRoleEnum;
3449
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3131
3450
  isUser: boolean;
3132
3451
  /** @format date-time */
3133
3452
  createdAt: string;
@@ -3274,7 +3593,7 @@ export interface NoContentResult {
3274
3593
  }
3275
3594
  export interface NotificationTemplate {
3276
3595
  /** @format date-time */
3277
- createdAt?: string | null;
3596
+ createdAt: string;
3278
3597
  /** @format date-time */
3279
3598
  updatedAt?: string | null;
3280
3599
  /** @format date-time */
@@ -3298,7 +3617,7 @@ export interface NotificationTemplate {
3298
3617
  }
3299
3618
  export interface NotificationTemplateBase {
3300
3619
  /** @format date-time */
3301
- createdAt?: string | null;
3620
+ createdAt: string;
3302
3621
  /** @format date-time */
3303
3622
  updatedAt?: string | null;
3304
3623
  /** @format date-time */
@@ -3734,7 +4053,7 @@ export interface SSOTokenRequest {
3734
4053
  redirectUri: string;
3735
4054
  }
3736
4055
  export interface SamlMetadataRequest {
3737
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4056
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
3738
4057
  }
3739
4058
  export interface SendForgotPasswordRequest {
3740
4059
  /**
@@ -3762,14 +4081,14 @@ export interface SendNotificationForLoanRequest {
3762
4081
  }
3763
4082
  export interface SiteConfiguration {
3764
4083
  /** @format date-time */
3765
- createdAt?: string | null;
4084
+ createdAt: string;
3766
4085
  /** @format date-time */
3767
4086
  updatedAt?: string | null;
3768
4087
  /** @format date-time */
3769
4088
  deletedAt?: string | null;
3770
4089
  /** @format uuid */
3771
4090
  id: string;
3772
- type: SiteConfigurationTypeEnum;
4091
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3773
4092
  /** @format uuid */
3774
4093
  entityID: string;
3775
4094
  /** @format int32 */
@@ -3956,14 +4275,14 @@ export interface SiteConfiguration {
3956
4275
  }
3957
4276
  export interface SiteConfigurationByUrl {
3958
4277
  /** @format date-time */
3959
- createdAt?: string | null;
4278
+ createdAt: string;
3960
4279
  /** @format date-time */
3961
4280
  updatedAt?: string | null;
3962
4281
  /** @format date-time */
3963
4282
  deletedAt?: string | null;
3964
4283
  /** @format uuid */
3965
4284
  id: string;
3966
- type: SiteConfigurationByUrlTypeEnum;
4285
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3967
4286
  /** @format uuid */
3968
4287
  entityID: string;
3969
4288
  /** @format int32 */
@@ -4174,7 +4493,7 @@ export interface SiteConfigurationForm {
4174
4493
  export interface SiteConfigurationReduced {
4175
4494
  /** @format uuid */
4176
4495
  id: string;
4177
- type: SiteConfigurationReducedTypeEnum;
4496
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4178
4497
  url?: string | null;
4179
4498
  name: string;
4180
4499
  /** @format int64 */
@@ -4191,7 +4510,7 @@ export interface SiteConfigurationRequest {
4191
4510
  entityID: string;
4192
4511
  /** @format int32 */
4193
4512
  entityType: number;
4194
- type: SiteConfigurationRequestTypeEnum;
4513
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4195
4514
  url: string;
4196
4515
  name: string;
4197
4516
  introduction?: string | null;
@@ -4366,7 +4685,7 @@ export interface SiteConfigurationSearchCriteria {
4366
4685
  export interface SiteConfigurationSummary {
4367
4686
  /** @format uuid */
4368
4687
  id: string;
4369
- type: SiteConfigurationSummaryTypeEnum;
4688
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4370
4689
  url?: string | null;
4371
4690
  name: string;
4372
4691
  /** @format int64 */
@@ -4395,7 +4714,7 @@ export interface SiteConfigurationWithInherited {
4395
4714
  }
4396
4715
  export interface SocialSurveyRecord {
4397
4716
  /** @format date-time */
4398
- createdAt?: string | null;
4717
+ createdAt: string;
4399
4718
  /** @format date-time */
4400
4719
  updatedAt?: string | null;
4401
4720
  /** @format date-time */
@@ -4410,6 +4729,13 @@ export interface SocialSurveyRecord {
4410
4729
  /** @format date-time */
4411
4730
  reviewCompletedTimeStamp?: string | null;
4412
4731
  }
4732
+ export interface SupportedModel {
4733
+ modelId: string;
4734
+ displayName: string;
4735
+ provider: string;
4736
+ description?: string | null;
4737
+ isDefault: boolean;
4738
+ }
4413
4739
  export interface SurveyEmailRequest {
4414
4740
  /** @minLength 1 */
4415
4741
  loanOfficerEmailAddress: string;
@@ -4647,6 +4973,60 @@ export interface UpdateAccountRequest {
4647
4973
  asoSettings?: ASOSettings | null;
4648
4974
  settings: AccountSettingsRequest;
4649
4975
  }
4976
+ export interface UpdateAiCanonicalFieldRequest {
4977
+ /**
4978
+ * @minLength 1
4979
+ * @maxLength 200
4980
+ */
4981
+ displayName: string;
4982
+ /** @minLength 1 */
4983
+ description: string;
4984
+ /** @minItems 1 */
4985
+ allowedRoles: string[];
4986
+ isPii: boolean;
4987
+ }
4988
+ export interface UpdateAiGuardrailRequest {
4989
+ /**
4990
+ * @minLength 1
4991
+ * @maxLength 200
4992
+ */
4993
+ name: string;
4994
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
4995
+ description?: string | null;
4996
+ /** @minItems 1 */
4997
+ keywords: string[];
4998
+ /** @minLength 1 */
4999
+ responseTemplate: string;
5000
+ }
5001
+ export interface UpdateAiPromptRequest {
5002
+ /**
5003
+ * @minLength 1
5004
+ * @maxLength 200
5005
+ */
5006
+ title: string;
5007
+ icon: string;
5008
+ /**
5009
+ * @minLength 1
5010
+ * @maxLength 500
5011
+ */
5012
+ description: string;
5013
+ documentTypes: string[];
5014
+ applicableGuidelines: string[];
5015
+ allowedRoles: string[];
5016
+ /** @minLength 1 */
5017
+ systemPrompt: string;
5018
+ /** @minLength 1 */
5019
+ userPromptTemplate: string;
5020
+ followUpPrompts: string[];
5021
+ /** @format int32 */
5022
+ sortOrder: number;
5023
+ category?: AiPromptCategory | null;
5024
+ queryTemplateName?: AiQueryTemplateName | null;
5025
+ displayHint?: AiDisplayHint | null;
5026
+ bedrockModelId?: string | null;
5027
+ requiredDataSources?: string[] | null;
5028
+ outputType?: AiOutputType | null;
5029
+ }
4650
5030
  export interface UpdateDocumentTemplateRequest {
4651
5031
  /** @minLength 1 */
4652
5032
  htmlBody: string;
@@ -4897,7 +5277,7 @@ export interface UsageReportStatistics {
4897
5277
  }
4898
5278
  export interface User {
4899
5279
  /** @format date-time */
4900
- createdAt?: string | null;
5280
+ createdAt: string;
4901
5281
  /** @format date-time */
4902
5282
  updatedAt?: string | null;
4903
5283
  /** @format date-time */
@@ -4943,7 +5323,7 @@ export interface UserDevice {
4943
5323
  export interface UserDraft {
4944
5324
  /** @format uuid */
4945
5325
  draftID: string;
4946
- role: UserDraftRoleEnum;
5326
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
4947
5327
  user: User;
4948
5328
  }
4949
5329
  export interface UserDraftPaginated {
@@ -4967,7 +5347,7 @@ export interface UserGroupAccessScope {
4967
5347
  id: string;
4968
5348
  /** @format uuid */
4969
5349
  groupId: string;
4970
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5350
+ scopeType: "User" | "Branch";
4971
5351
  /** @format uuid */
4972
5352
  userId?: string | null;
4973
5353
  /** @format uuid */
@@ -5000,7 +5380,7 @@ export interface UserLoan {
5000
5380
  deletedAt?: string | null;
5001
5381
  loanID: string;
5002
5382
  user: User;
5003
- role: UserLoanRoleEnum;
5383
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5004
5384
  /** @format int32 */
5005
5385
  borrowerPair?: number | null;
5006
5386
  /** @format int32 */
@@ -5012,10 +5392,10 @@ export interface UserLoanConsent {
5012
5392
  id: string;
5013
5393
  /** @format uuid */
5014
5394
  userLoanID: string;
5015
- type: UserLoanConsentTypeEnum;
5395
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5016
5396
  providedConsent: boolean;
5017
5397
  ipAddress?: string | null;
5018
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5398
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5019
5399
  /** @format date-time */
5020
5400
  createdAt: string;
5021
5401
  }
@@ -5147,7 +5527,7 @@ export interface UserSummary {
5147
5527
  id: string;
5148
5528
  name?: string | null;
5149
5529
  email?: string | null;
5150
- role: UserSummaryRoleEnum;
5530
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5151
5531
  }
5152
5532
  export interface VerifyPasswordRequest {
5153
5533
  /**
@@ -5180,48 +5560,6 @@ export interface Workflow {
5180
5560
  tileSubtitle: string;
5181
5561
  icon: string;
5182
5562
  }
5183
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5184
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5185
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5186
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5187
- /** @deprecated */
5188
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5189
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5190
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5191
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5192
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5193
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5194
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5195
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5196
- 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";
5197
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5198
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5199
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5200
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5201
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5202
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5203
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
5204
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5205
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
5206
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5207
- export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5208
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5209
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5210
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5211
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5212
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5213
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5214
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5215
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5216
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5217
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5218
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5219
- /** @default "Realtor" */
5220
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5221
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5222
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5223
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5224
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5225
5563
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5226
5564
  export type QueryParamsType = Record<string | number, any>;
5227
5565
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5267,7 +5605,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5267
5605
  }
5268
5606
  /**
5269
5607
  * @title The Big POS API
5270
- * @version v2.36.15
5608
+ * @version v2.37.6
5271
5609
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5272
5610
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5273
5611
  */
@@ -5405,6 +5743,386 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5405
5743
  * @response `422` `ProblemDetails` Client Error
5406
5744
  */
5407
5745
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
5746
+ /**
5747
+ * No description
5748
+ *
5749
+ * @tags AiAdmin
5750
+ * @name GetAiAuditLogs
5751
+ * @summary Get paginated audit logs
5752
+ * @request GET:/api/ai/admin/audit-logs
5753
+ * @secure
5754
+ * @response `200` `AiAuditLogPaginated` Success
5755
+ */
5756
+ getAiAuditLogs: (query?: {
5757
+ eventType?: AiAuditEventType;
5758
+ /** @format date-time */
5759
+ startDate?: string;
5760
+ /** @format date-time */
5761
+ endDate?: string;
5762
+ /** @format int32 */
5763
+ pageSize?: number;
5764
+ /** @format int32 */
5765
+ pageNumber?: number;
5766
+ sortBy?: string;
5767
+ sortDirection?: string;
5768
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
5769
+ /**
5770
+ * No description
5771
+ *
5772
+ * @tags AiAdmin
5773
+ * @name GetAiAdminStats
5774
+ * @summary Get AI admin dashboard stats
5775
+ * @request GET:/api/ai/admin/stats
5776
+ * @secure
5777
+ * @response `200` `AiAdminStats` Success
5778
+ */
5779
+ getAiAdminStats: (query?: {
5780
+ /** @format date-time */
5781
+ startDate?: string;
5782
+ /** @format date-time */
5783
+ endDate?: string;
5784
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
5785
+ /**
5786
+ * No description
5787
+ *
5788
+ * @tags AiAdminPrompt
5789
+ * @name GetAiPrompts
5790
+ * @summary Get all prompts
5791
+ * @request GET:/api/ai/admin/prompts
5792
+ * @secure
5793
+ * @response `200` `(AiPrompt)[]` Success
5794
+ */
5795
+ getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
5796
+ /**
5797
+ * No description
5798
+ *
5799
+ * @tags AiAdminPrompt
5800
+ * @name CreateAiPrompt
5801
+ * @summary Create custom prompt
5802
+ * @request POST:/api/ai/admin/prompts
5803
+ * @secure
5804
+ * @response `201` `AiPrompt` Created
5805
+ * @response `400` `ProblemDetails` Bad Request
5806
+ */
5807
+ createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5808
+ /**
5809
+ * No description
5810
+ *
5811
+ * @tags AiAdminPrompt
5812
+ * @name GetAiPrompt
5813
+ * @summary Get prompt by ID
5814
+ * @request GET:/api/ai/admin/prompts/{id}
5815
+ * @secure
5816
+ * @response `200` `AiPrompt` Success
5817
+ * @response `404` `ProblemDetails` Not Found
5818
+ */
5819
+ getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5820
+ /**
5821
+ * No description
5822
+ *
5823
+ * @tags AiAdminPrompt
5824
+ * @name UpdateAiPrompt
5825
+ * @summary Update prompt
5826
+ * @request PUT:/api/ai/admin/prompts/{id}
5827
+ * @secure
5828
+ * @response `200` `AiPrompt` Success
5829
+ * @response `400` `ProblemDetails` Bad Request
5830
+ * @response `404` `ProblemDetails` Not Found
5831
+ */
5832
+ updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5833
+ /**
5834
+ * No description
5835
+ *
5836
+ * @tags AiAdminPrompt
5837
+ * @name DeleteAiPrompt
5838
+ * @summary Delete prompt
5839
+ * @request DELETE:/api/ai/admin/prompts/{id}
5840
+ * @secure
5841
+ * @response `204` `void` No Content
5842
+ * @response `400` `ProblemDetails` Bad Request
5843
+ * @response `404` `ProblemDetails` Not Found
5844
+ */
5845
+ deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5846
+ /**
5847
+ * No description
5848
+ *
5849
+ * @tags AiAdminPrompt
5850
+ * @name ToggleAiPrompt
5851
+ * @summary Toggle prompt active/inactive
5852
+ * @request PATCH:/api/ai/admin/prompts/{id}/toggle
5853
+ * @secure
5854
+ * @response `200` `AiPrompt` Success
5855
+ * @response `404` `ProblemDetails` Not Found
5856
+ */
5857
+ toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5858
+ /**
5859
+ * No description
5860
+ *
5861
+ * @tags AiAdminPrompt
5862
+ * @name GenerateAiSystemPrompt
5863
+ * @summary Generate a system prompt from description
5864
+ * @request POST:/api/ai/admin/prompts/generate
5865
+ * @secure
5866
+ * @response `200` `GenerateSystemPrompt` Success
5867
+ * @response `400` `ProblemDetails` Bad Request
5868
+ */
5869
+ generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
5870
+ /**
5871
+ * No description
5872
+ *
5873
+ * @tags AiAdminPrompt
5874
+ * @name GetSupportedModels
5875
+ * @summary Get supported LLM models
5876
+ * @request GET:/api/ai/admin/prompts/supported-models
5877
+ * @secure
5878
+ * @response `200` `(SupportedModel)[]` Success
5879
+ */
5880
+ getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
5881
+ /**
5882
+ * No description
5883
+ *
5884
+ * @tags AiCanonicalField
5885
+ * @name GetAiCanonicalFields
5886
+ * @summary Get all canonical fields
5887
+ * @request GET:/api/ai/admin/fields
5888
+ * @secure
5889
+ * @response `200` `(AiCanonicalField)[]` Success
5890
+ */
5891
+ getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
5892
+ /**
5893
+ * No description
5894
+ *
5895
+ * @tags AiCanonicalField
5896
+ * @name CreateAiCanonicalField
5897
+ * @summary Create canonical field
5898
+ * @request POST:/api/ai/admin/fields
5899
+ * @secure
5900
+ * @response `201` `AiCanonicalField` Created
5901
+ * @response `400` `ProblemDetails` Bad Request
5902
+ */
5903
+ createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5904
+ /**
5905
+ * No description
5906
+ *
5907
+ * @tags AiCanonicalField
5908
+ * @name GetAiCanonicalField
5909
+ * @summary Get canonical field by ID
5910
+ * @request GET:/api/ai/admin/fields/{id}
5911
+ * @secure
5912
+ * @response `200` `AiCanonicalField` Success
5913
+ * @response `404` `ProblemDetails` Not Found
5914
+ */
5915
+ getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5916
+ /**
5917
+ * No description
5918
+ *
5919
+ * @tags AiCanonicalField
5920
+ * @name UpdateAiCanonicalField
5921
+ * @summary Update canonical field
5922
+ * @request PUT:/api/ai/admin/fields/{id}
5923
+ * @secure
5924
+ * @response `200` `AiCanonicalField` Success
5925
+ * @response `400` `ProblemDetails` Bad Request
5926
+ * @response `404` `ProblemDetails` Not Found
5927
+ */
5928
+ updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5929
+ /**
5930
+ * No description
5931
+ *
5932
+ * @tags AiCanonicalField
5933
+ * @name DeleteAiCanonicalField
5934
+ * @summary Delete canonical field
5935
+ * @request DELETE:/api/ai/admin/fields/{id}
5936
+ * @secure
5937
+ * @response `204` `void` No Content
5938
+ * @response `404` `ProblemDetails` Not Found
5939
+ */
5940
+ deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5941
+ /**
5942
+ * No description
5943
+ *
5944
+ * @tags AiCanonicalField
5945
+ * @name ToggleAiCanonicalField
5946
+ * @summary Toggle canonical field active/inactive
5947
+ * @request PATCH:/api/ai/admin/fields/{id}/toggle
5948
+ * @secure
5949
+ * @response `200` `AiCanonicalField` Success
5950
+ * @response `404` `ProblemDetails` Not Found
5951
+ */
5952
+ toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5953
+ /**
5954
+ * No description
5955
+ *
5956
+ * @tags AiChat
5957
+ * @name AiChat
5958
+ * @summary Send AI chat message
5959
+ * @request POST:/api/ai/chat
5960
+ * @secure
5961
+ * @response `200` `AiChat` Success
5962
+ * @response `400` `ProblemDetails` Bad Request
5963
+ * @response `401` `ProblemDetails` Unauthorized
5964
+ */
5965
+ aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
5966
+ /**
5967
+ * No description
5968
+ *
5969
+ * @tags AiConversation
5970
+ * @name GetAiConversations
5971
+ * @summary Get user conversations
5972
+ * @request GET:/api/ai/conversations
5973
+ * @secure
5974
+ * @response `200` `AiConversationListItemPaginated` Success
5975
+ */
5976
+ getAiConversations: (query?: {
5977
+ /** @format int32 */
5978
+ pageSize?: number;
5979
+ /** @format int32 */
5980
+ pageNumber?: number;
5981
+ sortBy?: string;
5982
+ sortDirection?: string;
5983
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
5984
+ /**
5985
+ * No description
5986
+ *
5987
+ * @tags AiConversation
5988
+ * @name GetAiConversation
5989
+ * @summary Get conversation with messages
5990
+ * @request GET:/api/ai/conversations/{id}
5991
+ * @secure
5992
+ * @response `200` `AiConversationDetail` Success
5993
+ * @response `403` `ProblemDetails` Forbidden
5994
+ * @response `404` `ProblemDetails` Not Found
5995
+ */
5996
+ getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
5997
+ /**
5998
+ * No description
5999
+ *
6000
+ * @tags AiConversation
6001
+ * @name DeleteAiConversation
6002
+ * @summary Delete conversation
6003
+ * @request DELETE:/api/ai/conversations/{id}
6004
+ * @secure
6005
+ * @response `204` `void` No Content
6006
+ * @response `403` `ProblemDetails` Forbidden
6007
+ * @response `404` `ProblemDetails` Not Found
6008
+ */
6009
+ deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6010
+ /**
6011
+ * No description
6012
+ *
6013
+ * @tags AiGuardrail
6014
+ * @name GetAiGuardrails
6015
+ * @summary Get all guardrails
6016
+ * @request GET:/api/ai/admin/guardrails
6017
+ * @secure
6018
+ * @response `200` `(AiGuardrail)[]` Success
6019
+ */
6020
+ getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
6021
+ /**
6022
+ * No description
6023
+ *
6024
+ * @tags AiGuardrail
6025
+ * @name CreateAiGuardrail
6026
+ * @summary Create custom guardrail
6027
+ * @request POST:/api/ai/admin/guardrails
6028
+ * @secure
6029
+ * @response `201` `AiGuardrail` Created
6030
+ * @response `400` `ProblemDetails` Bad Request
6031
+ */
6032
+ createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6033
+ /**
6034
+ * No description
6035
+ *
6036
+ * @tags AiGuardrail
6037
+ * @name GetAiGuardrail
6038
+ * @summary Get guardrail by ID
6039
+ * @request GET:/api/ai/admin/guardrails/{id}
6040
+ * @secure
6041
+ * @response `200` `AiGuardrail` Success
6042
+ * @response `404` `ProblemDetails` Not Found
6043
+ */
6044
+ getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6045
+ /**
6046
+ * No description
6047
+ *
6048
+ * @tags AiGuardrail
6049
+ * @name UpdateAiGuardrail
6050
+ * @summary Update guardrail
6051
+ * @request PUT:/api/ai/admin/guardrails/{id}
6052
+ * @secure
6053
+ * @response `200` `AiGuardrail` Success
6054
+ * @response `400` `ProblemDetails` Bad Request
6055
+ * @response `404` `ProblemDetails` Not Found
6056
+ */
6057
+ updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6058
+ /**
6059
+ * No description
6060
+ *
6061
+ * @tags AiGuardrail
6062
+ * @name DeleteAiGuardrail
6063
+ * @summary Delete guardrail
6064
+ * @request DELETE:/api/ai/admin/guardrails/{id}
6065
+ * @secure
6066
+ * @response `204` `void` No Content
6067
+ * @response `400` `ProblemDetails` Bad Request
6068
+ * @response `404` `ProblemDetails` Not Found
6069
+ */
6070
+ deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6071
+ /**
6072
+ * No description
6073
+ *
6074
+ * @tags AiGuardrail
6075
+ * @name ToggleAiGuardrail
6076
+ * @summary Toggle guardrail enabled/disabled
6077
+ * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6078
+ * @secure
6079
+ * @response `200` `AiGuardrail` Success
6080
+ * @response `404` `ProblemDetails` Not Found
6081
+ */
6082
+ toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6083
+ /**
6084
+ * No description
6085
+ *
6086
+ * @tags AiPrompt
6087
+ * @name GetAvailablePrompts
6088
+ * @summary Get available prompts for current user
6089
+ * @request GET:/api/ai/prompts
6090
+ * @secure
6091
+ * @response `200` `(AiPromptSummary)[]` Success
6092
+ */
6093
+ getAvailablePrompts: (query?: {
6094
+ documentType?: string;
6095
+ }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
6096
+ /**
6097
+ * No description
6098
+ *
6099
+ * @tags AuditLog
6100
+ * @name SearchAuditLogs
6101
+ * @summary Search
6102
+ * @request POST:/api/audit-logs/search
6103
+ * @secure
6104
+ * @response `200` `AuditLogEntryPaginated` Success
6105
+ */
6106
+ searchAuditLogs: (data: AuditLogSearchCriteria, query?: {
6107
+ /** @format int32 */
6108
+ pageSize?: number;
6109
+ /** @format int32 */
6110
+ pageNumber?: number;
6111
+ sortBy?: string;
6112
+ sortDirection?: string;
6113
+ }, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntryPaginated, any, {}>>;
6114
+ /**
6115
+ * No description
6116
+ *
6117
+ * @tags AuditLog
6118
+ * @name GetAuditLogById
6119
+ * @summary Get by ID
6120
+ * @request GET:/api/audit-logs/{id}
6121
+ * @secure
6122
+ * @response `200` `AuditLogEntry` Success
6123
+ * @response `404` `ProblemDetails` Not Found
6124
+ */
6125
+ getAuditLogById: (id: string, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntry, any, {}>>;
5408
6126
  /**
5409
6127
  * No description
5410
6128
  *
@@ -7543,6 +8261,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7543
8261
  * @response `200` `Loan` Success
7544
8262
  */
7545
8263
  importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
8264
+ /**
8265
+ * No description
8266
+ *
8267
+ * @tags Loans
8268
+ * @name SyncLoanToLos
8269
+ * @summary Sync loan to LOS
8270
+ * @request POST:/api/loans/{loanId}/sync-to-los
8271
+ * @secure
8272
+ * @response `202` `void` Accepted
8273
+ * @response `404` `ProblemDetails` Not Found
8274
+ */
8275
+ syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7546
8276
  /**
7547
8277
  * No description
7548
8278
  *
@@ -8074,7 +8804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8074
8804
  getPartners: (query?: {
8075
8805
  showAll?: boolean;
8076
8806
  /** @default "Realtor" */
8077
- role?: GetPartnersParamsRoleEnum;
8807
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8078
8808
  /** @format int32 */
8079
8809
  pageSize?: number;
8080
8810
  /** @format int32 */
@@ -8252,7 +8982,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8252
8982
  * @response `200` `File` Success
8253
8983
  * @response `404` `ProblemDetails` Not Found
8254
8984
  */
8255
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8985
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8256
8986
  /**
8257
8987
  * No description
8258
8988
  *
@@ -8263,7 +8993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8263
8993
  * @secure
8264
8994
  * @response `200` `File` Success
8265
8995
  */
8266
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8996
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8267
8997
  /**
8268
8998
  * No description
8269
8999
  *