@matech/thebigpos-sdk 2.36.9-rc0 → 2.36.11-aibi

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/src/index.ts CHANGED
@@ -304,6 +304,8 @@ export type FilterType =
304
304
  | "StringNotEquals"
305
305
  | "StringNotContains";
306
306
 
307
+ export type Environment = "Development" | "Staging" | "UAT" | "Production";
308
+
307
309
  export type EntityType =
308
310
  | "Account"
309
311
  | "Corporate"
@@ -326,6 +328,8 @@ export type DraftType = "NewLoan" | "EditLoan";
326
328
 
327
329
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
328
330
 
331
+ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
332
+
329
333
  export type BranchType = "Mortgage" | "RealEstate";
330
334
 
331
335
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -334,6 +338,64 @@ export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
334
338
 
335
339
  export type BillingType = "ClosedLoan" | "LoanOfficer";
336
340
 
341
+ export type AiStructuredDataType =
342
+ | "Table"
343
+ | "DocumentAnalysis"
344
+ | "DocumentList";
345
+
346
+ export type AiQueryTemplateName =
347
+ | "PipelineSummary"
348
+ | "LoanDetail"
349
+ | "LoansClosing"
350
+ | "StaleLoans"
351
+ | "LoansByType"
352
+ | "LoansByOfficer"
353
+ | "AverageLoanAmount"
354
+ | "LockedVsUnlocked";
355
+
356
+ export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General";
357
+
358
+ export type AiIntent =
359
+ | "Greeting"
360
+ | "Invalid"
361
+ | "Relevant"
362
+ | "DocumentList"
363
+ | "GeneralKnowledge"
364
+ | "Blocked";
365
+
366
+ export type AiGuardrailCategory =
367
+ | "ContentSafety"
368
+ | "PromptInjection"
369
+ | "Privacy"
370
+ | "Legal";
371
+
372
+ export type AiDisplayHint =
373
+ | "Table"
374
+ | "SummaryCards"
375
+ | "RankedList"
376
+ | "Comparison"
377
+ | "ExecutiveBrief";
378
+
379
+ export type AiAuditEventType =
380
+ | "Error"
381
+ | "GuardrailBlockedPre"
382
+ | "GuardrailPassedPre"
383
+ | "IntentClassified"
384
+ | "LoanResolvedFromMessage"
385
+ | "DocumentNotFound"
386
+ | "GuardrailBlockedPost"
387
+ | "GuardrailPassedPost"
388
+ | "DocumentAnalyzed"
389
+ | "DocumentList"
390
+ | "DocumentResolutionAmbiguous"
391
+ | "ResponseGenerated"
392
+ | "ParametersExtracted"
393
+ | "QueryExecuted"
394
+ | "LoanContextNotFound"
395
+ | "LoanContextLoaded"
396
+ | "GuardrailBlockedBedrock"
397
+ | "PromptMatched";
398
+
337
399
  export type AddressFamily =
338
400
  | "Unspecified"
339
401
  | "Unix"
@@ -421,7 +483,7 @@ export interface AccountBilling {
421
483
  }
422
484
 
423
485
  export interface AccountBillingRequest {
424
- billingType: AccountBillingRequestBillingTypeEnum;
486
+ billingType: "ClosedLoan" | "LoanOfficer";
425
487
  /**
426
488
  * @format double
427
489
  * @min 0
@@ -436,6 +498,7 @@ export interface AccountSettings {
436
498
  smsNumber?: string | null;
437
499
  ssoHostOverride?: string | null;
438
500
  isEarlyAdopter: boolean;
501
+ isAIEnabled: boolean;
439
502
  }
440
503
 
441
504
  export interface AccountSettingsRequest {
@@ -646,6 +709,235 @@ export interface AffordabilityCalculatorRequest {
646
709
  annualInsurance: number;
647
710
  }
648
711
 
712
+ export interface AiAdminStats {
713
+ /** @format int32 */
714
+ totalRequests: number;
715
+ /** @format int32 */
716
+ blockedRequests: number;
717
+ /** @format double */
718
+ averageResponseTimeMs: number;
719
+ intentDistribution: Record<string, number>;
720
+ topQueryTemplates: Record<string, number>;
721
+ period: string;
722
+ }
723
+
724
+ export interface AiAuditLog {
725
+ /** @format uuid */
726
+ id: string;
727
+ /** @format uuid */
728
+ requestId: string;
729
+ /** @format uuid */
730
+ userId: string;
731
+ eventType:
732
+ | "Error"
733
+ | "GuardrailBlockedPre"
734
+ | "GuardrailPassedPre"
735
+ | "IntentClassified"
736
+ | "LoanResolvedFromMessage"
737
+ | "DocumentNotFound"
738
+ | "GuardrailBlockedPost"
739
+ | "GuardrailPassedPost"
740
+ | "DocumentAnalyzed"
741
+ | "DocumentList"
742
+ | "DocumentResolutionAmbiguous"
743
+ | "ResponseGenerated"
744
+ | "ParametersExtracted"
745
+ | "QueryExecuted"
746
+ | "LoanContextNotFound"
747
+ | "LoanContextLoaded"
748
+ | "GuardrailBlockedBedrock"
749
+ | "PromptMatched";
750
+ details?: any;
751
+ /** @format date-time */
752
+ createdAt: string;
753
+ }
754
+
755
+ export interface AiAuditLogPaginated {
756
+ rows: AiAuditLog[];
757
+ pagination: Pagination;
758
+ /** @format int64 */
759
+ count: number;
760
+ }
761
+
762
+ export interface AiCanonicalField {
763
+ /** @format uuid */
764
+ id: string;
765
+ canonicalName: string;
766
+ displayName: string;
767
+ description: string;
768
+ allowedRoles: string[];
769
+ efPath?: string | null;
770
+ isPii: boolean;
771
+ isActive: boolean;
772
+ dataSource: string;
773
+ isDefault: boolean;
774
+ category?: string | null;
775
+ jsonPropertyName?: string | null;
776
+ textractKey?: string | null;
777
+ textractKeyAliases?: string | null;
778
+ hasAccountOverride: boolean;
779
+ /** @format date-time */
780
+ createdAt: string;
781
+ /** @format date-time */
782
+ updatedAt?: string | null;
783
+ }
784
+
785
+ export interface AiChat {
786
+ /** @format uuid */
787
+ conversationId: string;
788
+ /** @format uuid */
789
+ messageId: string;
790
+ response: AiChatBody;
791
+ metadata: AiChatMetadata;
792
+ }
793
+
794
+ export interface AiChatBody {
795
+ text: string;
796
+ data?: AiChatStructuredData | null;
797
+ suggestedFollowUps: string[];
798
+ }
799
+
800
+ export interface AiChatMessage {
801
+ /** @format uuid */
802
+ id: string;
803
+ userMessage: string;
804
+ assistantResponse: string;
805
+ intent?: AiIntent | null;
806
+ fieldsAccessed?: string[] | null;
807
+ /** @format date-time */
808
+ createdAt: string;
809
+ }
810
+
811
+ export interface AiChatMetadata {
812
+ intent:
813
+ | "Greeting"
814
+ | "Invalid"
815
+ | "Relevant"
816
+ | "DocumentList"
817
+ | "GeneralKnowledge"
818
+ | "Blocked";
819
+ fieldsAccessed: string[];
820
+ /** @format int64 */
821
+ queryTimeMs: number;
822
+ /** @format int64 */
823
+ llmTimeMs: number;
824
+ wasBlocked: boolean;
825
+ blockedReason?: string | null;
826
+ }
827
+
828
+ export interface AiChatRequest {
829
+ /**
830
+ * @minLength 1
831
+ * @maxLength 2000
832
+ */
833
+ message: string;
834
+ /** @format uuid */
835
+ conversationId?: string | null;
836
+ /** @format uuid */
837
+ loanId?: string | null;
838
+ /** @format uuid */
839
+ documentId?: string | null;
840
+ /** @format uuid */
841
+ promptId?: string | null;
842
+ }
843
+
844
+ export interface AiChatStructuredData {
845
+ type: "Table" | "DocumentAnalysis" | "DocumentList";
846
+ detectedDocumentType?: string | null;
847
+ columns: string[];
848
+ rows: string[][];
849
+ }
850
+
851
+ export interface AiConversationDetail {
852
+ /** @format uuid */
853
+ id: string;
854
+ /** @format date-time */
855
+ createdAt: string;
856
+ /** @format date-time */
857
+ updatedAt?: string | null;
858
+ messages: AiChatMessage[];
859
+ }
860
+
861
+ export interface AiConversationListItem {
862
+ /** @format uuid */
863
+ id: string;
864
+ preview: string;
865
+ /** @format int32 */
866
+ messageCount: number;
867
+ /** @format date-time */
868
+ createdAt: string;
869
+ /** @format date-time */
870
+ updatedAt?: string | null;
871
+ }
872
+
873
+ export interface AiConversationListItemPaginated {
874
+ rows: AiConversationListItem[];
875
+ pagination: Pagination;
876
+ /** @format int64 */
877
+ count: number;
878
+ }
879
+
880
+ export interface AiGuardrail {
881
+ /** @format uuid */
882
+ id: string;
883
+ name: string;
884
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
885
+ description?: string | null;
886
+ keywords: string[];
887
+ responseTemplate: string;
888
+ isDefault: boolean;
889
+ isEnabled: boolean;
890
+ /** @format date-time */
891
+ createdAt: string;
892
+ /** @format date-time */
893
+ updatedAt?: string | null;
894
+ }
895
+
896
+ export interface AiPrompt {
897
+ /** @format uuid */
898
+ id: string;
899
+ title: string;
900
+ icon: string;
901
+ slug: string;
902
+ description: string;
903
+ documentTypes: string[];
904
+ applicableGuidelines: string[];
905
+ allowedRoles: string[];
906
+ systemPrompt: string;
907
+ userPromptTemplate: string;
908
+ followUpPrompts: string[];
909
+ /** @format int32 */
910
+ sortOrder: number;
911
+ isDefault: boolean;
912
+ /** @format uuid */
913
+ accountId?: string | null;
914
+ isActive: boolean;
915
+ category?: AiPromptCategory | null;
916
+ queryTemplateName?: AiQueryTemplateName | null;
917
+ displayHint?: AiDisplayHint | null;
918
+ /** @format date-time */
919
+ createdAt: string;
920
+ /** @format date-time */
921
+ updatedAt?: string | null;
922
+ }
923
+
924
+ export interface AiPromptSummary {
925
+ /** @format uuid */
926
+ id: string;
927
+ title: string;
928
+ icon: string;
929
+ slug: string;
930
+ description: string;
931
+ documentTypes: string[];
932
+ applicableGuidelines: string[];
933
+ followUpPrompts: string[];
934
+ /** @format int32 */
935
+ sortOrder: number;
936
+ category?: AiPromptCategory | null;
937
+ queryTemplateName?: AiQueryTemplateName | null;
938
+ displayHint?: AiDisplayHint | null;
939
+ }
940
+
649
941
  export interface AllowImpersonationRequest {
650
942
  /**
651
943
  * @format email
@@ -996,7 +1288,7 @@ export interface CorporateSearchCriteria {
996
1288
  }
997
1289
 
998
1290
  export interface CreateAccessScopeRequest {
999
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1291
+ scopeType: "User" | "Branch";
1000
1292
  /** @format uuid */
1001
1293
  userId?: string | null;
1002
1294
  /** @format uuid */
@@ -1009,18 +1301,91 @@ export interface CreateAccountRequest {
1009
1301
  /** @minLength 1 */
1010
1302
  domain: string;
1011
1303
  eConsentBucket?: string | null;
1304
+ ignoreCoBorrowerRelationship: boolean;
1012
1305
  user: AdminUser;
1013
1306
  companyAddress: CompanyAddress;
1014
1307
  contactInfo: ContactInfo;
1308
+ theme: Theme;
1015
1309
  /**
1016
1310
  * @format int64
1017
1311
  * @min 0
1018
1312
  */
1019
1313
  nlmsid: number;
1020
1314
  settings: AccountSettingsRequest;
1315
+ environment: "Development" | "Staging" | "UAT" | "Production";
1316
+ losIntegration: LOSIntegration;
1021
1317
  billingSettings: AccountBillingRequest;
1022
1318
  }
1023
1319
 
1320
+ export interface CreateAiCanonicalFieldRequest {
1321
+ /**
1322
+ * @minLength 1
1323
+ * @maxLength 200
1324
+ */
1325
+ canonicalName: string;
1326
+ /**
1327
+ * @minLength 1
1328
+ * @maxLength 200
1329
+ */
1330
+ displayName: string;
1331
+ /** @minLength 1 */
1332
+ description: string;
1333
+ /** @minItems 1 */
1334
+ allowedRoles: string[];
1335
+ isPii: boolean;
1336
+ /** @minLength 1 */
1337
+ dataSource: string;
1338
+ textractKey?: string | null;
1339
+ textractKeyAliases?: string | null;
1340
+ category?: string | null;
1341
+ }
1342
+
1343
+ export interface CreateAiGuardrailRequest {
1344
+ /**
1345
+ * @minLength 1
1346
+ * @maxLength 200
1347
+ */
1348
+ name: string;
1349
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1350
+ description?: string | null;
1351
+ /** @minItems 1 */
1352
+ keywords: string[];
1353
+ /** @minLength 1 */
1354
+ responseTemplate: string;
1355
+ }
1356
+
1357
+ export interface CreateAiPromptRequest {
1358
+ /**
1359
+ * @minLength 1
1360
+ * @maxLength 200
1361
+ */
1362
+ title: string;
1363
+ icon: string;
1364
+ /**
1365
+ * @minLength 1
1366
+ * @maxLength 100
1367
+ */
1368
+ slug: string;
1369
+ /**
1370
+ * @minLength 1
1371
+ * @maxLength 500
1372
+ */
1373
+ description: string;
1374
+ documentTypes: string[];
1375
+ applicableGuidelines: string[];
1376
+ allowedRoles: string[];
1377
+ /** @minLength 1 */
1378
+ systemPrompt: string;
1379
+ /** @minLength 1 */
1380
+ userPromptTemplate: string;
1381
+ followUpPrompts: string[];
1382
+ /** @format int32 */
1383
+ sortOrder: number;
1384
+ category?: AiPromptCategory | null;
1385
+ queryTemplateName?: AiQueryTemplateName | null;
1386
+ displayHint?: AiDisplayHint | null;
1387
+ }
1388
+
1024
1389
  export interface CreateBranchRequest {
1025
1390
  /**
1026
1391
  * @minLength 1
@@ -1049,7 +1414,19 @@ export interface CreateDocumentTemplateRequest {
1049
1414
  export interface CreateGroupMemberRequest {
1050
1415
  /** @format uuid */
1051
1416
  userId: string;
1052
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1417
+ loanRole:
1418
+ | "Borrower"
1419
+ | "CoBorrower"
1420
+ | "NonBorrower"
1421
+ | "LoanOfficer"
1422
+ | "LoanProcessor"
1423
+ | "LoanOfficerAssistant"
1424
+ | "SupportingLoanOfficer"
1425
+ | "BuyerAgent"
1426
+ | "SellerAgent"
1427
+ | "TitleInsuranceAgent"
1428
+ | "EscrowAgent"
1429
+ | "SettlementAgent";
1053
1430
  }
1054
1431
 
1055
1432
  export interface CreateInviteRequest {
@@ -1061,7 +1438,7 @@ export interface CreateInviteRequest {
1061
1438
  emailAddress: string;
1062
1439
  phoneNumber?: string | null;
1063
1440
  /** @deprecated */
1064
- relationship: CreateInviteRequestRelationshipEnum;
1441
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1065
1442
  loanID: string;
1066
1443
  route?: string | null;
1067
1444
  /** @format uuid */
@@ -1084,7 +1461,7 @@ export interface CreateLoanImportRequest {
1084
1461
  * @minLength 1
1085
1462
  */
1086
1463
  startDate: string;
1087
- importMode: CreateLoanImportRequestImportModeEnum;
1464
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1088
1465
  }
1089
1466
 
1090
1467
  export interface CreateSession {
@@ -1106,7 +1483,19 @@ export interface CreateUserDeviceRequest {
1106
1483
  }
1107
1484
 
1108
1485
  export interface CreateUserDraft {
1109
- loanRole: CreateUserDraftLoanRoleEnum;
1486
+ loanRole:
1487
+ | "Borrower"
1488
+ | "CoBorrower"
1489
+ | "NonBorrower"
1490
+ | "LoanOfficer"
1491
+ | "LoanProcessor"
1492
+ | "LoanOfficerAssistant"
1493
+ | "SupportingLoanOfficer"
1494
+ | "BuyerAgent"
1495
+ | "SellerAgent"
1496
+ | "TitleInsuranceAgent"
1497
+ | "EscrowAgent"
1498
+ | "SettlementAgent";
1110
1499
  }
1111
1500
 
1112
1501
  export interface CreateUserGroupRequest {
@@ -1422,7 +1811,7 @@ export interface Draft {
1422
1811
  siteConfiguration: SiteConfigurationReduced;
1423
1812
  /** @format uuid */
1424
1813
  loanID?: string | null;
1425
- type: DraftTypeEnum;
1814
+ type: "NewLoan" | "EditLoan";
1426
1815
  isCoBorrower: boolean;
1427
1816
  }
1428
1817
 
@@ -1441,7 +1830,7 @@ export interface DraftContent {
1441
1830
  siteConfiguration: SiteConfigurationReduced;
1442
1831
  /** @format uuid */
1443
1832
  loanID?: string | null;
1444
- type: DraftContentTypeEnum;
1833
+ type: "NewLoan" | "EditLoan";
1445
1834
  isCoBorrower: boolean;
1446
1835
  applicationPayload: any;
1447
1836
  }
@@ -1571,8 +1960,15 @@ export interface EncompassRequestLog {
1571
1960
  losId?: string | null;
1572
1961
  /** @format uuid */
1573
1962
  accountId: string;
1574
- operationType: EncompassRequestLogOperationTypeEnum;
1575
- outcome: EncompassRequestLogOutcomeEnum;
1963
+ operationType:
1964
+ | "FieldUpdate"
1965
+ | "EConsentUpdate"
1966
+ | "DocumentSync"
1967
+ | "MilestoneUpdate"
1968
+ | "DocumentAttachment"
1969
+ | "General"
1970
+ | "FieldReader";
1971
+ outcome: "Success" | "Failure" | "PartialSuccess";
1576
1972
  message: string;
1577
1973
  endpoint?: string | null;
1578
1974
  httpMethod?: string | null;
@@ -1636,6 +2032,11 @@ export interface FileWithBytes {
1636
2032
  extension?: string | null;
1637
2033
  }
1638
2034
 
2035
+ export interface ForcePasswordReset {
2036
+ forcePasswordReset: boolean;
2037
+ email: string;
2038
+ }
2039
+
1639
2040
  export interface Form {
1640
2041
  /** @format date-time */
1641
2042
  createdAt?: string | null;
@@ -1804,7 +2205,20 @@ export interface FusionFieldDisplay {
1804
2205
  }
1805
2206
 
1806
2207
  export interface FusionReportFilter {
1807
- filterType: FusionReportFilterFilterTypeEnum;
2208
+ filterType:
2209
+ | "DateGreaterThanOrEqualTo"
2210
+ | "DateGreaterThan"
2211
+ | "DateLessThan"
2212
+ | "DateLessThanOrEqualTo"
2213
+ | "DateEquals"
2214
+ | "DateDoesntEqual"
2215
+ | "DateNonEmpty"
2216
+ | "DateEmpty"
2217
+ | "StringContains"
2218
+ | "StringEquals"
2219
+ | "StringNotEmpty"
2220
+ | "StringNotEquals"
2221
+ | "StringNotContains";
1808
2222
  targetField: string;
1809
2223
  targetValue: string;
1810
2224
  }
@@ -1932,7 +2346,40 @@ export interface GuidPatchOperation {
1932
2346
  }
1933
2347
 
1934
2348
  export interface IPAddress {
1935
- addressFamily: IpAddressAddressFamilyEnum;
2349
+ addressFamily:
2350
+ | "Unspecified"
2351
+ | "Unix"
2352
+ | "InterNetwork"
2353
+ | "ImpLink"
2354
+ | "Pup"
2355
+ | "Chaos"
2356
+ | "NS"
2357
+ | "Ipx"
2358
+ | "Iso"
2359
+ | "Osi"
2360
+ | "Ecma"
2361
+ | "DataKit"
2362
+ | "Ccitt"
2363
+ | "Sna"
2364
+ | "DecNet"
2365
+ | "DataLink"
2366
+ | "Lat"
2367
+ | "HyperChannel"
2368
+ | "AppleTalk"
2369
+ | "NetBios"
2370
+ | "VoiceView"
2371
+ | "FireFox"
2372
+ | "Banyan"
2373
+ | "Atm"
2374
+ | "InterNetworkV6"
2375
+ | "Cluster"
2376
+ | "Ieee12844"
2377
+ | "Irda"
2378
+ | "NetworkDesigners"
2379
+ | "Max"
2380
+ | "Packet"
2381
+ | "ControllerAreaNetwork"
2382
+ | "Unknown";
1936
2383
  /** @format int64 */
1937
2384
  scopeId: number;
1938
2385
  isIPv6Multicast: boolean;
@@ -2021,6 +2468,10 @@ export interface Invite {
2021
2468
  /** Array of operations to perform */
2022
2469
  export type JsonPatchDocument = Operation[];
2023
2470
 
2471
+ export interface LOSIntegration {
2472
+ instanceID: string;
2473
+ }
2474
+
2024
2475
  export interface LOSSettings {
2025
2476
  retailLoanClosingDateFieldID: string;
2026
2477
  wholesaleLoanClosingDateFieldID: string;
@@ -3175,7 +3626,19 @@ export interface LoanContact {
3175
3626
  email?: string | null;
3176
3627
  phone?: string | null;
3177
3628
  companyName?: string | null;
3178
- role: LoanContactRoleEnum;
3629
+ role:
3630
+ | "Borrower"
3631
+ | "CoBorrower"
3632
+ | "NonBorrower"
3633
+ | "LoanOfficer"
3634
+ | "LoanProcessor"
3635
+ | "LoanOfficerAssistant"
3636
+ | "SupportingLoanOfficer"
3637
+ | "BuyerAgent"
3638
+ | "SellerAgent"
3639
+ | "TitleInsuranceAgent"
3640
+ | "EscrowAgent"
3641
+ | "SettlementAgent";
3179
3642
  }
3180
3643
 
3181
3644
  export interface LoanContactList {
@@ -3311,14 +3774,19 @@ export interface LoanImport {
3311
3774
  /** @format int32 */
3312
3775
  importedCount: number;
3313
3776
  statusMessage?: string | null;
3314
- status: LoanImportStatusEnum;
3315
- importMode: LoanImportImportModeEnum;
3777
+ status:
3778
+ | "WaitingProcess"
3779
+ | "InProgress"
3780
+ | "Completed"
3781
+ | "Failed"
3782
+ | "Cancelled";
3783
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3316
3784
  /** @format date-time */
3317
3785
  createdAt?: string | null;
3318
3786
  }
3319
3787
 
3320
3788
  export interface LoanImportLog {
3321
- level: LoanImportLogLevelEnum;
3789
+ level: "None" | "Info" | "Warning" | "Error";
3322
3790
  message: string;
3323
3791
  /** @format date-time */
3324
3792
  createdAt: string;
@@ -3379,8 +3847,21 @@ export interface LoanListPaginated {
3379
3847
  export interface LoanLog {
3380
3848
  /** @format uuid */
3381
3849
  id: string;
3382
- level: LoanLogLevelEnum;
3383
- type: LoanLogTypeEnum;
3850
+ level: "None" | "Info" | "Warning" | "Error";
3851
+ type:
3852
+ | "Loan"
3853
+ | "Queue"
3854
+ | "POSFlagChanged"
3855
+ | "Verification"
3856
+ | "DocumentUploaded"
3857
+ | "LoanCreated"
3858
+ | "WorkflowSubmitted"
3859
+ | "UserInvitationSent"
3860
+ | "CoBorrowerAdded"
3861
+ | "TaskCompleted"
3862
+ | "LoanStatusChanged"
3863
+ | "EConsent"
3864
+ | "SensitiveDataPurge";
3384
3865
  message: string;
3385
3866
  /** @format date-time */
3386
3867
  createdAt: string;
@@ -3664,7 +4145,19 @@ export interface LoanUser {
3664
4145
  email: string;
3665
4146
  phone?: string | null;
3666
4147
  role: string;
3667
- loanRole: LoanUserLoanRoleEnum;
4148
+ loanRole:
4149
+ | "Borrower"
4150
+ | "CoBorrower"
4151
+ | "NonBorrower"
4152
+ | "LoanOfficer"
4153
+ | "LoanProcessor"
4154
+ | "LoanOfficerAssistant"
4155
+ | "SupportingLoanOfficer"
4156
+ | "BuyerAgent"
4157
+ | "SellerAgent"
4158
+ | "TitleInsuranceAgent"
4159
+ | "EscrowAgent"
4160
+ | "SettlementAgent";
3668
4161
  isUser: boolean;
3669
4162
  /** @format date-time */
3670
4163
  createdAt: string;
@@ -4309,7 +4802,7 @@ export interface SSOTokenRequest {
4309
4802
  }
4310
4803
 
4311
4804
  export interface SamlMetadataRequest {
4312
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4805
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4313
4806
  }
4314
4807
 
4315
4808
  export interface SendForgotPasswordRequest {
@@ -4348,7 +4841,7 @@ export interface SiteConfiguration {
4348
4841
  deletedAt?: string | null;
4349
4842
  /** @format uuid */
4350
4843
  id: string;
4351
- type: SiteConfigurationTypeEnum;
4844
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4352
4845
  /** @format uuid */
4353
4846
  entityID: string;
4354
4847
  /** @format int32 */
@@ -4543,7 +5036,7 @@ export interface SiteConfigurationByUrl {
4543
5036
  deletedAt?: string | null;
4544
5037
  /** @format uuid */
4545
5038
  id: string;
4546
- type: SiteConfigurationByUrlTypeEnum;
5039
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4547
5040
  /** @format uuid */
4548
5041
  entityID: string;
4549
5042
  /** @format int32 */
@@ -4756,7 +5249,7 @@ export interface SiteConfigurationForm {
4756
5249
  export interface SiteConfigurationReduced {
4757
5250
  /** @format uuid */
4758
5251
  id: string;
4759
- type: SiteConfigurationReducedTypeEnum;
5252
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4760
5253
  url?: string | null;
4761
5254
  name: string;
4762
5255
  /** @format int64 */
@@ -4774,7 +5267,7 @@ export interface SiteConfigurationRequest {
4774
5267
  entityID: string;
4775
5268
  /** @format int32 */
4776
5269
  entityType: number;
4777
- type: SiteConfigurationRequestTypeEnum;
5270
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4778
5271
  url: string;
4779
5272
  name: string;
4780
5273
  introduction?: string | null;
@@ -4951,7 +5444,7 @@ export interface SiteConfigurationSearchCriteria {
4951
5444
  export interface SiteConfigurationSummary {
4952
5445
  /** @format uuid */
4953
5446
  id: string;
4954
- type: SiteConfigurationSummaryTypeEnum;
5447
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4955
5448
  url?: string | null;
4956
5449
  name: string;
4957
5450
  /** @format int64 */
@@ -5140,6 +5633,15 @@ export interface TestSendNotificationForLoanRequest {
5140
5633
  attachments: Attachment[];
5141
5634
  }
5142
5635
 
5636
+ export interface Theme {
5637
+ logoURL: string;
5638
+ primaryColor: string;
5639
+ secondaryColor: string;
5640
+ backgroundColor?: string | null;
5641
+ textColor?: string | null;
5642
+ iconColor?: string | null;
5643
+ }
5644
+
5143
5645
  export interface TimeAtAddress {
5144
5646
  /** @format uuid */
5145
5647
  id?: string | null;
@@ -5250,6 +5752,60 @@ export interface UpdateAccountRequest {
5250
5752
  settings: AccountSettingsRequest;
5251
5753
  }
5252
5754
 
5755
+ export interface UpdateAiCanonicalFieldRequest {
5756
+ /**
5757
+ * @minLength 1
5758
+ * @maxLength 200
5759
+ */
5760
+ displayName: string;
5761
+ /** @minLength 1 */
5762
+ description: string;
5763
+ /** @minItems 1 */
5764
+ allowedRoles: string[];
5765
+ isPii: boolean;
5766
+ }
5767
+
5768
+ export interface UpdateAiGuardrailRequest {
5769
+ /**
5770
+ * @minLength 1
5771
+ * @maxLength 200
5772
+ */
5773
+ name: string;
5774
+ category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5775
+ description?: string | null;
5776
+ /** @minItems 1 */
5777
+ keywords: string[];
5778
+ /** @minLength 1 */
5779
+ responseTemplate: string;
5780
+ }
5781
+
5782
+ export interface UpdateAiPromptRequest {
5783
+ /**
5784
+ * @minLength 1
5785
+ * @maxLength 200
5786
+ */
5787
+ title: string;
5788
+ icon: string;
5789
+ /**
5790
+ * @minLength 1
5791
+ * @maxLength 500
5792
+ */
5793
+ description: string;
5794
+ documentTypes: string[];
5795
+ applicableGuidelines: string[];
5796
+ allowedRoles: string[];
5797
+ /** @minLength 1 */
5798
+ systemPrompt: string;
5799
+ /** @minLength 1 */
5800
+ userPromptTemplate: string;
5801
+ followUpPrompts: string[];
5802
+ /** @format int32 */
5803
+ sortOrder: number;
5804
+ category?: AiPromptCategory | null;
5805
+ queryTemplateName?: AiQueryTemplateName | null;
5806
+ displayHint?: AiDisplayHint | null;
5807
+ }
5808
+
5253
5809
  export interface UpdateDocumentTemplateRequest {
5254
5810
  /** @minLength 1 */
5255
5811
  htmlBody: string;
@@ -5568,7 +6124,19 @@ export interface UserDevice {
5568
6124
  export interface UserDraft {
5569
6125
  /** @format uuid */
5570
6126
  draftID: string;
5571
- role: UserDraftRoleEnum;
6127
+ role:
6128
+ | "Borrower"
6129
+ | "CoBorrower"
6130
+ | "NonBorrower"
6131
+ | "LoanOfficer"
6132
+ | "LoanProcessor"
6133
+ | "LoanOfficerAssistant"
6134
+ | "SupportingLoanOfficer"
6135
+ | "BuyerAgent"
6136
+ | "SellerAgent"
6137
+ | "TitleInsuranceAgent"
6138
+ | "EscrowAgent"
6139
+ | "SettlementAgent";
5572
6140
  user: User;
5573
6141
  }
5574
6142
 
@@ -5595,7 +6163,7 @@ export interface UserGroupAccessScope {
5595
6163
  id: string;
5596
6164
  /** @format uuid */
5597
6165
  groupId: string;
5598
- scopeType: UserGroupAccessScopeScopeTypeEnum;
6166
+ scopeType: "User" | "Branch";
5599
6167
  /** @format uuid */
5600
6168
  userId?: string | null;
5601
6169
  /** @format uuid */
@@ -5631,7 +6199,19 @@ export interface UserLoan {
5631
6199
  deletedAt?: string | null;
5632
6200
  loanID: string;
5633
6201
  user: User;
5634
- role: UserLoanRoleEnum;
6202
+ role:
6203
+ | "Borrower"
6204
+ | "CoBorrower"
6205
+ | "NonBorrower"
6206
+ | "LoanOfficer"
6207
+ | "LoanProcessor"
6208
+ | "LoanOfficerAssistant"
6209
+ | "SupportingLoanOfficer"
6210
+ | "BuyerAgent"
6211
+ | "SellerAgent"
6212
+ | "TitleInsuranceAgent"
6213
+ | "EscrowAgent"
6214
+ | "SettlementAgent";
5635
6215
  /** @format int32 */
5636
6216
  borrowerPair?: number | null;
5637
6217
  /** @format int32 */
@@ -5644,9 +6224,10 @@ export interface UserLoanConsent {
5644
6224
  id: string;
5645
6225
  /** @format uuid */
5646
6226
  userLoanID: string;
5647
- type: UserLoanConsentTypeEnum;
6227
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5648
6228
  providedConsent: boolean;
5649
6229
  ipAddress?: string | null;
6230
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5650
6231
  /** @format date-time */
5651
6232
  createdAt: string;
5652
6233
  }
@@ -5791,7 +6372,17 @@ export interface UserSummary {
5791
6372
  id: string;
5792
6373
  name?: string | null;
5793
6374
  email?: string | null;
5794
- role: UserSummaryRoleEnum;
6375
+ role:
6376
+ | "Borrower"
6377
+ | "LoanOfficer"
6378
+ | "Admin"
6379
+ | "SuperAdmin"
6380
+ | "Realtor"
6381
+ | "SettlementAgent"
6382
+ | "LoanProcessor"
6383
+ | "LoanOfficerAssistant"
6384
+ | "BranchManager"
6385
+ | "SystemAdmin";
5795
6386
  }
5796
6387
 
5797
6388
  export interface VerifyPasswordRequest {
@@ -5827,329 +6418,37 @@ export interface Workflow {
5827
6418
  icon: string;
5828
6419
  }
5829
6420
 
5830
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5831
-
5832
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6421
+ import type {
6422
+ AxiosInstance,
6423
+ AxiosRequestConfig,
6424
+ AxiosResponse,
6425
+ HeadersDefaults,
6426
+ ResponseType,
6427
+ } from "axios";
6428
+ import axios from "axios";
5833
6429
 
5834
- export type CreateGroupMemberRequestLoanRoleEnum =
5835
- | "Borrower"
5836
- | "CoBorrower"
5837
- | "NonBorrower"
5838
- | "LoanOfficer"
5839
- | "LoanProcessor"
5840
- | "LoanOfficerAssistant"
5841
- | "SupportingLoanOfficer"
5842
- | "BuyerAgent"
5843
- | "SellerAgent"
5844
- | "TitleInsuranceAgent"
5845
- | "EscrowAgent"
5846
- | "SettlementAgent";
6430
+ export type QueryParamsType = Record<string | number, any>;
5847
6431
 
5848
- /** @deprecated */
5849
- export type CreateInviteRequestRelationshipEnum =
5850
- | "NotApplicable"
5851
- | "Spouse"
5852
- | "NonSpouse";
6432
+ export interface FullRequestParams
6433
+ extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
6434
+ /** set parameter to `true` for call `securityWorker` for this request */
6435
+ secure?: boolean;
6436
+ /** request path */
6437
+ path: string;
6438
+ /** content type of request body */
6439
+ type?: ContentType;
6440
+ /** query params */
6441
+ query?: QueryParamsType;
6442
+ /** format of response (i.e. response.json() -> format: "json") */
6443
+ format?: ResponseType;
6444
+ /** request body */
6445
+ body?: unknown;
6446
+ }
5853
6447
 
5854
- export type CreateLoanImportRequestImportModeEnum =
5855
- | "All"
5856
- | "NewOnly"
5857
- | "UpdateOnly";
5858
-
5859
- export type CreateUserDraftLoanRoleEnum =
5860
- | "Borrower"
5861
- | "CoBorrower"
5862
- | "NonBorrower"
5863
- | "LoanOfficer"
5864
- | "LoanProcessor"
5865
- | "LoanOfficerAssistant"
5866
- | "SupportingLoanOfficer"
5867
- | "BuyerAgent"
5868
- | "SellerAgent"
5869
- | "TitleInsuranceAgent"
5870
- | "EscrowAgent"
5871
- | "SettlementAgent";
5872
-
5873
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5874
-
5875
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5876
-
5877
- export type EncompassRequestLogOperationTypeEnum =
5878
- | "FieldUpdate"
5879
- | "EConsentUpdate"
5880
- | "DocumentSync"
5881
- | "MilestoneUpdate"
5882
- | "DocumentAttachment"
5883
- | "General"
5884
- | "FieldReader";
5885
-
5886
- export type EncompassRequestLogOutcomeEnum =
5887
- | "Success"
5888
- | "Failure"
5889
- | "PartialSuccess";
5890
-
5891
- export type FusionReportFilterFilterTypeEnum =
5892
- | "DateGreaterThanOrEqualTo"
5893
- | "DateGreaterThan"
5894
- | "DateLessThan"
5895
- | "DateLessThanOrEqualTo"
5896
- | "DateEquals"
5897
- | "DateDoesntEqual"
5898
- | "DateNonEmpty"
5899
- | "DateEmpty"
5900
- | "StringContains"
5901
- | "StringEquals"
5902
- | "StringNotEmpty"
5903
- | "StringNotEquals"
5904
- | "StringNotContains";
5905
-
5906
- export type IpAddressAddressFamilyEnum =
5907
- | "Unspecified"
5908
- | "Unix"
5909
- | "InterNetwork"
5910
- | "ImpLink"
5911
- | "Pup"
5912
- | "Chaos"
5913
- | "NS"
5914
- | "Ipx"
5915
- | "Iso"
5916
- | "Osi"
5917
- | "Ecma"
5918
- | "DataKit"
5919
- | "Ccitt"
5920
- | "Sna"
5921
- | "DecNet"
5922
- | "DataLink"
5923
- | "Lat"
5924
- | "HyperChannel"
5925
- | "AppleTalk"
5926
- | "NetBios"
5927
- | "VoiceView"
5928
- | "FireFox"
5929
- | "Banyan"
5930
- | "Atm"
5931
- | "InterNetworkV6"
5932
- | "Cluster"
5933
- | "Ieee12844"
5934
- | "Irda"
5935
- | "NetworkDesigners"
5936
- | "Max"
5937
- | "Packet"
5938
- | "ControllerAreaNetwork"
5939
- | "Unknown";
5940
-
5941
- export type LoanContactRoleEnum =
5942
- | "Borrower"
5943
- | "CoBorrower"
5944
- | "NonBorrower"
5945
- | "LoanOfficer"
5946
- | "LoanProcessor"
5947
- | "LoanOfficerAssistant"
5948
- | "SupportingLoanOfficer"
5949
- | "BuyerAgent"
5950
- | "SellerAgent"
5951
- | "TitleInsuranceAgent"
5952
- | "EscrowAgent"
5953
- | "SettlementAgent";
5954
-
5955
- export type LoanImportStatusEnum =
5956
- | "WaitingProcess"
5957
- | "InProgress"
5958
- | "Completed"
5959
- | "Failed"
5960
- | "Cancelled";
5961
-
5962
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5963
-
5964
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5965
-
5966
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5967
-
5968
- export type LoanLogTypeEnum =
5969
- | "Loan"
5970
- | "Queue"
5971
- | "POSFlagChanged"
5972
- | "Verification"
5973
- | "DocumentUploaded"
5974
- | "LoanCreated"
5975
- | "WorkflowSubmitted"
5976
- | "UserInvitationSent"
5977
- | "CoBorrowerAdded"
5978
- | "TaskCompleted"
5979
- | "LoanStatusChanged"
5980
- | "EConsent"
5981
- | "SensitiveDataPurge";
5982
-
5983
- export type LoanUserLoanRoleEnum =
5984
- | "Borrower"
5985
- | "CoBorrower"
5986
- | "NonBorrower"
5987
- | "LoanOfficer"
5988
- | "LoanProcessor"
5989
- | "LoanOfficerAssistant"
5990
- | "SupportingLoanOfficer"
5991
- | "BuyerAgent"
5992
- | "SellerAgent"
5993
- | "TitleInsuranceAgent"
5994
- | "EscrowAgent"
5995
- | "SettlementAgent";
5996
-
5997
- export type SamlMetadataRequestSsoIntegrationEnum =
5998
- | "ConsumerConnect"
5999
- | "TheBigPOS"
6000
- | "POSF";
6001
-
6002
- export type SiteConfigurationTypeEnum =
6003
- | "None"
6004
- | "Account"
6005
- | "Corporate"
6006
- | "Branch"
6007
- | "LoanOfficer"
6008
- | "Partner";
6009
-
6010
- export type SiteConfigurationByUrlTypeEnum =
6011
- | "None"
6012
- | "Account"
6013
- | "Corporate"
6014
- | "Branch"
6015
- | "LoanOfficer"
6016
- | "Partner";
6017
-
6018
- export type SiteConfigurationReducedTypeEnum =
6019
- | "None"
6020
- | "Account"
6021
- | "Corporate"
6022
- | "Branch"
6023
- | "LoanOfficer"
6024
- | "Partner";
6025
-
6026
- export type SiteConfigurationRequestTypeEnum =
6027
- | "None"
6028
- | "Account"
6029
- | "Corporate"
6030
- | "Branch"
6031
- | "LoanOfficer"
6032
- | "Partner";
6033
-
6034
- export type SiteConfigurationSummaryTypeEnum =
6035
- | "None"
6036
- | "Account"
6037
- | "Corporate"
6038
- | "Branch"
6039
- | "LoanOfficer"
6040
- | "Partner";
6041
-
6042
- export type UserDraftRoleEnum =
6043
- | "Borrower"
6044
- | "CoBorrower"
6045
- | "NonBorrower"
6046
- | "LoanOfficer"
6047
- | "LoanProcessor"
6048
- | "LoanOfficerAssistant"
6049
- | "SupportingLoanOfficer"
6050
- | "BuyerAgent"
6051
- | "SellerAgent"
6052
- | "TitleInsuranceAgent"
6053
- | "EscrowAgent"
6054
- | "SettlementAgent";
6055
-
6056
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6057
-
6058
- export type UserLoanRoleEnum =
6059
- | "Borrower"
6060
- | "CoBorrower"
6061
- | "NonBorrower"
6062
- | "LoanOfficer"
6063
- | "LoanProcessor"
6064
- | "LoanOfficerAssistant"
6065
- | "SupportingLoanOfficer"
6066
- | "BuyerAgent"
6067
- | "SellerAgent"
6068
- | "TitleInsuranceAgent"
6069
- | "EscrowAgent"
6070
- | "SettlementAgent";
6071
-
6072
- export type UserLoanConsentTypeEnum =
6073
- | "Econsent"
6074
- | "CreditAuthorization"
6075
- | "Tcpa";
6076
-
6077
- export type UserSummaryRoleEnum =
6078
- | "Borrower"
6079
- | "LoanOfficer"
6080
- | "Admin"
6081
- | "SuperAdmin"
6082
- | "Realtor"
6083
- | "SettlementAgent"
6084
- | "LoanProcessor"
6085
- | "LoanOfficerAssistant"
6086
- | "BranchManager"
6087
- | "SystemAdmin";
6088
-
6089
- /** @default "Realtor" */
6090
- export type GetPartnersParamsRoleEnum =
6091
- | "Borrower"
6092
- | "LoanOfficer"
6093
- | "Admin"
6094
- | "SuperAdmin"
6095
- | "Realtor"
6096
- | "SettlementAgent"
6097
- | "LoanProcessor"
6098
- | "LoanOfficerAssistant"
6099
- | "BranchManager"
6100
- | "SystemAdmin";
6101
-
6102
- export type GetSamlMetadataParamsSSoIntegrationEnum =
6103
- | "ConsumerConnect"
6104
- | "TheBigPOS"
6105
- | "POSF";
6106
-
6107
- export type GetSamlMetadataParamsEnum =
6108
- | "ConsumerConnect"
6109
- | "TheBigPOS"
6110
- | "POSF";
6111
-
6112
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6113
- | "ConsumerConnect"
6114
- | "TheBigPOS"
6115
- | "POSF";
6116
-
6117
- export type CreateOrReplaceSamlMetadataParamsEnum =
6118
- | "ConsumerConnect"
6119
- | "TheBigPOS"
6120
- | "POSF";
6121
-
6122
- import type {
6123
- AxiosInstance,
6124
- AxiosRequestConfig,
6125
- AxiosResponse,
6126
- HeadersDefaults,
6127
- ResponseType,
6128
- } from "axios";
6129
- import axios from "axios";
6130
-
6131
- export type QueryParamsType = Record<string | number, any>;
6132
-
6133
- export interface FullRequestParams
6134
- extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
6135
- /** set parameter to `true` for call `securityWorker` for this request */
6136
- secure?: boolean;
6137
- /** request path */
6138
- path: string;
6139
- /** content type of request body */
6140
- type?: ContentType;
6141
- /** query params */
6142
- query?: QueryParamsType;
6143
- /** format of response (i.e. response.json() -> format: "json") */
6144
- format?: ResponseType;
6145
- /** request body */
6146
- body?: unknown;
6147
- }
6148
-
6149
- export type RequestParams = Omit<
6150
- FullRequestParams,
6151
- "body" | "method" | "query" | "path"
6152
- >;
6448
+ export type RequestParams = Omit<
6449
+ FullRequestParams,
6450
+ "body" | "method" | "query" | "path"
6451
+ >;
6153
6452
 
6154
6453
  export interface ApiConfig<SecurityDataType = unknown>
6155
6454
  extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
@@ -6297,7 +6596,7 @@ export class HttpClient<SecurityDataType = unknown> {
6297
6596
 
6298
6597
  /**
6299
6598
  * @title The Big POS API
6300
- * @version v2.36.9
6599
+ * @version v2.36.11
6301
6600
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6302
6601
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6303
6602
  */
@@ -6549,17 +6848,588 @@ export class Api<
6549
6848
  /**
6550
6849
  * No description
6551
6850
  *
6552
- * @tags Authentication
6553
- * @name GetTokenFromRefreshToken
6554
- * @summary Generate Token From Refresh Token
6555
- * @request POST:/api/refresh-token
6851
+ * @tags AiAdmin
6852
+ * @name GetAiAuditLogs
6853
+ * @summary Get paginated audit logs
6854
+ * @request GET:/api/ai/admin/audit-logs
6556
6855
  * @secure
6557
- * @response `200` `Token` Success
6558
- * @response `401` `ProblemDetails` Unauthorized
6559
- * @response `422` `UnprocessableEntity` Client Error
6856
+ * @response `200` `AiAuditLogPaginated` Success
6560
6857
  */
6561
- getTokenFromRefreshToken: (
6562
- data: RefreshTokenRequest,
6858
+ getAiAuditLogs: (
6859
+ query?: {
6860
+ eventType?: AiAuditEventType;
6861
+ /** @format date-time */
6862
+ startDate?: string;
6863
+ /** @format date-time */
6864
+ endDate?: string;
6865
+ /** @format int32 */
6866
+ pageSize?: number;
6867
+ /** @format int32 */
6868
+ pageNumber?: number;
6869
+ sortBy?: string;
6870
+ sortDirection?: string;
6871
+ },
6872
+ params: RequestParams = {},
6873
+ ) =>
6874
+ this.request<AiAuditLogPaginated, any>({
6875
+ path: `/api/ai/admin/audit-logs`,
6876
+ method: "GET",
6877
+ query: query,
6878
+ secure: true,
6879
+ format: "json",
6880
+ ...params,
6881
+ }),
6882
+
6883
+ /**
6884
+ * No description
6885
+ *
6886
+ * @tags AiAdmin
6887
+ * @name GetAiAdminStats
6888
+ * @summary Get AI admin dashboard stats
6889
+ * @request GET:/api/ai/admin/stats
6890
+ * @secure
6891
+ * @response `200` `AiAdminStats` Success
6892
+ */
6893
+ getAiAdminStats: (
6894
+ query?: {
6895
+ /** @format date-time */
6896
+ startDate?: string;
6897
+ /** @format date-time */
6898
+ endDate?: string;
6899
+ },
6900
+ params: RequestParams = {},
6901
+ ) =>
6902
+ this.request<AiAdminStats, any>({
6903
+ path: `/api/ai/admin/stats`,
6904
+ method: "GET",
6905
+ query: query,
6906
+ secure: true,
6907
+ format: "json",
6908
+ ...params,
6909
+ }),
6910
+
6911
+ /**
6912
+ * No description
6913
+ *
6914
+ * @tags AiAdminPrompt
6915
+ * @name GetAiPrompts
6916
+ * @summary Get all prompts
6917
+ * @request GET:/api/ai/admin/prompts
6918
+ * @secure
6919
+ * @response `200` `(AiPrompt)[]` Success
6920
+ */
6921
+ getAiPrompts: (params: RequestParams = {}) =>
6922
+ this.request<AiPrompt[], any>({
6923
+ path: `/api/ai/admin/prompts`,
6924
+ method: "GET",
6925
+ secure: true,
6926
+ format: "json",
6927
+ ...params,
6928
+ }),
6929
+
6930
+ /**
6931
+ * No description
6932
+ *
6933
+ * @tags AiAdminPrompt
6934
+ * @name CreateAiPrompt
6935
+ * @summary Create custom prompt
6936
+ * @request POST:/api/ai/admin/prompts
6937
+ * @secure
6938
+ * @response `201` `AiPrompt` Created
6939
+ * @response `400` `ProblemDetails` Bad Request
6940
+ */
6941
+ createAiPrompt: (data: CreateAiPromptRequest, params: RequestParams = {}) =>
6942
+ this.request<AiPrompt, ProblemDetails>({
6943
+ path: `/api/ai/admin/prompts`,
6944
+ method: "POST",
6945
+ body: data,
6946
+ secure: true,
6947
+ type: ContentType.Json,
6948
+ format: "json",
6949
+ ...params,
6950
+ }),
6951
+
6952
+ /**
6953
+ * No description
6954
+ *
6955
+ * @tags AiAdminPrompt
6956
+ * @name GetAiPrompt
6957
+ * @summary Get prompt by ID
6958
+ * @request GET:/api/ai/admin/prompts/{id}
6959
+ * @secure
6960
+ * @response `200` `AiPrompt` Success
6961
+ * @response `404` `ProblemDetails` Not Found
6962
+ */
6963
+ getAiPrompt: (id: string, params: RequestParams = {}) =>
6964
+ this.request<AiPrompt, ProblemDetails>({
6965
+ path: `/api/ai/admin/prompts/${id}`,
6966
+ method: "GET",
6967
+ secure: true,
6968
+ format: "json",
6969
+ ...params,
6970
+ }),
6971
+
6972
+ /**
6973
+ * No description
6974
+ *
6975
+ * @tags AiAdminPrompt
6976
+ * @name UpdateAiPrompt
6977
+ * @summary Update prompt
6978
+ * @request PUT:/api/ai/admin/prompts/{id}
6979
+ * @secure
6980
+ * @response `200` `AiPrompt` Success
6981
+ * @response `400` `ProblemDetails` Bad Request
6982
+ * @response `404` `ProblemDetails` Not Found
6983
+ */
6984
+ updateAiPrompt: (
6985
+ id: string,
6986
+ data: UpdateAiPromptRequest,
6987
+ params: RequestParams = {},
6988
+ ) =>
6989
+ this.request<AiPrompt, ProblemDetails>({
6990
+ path: `/api/ai/admin/prompts/${id}`,
6991
+ method: "PUT",
6992
+ body: data,
6993
+ secure: true,
6994
+ type: ContentType.Json,
6995
+ format: "json",
6996
+ ...params,
6997
+ }),
6998
+
6999
+ /**
7000
+ * No description
7001
+ *
7002
+ * @tags AiAdminPrompt
7003
+ * @name DeleteAiPrompt
7004
+ * @summary Delete prompt
7005
+ * @request DELETE:/api/ai/admin/prompts/{id}
7006
+ * @secure
7007
+ * @response `204` `void` No Content
7008
+ * @response `400` `ProblemDetails` Bad Request
7009
+ * @response `404` `ProblemDetails` Not Found
7010
+ */
7011
+ deleteAiPrompt: (id: string, params: RequestParams = {}) =>
7012
+ this.request<void, ProblemDetails>({
7013
+ path: `/api/ai/admin/prompts/${id}`,
7014
+ method: "DELETE",
7015
+ secure: true,
7016
+ ...params,
7017
+ }),
7018
+
7019
+ /**
7020
+ * No description
7021
+ *
7022
+ * @tags AiAdminPrompt
7023
+ * @name ToggleAiPrompt
7024
+ * @summary Toggle prompt active/inactive
7025
+ * @request PATCH:/api/ai/admin/prompts/{id}/toggle
7026
+ * @secure
7027
+ * @response `200` `AiPrompt` Success
7028
+ * @response `404` `ProblemDetails` Not Found
7029
+ */
7030
+ toggleAiPrompt: (id: string, params: RequestParams = {}) =>
7031
+ this.request<AiPrompt, ProblemDetails>({
7032
+ path: `/api/ai/admin/prompts/${id}/toggle`,
7033
+ method: "PATCH",
7034
+ secure: true,
7035
+ format: "json",
7036
+ ...params,
7037
+ }),
7038
+
7039
+ /**
7040
+ * No description
7041
+ *
7042
+ * @tags AiCanonicalField
7043
+ * @name GetAiCanonicalFields
7044
+ * @summary Get all canonical fields
7045
+ * @request GET:/api/ai/admin/fields
7046
+ * @secure
7047
+ * @response `200` `(AiCanonicalField)[]` Success
7048
+ */
7049
+ getAiCanonicalFields: (params: RequestParams = {}) =>
7050
+ this.request<AiCanonicalField[], any>({
7051
+ path: `/api/ai/admin/fields`,
7052
+ method: "GET",
7053
+ secure: true,
7054
+ format: "json",
7055
+ ...params,
7056
+ }),
7057
+
7058
+ /**
7059
+ * No description
7060
+ *
7061
+ * @tags AiCanonicalField
7062
+ * @name CreateAiCanonicalField
7063
+ * @summary Create canonical field
7064
+ * @request POST:/api/ai/admin/fields
7065
+ * @secure
7066
+ * @response `201` `AiCanonicalField` Created
7067
+ * @response `400` `ProblemDetails` Bad Request
7068
+ */
7069
+ createAiCanonicalField: (
7070
+ data: CreateAiCanonicalFieldRequest,
7071
+ params: RequestParams = {},
7072
+ ) =>
7073
+ this.request<AiCanonicalField, ProblemDetails>({
7074
+ path: `/api/ai/admin/fields`,
7075
+ method: "POST",
7076
+ body: data,
7077
+ secure: true,
7078
+ type: ContentType.JsonPatch,
7079
+ format: "json",
7080
+ ...params,
7081
+ }),
7082
+
7083
+ /**
7084
+ * No description
7085
+ *
7086
+ * @tags AiCanonicalField
7087
+ * @name GetAiCanonicalField
7088
+ * @summary Get canonical field by ID
7089
+ * @request GET:/api/ai/admin/fields/{id}
7090
+ * @secure
7091
+ * @response `200` `AiCanonicalField` Success
7092
+ * @response `404` `ProblemDetails` Not Found
7093
+ */
7094
+ getAiCanonicalField: (id: string, params: RequestParams = {}) =>
7095
+ this.request<AiCanonicalField, ProblemDetails>({
7096
+ path: `/api/ai/admin/fields/${id}`,
7097
+ method: "GET",
7098
+ secure: true,
7099
+ format: "json",
7100
+ ...params,
7101
+ }),
7102
+
7103
+ /**
7104
+ * No description
7105
+ *
7106
+ * @tags AiCanonicalField
7107
+ * @name UpdateAiCanonicalField
7108
+ * @summary Update canonical field
7109
+ * @request PUT:/api/ai/admin/fields/{id}
7110
+ * @secure
7111
+ * @response `200` `AiCanonicalField` Success
7112
+ * @response `400` `ProblemDetails` Bad Request
7113
+ * @response `404` `ProblemDetails` Not Found
7114
+ */
7115
+ updateAiCanonicalField: (
7116
+ id: string,
7117
+ data: UpdateAiCanonicalFieldRequest,
7118
+ params: RequestParams = {},
7119
+ ) =>
7120
+ this.request<AiCanonicalField, ProblemDetails>({
7121
+ path: `/api/ai/admin/fields/${id}`,
7122
+ method: "PUT",
7123
+ body: data,
7124
+ secure: true,
7125
+ type: ContentType.Json,
7126
+ format: "json",
7127
+ ...params,
7128
+ }),
7129
+
7130
+ /**
7131
+ * No description
7132
+ *
7133
+ * @tags AiCanonicalField
7134
+ * @name DeleteAiCanonicalField
7135
+ * @summary Delete canonical field
7136
+ * @request DELETE:/api/ai/admin/fields/{id}
7137
+ * @secure
7138
+ * @response `204` `void` No Content
7139
+ * @response `404` `ProblemDetails` Not Found
7140
+ */
7141
+ deleteAiCanonicalField: (id: string, params: RequestParams = {}) =>
7142
+ this.request<void, ProblemDetails>({
7143
+ path: `/api/ai/admin/fields/${id}`,
7144
+ method: "DELETE",
7145
+ secure: true,
7146
+ ...params,
7147
+ }),
7148
+
7149
+ /**
7150
+ * No description
7151
+ *
7152
+ * @tags AiCanonicalField
7153
+ * @name ToggleAiCanonicalField
7154
+ * @summary Toggle canonical field active/inactive
7155
+ * @request PATCH:/api/ai/admin/fields/{id}/toggle
7156
+ * @secure
7157
+ * @response `200` `AiCanonicalField` Success
7158
+ * @response `404` `ProblemDetails` Not Found
7159
+ */
7160
+ toggleAiCanonicalField: (id: string, params: RequestParams = {}) =>
7161
+ this.request<AiCanonicalField, ProblemDetails>({
7162
+ path: `/api/ai/admin/fields/${id}/toggle`,
7163
+ method: "PATCH",
7164
+ secure: true,
7165
+ format: "json",
7166
+ ...params,
7167
+ }),
7168
+
7169
+ /**
7170
+ * No description
7171
+ *
7172
+ * @tags AiChat
7173
+ * @name AiChat
7174
+ * @summary Send AI chat message
7175
+ * @request POST:/api/ai/chat
7176
+ * @secure
7177
+ * @response `200` `AiChat` Success
7178
+ * @response `400` `ProblemDetails` Bad Request
7179
+ * @response `401` `ProblemDetails` Unauthorized
7180
+ */
7181
+ aiChat: (data: AiChatRequest, params: RequestParams = {}) =>
7182
+ this.request<AiChat, ProblemDetails>({
7183
+ path: `/api/ai/chat`,
7184
+ method: "POST",
7185
+ body: data,
7186
+ secure: true,
7187
+ type: ContentType.JsonPatch,
7188
+ format: "json",
7189
+ ...params,
7190
+ }),
7191
+
7192
+ /**
7193
+ * No description
7194
+ *
7195
+ * @tags AiConversation
7196
+ * @name GetAiConversations
7197
+ * @summary Get user conversations
7198
+ * @request GET:/api/ai/conversations
7199
+ * @secure
7200
+ * @response `200` `AiConversationListItemPaginated` Success
7201
+ */
7202
+ getAiConversations: (
7203
+ query?: {
7204
+ /** @format int32 */
7205
+ pageSize?: number;
7206
+ /** @format int32 */
7207
+ pageNumber?: number;
7208
+ sortBy?: string;
7209
+ sortDirection?: string;
7210
+ },
7211
+ params: RequestParams = {},
7212
+ ) =>
7213
+ this.request<AiConversationListItemPaginated, any>({
7214
+ path: `/api/ai/conversations`,
7215
+ method: "GET",
7216
+ query: query,
7217
+ secure: true,
7218
+ format: "json",
7219
+ ...params,
7220
+ }),
7221
+
7222
+ /**
7223
+ * No description
7224
+ *
7225
+ * @tags AiConversation
7226
+ * @name GetAiConversation
7227
+ * @summary Get conversation with messages
7228
+ * @request GET:/api/ai/conversations/{id}
7229
+ * @secure
7230
+ * @response `200` `AiConversationDetail` Success
7231
+ * @response `403` `ProblemDetails` Forbidden
7232
+ * @response `404` `ProblemDetails` Not Found
7233
+ */
7234
+ getAiConversation: (id: string, params: RequestParams = {}) =>
7235
+ this.request<AiConversationDetail, ProblemDetails>({
7236
+ path: `/api/ai/conversations/${id}`,
7237
+ method: "GET",
7238
+ secure: true,
7239
+ format: "json",
7240
+ ...params,
7241
+ }),
7242
+
7243
+ /**
7244
+ * No description
7245
+ *
7246
+ * @tags AiConversation
7247
+ * @name DeleteAiConversation
7248
+ * @summary Delete conversation
7249
+ * @request DELETE:/api/ai/conversations/{id}
7250
+ * @secure
7251
+ * @response `204` `void` No Content
7252
+ * @response `403` `ProblemDetails` Forbidden
7253
+ * @response `404` `ProblemDetails` Not Found
7254
+ */
7255
+ deleteAiConversation: (id: string, params: RequestParams = {}) =>
7256
+ this.request<void, ProblemDetails>({
7257
+ path: `/api/ai/conversations/${id}`,
7258
+ method: "DELETE",
7259
+ secure: true,
7260
+ ...params,
7261
+ }),
7262
+
7263
+ /**
7264
+ * No description
7265
+ *
7266
+ * @tags AiGuardrail
7267
+ * @name GetAiGuardrails
7268
+ * @summary Get all guardrails
7269
+ * @request GET:/api/ai/admin/guardrails
7270
+ * @secure
7271
+ * @response `200` `(AiGuardrail)[]` Success
7272
+ */
7273
+ getAiGuardrails: (params: RequestParams = {}) =>
7274
+ this.request<AiGuardrail[], any>({
7275
+ path: `/api/ai/admin/guardrails`,
7276
+ method: "GET",
7277
+ secure: true,
7278
+ format: "json",
7279
+ ...params,
7280
+ }),
7281
+
7282
+ /**
7283
+ * No description
7284
+ *
7285
+ * @tags AiGuardrail
7286
+ * @name CreateAiGuardrail
7287
+ * @summary Create custom guardrail
7288
+ * @request POST:/api/ai/admin/guardrails
7289
+ * @secure
7290
+ * @response `201` `AiGuardrail` Created
7291
+ * @response `400` `ProblemDetails` Bad Request
7292
+ */
7293
+ createAiGuardrail: (
7294
+ data: CreateAiGuardrailRequest,
7295
+ params: RequestParams = {},
7296
+ ) =>
7297
+ this.request<AiGuardrail, ProblemDetails>({
7298
+ path: `/api/ai/admin/guardrails`,
7299
+ method: "POST",
7300
+ body: data,
7301
+ secure: true,
7302
+ type: ContentType.Json,
7303
+ format: "json",
7304
+ ...params,
7305
+ }),
7306
+
7307
+ /**
7308
+ * No description
7309
+ *
7310
+ * @tags AiGuardrail
7311
+ * @name GetAiGuardrail
7312
+ * @summary Get guardrail by ID
7313
+ * @request GET:/api/ai/admin/guardrails/{id}
7314
+ * @secure
7315
+ * @response `200` `AiGuardrail` Success
7316
+ * @response `404` `ProblemDetails` Not Found
7317
+ */
7318
+ getAiGuardrail: (id: string, params: RequestParams = {}) =>
7319
+ this.request<AiGuardrail, ProblemDetails>({
7320
+ path: `/api/ai/admin/guardrails/${id}`,
7321
+ method: "GET",
7322
+ secure: true,
7323
+ format: "json",
7324
+ ...params,
7325
+ }),
7326
+
7327
+ /**
7328
+ * No description
7329
+ *
7330
+ * @tags AiGuardrail
7331
+ * @name UpdateAiGuardrail
7332
+ * @summary Update guardrail
7333
+ * @request PUT:/api/ai/admin/guardrails/{id}
7334
+ * @secure
7335
+ * @response `200` `AiGuardrail` Success
7336
+ * @response `400` `ProblemDetails` Bad Request
7337
+ * @response `404` `ProblemDetails` Not Found
7338
+ */
7339
+ updateAiGuardrail: (
7340
+ id: string,
7341
+ data: UpdateAiGuardrailRequest,
7342
+ params: RequestParams = {},
7343
+ ) =>
7344
+ this.request<AiGuardrail, ProblemDetails>({
7345
+ path: `/api/ai/admin/guardrails/${id}`,
7346
+ method: "PUT",
7347
+ body: data,
7348
+ secure: true,
7349
+ type: ContentType.Json,
7350
+ format: "json",
7351
+ ...params,
7352
+ }),
7353
+
7354
+ /**
7355
+ * No description
7356
+ *
7357
+ * @tags AiGuardrail
7358
+ * @name DeleteAiGuardrail
7359
+ * @summary Delete guardrail
7360
+ * @request DELETE:/api/ai/admin/guardrails/{id}
7361
+ * @secure
7362
+ * @response `204` `void` No Content
7363
+ * @response `400` `ProblemDetails` Bad Request
7364
+ * @response `404` `ProblemDetails` Not Found
7365
+ */
7366
+ deleteAiGuardrail: (id: string, params: RequestParams = {}) =>
7367
+ this.request<void, ProblemDetails>({
7368
+ path: `/api/ai/admin/guardrails/${id}`,
7369
+ method: "DELETE",
7370
+ secure: true,
7371
+ ...params,
7372
+ }),
7373
+
7374
+ /**
7375
+ * No description
7376
+ *
7377
+ * @tags AiGuardrail
7378
+ * @name ToggleAiGuardrail
7379
+ * @summary Toggle guardrail enabled/disabled
7380
+ * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
7381
+ * @secure
7382
+ * @response `200` `AiGuardrail` Success
7383
+ * @response `404` `ProblemDetails` Not Found
7384
+ */
7385
+ toggleAiGuardrail: (id: string, params: RequestParams = {}) =>
7386
+ this.request<AiGuardrail, ProblemDetails>({
7387
+ path: `/api/ai/admin/guardrails/${id}/toggle`,
7388
+ method: "PATCH",
7389
+ secure: true,
7390
+ format: "json",
7391
+ ...params,
7392
+ }),
7393
+
7394
+ /**
7395
+ * No description
7396
+ *
7397
+ * @tags AiPrompt
7398
+ * @name GetAvailablePrompts
7399
+ * @summary Get available prompts for current user
7400
+ * @request GET:/api/ai/prompts
7401
+ * @secure
7402
+ * @response `200` `(AiPromptSummary)[]` Success
7403
+ */
7404
+ getAvailablePrompts: (
7405
+ query?: {
7406
+ documentType?: string;
7407
+ },
7408
+ params: RequestParams = {},
7409
+ ) =>
7410
+ this.request<AiPromptSummary[], any>({
7411
+ path: `/api/ai/prompts`,
7412
+ method: "GET",
7413
+ query: query,
7414
+ secure: true,
7415
+ format: "json",
7416
+ ...params,
7417
+ }),
7418
+
7419
+ /**
7420
+ * No description
7421
+ *
7422
+ * @tags Authentication
7423
+ * @name GetTokenFromRefreshToken
7424
+ * @summary Generate Token From Refresh Token
7425
+ * @request POST:/api/refresh-token
7426
+ * @secure
7427
+ * @response `200` `Token` Success
7428
+ * @response `401` `ProblemDetails` Unauthorized
7429
+ * @response `422` `UnprocessableEntity` Client Error
7430
+ */
7431
+ getTokenFromRefreshToken: (
7432
+ data: RefreshTokenRequest,
6563
7433
  params: RequestParams = {},
6564
7434
  ) =>
6565
7435
  this.request<Token, ProblemDetails | UnprocessableEntity>({
@@ -6567,7 +7437,7 @@ export class Api<
6567
7437
  method: "POST",
6568
7438
  body: data,
6569
7439
  secure: true,
6570
- type: ContentType.Json,
7440
+ type: ContentType.JsonPatch,
6571
7441
  format: "json",
6572
7442
  ...params,
6573
7443
  }),
@@ -6580,11 +7450,11 @@ export class Api<
6580
7450
  * @summary Get Token
6581
7451
  * @request POST:/api/token
6582
7452
  * @secure
6583
- * @response `200` `Token` Success
7453
+ * @response `200` `ForcePasswordReset` Success
6584
7454
  * @response `422` `UnprocessableEntity` Client Error
6585
7455
  */
6586
7456
  getToken: (data: TokenRequest, params: RequestParams = {}) =>
6587
- this.request<Token, UnprocessableEntity>({
7457
+ this.request<ForcePasswordReset, UnprocessableEntity>({
6588
7458
  path: `/api/token`,
6589
7459
  method: "POST",
6590
7460
  body: data,
@@ -6602,14 +7472,14 @@ export class Api<
6602
7472
  * @summary Get Token From Challenge Code
6603
7473
  * @request POST:/api/token/code
6604
7474
  * @secure
6605
- * @response `200` `Token` Success
7475
+ * @response `200` `ForcePasswordReset` Success
6606
7476
  * @response `422` `UnprocessableEntity` Client Error
6607
7477
  */
6608
7478
  getTokenFromChallengeCode: (
6609
7479
  data: TokenChallengeRequest,
6610
7480
  params: RequestParams = {},
6611
7481
  ) =>
6612
- this.request<Token, UnprocessableEntity>({
7482
+ this.request<ForcePasswordReset, UnprocessableEntity>({
6613
7483
  path: `/api/token/code`,
6614
7484
  method: "POST",
6615
7485
  body: data,
@@ -11575,7 +12445,17 @@ export class Api<
11575
12445
  query?: {
11576
12446
  showAll?: boolean;
11577
12447
  /** @default "Realtor" */
11578
- role?: GetPartnersParamsRoleEnum;
12448
+ role?:
12449
+ | "Borrower"
12450
+ | "LoanOfficer"
12451
+ | "Admin"
12452
+ | "SuperAdmin"
12453
+ | "Realtor"
12454
+ | "SettlementAgent"
12455
+ | "LoanProcessor"
12456
+ | "LoanOfficerAssistant"
12457
+ | "BranchManager"
12458
+ | "SystemAdmin";
11579
12459
  /** @format int32 */
11580
12460
  pageSize?: number;
11581
12461
  /** @format int32 */
@@ -11911,7 +12791,7 @@ export class Api<
11911
12791
  * @response `404` `ProblemDetails` Not Found
11912
12792
  */
11913
12793
  getSamlMetadata: (
11914
- sSoIntegration: GetSamlMetadataParamsEnum,
12794
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
11915
12795
  ssoIntegration: string,
11916
12796
  params: RequestParams = {},
11917
12797
  ) =>
@@ -11933,7 +12813,7 @@ export class Api<
11933
12813
  * @response `200` `File` Success
11934
12814
  */
11935
12815
  createOrReplaceSamlMetadata: (
11936
- sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
12816
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
11937
12817
  ssoIntegration: string,
11938
12818
  params: RequestParams = {},
11939
12819
  ) =>