@matech/thebigpos-sdk 2.36.16-rc2 → 2.37.0-aibi-10

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,14 @@ 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 AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
58
+ export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans";
59
+ export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
60
+ export type AiOutputType = "Text" | "Document";
61
+ export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
62
+ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
63
+ export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
64
+ export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
57
65
  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
66
  export interface ASOSettings {
59
67
  enabled: boolean;
@@ -104,7 +112,7 @@ export interface AccountBilling {
104
112
  contractedRate: number;
105
113
  }
106
114
  export interface AccountBillingRequest {
107
- billingType: AccountBillingRequestBillingTypeEnum;
115
+ billingType: "ClosedLoan" | "LoanOfficer";
108
116
  /**
109
117
  * @format double
110
118
  * @min 0
@@ -118,6 +126,7 @@ export interface AccountSettings {
118
126
  smsNumber?: string | null;
119
127
  ssoHostOverride?: string | null;
120
128
  isEarlyAdopter: boolean;
129
+ isAIEnabled: boolean;
121
130
  }
122
131
  export interface AccountSettingsRequest {
123
132
  isSmsEnabled: boolean;
@@ -179,7 +188,7 @@ export interface AddressV3 {
179
188
  }
180
189
  export interface AdminAccessGetForms {
181
190
  /** @format date-time */
182
- createdAt?: string | null;
191
+ createdAt: string;
183
192
  /** @format date-time */
184
193
  updatedAt?: string | null;
185
194
  /** @format date-time */
@@ -200,7 +209,7 @@ export interface AdminAccessGetForms {
200
209
  }
201
210
  export interface AdminAccessUser {
202
211
  /** @format date-time */
203
- createdAt?: string | null;
212
+ createdAt: string;
204
213
  /** @format date-time */
205
214
  updatedAt?: string | null;
206
215
  /** @format date-time */
@@ -317,6 +326,206 @@ export interface AffordabilityCalculatorRequest {
317
326
  */
318
327
  annualInsurance: number;
319
328
  }
329
+ export interface AiAdminStats {
330
+ /** @format int32 */
331
+ totalRequests: number;
332
+ /** @format int32 */
333
+ blockedRequests: number;
334
+ /** @format double */
335
+ averageResponseTimeMs: number;
336
+ intentDistribution: Record<string, number>;
337
+ topQueryTemplates: Record<string, number>;
338
+ period: string;
339
+ }
340
+ export interface AiAuditLog {
341
+ /** @format uuid */
342
+ id: string;
343
+ /** @format uuid */
344
+ requestId: string;
345
+ /** @format uuid */
346
+ userId: string;
347
+ eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
348
+ details?: any;
349
+ /** @format date-time */
350
+ createdAt: string;
351
+ }
352
+ export interface AiAuditLogPaginated {
353
+ rows: AiAuditLog[];
354
+ pagination: Pagination;
355
+ /** @format int64 */
356
+ count: number;
357
+ }
358
+ export interface AiCanonicalField {
359
+ /** @format uuid */
360
+ id: string;
361
+ canonicalName: string;
362
+ displayName: string;
363
+ description: string;
364
+ allowedRoles: string[];
365
+ efPath?: string | null;
366
+ isPii: boolean;
367
+ isActive: boolean;
368
+ dataSource: string;
369
+ isDefault: boolean;
370
+ category?: string | null;
371
+ jsonPropertyName?: string | null;
372
+ textractKey?: string | null;
373
+ textractKeyAliases?: string | null;
374
+ hasAccountOverride: boolean;
375
+ /** @format date-time */
376
+ createdAt: string;
377
+ /** @format date-time */
378
+ updatedAt?: string | null;
379
+ }
380
+ export interface AiChat {
381
+ /** @format uuid */
382
+ conversationId: string;
383
+ /** @format uuid */
384
+ messageId: string;
385
+ response: AiChatBody;
386
+ metadata: AiChatMetadata;
387
+ }
388
+ export interface AiChatBody {
389
+ text: string;
390
+ data?: AiChatStructuredData | null;
391
+ suggestedFollowUps: string[];
392
+ }
393
+ export interface AiChatMessage {
394
+ /** @format uuid */
395
+ id: string;
396
+ userMessage: string;
397
+ assistantResponse: string;
398
+ intent?: AiIntent | null;
399
+ fieldsAccessed?: string[] | null;
400
+ /** @format date-time */
401
+ createdAt: string;
402
+ }
403
+ export interface AiChatMetadata {
404
+ intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
405
+ fieldsAccessed: string[];
406
+ /** @format int64 */
407
+ queryTimeMs: number;
408
+ /** @format int64 */
409
+ llmTimeMs: number;
410
+ wasBlocked: boolean;
411
+ blockedReason?: string | null;
412
+ }
413
+ export interface AiChatRequest {
414
+ /**
415
+ * @minLength 1
416
+ * @maxLength 2000
417
+ */
418
+ message: string;
419
+ /** @format uuid */
420
+ conversationId?: string | null;
421
+ /** @format uuid */
422
+ loanId?: string | null;
423
+ documentIds?: string[] | null;
424
+ /** @format uuid */
425
+ promptId?: string | null;
426
+ }
427
+ export interface AiChatStructuredData {
428
+ type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
429
+ displayHint?: AiDisplayHint | null;
430
+ detectedDocumentType?: string | null;
431
+ columns: string[];
432
+ rows: string[][];
433
+ /** @format uuid */
434
+ generatedDocumentId?: string | null;
435
+ generatedFileName?: string | null;
436
+ }
437
+ export interface AiConversationDetail {
438
+ /** @format uuid */
439
+ id: string;
440
+ /** @format date-time */
441
+ createdAt: string;
442
+ /** @format date-time */
443
+ updatedAt?: string | null;
444
+ messages: AiChatMessage[];
445
+ }
446
+ export interface AiConversationListItem {
447
+ /** @format uuid */
448
+ id: string;
449
+ preview: string;
450
+ /** @format int32 */
451
+ messageCount: number;
452
+ /** @format date-time */
453
+ createdAt: string;
454
+ /** @format date-time */
455
+ updatedAt?: string | null;
456
+ }
457
+ export interface AiConversationListItemPaginated {
458
+ rows: AiConversationListItem[];
459
+ pagination: Pagination;
460
+ /** @format int64 */
461
+ count: number;
462
+ }
463
+ export interface AiGuardrail {
464
+ /** @format uuid */
465
+ id: string;
466
+ name: string;
467
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
468
+ description?: string | null;
469
+ keywords: string[];
470
+ responseTemplate: string;
471
+ isDefault: boolean;
472
+ isEnabled: boolean;
473
+ hasAccountOverride: boolean;
474
+ /** @format date-time */
475
+ createdAt: string;
476
+ /** @format date-time */
477
+ updatedAt?: string | null;
478
+ }
479
+ export interface AiPrompt {
480
+ /** @format uuid */
481
+ id: string;
482
+ title: string;
483
+ icon: string;
484
+ slug: string;
485
+ description: string;
486
+ documentTypes: string[];
487
+ applicableGuidelines: string[];
488
+ allowedRoles: string[];
489
+ systemPrompt: string;
490
+ userPromptTemplate: string;
491
+ followUpPrompts: string[];
492
+ /** @format int32 */
493
+ sortOrder: number;
494
+ isDefault: boolean;
495
+ /** @format uuid */
496
+ accountId?: string | null;
497
+ isActive: boolean;
498
+ category?: AiPromptCategory | null;
499
+ queryTemplateName?: AiQueryTemplateName | null;
500
+ displayHint?: AiDisplayHint | null;
501
+ bedrockModelId?: string | null;
502
+ requiredDataSources?: string[] | null;
503
+ outputType?: AiOutputType | null;
504
+ hasAccountOverride: boolean;
505
+ /** @format date-time */
506
+ createdAt: string;
507
+ /** @format date-time */
508
+ updatedAt?: string | null;
509
+ }
510
+ export interface AiPromptSummary {
511
+ /** @format uuid */
512
+ id: string;
513
+ title: string;
514
+ icon: string;
515
+ slug: string;
516
+ description: string;
517
+ documentTypes: string[];
518
+ applicableGuidelines: string[];
519
+ followUpPrompts: string[];
520
+ /** @format int32 */
521
+ sortOrder: number;
522
+ category?: AiPromptCategory | null;
523
+ queryTemplateName?: AiQueryTemplateName | null;
524
+ displayHint?: AiDisplayHint | null;
525
+ bedrockModelId?: string | null;
526
+ requiredDataSources?: string[] | null;
527
+ outputType?: AiOutputType | null;
528
+ }
320
529
  export interface AllowImpersonationRequest {
321
530
  /**
322
531
  * @format email
@@ -448,7 +657,7 @@ export interface BranchSummary {
448
657
  }
449
658
  export interface BranchUser {
450
659
  /** @format date-time */
451
- createdAt?: string | null;
660
+ createdAt: string;
452
661
  /** @format date-time */
453
662
  updatedAt?: string | null;
454
663
  /** @format date-time */
@@ -598,7 +807,7 @@ export interface ContactInfo {
598
807
  }
599
808
  export interface Corporate {
600
809
  /** @format date-time */
601
- createdAt?: string | null;
810
+ createdAt: string;
602
811
  /** @format date-time */
603
812
  updatedAt?: string | null;
604
813
  /** @format date-time */
@@ -639,7 +848,7 @@ export interface CorporateSearchCriteria {
639
848
  isActive?: boolean | null;
640
849
  }
641
850
  export interface CreateAccessScopeRequest {
642
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
851
+ scopeType: "User" | "Branch";
643
852
  /** @format uuid */
644
853
  userId?: string | null;
645
854
  /** @format uuid */
@@ -662,10 +871,72 @@ export interface CreateAccountRequest {
662
871
  */
663
872
  nlmsid: number;
664
873
  settings: AccountSettingsRequest;
665
- environment: CreateAccountRequestEnvironmentEnum;
874
+ environment: "Development" | "Staging" | "UAT" | "Production";
666
875
  losIntegration: LOSIntegration;
667
876
  billingSettings: AccountBillingRequest;
668
877
  }
878
+ export interface CreateAiCanonicalFieldRequest {
879
+ /**
880
+ * @minLength 1
881
+ * @maxLength 200
882
+ */
883
+ displayName: string;
884
+ /** @minLength 1 */
885
+ description: string;
886
+ /** @minItems 1 */
887
+ allowedRoles: string[];
888
+ isPii: boolean;
889
+ /** @minLength 1 */
890
+ dataSource: string;
891
+ category?: string | null;
892
+ }
893
+ export interface CreateAiGuardrailRequest {
894
+ /**
895
+ * @minLength 1
896
+ * @maxLength 200
897
+ */
898
+ name: string;
899
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
900
+ description?: string | null;
901
+ /** @minItems 1 */
902
+ keywords: string[];
903
+ /** @minLength 1 */
904
+ responseTemplate: string;
905
+ }
906
+ export interface CreateAiPromptRequest {
907
+ /**
908
+ * @minLength 1
909
+ * @maxLength 200
910
+ */
911
+ title: string;
912
+ icon: string;
913
+ /**
914
+ * @minLength 1
915
+ * @maxLength 100
916
+ */
917
+ slug: string;
918
+ /**
919
+ * @minLength 1
920
+ * @maxLength 500
921
+ */
922
+ description: string;
923
+ documentTypes: string[];
924
+ applicableGuidelines: string[];
925
+ allowedRoles: string[];
926
+ /** @minLength 1 */
927
+ systemPrompt: string;
928
+ /** @minLength 1 */
929
+ userPromptTemplate: string;
930
+ followUpPrompts: string[];
931
+ /** @format int32 */
932
+ sortOrder: number;
933
+ category?: AiPromptCategory | null;
934
+ queryTemplateName?: AiQueryTemplateName | null;
935
+ displayHint?: AiDisplayHint | null;
936
+ bedrockModelId?: string | null;
937
+ requiredDataSources?: string[] | null;
938
+ outputType?: AiOutputType | null;
939
+ }
669
940
  export interface CreateBranchRequest {
670
941
  /**
671
942
  * @minLength 1
@@ -692,7 +963,7 @@ export interface CreateDocumentTemplateRequest {
692
963
  export interface CreateGroupMemberRequest {
693
964
  /** @format uuid */
694
965
  userId: string;
695
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
966
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
696
967
  }
697
968
  export interface CreateInviteRequest {
698
969
  /** @minLength 1 */
@@ -703,7 +974,7 @@ export interface CreateInviteRequest {
703
974
  emailAddress: string;
704
975
  phoneNumber?: string | null;
705
976
  /** @deprecated */
706
- relationship: CreateInviteRequestRelationshipEnum;
977
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
707
978
  loanID: string;
708
979
  route?: string | null;
709
980
  /** @format uuid */
@@ -725,7 +996,7 @@ export interface CreateLoanImportRequest {
725
996
  * @minLength 1
726
997
  */
727
998
  startDate: string;
728
- importMode: CreateLoanImportRequestImportModeEnum;
999
+ importMode: "All" | "NewOnly" | "UpdateOnly";
729
1000
  }
730
1001
  export interface CreateSession {
731
1002
  sessionId: string;
@@ -743,7 +1014,7 @@ export interface CreateUserDeviceRequest {
743
1014
  token: string;
744
1015
  }
745
1016
  export interface CreateUserDraft {
746
- loanRole: CreateUserDraftLoanRoleEnum;
1017
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
747
1018
  }
748
1019
  export interface CreateUserGroupRequest {
749
1020
  /**
@@ -799,7 +1070,7 @@ export interface CustomLoanData {
799
1070
  }
800
1071
  export interface DetailedUser {
801
1072
  /** @format date-time */
802
- createdAt?: string | null;
1073
+ createdAt: string;
803
1074
  /** @format date-time */
804
1075
  updatedAt?: string | null;
805
1076
  /** @format date-time */
@@ -939,7 +1210,7 @@ export interface DocumentSync {
939
1210
  }
940
1211
  export interface DocumentTemplate {
941
1212
  /** @format date-time */
942
- createdAt?: string | null;
1213
+ createdAt: string;
943
1214
  /** @format date-time */
944
1215
  updatedAt?: string | null;
945
1216
  /** @format date-time */
@@ -959,7 +1230,7 @@ export interface DocumentTemplate {
959
1230
  }
960
1231
  export interface DocumentTemplateBase {
961
1232
  /** @format date-time */
962
- createdAt?: string | null;
1233
+ createdAt: string;
963
1234
  /** @format date-time */
964
1235
  updatedAt?: string | null;
965
1236
  /** @format date-time */
@@ -1035,7 +1306,7 @@ export interface Draft {
1035
1306
  siteConfiguration: SiteConfigurationReduced;
1036
1307
  /** @format uuid */
1037
1308
  loanID?: string | null;
1038
- type: DraftTypeEnum;
1309
+ type: "NewLoan" | "EditLoan";
1039
1310
  isCoBorrower: boolean;
1040
1311
  }
1041
1312
  export interface DraftContent {
@@ -1053,7 +1324,7 @@ export interface DraftContent {
1053
1324
  siteConfiguration: SiteConfigurationReduced;
1054
1325
  /** @format uuid */
1055
1326
  loanID?: string | null;
1056
- type: DraftContentTypeEnum;
1327
+ type: "NewLoan" | "EditLoan";
1057
1328
  isCoBorrower: boolean;
1058
1329
  applicationPayload: any;
1059
1330
  }
@@ -1080,7 +1351,7 @@ export interface EConsentInformation {
1080
1351
  }
1081
1352
  export interface EnabledServices {
1082
1353
  /** @format date-time */
1083
- createdAt?: string | null;
1354
+ createdAt: string;
1084
1355
  /** @format date-time */
1085
1356
  updatedAt?: string | null;
1086
1357
  /** @format date-time */
@@ -1172,8 +1443,8 @@ export interface EncompassRequestLog {
1172
1443
  losId?: string | null;
1173
1444
  /** @format uuid */
1174
1445
  accountId: string;
1175
- operationType: EncompassRequestLogOperationTypeEnum;
1176
- outcome: EncompassRequestLogOutcomeEnum;
1446
+ operationType: "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1447
+ outcome: "Success" | "Failure" | "PartialSuccess";
1177
1448
  message: string;
1178
1449
  endpoint?: string | null;
1179
1450
  httpMethod?: string | null;
@@ -1235,7 +1506,7 @@ export interface ForcePasswordReset {
1235
1506
  }
1236
1507
  export interface Form {
1237
1508
  /** @format date-time */
1238
- createdAt?: string | null;
1509
+ createdAt: string;
1239
1510
  /** @format date-time */
1240
1511
  updatedAt?: string | null;
1241
1512
  /** @format date-time */
@@ -1390,7 +1661,7 @@ export interface FusionFieldDisplay {
1390
1661
  fieldValue: string;
1391
1662
  }
1392
1663
  export interface FusionReportFilter {
1393
- filterType: FusionReportFilterFilterTypeEnum;
1664
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1394
1665
  targetField: string;
1395
1666
  targetValue: string;
1396
1667
  }
@@ -1410,12 +1681,23 @@ export interface GenerateDocumentRequest {
1410
1681
  preview: boolean;
1411
1682
  recipients: string[];
1412
1683
  }
1684
+ export interface GenerateSystemPrompt {
1685
+ systemPrompt: string;
1686
+ }
1687
+ export interface GenerateSystemPromptRequest {
1688
+ /**
1689
+ * @minLength 1
1690
+ * @maxLength 2000
1691
+ */
1692
+ description: string;
1693
+ category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
1694
+ }
1413
1695
  export interface GetApplications {
1414
1696
  applications: ApplicationRowData[];
1415
1697
  }
1416
1698
  export interface GetBranch {
1417
1699
  /** @format date-time */
1418
- createdAt?: string | null;
1700
+ createdAt: string;
1419
1701
  /** @format date-time */
1420
1702
  updatedAt?: string | null;
1421
1703
  /** @format date-time */
@@ -1504,7 +1786,7 @@ export interface GuidPatchOperation {
1504
1786
  from?: string | null;
1505
1787
  }
1506
1788
  export interface IPAddress {
1507
- addressFamily: IpAddressAddressFamilyEnum;
1789
+ 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
1790
  /** @format int64 */
1509
1791
  scopeId: number;
1510
1792
  isIPv6Multicast: boolean;
@@ -1521,7 +1803,7 @@ export interface IPAddress {
1521
1803
  }
1522
1804
  export interface ImpersonatedDetailedUser {
1523
1805
  /** @format date-time */
1524
- createdAt?: string | null;
1806
+ createdAt: string;
1525
1807
  /** @format date-time */
1526
1808
  updatedAt?: string | null;
1527
1809
  /** @format date-time */
@@ -1754,7 +2036,6 @@ export interface Loan {
1754
2036
  financial?: LoanFinancial | null;
1755
2037
  borrowers: LoanBorrower[];
1756
2038
  nonOwningBorrowers: LoanNonOwningBorrower[];
1757
- loanLogs: LoanLog[];
1758
2039
  userLoans: UserLoan[];
1759
2040
  contacts: LoanContact[];
1760
2041
  }
@@ -1811,7 +2092,7 @@ export interface LoanBorrower {
1811
2092
  citizenship?: LoanCitizenship | null;
1812
2093
  maritalStatus?: LoanMaritalStatus | null;
1813
2094
  languagePreference?: LoanLanguagePreference | null;
1814
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2095
+ applicationStatus: "Draft" | "Complete";
1815
2096
  /** @format int32 */
1816
2097
  numberOfDependents?: number | null;
1817
2098
  isPrimaryBorrower: boolean;
@@ -2668,7 +2949,7 @@ export interface LoanContact {
2668
2949
  email?: string | null;
2669
2950
  phone?: string | null;
2670
2951
  companyName?: string | null;
2671
- role: LoanContactRoleEnum;
2952
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
2672
2953
  }
2673
2954
  export interface LoanContactList {
2674
2955
  email: string;
@@ -2698,7 +2979,7 @@ export interface LoanDocument {
2698
2979
  }
2699
2980
  export interface LoanDocumentSearch {
2700
2981
  /** @format date-time */
2701
- createdAt?: string | null;
2982
+ createdAt: string;
2702
2983
  /** @format date-time */
2703
2984
  updatedAt?: string | null;
2704
2985
  /** @format date-time */
@@ -2793,13 +3074,13 @@ export interface LoanImport {
2793
3074
  /** @format int32 */
2794
3075
  importedCount: number;
2795
3076
  statusMessage?: string | null;
2796
- status: LoanImportStatusEnum;
2797
- importMode: LoanImportImportModeEnum;
3077
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3078
+ importMode: "All" | "NewOnly" | "UpdateOnly";
2798
3079
  /** @format date-time */
2799
3080
  createdAt?: string | null;
2800
3081
  }
2801
3082
  export interface LoanImportLog {
2802
- level: LoanImportLogLevelEnum;
3083
+ level: "None" | "Info" | "Warning" | "Error";
2803
3084
  message: string;
2804
3085
  /** @format date-time */
2805
3086
  createdAt: string;
@@ -2854,8 +3135,8 @@ export interface LoanListPaginated {
2854
3135
  export interface LoanLog {
2855
3136
  /** @format uuid */
2856
3137
  id: string;
2857
- level: LoanLogLevelEnum;
2858
- type: LoanLogTypeEnum;
3138
+ level: "None" | "Info" | "Warning" | "Error";
3139
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2859
3140
  message: string;
2860
3141
  /** @format date-time */
2861
3142
  createdAt: string;
@@ -2863,8 +3144,8 @@ export interface LoanLog {
2863
3144
  export interface LoanLogDetail {
2864
3145
  /** @format uuid */
2865
3146
  id: string;
2866
- level: LoanLogDetailLevelEnum;
2867
- type: LoanLogDetailTypeEnum;
3147
+ level: "None" | "Info" | "Warning" | "Error";
3148
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2868
3149
  message: string;
2869
3150
  /** @format date-time */
2870
3151
  createdAt: string;
@@ -3127,7 +3408,7 @@ export interface LoanUser {
3127
3408
  email: string;
3128
3409
  phone?: string | null;
3129
3410
  role: string;
3130
- loanRole: LoanUserLoanRoleEnum;
3411
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3131
3412
  isUser: boolean;
3132
3413
  /** @format date-time */
3133
3414
  createdAt: string;
@@ -3185,7 +3466,7 @@ export interface MilestoneConfigurationRequest {
3185
3466
  }
3186
3467
  export interface MobileSettings {
3187
3468
  /** @format uuid */
3188
- id: string;
3469
+ id?: string | null;
3189
3470
  hasMobile: boolean;
3190
3471
  /** @deprecated */
3191
3472
  downloadLink?: string | null;
@@ -3274,7 +3555,7 @@ export interface NoContentResult {
3274
3555
  }
3275
3556
  export interface NotificationTemplate {
3276
3557
  /** @format date-time */
3277
- createdAt?: string | null;
3558
+ createdAt: string;
3278
3559
  /** @format date-time */
3279
3560
  updatedAt?: string | null;
3280
3561
  /** @format date-time */
@@ -3298,7 +3579,7 @@ export interface NotificationTemplate {
3298
3579
  }
3299
3580
  export interface NotificationTemplateBase {
3300
3581
  /** @format date-time */
3301
- createdAt?: string | null;
3582
+ createdAt: string;
3302
3583
  /** @format date-time */
3303
3584
  updatedAt?: string | null;
3304
3585
  /** @format date-time */
@@ -3734,7 +4015,7 @@ export interface SSOTokenRequest {
3734
4015
  redirectUri: string;
3735
4016
  }
3736
4017
  export interface SamlMetadataRequest {
3737
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4018
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
3738
4019
  }
3739
4020
  export interface SendForgotPasswordRequest {
3740
4021
  /**
@@ -3762,14 +4043,14 @@ export interface SendNotificationForLoanRequest {
3762
4043
  }
3763
4044
  export interface SiteConfiguration {
3764
4045
  /** @format date-time */
3765
- createdAt?: string | null;
4046
+ createdAt: string;
3766
4047
  /** @format date-time */
3767
4048
  updatedAt?: string | null;
3768
4049
  /** @format date-time */
3769
4050
  deletedAt?: string | null;
3770
4051
  /** @format uuid */
3771
4052
  id: string;
3772
- type: SiteConfigurationTypeEnum;
4053
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3773
4054
  /** @format uuid */
3774
4055
  entityID: string;
3775
4056
  /** @format int32 */
@@ -3956,14 +4237,14 @@ export interface SiteConfiguration {
3956
4237
  }
3957
4238
  export interface SiteConfigurationByUrl {
3958
4239
  /** @format date-time */
3959
- createdAt?: string | null;
4240
+ createdAt: string;
3960
4241
  /** @format date-time */
3961
4242
  updatedAt?: string | null;
3962
4243
  /** @format date-time */
3963
4244
  deletedAt?: string | null;
3964
4245
  /** @format uuid */
3965
4246
  id: string;
3966
- type: SiteConfigurationByUrlTypeEnum;
4247
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3967
4248
  /** @format uuid */
3968
4249
  entityID: string;
3969
4250
  /** @format int32 */
@@ -4174,7 +4455,7 @@ export interface SiteConfigurationForm {
4174
4455
  export interface SiteConfigurationReduced {
4175
4456
  /** @format uuid */
4176
4457
  id: string;
4177
- type: SiteConfigurationReducedTypeEnum;
4458
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4178
4459
  url?: string | null;
4179
4460
  name: string;
4180
4461
  /** @format int64 */
@@ -4191,7 +4472,7 @@ export interface SiteConfigurationRequest {
4191
4472
  entityID: string;
4192
4473
  /** @format int32 */
4193
4474
  entityType: number;
4194
- type: SiteConfigurationRequestTypeEnum;
4475
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4195
4476
  url: string;
4196
4477
  name: string;
4197
4478
  introduction?: string | null;
@@ -4366,7 +4647,7 @@ export interface SiteConfigurationSearchCriteria {
4366
4647
  export interface SiteConfigurationSummary {
4367
4648
  /** @format uuid */
4368
4649
  id: string;
4369
- type: SiteConfigurationSummaryTypeEnum;
4650
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4370
4651
  url?: string | null;
4371
4652
  name: string;
4372
4653
  /** @format int64 */
@@ -4395,7 +4676,7 @@ export interface SiteConfigurationWithInherited {
4395
4676
  }
4396
4677
  export interface SocialSurveyRecord {
4397
4678
  /** @format date-time */
4398
- createdAt?: string | null;
4679
+ createdAt: string;
4399
4680
  /** @format date-time */
4400
4681
  updatedAt?: string | null;
4401
4682
  /** @format date-time */
@@ -4410,6 +4691,13 @@ export interface SocialSurveyRecord {
4410
4691
  /** @format date-time */
4411
4692
  reviewCompletedTimeStamp?: string | null;
4412
4693
  }
4694
+ export interface SupportedModel {
4695
+ modelId: string;
4696
+ displayName: string;
4697
+ provider: string;
4698
+ description?: string | null;
4699
+ isDefault: boolean;
4700
+ }
4413
4701
  export interface SurveyEmailRequest {
4414
4702
  /** @minLength 1 */
4415
4703
  loanOfficerEmailAddress: string;
@@ -4647,6 +4935,60 @@ export interface UpdateAccountRequest {
4647
4935
  asoSettings?: ASOSettings | null;
4648
4936
  settings: AccountSettingsRequest;
4649
4937
  }
4938
+ export interface UpdateAiCanonicalFieldRequest {
4939
+ /**
4940
+ * @minLength 1
4941
+ * @maxLength 200
4942
+ */
4943
+ displayName: string;
4944
+ /** @minLength 1 */
4945
+ description: string;
4946
+ /** @minItems 1 */
4947
+ allowedRoles: string[];
4948
+ isPii: boolean;
4949
+ }
4950
+ export interface UpdateAiGuardrailRequest {
4951
+ /**
4952
+ * @minLength 1
4953
+ * @maxLength 200
4954
+ */
4955
+ name: string;
4956
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
4957
+ description?: string | null;
4958
+ /** @minItems 1 */
4959
+ keywords: string[];
4960
+ /** @minLength 1 */
4961
+ responseTemplate: string;
4962
+ }
4963
+ export interface UpdateAiPromptRequest {
4964
+ /**
4965
+ * @minLength 1
4966
+ * @maxLength 200
4967
+ */
4968
+ title: string;
4969
+ icon: string;
4970
+ /**
4971
+ * @minLength 1
4972
+ * @maxLength 500
4973
+ */
4974
+ description: string;
4975
+ documentTypes: string[];
4976
+ applicableGuidelines: string[];
4977
+ allowedRoles: string[];
4978
+ /** @minLength 1 */
4979
+ systemPrompt: string;
4980
+ /** @minLength 1 */
4981
+ userPromptTemplate: string;
4982
+ followUpPrompts: string[];
4983
+ /** @format int32 */
4984
+ sortOrder: number;
4985
+ category?: AiPromptCategory | null;
4986
+ queryTemplateName?: AiQueryTemplateName | null;
4987
+ displayHint?: AiDisplayHint | null;
4988
+ bedrockModelId?: string | null;
4989
+ requiredDataSources?: string[] | null;
4990
+ outputType?: AiOutputType | null;
4991
+ }
4650
4992
  export interface UpdateDocumentTemplateRequest {
4651
4993
  /** @minLength 1 */
4652
4994
  htmlBody: string;
@@ -4897,7 +5239,7 @@ export interface UsageReportStatistics {
4897
5239
  }
4898
5240
  export interface User {
4899
5241
  /** @format date-time */
4900
- createdAt?: string | null;
5242
+ createdAt: string;
4901
5243
  /** @format date-time */
4902
5244
  updatedAt?: string | null;
4903
5245
  /** @format date-time */
@@ -4943,7 +5285,7 @@ export interface UserDevice {
4943
5285
  export interface UserDraft {
4944
5286
  /** @format uuid */
4945
5287
  draftID: string;
4946
- role: UserDraftRoleEnum;
5288
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
4947
5289
  user: User;
4948
5290
  }
4949
5291
  export interface UserDraftPaginated {
@@ -4967,7 +5309,7 @@ export interface UserGroupAccessScope {
4967
5309
  id: string;
4968
5310
  /** @format uuid */
4969
5311
  groupId: string;
4970
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5312
+ scopeType: "User" | "Branch";
4971
5313
  /** @format uuid */
4972
5314
  userId?: string | null;
4973
5315
  /** @format uuid */
@@ -5000,7 +5342,7 @@ export interface UserLoan {
5000
5342
  deletedAt?: string | null;
5001
5343
  loanID: string;
5002
5344
  user: User;
5003
- role: UserLoanRoleEnum;
5345
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5004
5346
  /** @format int32 */
5005
5347
  borrowerPair?: number | null;
5006
5348
  /** @format int32 */
@@ -5012,10 +5354,10 @@ export interface UserLoanConsent {
5012
5354
  id: string;
5013
5355
  /** @format uuid */
5014
5356
  userLoanID: string;
5015
- type: UserLoanConsentTypeEnum;
5357
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5016
5358
  providedConsent: boolean;
5017
5359
  ipAddress?: string | null;
5018
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5360
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5019
5361
  /** @format date-time */
5020
5362
  createdAt: string;
5021
5363
  }
@@ -5147,7 +5489,7 @@ export interface UserSummary {
5147
5489
  id: string;
5148
5490
  name?: string | null;
5149
5491
  email?: string | null;
5150
- role: UserSummaryRoleEnum;
5492
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5151
5493
  }
5152
5494
  export interface VerifyPasswordRequest {
5153
5495
  /**
@@ -5180,48 +5522,6 @@ export interface Workflow {
5180
5522
  tileSubtitle: string;
5181
5523
  icon: string;
5182
5524
  }
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
5525
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5226
5526
  export type QueryParamsType = Record<string | number, any>;
5227
5527
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5267,7 +5567,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5267
5567
  }
5268
5568
  /**
5269
5569
  * @title The Big POS API
5270
- * @version v2.36.15
5570
+ * @version v2.37.0
5271
5571
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5272
5572
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5273
5573
  */
@@ -5405,6 +5705,356 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5405
5705
  * @response `422` `ProblemDetails` Client Error
5406
5706
  */
5407
5707
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
5708
+ /**
5709
+ * No description
5710
+ *
5711
+ * @tags AiAdmin
5712
+ * @name GetAiAuditLogs
5713
+ * @summary Get paginated audit logs
5714
+ * @request GET:/api/ai/admin/audit-logs
5715
+ * @secure
5716
+ * @response `200` `AiAuditLogPaginated` Success
5717
+ */
5718
+ getAiAuditLogs: (query?: {
5719
+ eventType?: AiAuditEventType;
5720
+ /** @format date-time */
5721
+ startDate?: string;
5722
+ /** @format date-time */
5723
+ endDate?: string;
5724
+ /** @format int32 */
5725
+ pageSize?: number;
5726
+ /** @format int32 */
5727
+ pageNumber?: number;
5728
+ sortBy?: string;
5729
+ sortDirection?: string;
5730
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
5731
+ /**
5732
+ * No description
5733
+ *
5734
+ * @tags AiAdmin
5735
+ * @name GetAiAdminStats
5736
+ * @summary Get AI admin dashboard stats
5737
+ * @request GET:/api/ai/admin/stats
5738
+ * @secure
5739
+ * @response `200` `AiAdminStats` Success
5740
+ */
5741
+ getAiAdminStats: (query?: {
5742
+ /** @format date-time */
5743
+ startDate?: string;
5744
+ /** @format date-time */
5745
+ endDate?: string;
5746
+ }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
5747
+ /**
5748
+ * No description
5749
+ *
5750
+ * @tags AiAdminPrompt
5751
+ * @name GetAiPrompts
5752
+ * @summary Get all prompts
5753
+ * @request GET:/api/ai/admin/prompts
5754
+ * @secure
5755
+ * @response `200` `(AiPrompt)[]` Success
5756
+ */
5757
+ getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
5758
+ /**
5759
+ * No description
5760
+ *
5761
+ * @tags AiAdminPrompt
5762
+ * @name CreateAiPrompt
5763
+ * @summary Create custom prompt
5764
+ * @request POST:/api/ai/admin/prompts
5765
+ * @secure
5766
+ * @response `201` `AiPrompt` Created
5767
+ * @response `400` `ProblemDetails` Bad Request
5768
+ */
5769
+ createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5770
+ /**
5771
+ * No description
5772
+ *
5773
+ * @tags AiAdminPrompt
5774
+ * @name GetAiPrompt
5775
+ * @summary Get prompt by ID
5776
+ * @request GET:/api/ai/admin/prompts/{id}
5777
+ * @secure
5778
+ * @response `200` `AiPrompt` Success
5779
+ * @response `404` `ProblemDetails` Not Found
5780
+ */
5781
+ getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5782
+ /**
5783
+ * No description
5784
+ *
5785
+ * @tags AiAdminPrompt
5786
+ * @name UpdateAiPrompt
5787
+ * @summary Update prompt
5788
+ * @request PUT:/api/ai/admin/prompts/{id}
5789
+ * @secure
5790
+ * @response `200` `AiPrompt` Success
5791
+ * @response `400` `ProblemDetails` Bad Request
5792
+ * @response `404` `ProblemDetails` Not Found
5793
+ */
5794
+ updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5795
+ /**
5796
+ * No description
5797
+ *
5798
+ * @tags AiAdminPrompt
5799
+ * @name DeleteAiPrompt
5800
+ * @summary Delete prompt
5801
+ * @request DELETE:/api/ai/admin/prompts/{id}
5802
+ * @secure
5803
+ * @response `204` `void` No Content
5804
+ * @response `400` `ProblemDetails` Bad Request
5805
+ * @response `404` `ProblemDetails` Not Found
5806
+ */
5807
+ deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5808
+ /**
5809
+ * No description
5810
+ *
5811
+ * @tags AiAdminPrompt
5812
+ * @name ToggleAiPrompt
5813
+ * @summary Toggle prompt active/inactive
5814
+ * @request PATCH:/api/ai/admin/prompts/{id}/toggle
5815
+ * @secure
5816
+ * @response `200` `AiPrompt` Success
5817
+ * @response `404` `ProblemDetails` Not Found
5818
+ */
5819
+ toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5820
+ /**
5821
+ * No description
5822
+ *
5823
+ * @tags AiAdminPrompt
5824
+ * @name GenerateAiSystemPrompt
5825
+ * @summary Generate a system prompt from description
5826
+ * @request POST:/api/ai/admin/prompts/generate
5827
+ * @secure
5828
+ * @response `200` `GenerateSystemPrompt` Success
5829
+ * @response `400` `ProblemDetails` Bad Request
5830
+ */
5831
+ generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
5832
+ /**
5833
+ * No description
5834
+ *
5835
+ * @tags AiAdminPrompt
5836
+ * @name GetSupportedModels
5837
+ * @summary Get supported LLM models
5838
+ * @request GET:/api/ai/admin/prompts/supported-models
5839
+ * @secure
5840
+ * @response `200` `(SupportedModel)[]` Success
5841
+ */
5842
+ getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
5843
+ /**
5844
+ * No description
5845
+ *
5846
+ * @tags AiCanonicalField
5847
+ * @name GetAiCanonicalFields
5848
+ * @summary Get all canonical fields
5849
+ * @request GET:/api/ai/admin/fields
5850
+ * @secure
5851
+ * @response `200` `(AiCanonicalField)[]` Success
5852
+ */
5853
+ getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
5854
+ /**
5855
+ * No description
5856
+ *
5857
+ * @tags AiCanonicalField
5858
+ * @name CreateAiCanonicalField
5859
+ * @summary Create canonical field
5860
+ * @request POST:/api/ai/admin/fields
5861
+ * @secure
5862
+ * @response `201` `AiCanonicalField` Created
5863
+ * @response `400` `ProblemDetails` Bad Request
5864
+ */
5865
+ createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5866
+ /**
5867
+ * No description
5868
+ *
5869
+ * @tags AiCanonicalField
5870
+ * @name GetAiCanonicalField
5871
+ * @summary Get canonical field by ID
5872
+ * @request GET:/api/ai/admin/fields/{id}
5873
+ * @secure
5874
+ * @response `200` `AiCanonicalField` Success
5875
+ * @response `404` `ProblemDetails` Not Found
5876
+ */
5877
+ getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5878
+ /**
5879
+ * No description
5880
+ *
5881
+ * @tags AiCanonicalField
5882
+ * @name UpdateAiCanonicalField
5883
+ * @summary Update canonical field
5884
+ * @request PUT:/api/ai/admin/fields/{id}
5885
+ * @secure
5886
+ * @response `200` `AiCanonicalField` Success
5887
+ * @response `400` `ProblemDetails` Bad Request
5888
+ * @response `404` `ProblemDetails` Not Found
5889
+ */
5890
+ updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5891
+ /**
5892
+ * No description
5893
+ *
5894
+ * @tags AiCanonicalField
5895
+ * @name DeleteAiCanonicalField
5896
+ * @summary Delete canonical field
5897
+ * @request DELETE:/api/ai/admin/fields/{id}
5898
+ * @secure
5899
+ * @response `204` `void` No Content
5900
+ * @response `404` `ProblemDetails` Not Found
5901
+ */
5902
+ deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5903
+ /**
5904
+ * No description
5905
+ *
5906
+ * @tags AiCanonicalField
5907
+ * @name ToggleAiCanonicalField
5908
+ * @summary Toggle canonical field active/inactive
5909
+ * @request PATCH:/api/ai/admin/fields/{id}/toggle
5910
+ * @secure
5911
+ * @response `200` `AiCanonicalField` Success
5912
+ * @response `404` `ProblemDetails` Not Found
5913
+ */
5914
+ toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5915
+ /**
5916
+ * No description
5917
+ *
5918
+ * @tags AiChat
5919
+ * @name AiChat
5920
+ * @summary Send AI chat message
5921
+ * @request POST:/api/ai/chat
5922
+ * @secure
5923
+ * @response `200` `AiChat` Success
5924
+ * @response `400` `ProblemDetails` Bad Request
5925
+ * @response `401` `ProblemDetails` Unauthorized
5926
+ */
5927
+ aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
5928
+ /**
5929
+ * No description
5930
+ *
5931
+ * @tags AiConversation
5932
+ * @name GetAiConversations
5933
+ * @summary Get user conversations
5934
+ * @request GET:/api/ai/conversations
5935
+ * @secure
5936
+ * @response `200` `AiConversationListItemPaginated` Success
5937
+ */
5938
+ getAiConversations: (query?: {
5939
+ /** @format int32 */
5940
+ pageSize?: number;
5941
+ /** @format int32 */
5942
+ pageNumber?: number;
5943
+ sortBy?: string;
5944
+ sortDirection?: string;
5945
+ }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
5946
+ /**
5947
+ * No description
5948
+ *
5949
+ * @tags AiConversation
5950
+ * @name GetAiConversation
5951
+ * @summary Get conversation with messages
5952
+ * @request GET:/api/ai/conversations/{id}
5953
+ * @secure
5954
+ * @response `200` `AiConversationDetail` Success
5955
+ * @response `403` `ProblemDetails` Forbidden
5956
+ * @response `404` `ProblemDetails` Not Found
5957
+ */
5958
+ getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
5959
+ /**
5960
+ * No description
5961
+ *
5962
+ * @tags AiConversation
5963
+ * @name DeleteAiConversation
5964
+ * @summary Delete conversation
5965
+ * @request DELETE:/api/ai/conversations/{id}
5966
+ * @secure
5967
+ * @response `204` `void` No Content
5968
+ * @response `403` `ProblemDetails` Forbidden
5969
+ * @response `404` `ProblemDetails` Not Found
5970
+ */
5971
+ deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5972
+ /**
5973
+ * No description
5974
+ *
5975
+ * @tags AiGuardrail
5976
+ * @name GetAiGuardrails
5977
+ * @summary Get all guardrails
5978
+ * @request GET:/api/ai/admin/guardrails
5979
+ * @secure
5980
+ * @response `200` `(AiGuardrail)[]` Success
5981
+ */
5982
+ getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
5983
+ /**
5984
+ * No description
5985
+ *
5986
+ * @tags AiGuardrail
5987
+ * @name CreateAiGuardrail
5988
+ * @summary Create custom guardrail
5989
+ * @request POST:/api/ai/admin/guardrails
5990
+ * @secure
5991
+ * @response `201` `AiGuardrail` Created
5992
+ * @response `400` `ProblemDetails` Bad Request
5993
+ */
5994
+ createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
5995
+ /**
5996
+ * No description
5997
+ *
5998
+ * @tags AiGuardrail
5999
+ * @name GetAiGuardrail
6000
+ * @summary Get guardrail by ID
6001
+ * @request GET:/api/ai/admin/guardrails/{id}
6002
+ * @secure
6003
+ * @response `200` `AiGuardrail` Success
6004
+ * @response `404` `ProblemDetails` Not Found
6005
+ */
6006
+ getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6007
+ /**
6008
+ * No description
6009
+ *
6010
+ * @tags AiGuardrail
6011
+ * @name UpdateAiGuardrail
6012
+ * @summary Update guardrail
6013
+ * @request PUT:/api/ai/admin/guardrails/{id}
6014
+ * @secure
6015
+ * @response `200` `AiGuardrail` Success
6016
+ * @response `400` `ProblemDetails` Bad Request
6017
+ * @response `404` `ProblemDetails` Not Found
6018
+ */
6019
+ updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6020
+ /**
6021
+ * No description
6022
+ *
6023
+ * @tags AiGuardrail
6024
+ * @name DeleteAiGuardrail
6025
+ * @summary Delete guardrail
6026
+ * @request DELETE:/api/ai/admin/guardrails/{id}
6027
+ * @secure
6028
+ * @response `204` `void` No Content
6029
+ * @response `400` `ProblemDetails` Bad Request
6030
+ * @response `404` `ProblemDetails` Not Found
6031
+ */
6032
+ deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6033
+ /**
6034
+ * No description
6035
+ *
6036
+ * @tags AiGuardrail
6037
+ * @name ToggleAiGuardrail
6038
+ * @summary Toggle guardrail enabled/disabled
6039
+ * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6040
+ * @secure
6041
+ * @response `200` `AiGuardrail` Success
6042
+ * @response `404` `ProblemDetails` Not Found
6043
+ */
6044
+ toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6045
+ /**
6046
+ * No description
6047
+ *
6048
+ * @tags AiPrompt
6049
+ * @name GetAvailablePrompts
6050
+ * @summary Get available prompts for current user
6051
+ * @request GET:/api/ai/prompts
6052
+ * @secure
6053
+ * @response `200` `(AiPromptSummary)[]` Success
6054
+ */
6055
+ getAvailablePrompts: (query?: {
6056
+ documentType?: string;
6057
+ }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
5408
6058
  /**
5409
6059
  * No description
5410
6060
  *
@@ -8074,7 +8724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8074
8724
  getPartners: (query?: {
8075
8725
  showAll?: boolean;
8076
8726
  /** @default "Realtor" */
8077
- role?: GetPartnersParamsRoleEnum;
8727
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8078
8728
  /** @format int32 */
8079
8729
  pageSize?: number;
8080
8730
  /** @format int32 */
@@ -8252,7 +8902,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8252
8902
  * @response `200` `File` Success
8253
8903
  * @response `404` `ProblemDetails` Not Found
8254
8904
  */
8255
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8905
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8256
8906
  /**
8257
8907
  * No description
8258
8908
  *
@@ -8263,7 +8913,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8263
8913
  * @secure
8264
8914
  * @response `200` `File` Success
8265
8915
  */
8266
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8916
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8267
8917
  /**
8268
8918
  * No description
8269
8919
  *