@matech/thebigpos-sdk 2.40.3-aibi-1 → 2.40.4-rc0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/README.md +73 -73
  4. package/dist/index.d.ts +126 -887
  5. package/dist/index.js +8 -407
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -1
  8. package/src/index.ts +814 -1878
  9. package/tsconfig.json +27 -27
package/src/index.ts CHANGED
@@ -392,89 +392,6 @@ export type AuditChangeType =
392
392
  | "HardDeleted"
393
393
  | "Restored";
394
394
 
395
- export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
396
-
397
- export type AiUrlSourceCategory =
398
- | "Regulatory"
399
- | "Guidelines"
400
- | "MarketData"
401
- | "Custom";
402
-
403
- export type AiStructuredDataType =
404
- | "Table"
405
- | "DocumentAnalysis"
406
- | "DocumentList"
407
- | "GeneratedDocument";
408
-
409
- export type AiQueryTemplateName =
410
- | "PipelineSummary"
411
- | "LoanDetail"
412
- | "LoansClosing"
413
- | "StaleLoans"
414
- | "LoansByType"
415
- | "LoansByOfficer"
416
- | "AverageLoanAmount"
417
- | "LockedVsUnlocked"
418
- | "LoansByPurpose"
419
- | "LoansByPropertyState"
420
- | "LoansByRate"
421
- | "DtiLtvRisk"
422
- | "DisclosureTracking"
423
- | "NewLoans"
424
- | "ExpiringLocks"
425
- | "ClosedLoans";
426
-
427
- export type AiPromptCategory =
428
- | "DocumentAnalysis"
429
- | "DataQuery"
430
- | "General"
431
- | "Action";
432
-
433
- export type AiOutputType = "Text" | "Document";
434
-
435
- export type AiIntent =
436
- | "Greeting"
437
- | "Invalid"
438
- | "Relevant"
439
- | "LoanSpecific"
440
- | "DocumentList"
441
- | "GeneralKnowledge"
442
- | "Blocked"
443
- | "Action";
444
-
445
- export type AiGuardrailCategory =
446
- | "ContentSafety"
447
- | "PromptInjection"
448
- | "Privacy"
449
- | "Legal";
450
-
451
- export type AiDisplayHint =
452
- | "Table"
453
- | "SummaryCards"
454
- | "RankedList"
455
- | "Comparison"
456
- | "ExecutiveBrief";
457
-
458
- export type AiAuditEventType =
459
- | "Error"
460
- | "GuardrailBlockedPre"
461
- | "GuardrailPassedPre"
462
- | "IntentClassified"
463
- | "LoanResolvedFromMessage"
464
- | "DocumentNotFound"
465
- | "GuardrailBlockedPost"
466
- | "GuardrailPassedPost"
467
- | "DocumentAnalyzed"
468
- | "DocumentList"
469
- | "DocumentResolutionAmbiguous"
470
- | "ResponseGenerated"
471
- | "ParametersExtracted"
472
- | "QueryExecuted"
473
- | "LoanContextNotFound"
474
- | "LoanContextLoaded"
475
- | "GuardrailBlockedBedrock"
476
- | "PromptMatched";
477
-
478
395
  export type AddressFamily =
479
396
  | "Unspecified"
480
397
  | "Unix"
@@ -562,7 +479,7 @@ export interface AccountBilling {
562
479
  }
563
480
 
564
481
  export interface AccountBillingRequest {
565
- billingType: "ClosedLoan" | "LoanOfficer";
482
+ billingType: AccountBillingRequestBillingTypeEnum;
566
483
  /**
567
484
  * @format double
568
485
  * @min 0
@@ -577,7 +494,6 @@ export interface AccountSettings {
577
494
  smsNumber?: string | null;
578
495
  ssoHostOverride?: string | null;
579
496
  isEarlyAdopter: boolean;
580
- isAIEnabled: boolean;
581
497
  }
582
498
 
583
499
  export interface AccountSettingsRequest {
@@ -789,263 +705,6 @@ export interface AffordabilityCalculatorRequest {
789
705
  annualInsurance: number;
790
706
  }
791
707
 
792
- export interface AiAdminStats {
793
- /** @format int32 */
794
- totalRequests: number;
795
- /** @format int32 */
796
- blockedRequests: number;
797
- /** @format double */
798
- averageResponseTimeMs: number;
799
- intentDistribution: Record<string, number>;
800
- topQueryTemplates: Record<string, number>;
801
- period: string;
802
- }
803
-
804
- export interface AiAuditLog {
805
- /** @format uuid */
806
- id: string;
807
- /** @format uuid */
808
- requestId: string;
809
- /** @format uuid */
810
- userId: string;
811
- eventType:
812
- | "Error"
813
- | "GuardrailBlockedPre"
814
- | "GuardrailPassedPre"
815
- | "IntentClassified"
816
- | "LoanResolvedFromMessage"
817
- | "DocumentNotFound"
818
- | "GuardrailBlockedPost"
819
- | "GuardrailPassedPost"
820
- | "DocumentAnalyzed"
821
- | "DocumentList"
822
- | "DocumentResolutionAmbiguous"
823
- | "ResponseGenerated"
824
- | "ParametersExtracted"
825
- | "QueryExecuted"
826
- | "LoanContextNotFound"
827
- | "LoanContextLoaded"
828
- | "GuardrailBlockedBedrock"
829
- | "PromptMatched";
830
- details?: any;
831
- /** @format date-time */
832
- createdAt: string;
833
- }
834
-
835
- export interface AiAuditLogPaginated {
836
- rows: AiAuditLog[];
837
- pagination: Pagination;
838
- /** @format int64 */
839
- count: number;
840
- }
841
-
842
- export interface AiCanonicalField {
843
- /** @format uuid */
844
- id: string;
845
- canonicalName: string;
846
- displayName: string;
847
- description: string;
848
- allowedRoles: string[];
849
- efPath?: string | null;
850
- isPii: boolean;
851
- isActive: boolean;
852
- dataSource: string;
853
- isDefault: boolean;
854
- category?: string | null;
855
- jsonPropertyName?: string | null;
856
- textractKey?: string | null;
857
- textractKeyAliases?: string | null;
858
- hasAccountOverride: boolean;
859
- /** @format date-time */
860
- createdAt: string;
861
- /** @format date-time */
862
- updatedAt?: string | null;
863
- }
864
-
865
- export interface AiChat {
866
- /** @format uuid */
867
- conversationId: string;
868
- /** @format uuid */
869
- messageId: string;
870
- response: AiChatBody;
871
- metadata: AiChatMetadata;
872
- }
873
-
874
- export interface AiChatBody {
875
- text: string;
876
- data?: AiChatStructuredData | null;
877
- suggestedFollowUps: string[];
878
- }
879
-
880
- export interface AiChatMessage {
881
- /** @format uuid */
882
- id: string;
883
- userMessage: string;
884
- assistantResponse: string;
885
- intent?: AiIntent | null;
886
- fieldsAccessed?: string[] | null;
887
- /** @format date-time */
888
- createdAt: string;
889
- }
890
-
891
- export interface AiChatMetadata {
892
- intent:
893
- | "Greeting"
894
- | "Invalid"
895
- | "Relevant"
896
- | "LoanSpecific"
897
- | "DocumentList"
898
- | "GeneralKnowledge"
899
- | "Blocked"
900
- | "Action";
901
- fieldsAccessed: string[];
902
- /** @format int64 */
903
- queryTimeMs: number;
904
- /** @format int64 */
905
- llmTimeMs: number;
906
- wasBlocked: boolean;
907
- blockedReason?: string | null;
908
- }
909
-
910
- export interface AiChatRequest {
911
- /**
912
- * @minLength 1
913
- * @maxLength 2000
914
- */
915
- message: string;
916
- /** @format uuid */
917
- conversationId?: string | null;
918
- /** @format uuid */
919
- loanId?: string | null;
920
- documentIds?: string[] | null;
921
- /** @format uuid */
922
- promptId?: string | null;
923
- }
924
-
925
- export interface AiChatStructuredData {
926
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
927
- displayHint?: AiDisplayHint | null;
928
- detectedDocumentType?: string | null;
929
- columns: string[];
930
- rows: string[][];
931
- /** @format uuid */
932
- generatedDocumentId?: string | null;
933
- generatedFileName?: string | null;
934
- }
935
-
936
- export interface AiConversationDetail {
937
- /** @format uuid */
938
- id: string;
939
- /** @format date-time */
940
- createdAt: string;
941
- /** @format date-time */
942
- updatedAt?: string | null;
943
- messages: AiChatMessage[];
944
- }
945
-
946
- export interface AiConversationListItem {
947
- /** @format uuid */
948
- id: string;
949
- preview: string;
950
- /** @format int32 */
951
- messageCount: number;
952
- /** @format date-time */
953
- createdAt: string;
954
- /** @format date-time */
955
- updatedAt?: string | null;
956
- }
957
-
958
- export interface AiConversationListItemPaginated {
959
- rows: AiConversationListItem[];
960
- pagination: Pagination;
961
- /** @format int64 */
962
- count: number;
963
- }
964
-
965
- export interface AiGuardrail {
966
- /** @format uuid */
967
- id: string;
968
- name: string;
969
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
970
- description?: string | null;
971
- keywords: string[];
972
- responseTemplate: string;
973
- isDefault: boolean;
974
- isEnabled: boolean;
975
- hasAccountOverride: boolean;
976
- /** @format date-time */
977
- createdAt: string;
978
- /** @format date-time */
979
- updatedAt?: string | null;
980
- }
981
-
982
- export interface AiPrompt {
983
- /** @format uuid */
984
- id: string;
985
- title: string;
986
- icon: string;
987
- slug: string;
988
- description: string;
989
- documentTypes: string[];
990
- applicableGuidelines: string[];
991
- allowedRoles: string[];
992
- systemPrompt: string;
993
- userPromptTemplate: string;
994
- followUpPrompts: string[];
995
- /** @format int32 */
996
- sortOrder: number;
997
- isDefault: boolean;
998
- /** @format uuid */
999
- accountId?: string | null;
1000
- isActive: boolean;
1001
- category?: AiPromptCategory | null;
1002
- queryTemplateName?: AiQueryTemplateName | null;
1003
- displayHint?: AiDisplayHint | null;
1004
- bedrockModelId?: string | null;
1005
- requiredDataSources?: string[] | null;
1006
- outputType?: AiOutputType | null;
1007
- hasAccountOverride: boolean;
1008
- /** @format date-time */
1009
- createdAt: string;
1010
- /** @format date-time */
1011
- updatedAt?: string | null;
1012
- }
1013
-
1014
- export interface AiPromptSummary {
1015
- /** @format uuid */
1016
- id: string;
1017
- title: string;
1018
- icon: string;
1019
- slug: string;
1020
- description: string;
1021
- documentTypes: string[];
1022
- applicableGuidelines: string[];
1023
- followUpPrompts: string[];
1024
- /** @format int32 */
1025
- sortOrder: number;
1026
- category?: AiPromptCategory | null;
1027
- queryTemplateName?: AiQueryTemplateName | null;
1028
- displayHint?: AiDisplayHint | null;
1029
- bedrockModelId?: string | null;
1030
- requiredDataSources?: string[] | null;
1031
- outputType?: AiOutputType | null;
1032
- }
1033
-
1034
- export interface AiUrlSource {
1035
- /** @format uuid */
1036
- id: string;
1037
- name: string;
1038
- url: string;
1039
- description?: string | null;
1040
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1041
- scope: "FullDomain" | "SpecificPath";
1042
- isActive: boolean;
1043
- /** @format date-time */
1044
- createdAt: string;
1045
- /** @format date-time */
1046
- updatedAt?: string | null;
1047
- }
1048
-
1049
708
  export interface AllowImpersonationRequest {
1050
709
  /**
1051
710
  * @format email
@@ -1158,12 +817,7 @@ export interface AuditLogEntry {
1158
817
  /** @format uuid */
1159
818
  id: string;
1160
819
  entityType: string;
1161
- changeType:
1162
- | "Created"
1163
- | "Modified"
1164
- | "SoftDeleted"
1165
- | "HardDeleted"
1166
- | "Restored";
820
+ changeType: AuditLogEntryChangeTypeEnum;
1167
821
  /** @format uuid */
1168
822
  entityId: string;
1169
823
  performedBy?: AuditLogUser | null;
@@ -1477,7 +1131,7 @@ export interface CorporateSearchCriteria {
1477
1131
  }
1478
1132
 
1479
1133
  export interface CreateAccessScopeRequest {
1480
- scopeType: "User" | "Branch";
1134
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1481
1135
  /** @format uuid */
1482
1136
  userId?: string | null;
1483
1137
  /** @format uuid */
@@ -1501,92 +1155,11 @@ export interface CreateAccountRequest {
1501
1155
  */
1502
1156
  nlmsid: number;
1503
1157
  settings: AccountSettingsRequest;
1504
- environment: "Development" | "Staging" | "UAT" | "Production";
1158
+ environment: CreateAccountRequestEnvironmentEnum;
1505
1159
  losIntegration: LOSIntegration;
1506
1160
  billingSettings: AccountBillingRequest;
1507
1161
  }
1508
1162
 
1509
- export interface CreateAiCanonicalFieldRequest {
1510
- /**
1511
- * @minLength 1
1512
- * @maxLength 200
1513
- */
1514
- displayName: string;
1515
- /** @minLength 1 */
1516
- description: string;
1517
- /** @minItems 1 */
1518
- allowedRoles: string[];
1519
- isPii: boolean;
1520
- /** @minLength 1 */
1521
- dataSource: string;
1522
- category?: string | null;
1523
- }
1524
-
1525
- export interface CreateAiGuardrailRequest {
1526
- /**
1527
- * @minLength 1
1528
- * @maxLength 200
1529
- */
1530
- name: string;
1531
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1532
- description?: string | null;
1533
- /** @minItems 1 */
1534
- keywords: string[];
1535
- /** @minLength 1 */
1536
- responseTemplate: string;
1537
- }
1538
-
1539
- export interface CreateAiPromptRequest {
1540
- /**
1541
- * @minLength 1
1542
- * @maxLength 200
1543
- */
1544
- title: string;
1545
- icon: string;
1546
- /**
1547
- * @minLength 1
1548
- * @maxLength 100
1549
- */
1550
- slug: string;
1551
- /**
1552
- * @minLength 1
1553
- * @maxLength 500
1554
- */
1555
- description: string;
1556
- documentTypes: string[];
1557
- applicableGuidelines: string[];
1558
- allowedRoles: string[];
1559
- /** @minLength 1 */
1560
- systemPrompt: string;
1561
- /** @minLength 1 */
1562
- userPromptTemplate: string;
1563
- followUpPrompts: string[];
1564
- /** @format int32 */
1565
- sortOrder: number;
1566
- category?: AiPromptCategory | null;
1567
- queryTemplateName?: AiQueryTemplateName | null;
1568
- displayHint?: AiDisplayHint | null;
1569
- bedrockModelId?: string | null;
1570
- requiredDataSources?: string[] | null;
1571
- outputType?: AiOutputType | null;
1572
- }
1573
-
1574
- export interface CreateAiUrlSourceRequest {
1575
- /**
1576
- * @minLength 1
1577
- * @maxLength 200
1578
- */
1579
- name: string;
1580
- /**
1581
- * @minLength 1
1582
- * @maxLength 2048
1583
- */
1584
- url: string;
1585
- description?: string | null;
1586
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1587
- scope: "FullDomain" | "SpecificPath";
1588
- }
1589
-
1590
1163
  export interface CreateBranchRequest {
1591
1164
  /**
1592
1165
  * @minLength 1
@@ -1620,15 +1193,8 @@ export interface CreateCustomFieldDefinitionRequest {
1620
1193
  name: string;
1621
1194
  defaultValue?: string | null;
1622
1195
  regexPattern?: string | null;
1623
- dataType:
1624
- | "String"
1625
- | "Number"
1626
- | "Decimal"
1627
- | "Boolean"
1628
- | "Date"
1629
- | "SingleSelect"
1630
- | "MultiSelect";
1631
- entityType: "Loan";
1196
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1197
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1632
1198
  options?: CustomFieldOptionRequest[] | null;
1633
1199
  permissions?: CustomFieldPermissionRequest[] | null;
1634
1200
  }
@@ -1650,20 +1216,7 @@ export interface CreateDocumentTemplateRequest {
1650
1216
  export interface CreateGroupMemberRequest {
1651
1217
  /** @format uuid */
1652
1218
  userId: string;
1653
- loanRole:
1654
- | "Borrower"
1655
- | "CoBorrower"
1656
- | "NonBorrower"
1657
- | "LoanOfficer"
1658
- | "LoanProcessor"
1659
- | "LoanOfficerAssistant"
1660
- | "SupportingLoanOfficer"
1661
- | "BuyerAgent"
1662
- | "SellerAgent"
1663
- | "TitleInsuranceAgent"
1664
- | "EscrowAgent"
1665
- | "SettlementAgent"
1666
- | "Admin";
1219
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1667
1220
  }
1668
1221
 
1669
1222
  export interface CreateInviteRequest {
@@ -1675,7 +1228,7 @@ export interface CreateInviteRequest {
1675
1228
  emailAddress: string;
1676
1229
  phoneNumber?: string | null;
1677
1230
  /** @deprecated */
1678
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1231
+ relationship: CreateInviteRequestRelationshipEnum;
1679
1232
  loanID: string;
1680
1233
  route?: string | null;
1681
1234
  /** @format uuid */
@@ -1707,7 +1260,7 @@ export interface CreateLoanImportRequest {
1707
1260
  * @minLength 1
1708
1261
  */
1709
1262
  startDate: string;
1710
- importMode: "All" | "NewOnly" | "UpdateOnly";
1263
+ importMode: CreateLoanImportRequestImportModeEnum;
1711
1264
  }
1712
1265
 
1713
1266
  export interface CreateSession {
@@ -1729,20 +1282,7 @@ export interface CreateUserDeviceRequest {
1729
1282
  }
1730
1283
 
1731
1284
  export interface CreateUserDraft {
1732
- loanRole:
1733
- | "Borrower"
1734
- | "CoBorrower"
1735
- | "NonBorrower"
1736
- | "LoanOfficer"
1737
- | "LoanProcessor"
1738
- | "LoanOfficerAssistant"
1739
- | "SupportingLoanOfficer"
1740
- | "BuyerAgent"
1741
- | "SellerAgent"
1742
- | "TitleInsuranceAgent"
1743
- | "EscrowAgent"
1744
- | "SettlementAgent"
1745
- | "Admin";
1285
+ loanRole: CreateUserDraftLoanRoleEnum;
1746
1286
  }
1747
1287
 
1748
1288
  export interface CreateUserGroupRequest {
@@ -1829,15 +1369,8 @@ export interface CustomFieldDefinition {
1829
1369
  name: string;
1830
1370
  defaultValue?: string | null;
1831
1371
  regexPattern?: string | null;
1832
- dataType:
1833
- | "String"
1834
- | "Number"
1835
- | "Decimal"
1836
- | "Boolean"
1837
- | "Date"
1838
- | "SingleSelect"
1839
- | "MultiSelect";
1840
- entityType: "Loan";
1372
+ dataType: CustomFieldDefinitionDataTypeEnum;
1373
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1841
1374
  options: CustomFieldOption[];
1842
1375
  permissions: CustomFieldPermission[];
1843
1376
  encompassMapping?: EncompassMapping | null;
@@ -1852,14 +1385,7 @@ export interface CustomFieldEntry {
1852
1385
  displayOrder: number;
1853
1386
  name: string;
1854
1387
  value: string;
1855
- dataType:
1856
- | "String"
1857
- | "Number"
1858
- | "Decimal"
1859
- | "Boolean"
1860
- | "Date"
1861
- | "SingleSelect"
1862
- | "MultiSelect";
1388
+ dataType: CustomFieldEntryDataTypeEnum;
1863
1389
  }
1864
1390
 
1865
1391
  export interface CustomFieldOption {
@@ -1879,31 +1405,13 @@ export interface CustomFieldOptionRequest {
1879
1405
  export interface CustomFieldPermission {
1880
1406
  /** @format uuid */
1881
1407
  id: string;
1882
- role:
1883
- | "Borrower"
1884
- | "LoanOfficer"
1885
- | "Admin"
1886
- | "SuperAdmin"
1887
- | "Realtor"
1888
- | "SettlementAgent"
1889
- | "LoanProcessor"
1890
- | "LoanOfficerAssistant"
1891
- | "SystemAdmin";
1892
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1408
+ role: CustomFieldPermissionRoleEnum;
1409
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1893
1410
  }
1894
1411
 
1895
1412
  export interface CustomFieldPermissionRequest {
1896
- role:
1897
- | "Borrower"
1898
- | "LoanOfficer"
1899
- | "Admin"
1900
- | "SuperAdmin"
1901
- | "Realtor"
1902
- | "SettlementAgent"
1903
- | "LoanProcessor"
1904
- | "LoanOfficerAssistant"
1905
- | "SystemAdmin";
1906
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1413
+ role: CustomFieldPermissionRequestRoleEnum;
1414
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1907
1415
  }
1908
1416
 
1909
1417
  export interface CustomFieldValue {
@@ -1915,18 +1423,7 @@ export interface CustomFieldValue {
1915
1423
  customFieldDefinitionID: string;
1916
1424
  value: string;
1917
1425
  definitionName: string;
1918
- dataType:
1919
- | "String"
1920
- | "Number"
1921
- | "Decimal"
1922
- | "Boolean"
1923
- | "Date"
1924
- | "SingleSelect"
1925
- | "MultiSelect";
1926
- }
1927
-
1928
- export interface CustomLoanData {
1929
- eConsentInformation?: EConsentInformation | null;
1426
+ dataType: CustomFieldValueDataTypeEnum;
1930
1427
  }
1931
1428
 
1932
1429
  export interface DetailedUser {
@@ -2186,7 +1683,7 @@ export interface Draft {
2186
1683
  siteConfiguration: SiteConfigurationReduced;
2187
1684
  /** @format uuid */
2188
1685
  loanID?: string | null;
2189
- type: "NewLoan" | "EditLoan";
1686
+ type: DraftTypeEnum;
2190
1687
  isCoBorrower: boolean;
2191
1688
  }
2192
1689
 
@@ -2205,7 +1702,7 @@ export interface DraftContent {
2205
1702
  siteConfiguration: SiteConfigurationReduced;
2206
1703
  /** @format uuid */
2207
1704
  loanID?: string | null;
2208
- type: "NewLoan" | "EditLoan";
1705
+ type: DraftContentTypeEnum;
2209
1706
  isCoBorrower: boolean;
2210
1707
  applicationPayload: any;
2211
1708
  }
@@ -2228,14 +1725,6 @@ export interface DraftRequest {
2228
1725
  isCoBorrower: boolean;
2229
1726
  }
2230
1727
 
2231
- export interface EConsentInformation {
2232
- status: string;
2233
- /** @format date-time */
2234
- acceptedDate?: string | null;
2235
- ipAddress?: string | null;
2236
- source?: string | null;
2237
- }
2238
-
2239
1728
  export interface EnabledServices {
2240
1729
  /** @format date-time */
2241
1730
  createdAt: string;
@@ -2303,7 +1792,7 @@ export interface EncompassCredentialsDetail {
2303
1792
  defaultLoanOfficerUserName?: string | null;
2304
1793
  clearStateIfUnlicensed: boolean;
2305
1794
  baseUrl?: string | null;
2306
- signingMethod: "ConsumerConnect" | "POSF";
1795
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
2307
1796
  subscriptionId?: string | null;
2308
1797
  environment?: string | null;
2309
1798
  }
@@ -2319,7 +1808,7 @@ export interface EncompassCredentialsRequest {
2319
1808
  defaultLoanOfficerUserName?: string | null;
2320
1809
  clearStateIfUnlicensed: boolean;
2321
1810
  baseUrl?: string | null;
2322
- signingMethod: "ConsumerConnect" | "POSF";
1811
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
2323
1812
  subscriptionId?: string | null;
2324
1813
  environment?: string | null;
2325
1814
  clientID?: string | null;
@@ -2436,15 +1925,8 @@ export interface EncompassRequestLog {
2436
1925
  losId?: string | null;
2437
1926
  /** @format uuid */
2438
1927
  accountId: string;
2439
- operationType:
2440
- | "FieldUpdate"
2441
- | "ConsentUpdate"
2442
- | "DocumentSync"
2443
- | "MilestoneUpdate"
2444
- | "DocumentAttachment"
2445
- | "General"
2446
- | "FieldReader";
2447
- outcome: "Success" | "Failure" | "PartialSuccess";
1928
+ operationType: EncompassRequestLogOperationTypeEnum;
1929
+ outcome: EncompassRequestLogOutcomeEnum;
2448
1930
  message: string;
2449
1931
  endpoint?: string | null;
2450
1932
  httpMethod?: string | null;
@@ -2681,20 +2163,7 @@ export interface FusionFieldDisplay {
2681
2163
  }
2682
2164
 
2683
2165
  export interface FusionReportFilter {
2684
- filterType:
2685
- | "DateGreaterThanOrEqualTo"
2686
- | "DateGreaterThan"
2687
- | "DateLessThan"
2688
- | "DateLessThanOrEqualTo"
2689
- | "DateEquals"
2690
- | "DateDoesntEqual"
2691
- | "DateNonEmpty"
2692
- | "DateEmpty"
2693
- | "StringContains"
2694
- | "StringEquals"
2695
- | "StringNotEmpty"
2696
- | "StringNotEquals"
2697
- | "StringNotContains";
2166
+ filterType: FusionReportFilterFilterTypeEnum;
2698
2167
  targetField: string;
2699
2168
  targetValue: string;
2700
2169
  }
@@ -2716,19 +2185,6 @@ export interface GenerateDocumentRequest {
2716
2185
  recipients: string[];
2717
2186
  }
2718
2187
 
2719
- export interface GenerateSystemPrompt {
2720
- systemPrompt: string;
2721
- }
2722
-
2723
- export interface GenerateSystemPromptRequest {
2724
- /**
2725
- * @minLength 1
2726
- * @maxLength 2000
2727
- */
2728
- description: string;
2729
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2730
- }
2731
-
2732
2188
  export interface GetApplications {
2733
2189
  applications: ApplicationRowData[];
2734
2190
  }
@@ -2835,40 +2291,7 @@ export interface GuidPatchOperation {
2835
2291
  }
2836
2292
 
2837
2293
  export interface IPAddress {
2838
- addressFamily:
2839
- | "Unspecified"
2840
- | "Unix"
2841
- | "InterNetwork"
2842
- | "ImpLink"
2843
- | "Pup"
2844
- | "Chaos"
2845
- | "NS"
2846
- | "Ipx"
2847
- | "Iso"
2848
- | "Osi"
2849
- | "Ecma"
2850
- | "DataKit"
2851
- | "Ccitt"
2852
- | "Sna"
2853
- | "DecNet"
2854
- | "DataLink"
2855
- | "Lat"
2856
- | "HyperChannel"
2857
- | "AppleTalk"
2858
- | "NetBios"
2859
- | "VoiceView"
2860
- | "FireFox"
2861
- | "Banyan"
2862
- | "Atm"
2863
- | "InterNetworkV6"
2864
- | "Cluster"
2865
- | "Ieee12844"
2866
- | "Irda"
2867
- | "NetworkDesigners"
2868
- | "Max"
2869
- | "Packet"
2870
- | "ControllerAreaNetwork"
2871
- | "Unknown";
2294
+ addressFamily: IpAddressAddressFamilyEnum;
2872
2295
  /** @format int64 */
2873
2296
  scopeId: number;
2874
2297
  isIPv6Multicast: boolean;
@@ -3136,7 +2559,7 @@ export interface Loan {
3136
2559
  userLoans: UserLoan[];
3137
2560
  contacts: LoanContact[];
3138
2561
  customFields: CustomFieldEntry[];
3139
- signingMethod: "ConsumerConnect" | "POSF";
2562
+ signingMethod: LoanSigningMethodEnum;
3140
2563
  }
3141
2564
 
3142
2565
  export interface LoanApplication {
@@ -3195,7 +2618,7 @@ export interface LoanBorrower {
3195
2618
  citizenship?: LoanCitizenship | null;
3196
2619
  maritalStatus?: LoanMaritalStatus | null;
3197
2620
  languagePreference?: LoanLanguagePreference | null;
3198
- applicationStatus: "Draft" | "Complete";
2621
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
3199
2622
  /** @format int32 */
3200
2623
  numberOfDependents?: number | null;
3201
2624
  isPrimaryBorrower: boolean;
@@ -4120,20 +3543,7 @@ export interface LoanContact {
4120
3543
  email?: string | null;
4121
3544
  phone?: string | null;
4122
3545
  companyName?: string | null;
4123
- role:
4124
- | "Borrower"
4125
- | "CoBorrower"
4126
- | "NonBorrower"
4127
- | "LoanOfficer"
4128
- | "LoanProcessor"
4129
- | "LoanOfficerAssistant"
4130
- | "SupportingLoanOfficer"
4131
- | "BuyerAgent"
4132
- | "SellerAgent"
4133
- | "TitleInsuranceAgent"
4134
- | "EscrowAgent"
4135
- | "SettlementAgent"
4136
- | "Admin";
3546
+ role: LoanContactRoleEnum;
4137
3547
  }
4138
3548
 
4139
3549
  export interface LoanContactList {
@@ -4187,39 +3597,13 @@ export interface LoanDocumentFolderPermission {
4187
3597
  id: string;
4188
3598
  /** @format uuid */
4189
3599
  loanDocumentFolderID: string;
4190
- role:
4191
- | "Borrower"
4192
- | "CoBorrower"
4193
- | "NonBorrower"
4194
- | "LoanOfficer"
4195
- | "LoanProcessor"
4196
- | "LoanOfficerAssistant"
4197
- | "SupportingLoanOfficer"
4198
- | "BuyerAgent"
4199
- | "SellerAgent"
4200
- | "TitleInsuranceAgent"
4201
- | "EscrowAgent"
4202
- | "SettlementAgent"
4203
- | "Admin";
4204
- level: "None" | "Read" | "Write" | "Manage";
3600
+ role: LoanDocumentFolderPermissionRoleEnum;
3601
+ level: LoanDocumentFolderPermissionLevelEnum;
4205
3602
  }
4206
3603
 
4207
3604
  export interface LoanDocumentFolderPermissionRequest {
4208
- role:
4209
- | "Borrower"
4210
- | "CoBorrower"
4211
- | "NonBorrower"
4212
- | "LoanOfficer"
4213
- | "LoanProcessor"
4214
- | "LoanOfficerAssistant"
4215
- | "SupportingLoanOfficer"
4216
- | "BuyerAgent"
4217
- | "SellerAgent"
4218
- | "TitleInsuranceAgent"
4219
- | "EscrowAgent"
4220
- | "SettlementAgent"
4221
- | "Admin";
4222
- level: "None" | "Read" | "Write" | "Manage";
3605
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3606
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
4223
3607
  }
4224
3608
 
4225
3609
  export interface LoanDocumentFolderUsage {
@@ -4337,19 +3721,14 @@ export interface LoanImport {
4337
3721
  /** @format int32 */
4338
3722
  importedCount: number;
4339
3723
  statusMessage?: string | null;
4340
- status:
4341
- | "WaitingProcess"
4342
- | "InProgress"
4343
- | "Completed"
4344
- | "Failed"
4345
- | "Cancelled";
4346
- importMode: "All" | "NewOnly" | "UpdateOnly";
3724
+ status: LoanImportStatusEnum;
3725
+ importMode: LoanImportImportModeEnum;
4347
3726
  /** @format date-time */
4348
3727
  createdAt?: string | null;
4349
3728
  }
4350
3729
 
4351
3730
  export interface LoanImportLog {
4352
- level: "None" | "Info" | "Warning" | "Error";
3731
+ level: LoanImportLogLevelEnum;
4353
3732
  message: string;
4354
3733
  /** @format date-time */
4355
3734
  createdAt: string;
@@ -4410,24 +3789,8 @@ export interface LoanListPaginated {
4410
3789
  export interface LoanLog {
4411
3790
  /** @format uuid */
4412
3791
  id: string;
4413
- level: "None" | "Info" | "Warning" | "Error";
4414
- type:
4415
- | "Loan"
4416
- | "Queue"
4417
- | "POSFlagChanged"
4418
- | "Verification"
4419
- | "DocumentUploaded"
4420
- | "LoanCreated"
4421
- | "WorkflowSubmitted"
4422
- | "UserInvitationSent"
4423
- | "CoBorrowerAdded"
4424
- | "TaskCompleted"
4425
- | "LoanStatusChanged"
4426
- | "Consent"
4427
- | "SensitiveDataPurge"
4428
- | "ClosingDateUpdated"
4429
- | "ConsumerConnectAssociation"
4430
- | "TaskReminderSent";
3792
+ level: LoanLogLevelEnum;
3793
+ type: LoanLogTypeEnum;
4431
3794
  message: string;
4432
3795
  /** @format date-time */
4433
3796
  createdAt: string;
@@ -4436,24 +3799,8 @@ export interface LoanLog {
4436
3799
  export interface LoanLogDetail {
4437
3800
  /** @format uuid */
4438
3801
  id: string;
4439
- level: "None" | "Info" | "Warning" | "Error";
4440
- type:
4441
- | "Loan"
4442
- | "Queue"
4443
- | "POSFlagChanged"
4444
- | "Verification"
4445
- | "DocumentUploaded"
4446
- | "LoanCreated"
4447
- | "WorkflowSubmitted"
4448
- | "UserInvitationSent"
4449
- | "CoBorrowerAdded"
4450
- | "TaskCompleted"
4451
- | "LoanStatusChanged"
4452
- | "Consent"
4453
- | "SensitiveDataPurge"
4454
- | "ClosingDateUpdated"
4455
- | "ConsumerConnectAssociation"
4456
- | "TaskReminderSent";
3802
+ level: LoanLogDetailLevelEnum;
3803
+ type: LoanLogDetailTypeEnum;
4457
3804
  message: string;
4458
3805
  /** @format date-time */
4459
3806
  createdAt: string;
@@ -4741,7 +4088,7 @@ export interface LoanTaskSearchRequest {
4741
4088
  }
4742
4089
 
4743
4090
  export interface LoanTaskStatusSummary {
4744
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
4091
+ status: LoanTaskStatusSummaryStatusEnum;
4745
4092
  /** @format int32 */
4746
4093
  count: number;
4747
4094
  }
@@ -4754,20 +4101,7 @@ export interface LoanUser {
4754
4101
  email: string;
4755
4102
  phone?: string | null;
4756
4103
  role: string;
4757
- loanRole:
4758
- | "Borrower"
4759
- | "CoBorrower"
4760
- | "NonBorrower"
4761
- | "LoanOfficer"
4762
- | "LoanProcessor"
4763
- | "LoanOfficerAssistant"
4764
- | "SupportingLoanOfficer"
4765
- | "BuyerAgent"
4766
- | "SellerAgent"
4767
- | "TitleInsuranceAgent"
4768
- | "EscrowAgent"
4769
- | "SettlementAgent"
4770
- | "Admin";
4104
+ loanRole: LoanUserLoanRoleEnum;
4771
4105
  isUser: boolean;
4772
4106
  /** @format date-time */
4773
4107
  createdAt: string;
@@ -4803,13 +4137,7 @@ export interface LosOperationTracking {
4803
4137
  operationType: string;
4804
4138
  correlationKey: string;
4805
4139
  lastTriggerSource?: string | null;
4806
- status:
4807
- | "Pending"
4808
- | "Success"
4809
- | "Failed"
4810
- | "ConfigurationError"
4811
- | "PermanentFailure"
4812
- | "Locked";
4140
+ status: LosOperationTrackingStatusEnum;
4813
4141
  /** @format date-time */
4814
4142
  createdAt: string;
4815
4143
  /** @format date-time */
@@ -4876,7 +4204,7 @@ export interface LosSyncStep {
4876
4204
  /** @format int32 */
4877
4205
  order: number;
4878
4206
  name: string;
4879
- severity: "Success" | "Info" | "Warning" | "Error";
4207
+ severity: LosSyncStepSeverityEnum;
4880
4208
  message: string;
4881
4209
  /** @format date-time */
4882
4210
  atUtc: string;
@@ -5209,7 +4537,7 @@ export interface NotificationTemplateVersionUpdateRequest {
5209
4537
 
5210
4538
  export interface Operation {
5211
4539
  op?: string;
5212
- value?: string | number | boolean | null | object;
4540
+ value?: object | null;
5213
4541
  path?: string;
5214
4542
  }
5215
4543
 
@@ -5565,7 +4893,7 @@ export interface SSOTokenRequest {
5565
4893
  }
5566
4894
 
5567
4895
  export interface SamlMetadataRequest {
5568
- ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4896
+ ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
5569
4897
  }
5570
4898
 
5571
4899
  export interface SendForgotPasswordRequest {
@@ -5623,7 +4951,7 @@ export interface SiteConfiguration {
5623
4951
  deletedAt?: string | null;
5624
4952
  /** @format uuid */
5625
4953
  id: string;
5626
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4954
+ type: SiteConfigurationTypeEnum;
5627
4955
  /** @format uuid */
5628
4956
  entityID: string;
5629
4957
  /** @format int32 */
@@ -5818,7 +5146,7 @@ export interface SiteConfigurationByUrl {
5818
5146
  deletedAt?: string | null;
5819
5147
  /** @format uuid */
5820
5148
  id: string;
5821
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5149
+ type: SiteConfigurationByUrlTypeEnum;
5822
5150
  /** @format uuid */
5823
5151
  entityID: string;
5824
5152
  /** @format int32 */
@@ -6031,7 +5359,7 @@ export interface SiteConfigurationForm {
6031
5359
  export interface SiteConfigurationReduced {
6032
5360
  /** @format uuid */
6033
5361
  id: string;
6034
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5362
+ type: SiteConfigurationReducedTypeEnum;
6035
5363
  url?: string | null;
6036
5364
  name: string;
6037
5365
  /** @format int64 */
@@ -6049,7 +5377,7 @@ export interface SiteConfigurationRequest {
6049
5377
  entityID: string;
6050
5378
  /** @format int32 */
6051
5379
  entityType: number;
6052
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5380
+ type: SiteConfigurationRequestTypeEnum;
6053
5381
  url: string;
6054
5382
  name: string;
6055
5383
  introduction?: string | null;
@@ -6226,7 +5554,7 @@ export interface SiteConfigurationSearchCriteria {
6226
5554
  export interface SiteConfigurationSummary {
6227
5555
  /** @format uuid */
6228
5556
  id: string;
6229
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5557
+ type: SiteConfigurationSummaryTypeEnum;
6230
5558
  url?: string | null;
6231
5559
  name: string;
6232
5560
  /** @format int64 */
@@ -6274,14 +5602,6 @@ export interface SocialSurveyRecord {
6274
5602
  reviewCompletedTimeStamp?: string | null;
6275
5603
  }
6276
5604
 
6277
- export interface SupportedModel {
6278
- modelId: string;
6279
- displayName: string;
6280
- provider: string;
6281
- description?: string | null;
6282
- isDefault: boolean;
6283
- }
6284
-
6285
5605
  export interface SurveyEmailRequest {
6286
5606
  /** @minLength 1 */
6287
5607
  loanOfficerEmailAddress: string;
@@ -6547,79 +5867,6 @@ export interface UpdateAccountRequest {
6547
5867
  settings: AccountSettingsRequest;
6548
5868
  }
6549
5869
 
6550
- export interface UpdateAiCanonicalFieldRequest {
6551
- /**
6552
- * @minLength 1
6553
- * @maxLength 200
6554
- */
6555
- displayName: string;
6556
- /** @minLength 1 */
6557
- description: string;
6558
- /** @minItems 1 */
6559
- allowedRoles: string[];
6560
- isPii: boolean;
6561
- }
6562
-
6563
- export interface UpdateAiGuardrailRequest {
6564
- /**
6565
- * @minLength 1
6566
- * @maxLength 200
6567
- */
6568
- name: string;
6569
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6570
- description?: string | null;
6571
- /** @minItems 1 */
6572
- keywords: string[];
6573
- /** @minLength 1 */
6574
- responseTemplate: string;
6575
- }
6576
-
6577
- export interface UpdateAiPromptRequest {
6578
- /**
6579
- * @minLength 1
6580
- * @maxLength 200
6581
- */
6582
- title: string;
6583
- icon: string;
6584
- /**
6585
- * @minLength 1
6586
- * @maxLength 500
6587
- */
6588
- description: string;
6589
- documentTypes: string[];
6590
- applicableGuidelines: string[];
6591
- allowedRoles: string[];
6592
- /** @minLength 1 */
6593
- systemPrompt: string;
6594
- /** @minLength 1 */
6595
- userPromptTemplate: string;
6596
- followUpPrompts: string[];
6597
- /** @format int32 */
6598
- sortOrder: number;
6599
- category?: AiPromptCategory | null;
6600
- queryTemplateName?: AiQueryTemplateName | null;
6601
- displayHint?: AiDisplayHint | null;
6602
- bedrockModelId?: string | null;
6603
- requiredDataSources?: string[] | null;
6604
- outputType?: AiOutputType | null;
6605
- }
6606
-
6607
- export interface UpdateAiUrlSourceRequest {
6608
- /**
6609
- * @minLength 1
6610
- * @maxLength 200
6611
- */
6612
- name: string;
6613
- /**
6614
- * @minLength 1
6615
- * @maxLength 2048
6616
- */
6617
- url: string;
6618
- description?: string | null;
6619
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6620
- scope: "FullDomain" | "SpecificPath";
6621
- }
6622
-
6623
5870
  export interface UpdateCustomFieldDefinitionRequest {
6624
5871
  isRequired: boolean;
6625
5872
  /**
@@ -6975,20 +6222,7 @@ export interface UserDevice {
6975
6222
  export interface UserDraft {
6976
6223
  /** @format uuid */
6977
6224
  draftID: string;
6978
- role:
6979
- | "Borrower"
6980
- | "CoBorrower"
6981
- | "NonBorrower"
6982
- | "LoanOfficer"
6983
- | "LoanProcessor"
6984
- | "LoanOfficerAssistant"
6985
- | "SupportingLoanOfficer"
6986
- | "BuyerAgent"
6987
- | "SellerAgent"
6988
- | "TitleInsuranceAgent"
6989
- | "EscrowAgent"
6990
- | "SettlementAgent"
6991
- | "Admin";
6225
+ role: UserDraftRoleEnum;
6992
6226
  user: User;
6993
6227
  }
6994
6228
 
@@ -7015,7 +6249,7 @@ export interface UserGroupAccessScope {
7015
6249
  id: string;
7016
6250
  /** @format uuid */
7017
6251
  groupId: string;
7018
- scopeType: "User" | "Branch";
6252
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
7019
6253
  /** @format uuid */
7020
6254
  userId?: string | null;
7021
6255
  /** @format uuid */
@@ -7051,25 +6285,11 @@ export interface UserLoan {
7051
6285
  deletedAt?: string | null;
7052
6286
  loanID: string;
7053
6287
  user: User;
7054
- role:
7055
- | "Borrower"
7056
- | "CoBorrower"
7057
- | "NonBorrower"
7058
- | "LoanOfficer"
7059
- | "LoanProcessor"
7060
- | "LoanOfficerAssistant"
7061
- | "SupportingLoanOfficer"
7062
- | "BuyerAgent"
7063
- | "SellerAgent"
7064
- | "TitleInsuranceAgent"
7065
- | "EscrowAgent"
7066
- | "SettlementAgent"
7067
- | "Admin";
6288
+ role: UserLoanRoleEnum;
7068
6289
  /** @format int32 */
7069
6290
  borrowerPair?: number | null;
7070
6291
  /** @format int32 */
7071
6292
  borrowerPosition?: number | null;
7072
- customLoanData?: CustomLoanData | null;
7073
6293
  consents: UserLoanConsent[];
7074
6294
  }
7075
6295
 
@@ -7078,10 +6298,10 @@ export interface UserLoanConsent {
7078
6298
  id: string;
7079
6299
  /** @format uuid */
7080
6300
  userLoanID: string;
7081
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
6301
+ type: UserLoanConsentTypeEnum;
7082
6302
  providedConsent: boolean;
7083
6303
  ipAddress?: string | null;
7084
- losSyncStatus: "NotStarted" | "Failed" | "Success";
6304
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
7085
6305
  /** @format date-time */
7086
6306
  createdAt: string;
7087
6307
  /** @format date-time */
@@ -7236,16 +6456,7 @@ export interface UserSummary {
7236
6456
  id: string;
7237
6457
  name?: string | null;
7238
6458
  email?: string | null;
7239
- role:
7240
- | "Borrower"
7241
- | "LoanOfficer"
7242
- | "Admin"
7243
- | "SuperAdmin"
7244
- | "Realtor"
7245
- | "SettlementAgent"
7246
- | "LoanProcessor"
7247
- | "LoanOfficerAssistant"
7248
- | "SystemAdmin";
6459
+ role: UserSummaryRoleEnum;
7249
6460
  }
7250
6461
 
7251
6462
  export interface VerifyPasswordRequest {
@@ -7281,905 +6492,721 @@ export interface Workflow {
7281
6492
  icon: string;
7282
6493
  }
7283
6494
 
7284
- import type {
7285
- AxiosInstance,
7286
- AxiosRequestConfig,
7287
- AxiosResponse,
7288
- HeadersDefaults,
7289
- ResponseType,
7290
- } from "axios";
7291
- import axios from "axios";
6495
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
7292
6496
 
7293
- export type QueryParamsType = Record<string | number, any>;
6497
+ export type AuditLogEntryChangeTypeEnum =
6498
+ | "Created"
6499
+ | "Modified"
6500
+ | "SoftDeleted"
6501
+ | "HardDeleted"
6502
+ | "Restored";
7294
6503
 
7295
- export interface FullRequestParams
7296
- extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
7297
- /** set parameter to `true` for call `securityWorker` for this request */
7298
- secure?: boolean;
7299
- /** request path */
7300
- path: string;
7301
- /** content type of request body */
7302
- type?: ContentType;
7303
- /** query params */
7304
- query?: QueryParamsType;
7305
- /** format of response (i.e. response.json() -> format: "json") */
7306
- format?: ResponseType;
7307
- /** request body */
7308
- body?: unknown;
7309
- }
6504
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
7310
6505
 
7311
- export type RequestParams = Omit<
7312
- FullRequestParams,
7313
- "body" | "method" | "query" | "path"
7314
- >;
6506
+ export type CreateAccountRequestEnvironmentEnum =
6507
+ | "Development"
6508
+ | "Staging"
6509
+ | "UAT"
6510
+ | "Production";
7315
6511
 
7316
- export interface ApiConfig<SecurityDataType = unknown>
7317
- extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
7318
- securityWorker?: (
7319
- securityData: SecurityDataType | null,
7320
- ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
7321
- secure?: boolean;
7322
- format?: ResponseType;
7323
- }
6512
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum =
6513
+ | "String"
6514
+ | "Number"
6515
+ | "Decimal"
6516
+ | "Boolean"
6517
+ | "Date"
6518
+ | "SingleSelect"
6519
+ | "MultiSelect";
7324
6520
 
7325
- export enum ContentType {
7326
- JsonPatch = "application/json-patch+json",
7327
- Json = "application/json",
7328
- JsonApi = "application/vnd.api+json",
7329
- FormData = "multipart/form-data",
7330
- UrlEncoded = "application/x-www-form-urlencoded",
7331
- Text = "text/plain",
7332
- }
6521
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
7333
6522
 
7334
- export class HttpClient<SecurityDataType = unknown> {
7335
- public instance: AxiosInstance;
7336
- private securityData: SecurityDataType | null = null;
7337
- private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
7338
- private secure?: boolean;
7339
- private format?: ResponseType;
6523
+ export type CreateGroupMemberRequestLoanRoleEnum =
6524
+ | "Borrower"
6525
+ | "CoBorrower"
6526
+ | "NonBorrower"
6527
+ | "LoanOfficer"
6528
+ | "LoanProcessor"
6529
+ | "LoanOfficerAssistant"
6530
+ | "SupportingLoanOfficer"
6531
+ | "BuyerAgent"
6532
+ | "SellerAgent"
6533
+ | "TitleInsuranceAgent"
6534
+ | "EscrowAgent"
6535
+ | "SettlementAgent"
6536
+ | "Admin";
7340
6537
 
7341
- constructor({
7342
- securityWorker,
7343
- secure,
7344
- format,
7345
- ...axiosConfig
7346
- }: ApiConfig<SecurityDataType> = {}) {
7347
- this.instance = axios.create({
7348
- ...axiosConfig,
7349
- baseURL: axiosConfig.baseURL || "",
7350
- });
7351
- this.secure = secure;
7352
- this.format = format;
7353
- this.securityWorker = securityWorker;
7354
- }
6538
+ /** @deprecated */
6539
+ export type CreateInviteRequestRelationshipEnum =
6540
+ | "NotApplicable"
6541
+ | "Spouse"
6542
+ | "NonSpouse";
7355
6543
 
7356
- public setSecurityData = (data: SecurityDataType | null) => {
7357
- this.securityData = data;
7358
- };
6544
+ export type CreateLoanImportRequestImportModeEnum =
6545
+ | "All"
6546
+ | "NewOnly"
6547
+ | "UpdateOnly";
7359
6548
 
7360
- protected mergeRequestParams(
7361
- params1: AxiosRequestConfig,
7362
- params2?: AxiosRequestConfig,
7363
- ): AxiosRequestConfig {
7364
- const method = params1.method || (params2 && params2.method);
6549
+ export type CreateUserDraftLoanRoleEnum =
6550
+ | "Borrower"
6551
+ | "CoBorrower"
6552
+ | "NonBorrower"
6553
+ | "LoanOfficer"
6554
+ | "LoanProcessor"
6555
+ | "LoanOfficerAssistant"
6556
+ | "SupportingLoanOfficer"
6557
+ | "BuyerAgent"
6558
+ | "SellerAgent"
6559
+ | "TitleInsuranceAgent"
6560
+ | "EscrowAgent"
6561
+ | "SettlementAgent"
6562
+ | "Admin";
7365
6563
 
7366
- return {
7367
- ...this.instance.defaults,
7368
- ...params1,
7369
- ...(params2 || {}),
7370
- headers: {
7371
- ...((method &&
7372
- this.instance.defaults.headers[
7373
- method.toLowerCase() as keyof HeadersDefaults
7374
- ]) ||
7375
- {}),
7376
- ...(params1.headers || {}),
7377
- ...((params2 && params2.headers) || {}),
7378
- },
7379
- };
7380
- }
6564
+ export type CustomFieldDefinitionDataTypeEnum =
6565
+ | "String"
6566
+ | "Number"
6567
+ | "Decimal"
6568
+ | "Boolean"
6569
+ | "Date"
6570
+ | "SingleSelect"
6571
+ | "MultiSelect";
7381
6572
 
7382
- protected stringifyFormItem(formItem: unknown) {
7383
- if (typeof formItem === "object" && formItem !== null) {
7384
- return JSON.stringify(formItem);
7385
- } else {
7386
- return `${formItem}`;
7387
- }
7388
- }
6573
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
7389
6574
 
7390
- protected createFormData(input: Record<string, unknown>): FormData {
7391
- if (input instanceof FormData) {
7392
- return input;
7393
- }
7394
- return Object.keys(input || {}).reduce((formData, key) => {
7395
- const property = input[key];
7396
- const propertyContent: any[] =
7397
- property instanceof Array ? property : [property];
6575
+ export type CustomFieldEntryDataTypeEnum =
6576
+ | "String"
6577
+ | "Number"
6578
+ | "Decimal"
6579
+ | "Boolean"
6580
+ | "Date"
6581
+ | "SingleSelect"
6582
+ | "MultiSelect";
7398
6583
 
7399
- for (const formItem of propertyContent) {
7400
- const isFileType = formItem instanceof Blob || formItem instanceof File;
7401
- formData.append(
7402
- key,
7403
- isFileType ? formItem : this.stringifyFormItem(formItem),
7404
- );
7405
- }
6584
+ export type CustomFieldPermissionRoleEnum =
6585
+ | "Borrower"
6586
+ | "LoanOfficer"
6587
+ | "Admin"
6588
+ | "SuperAdmin"
6589
+ | "Realtor"
6590
+ | "SettlementAgent"
6591
+ | "LoanProcessor"
6592
+ | "LoanOfficerAssistant"
6593
+ | "SystemAdmin";
7406
6594
 
7407
- return formData;
7408
- }, new FormData());
7409
- }
6595
+ export type CustomFieldPermissionAccessLevelEnum =
6596
+ | "NoAccess"
6597
+ | "ReadOnly"
6598
+ | "ReadWrite";
7410
6599
 
7411
- public request = async <T = any, _E = any>({
7412
- secure,
7413
- path,
7414
- type,
7415
- query,
7416
- format,
7417
- body,
7418
- ...params
7419
- }: FullRequestParams): Promise<AxiosResponse<T>> => {
7420
- const secureParams =
7421
- ((typeof secure === "boolean" ? secure : this.secure) &&
7422
- this.securityWorker &&
7423
- (await this.securityWorker(this.securityData))) ||
7424
- {};
7425
- const requestParams = this.mergeRequestParams(params, secureParams);
7426
- const responseFormat = format || this.format || undefined;
6600
+ export type CustomFieldPermissionRequestRoleEnum =
6601
+ | "Borrower"
6602
+ | "LoanOfficer"
6603
+ | "Admin"
6604
+ | "SuperAdmin"
6605
+ | "Realtor"
6606
+ | "SettlementAgent"
6607
+ | "LoanProcessor"
6608
+ | "LoanOfficerAssistant"
6609
+ | "SystemAdmin";
7427
6610
 
7428
- if (
7429
- type === ContentType.FormData &&
7430
- body &&
7431
- body !== null &&
7432
- typeof body === "object"
7433
- ) {
7434
- body = this.createFormData(body as Record<string, unknown>);
7435
- }
6611
+ export type CustomFieldPermissionRequestAccessLevelEnum =
6612
+ | "NoAccess"
6613
+ | "ReadOnly"
6614
+ | "ReadWrite";
7436
6615
 
7437
- if (
7438
- type === ContentType.Text &&
7439
- body &&
7440
- body !== null &&
7441
- typeof body !== "string"
7442
- ) {
7443
- body = JSON.stringify(body);
7444
- }
6616
+ export type CustomFieldValueDataTypeEnum =
6617
+ | "String"
6618
+ | "Number"
6619
+ | "Decimal"
6620
+ | "Boolean"
6621
+ | "Date"
6622
+ | "SingleSelect"
6623
+ | "MultiSelect";
7445
6624
 
7446
- return this.instance.request({
7447
- ...requestParams,
7448
- headers: {
7449
- ...(requestParams.headers || {}),
7450
- ...(type ? { "Content-Type": type } : {}),
7451
- },
7452
- params: query,
7453
- responseType: responseFormat,
7454
- data: body,
7455
- url: path,
7456
- });
7457
- };
7458
- }
6625
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
7459
6626
 
7460
- /**
7461
- * @title The Big POS API
7462
- * @version v2.40.3
7463
- * @termsOfService https://www.thebigpos.com/terms-of-use/
7464
- * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7465
- */
7466
- export class Api<
7467
- SecurityDataType extends unknown,
7468
- > extends HttpClient<SecurityDataType> {
7469
- /**
7470
- * No description
7471
- *
7472
- * @tags Saml
7473
- * @name PostRoot
7474
- * @request POST:/
7475
- * @secure
7476
- * @response `200` `void` Success
7477
- */
7478
- postRoot = (params: RequestParams = {}) =>
7479
- this.request<void, any>({
7480
- path: `/`,
7481
- method: "POST",
7482
- secure: true,
7483
- ...params,
7484
- });
6627
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
7485
6628
 
7486
- /**
7487
- * No description
7488
- *
7489
- * @tags TheBigPOS
7490
- * @name GetRoot
7491
- * @request GET:/
7492
- * @secure
7493
- * @response `200` `string` Success
7494
- */
7495
- getRoot = (params: RequestParams = {}) =>
7496
- this.request<string, any>({
7497
- path: `/`,
7498
- method: "GET",
7499
- secure: true,
7500
- ...params,
7501
- });
6629
+ export type EncompassCredentialsDetailSigningMethodEnum =
6630
+ | "ConsumerConnect"
6631
+ | "POSF";
7502
6632
 
7503
- api = {
7504
- /**
7505
- * No description
7506
- *
7507
- * @tags Account
7508
- * @name GetMyAccount
7509
- * @summary Get
7510
- * @request GET:/api/account
7511
- * @secure
7512
- * @response `200` `Account` Success
7513
- * @response `404` `ProblemDetails` Not Found
7514
- */
7515
- getMyAccount: (params: RequestParams = {}) =>
7516
- this.request<Account, ProblemDetails>({
7517
- path: `/api/account`,
7518
- method: "GET",
7519
- secure: true,
7520
- format: "json",
7521
- ...params,
7522
- }),
6633
+ export type EncompassCredentialsRequestSigningMethodEnum =
6634
+ | "ConsumerConnect"
6635
+ | "POSF";
7523
6636
 
7524
- /**
7525
- * No description
7526
- *
7527
- * @tags Account
7528
- * @name ReplaceMyAccount
7529
- * @summary Replace
7530
- * @request PUT:/api/account
7531
- * @secure
7532
- * @response `200` `Account` Success
7533
- * @response `404` `ProblemDetails` Not Found
7534
- * @response `422` `ProblemDetails` Client Error
7535
- */
7536
- replaceMyAccount: (
7537
- data: UpdateAccountRequest,
7538
- params: RequestParams = {},
7539
- ) =>
7540
- this.request<Account, ProblemDetails>({
7541
- path: `/api/account`,
7542
- method: "PUT",
7543
- body: data,
7544
- secure: true,
7545
- type: ContentType.Json,
7546
- format: "json",
7547
- ...params,
7548
- }),
6637
+ export type EncompassRequestLogOperationTypeEnum =
6638
+ | "FieldUpdate"
6639
+ | "ConsentUpdate"
6640
+ | "DocumentSync"
6641
+ | "MilestoneUpdate"
6642
+ | "DocumentAttachment"
6643
+ | "General"
6644
+ | "FieldReader";
7549
6645
 
7550
- /**
7551
- * No description
7552
- *
7553
- * @tags Account
7554
- * @name GetSiteConfigurationByAccount
7555
- * @summary Get Site Configuration
7556
- * @request GET:/api/account/site-configurations
7557
- * @secure
7558
- * @response `200` `SiteConfiguration` Success
7559
- */
7560
- getSiteConfigurationByAccount: (params: RequestParams = {}) =>
7561
- this.request<SiteConfiguration, any>({
7562
- path: `/api/account/site-configurations`,
7563
- method: "GET",
7564
- secure: true,
7565
- format: "json",
7566
- ...params,
7567
- }),
6646
+ export type EncompassRequestLogOutcomeEnum =
6647
+ | "Success"
6648
+ | "Failure"
6649
+ | "PartialSuccess";
7568
6650
 
7569
- /**
7570
- * No description
7571
- *
7572
- * @tags Account
7573
- * @name UpdateSiteConfigurationForAccount
7574
- * @summary Update Site Configuration
7575
- * @request PUT:/api/account/site-configurations
7576
- * @secure
7577
- * @response `200` `SiteConfiguration` Success
7578
- * @response `422` `UnprocessableEntity` Client Error
7579
- */
7580
- updateSiteConfigurationForAccount: (
7581
- data: SiteConfiguration,
7582
- params: RequestParams = {},
7583
- ) =>
7584
- this.request<SiteConfiguration, UnprocessableEntity>({
7585
- path: `/api/account/site-configurations`,
7586
- method: "PUT",
7587
- body: data,
7588
- secure: true,
7589
- type: ContentType.Json,
7590
- format: "json",
7591
- ...params,
7592
- }),
6651
+ export type FusionReportFilterFilterTypeEnum =
6652
+ | "DateGreaterThanOrEqualTo"
6653
+ | "DateGreaterThan"
6654
+ | "DateLessThan"
6655
+ | "DateLessThanOrEqualTo"
6656
+ | "DateEquals"
6657
+ | "DateDoesntEqual"
6658
+ | "DateNonEmpty"
6659
+ | "DateEmpty"
6660
+ | "StringContains"
6661
+ | "StringEquals"
6662
+ | "StringNotEmpty"
6663
+ | "StringNotEquals"
6664
+ | "StringNotContains";
6665
+
6666
+ export type IpAddressAddressFamilyEnum =
6667
+ | "Unspecified"
6668
+ | "Unix"
6669
+ | "InterNetwork"
6670
+ | "ImpLink"
6671
+ | "Pup"
6672
+ | "Chaos"
6673
+ | "NS"
6674
+ | "Ipx"
6675
+ | "Iso"
6676
+ | "Osi"
6677
+ | "Ecma"
6678
+ | "DataKit"
6679
+ | "Ccitt"
6680
+ | "Sna"
6681
+ | "DecNet"
6682
+ | "DataLink"
6683
+ | "Lat"
6684
+ | "HyperChannel"
6685
+ | "AppleTalk"
6686
+ | "NetBios"
6687
+ | "VoiceView"
6688
+ | "FireFox"
6689
+ | "Banyan"
6690
+ | "Atm"
6691
+ | "InterNetworkV6"
6692
+ | "Cluster"
6693
+ | "Ieee12844"
6694
+ | "Irda"
6695
+ | "NetworkDesigners"
6696
+ | "Max"
6697
+ | "Packet"
6698
+ | "ControllerAreaNetwork"
6699
+ | "Unknown";
6700
+
6701
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6702
+
6703
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6704
+
6705
+ export type LoanContactRoleEnum =
6706
+ | "Borrower"
6707
+ | "CoBorrower"
6708
+ | "NonBorrower"
6709
+ | "LoanOfficer"
6710
+ | "LoanProcessor"
6711
+ | "LoanOfficerAssistant"
6712
+ | "SupportingLoanOfficer"
6713
+ | "BuyerAgent"
6714
+ | "SellerAgent"
6715
+ | "TitleInsuranceAgent"
6716
+ | "EscrowAgent"
6717
+ | "SettlementAgent"
6718
+ | "Admin";
6719
+
6720
+ export type LoanDocumentFolderPermissionRoleEnum =
6721
+ | "Borrower"
6722
+ | "CoBorrower"
6723
+ | "NonBorrower"
6724
+ | "LoanOfficer"
6725
+ | "LoanProcessor"
6726
+ | "LoanOfficerAssistant"
6727
+ | "SupportingLoanOfficer"
6728
+ | "BuyerAgent"
6729
+ | "SellerAgent"
6730
+ | "TitleInsuranceAgent"
6731
+ | "EscrowAgent"
6732
+ | "SettlementAgent"
6733
+ | "Admin";
6734
+
6735
+ export type LoanDocumentFolderPermissionLevelEnum =
6736
+ | "None"
6737
+ | "Read"
6738
+ | "Write"
6739
+ | "Manage";
6740
+
6741
+ export type LoanDocumentFolderPermissionRequestRoleEnum =
6742
+ | "Borrower"
6743
+ | "CoBorrower"
6744
+ | "NonBorrower"
6745
+ | "LoanOfficer"
6746
+ | "LoanProcessor"
6747
+ | "LoanOfficerAssistant"
6748
+ | "SupportingLoanOfficer"
6749
+ | "BuyerAgent"
6750
+ | "SellerAgent"
6751
+ | "TitleInsuranceAgent"
6752
+ | "EscrowAgent"
6753
+ | "SettlementAgent"
6754
+ | "Admin";
6755
+
6756
+ export type LoanDocumentFolderPermissionRequestLevelEnum =
6757
+ | "None"
6758
+ | "Read"
6759
+ | "Write"
6760
+ | "Manage";
6761
+
6762
+ export type LoanImportStatusEnum =
6763
+ | "WaitingProcess"
6764
+ | "InProgress"
6765
+ | "Completed"
6766
+ | "Failed"
6767
+ | "Cancelled";
6768
+
6769
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6770
+
6771
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6772
+
6773
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6774
+
6775
+ export type LoanLogTypeEnum =
6776
+ | "Loan"
6777
+ | "Queue"
6778
+ | "POSFlagChanged"
6779
+ | "Verification"
6780
+ | "DocumentUploaded"
6781
+ | "LoanCreated"
6782
+ | "WorkflowSubmitted"
6783
+ | "UserInvitationSent"
6784
+ | "CoBorrowerAdded"
6785
+ | "TaskCompleted"
6786
+ | "LoanStatusChanged"
6787
+ | "Consent"
6788
+ | "SensitiveDataPurge"
6789
+ | "ClosingDateUpdated"
6790
+ | "ConsumerConnectAssociation"
6791
+ | "TaskReminderSent";
6792
+
6793
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6794
+
6795
+ export type LoanLogDetailTypeEnum =
6796
+ | "Loan"
6797
+ | "Queue"
6798
+ | "POSFlagChanged"
6799
+ | "Verification"
6800
+ | "DocumentUploaded"
6801
+ | "LoanCreated"
6802
+ | "WorkflowSubmitted"
6803
+ | "UserInvitationSent"
6804
+ | "CoBorrowerAdded"
6805
+ | "TaskCompleted"
6806
+ | "LoanStatusChanged"
6807
+ | "Consent"
6808
+ | "SensitiveDataPurge"
6809
+ | "ClosingDateUpdated"
6810
+ | "ConsumerConnectAssociation"
6811
+ | "TaskReminderSent";
6812
+
6813
+ export type LoanTaskStatusSummaryStatusEnum =
6814
+ | "Outstanding"
6815
+ | "Pending"
6816
+ | "Completed"
6817
+ | "Rejected"
6818
+ | "Unknown";
6819
+
6820
+ export type LoanUserLoanRoleEnum =
6821
+ | "Borrower"
6822
+ | "CoBorrower"
6823
+ | "NonBorrower"
6824
+ | "LoanOfficer"
6825
+ | "LoanProcessor"
6826
+ | "LoanOfficerAssistant"
6827
+ | "SupportingLoanOfficer"
6828
+ | "BuyerAgent"
6829
+ | "SellerAgent"
6830
+ | "TitleInsuranceAgent"
6831
+ | "EscrowAgent"
6832
+ | "SettlementAgent"
6833
+ | "Admin";
6834
+
6835
+ export type LosOperationTrackingStatusEnum =
6836
+ | "Pending"
6837
+ | "Success"
6838
+ | "Failed"
6839
+ | "ConfigurationError"
6840
+ | "PermanentFailure"
6841
+ | "Locked";
6842
+
6843
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6844
+
6845
+ export type SamlMetadataRequestSsoIntegrationEnum =
6846
+ | "ConsumerConnect"
6847
+ | "TheBigPOS"
6848
+ | "POSF";
6849
+
6850
+ export type SiteConfigurationTypeEnum =
6851
+ | "None"
6852
+ | "Account"
6853
+ | "Corporate"
6854
+ | "Branch"
6855
+ | "LoanOfficer"
6856
+ | "Partner";
6857
+
6858
+ export type SiteConfigurationByUrlTypeEnum =
6859
+ | "None"
6860
+ | "Account"
6861
+ | "Corporate"
6862
+ | "Branch"
6863
+ | "LoanOfficer"
6864
+ | "Partner";
6865
+
6866
+ export type SiteConfigurationReducedTypeEnum =
6867
+ | "None"
6868
+ | "Account"
6869
+ | "Corporate"
6870
+ | "Branch"
6871
+ | "LoanOfficer"
6872
+ | "Partner";
6873
+
6874
+ export type SiteConfigurationRequestTypeEnum =
6875
+ | "None"
6876
+ | "Account"
6877
+ | "Corporate"
6878
+ | "Branch"
6879
+ | "LoanOfficer"
6880
+ | "Partner";
6881
+
6882
+ export type SiteConfigurationSummaryTypeEnum =
6883
+ | "None"
6884
+ | "Account"
6885
+ | "Corporate"
6886
+ | "Branch"
6887
+ | "LoanOfficer"
6888
+ | "Partner";
6889
+
6890
+ export type UserDraftRoleEnum =
6891
+ | "Borrower"
6892
+ | "CoBorrower"
6893
+ | "NonBorrower"
6894
+ | "LoanOfficer"
6895
+ | "LoanProcessor"
6896
+ | "LoanOfficerAssistant"
6897
+ | "SupportingLoanOfficer"
6898
+ | "BuyerAgent"
6899
+ | "SellerAgent"
6900
+ | "TitleInsuranceAgent"
6901
+ | "EscrowAgent"
6902
+ | "SettlementAgent"
6903
+ | "Admin";
6904
+
6905
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6906
+
6907
+ export type UserLoanRoleEnum =
6908
+ | "Borrower"
6909
+ | "CoBorrower"
6910
+ | "NonBorrower"
6911
+ | "LoanOfficer"
6912
+ | "LoanProcessor"
6913
+ | "LoanOfficerAssistant"
6914
+ | "SupportingLoanOfficer"
6915
+ | "BuyerAgent"
6916
+ | "SellerAgent"
6917
+ | "TitleInsuranceAgent"
6918
+ | "EscrowAgent"
6919
+ | "SettlementAgent"
6920
+ | "Admin";
6921
+
6922
+ export type UserLoanConsentTypeEnum =
6923
+ | "Econsent"
6924
+ | "CreditAuthorization"
6925
+ | "Tcpa";
6926
+
6927
+ export type UserLoanConsentLosSyncStatusEnum =
6928
+ | "NotStarted"
6929
+ | "Failed"
6930
+ | "Success";
6931
+
6932
+ export type UserSummaryRoleEnum =
6933
+ | "Borrower"
6934
+ | "LoanOfficer"
6935
+ | "Admin"
6936
+ | "SuperAdmin"
6937
+ | "Realtor"
6938
+ | "SettlementAgent"
6939
+ | "LoanProcessor"
6940
+ | "LoanOfficerAssistant"
6941
+ | "SystemAdmin";
7593
6942
 
7594
- /**
7595
- * No description
7596
- *
7597
- * @tags Accounts
7598
- * @name GetAccounts
7599
- * @summary Get All
7600
- * @request GET:/api/accounts
7601
- * @secure
7602
- * @response `200` `(Account)[]` Success
7603
- */
7604
- getAccounts: (params: RequestParams = {}) =>
7605
- this.request<Account[], any>({
7606
- path: `/api/accounts`,
7607
- method: "GET",
7608
- secure: true,
7609
- format: "json",
7610
- ...params,
7611
- }),
6943
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
7612
6944
 
7613
- /**
7614
- * No description
7615
- *
7616
- * @tags Accounts
7617
- * @name CreateAccount
7618
- * @summary Create
7619
- * @request POST:/api/accounts
7620
- * @secure
7621
- * @response `201` `Account` Created
7622
- * @response `422` `ProblemDetails` Client Error
7623
- */
7624
- createAccount: (data: CreateAccountRequest, params: RequestParams = {}) =>
7625
- this.request<Account, ProblemDetails>({
7626
- path: `/api/accounts`,
7627
- method: "POST",
7628
- body: data,
7629
- secure: true,
7630
- type: ContentType.Json,
7631
- format: "json",
7632
- ...params,
7633
- }),
6945
+ /** @default "Realtor" */
6946
+ export type GetPartnersParamsRoleEnum =
6947
+ | "Borrower"
6948
+ | "LoanOfficer"
6949
+ | "Admin"
6950
+ | "SuperAdmin"
6951
+ | "Realtor"
6952
+ | "SettlementAgent"
6953
+ | "LoanProcessor"
6954
+ | "LoanOfficerAssistant"
6955
+ | "SystemAdmin";
7634
6956
 
7635
- /**
7636
- * No description
7637
- *
7638
- * @tags Accounts
7639
- * @name GetAccount
7640
- * @summary Get by ID
7641
- * @request GET:/api/accounts/{id}
7642
- * @secure
7643
- * @response `201` `Account` Created
7644
- * @response `422` `ProblemDetails` Client Error
7645
- */
7646
- getAccount: (id: string, params: RequestParams = {}) =>
7647
- this.request<Account, ProblemDetails>({
7648
- path: `/api/accounts/${id}`,
7649
- method: "GET",
7650
- secure: true,
7651
- format: "json",
7652
- ...params,
7653
- }),
6957
+ export type GetSamlMetadataParamsSSoIntegrationEnum =
6958
+ | "ConsumerConnect"
6959
+ | "TheBigPOS"
6960
+ | "POSF";
7654
6961
 
7655
- /**
7656
- * No description
7657
- *
7658
- * @tags Accounts
7659
- * @name DeleteAccount
7660
- * @summary Delete
7661
- * @request DELETE:/api/accounts/{id}
7662
- * @secure
7663
- * @response `204` `Account` No Content
7664
- * @response `404` `ProblemDetails` Not Found
7665
- * @response `422` `ProblemDetails` Client Error
7666
- */
7667
- deleteAccount: (
7668
- id: string,
7669
- query?: {
7670
- /** @default false */
7671
- hardDelete?: boolean;
7672
- },
7673
- params: RequestParams = {},
7674
- ) =>
7675
- this.request<Account, ProblemDetails>({
7676
- path: `/api/accounts/${id}`,
7677
- method: "DELETE",
7678
- query: query,
7679
- secure: true,
7680
- format: "json",
7681
- ...params,
7682
- }),
6962
+ export type GetSamlMetadataParamsEnum =
6963
+ | "ConsumerConnect"
6964
+ | "TheBigPOS"
6965
+ | "POSF";
7683
6966
 
7684
- /**
7685
- * No description
7686
- *
7687
- * @tags Accounts
7688
- * @name UpdateAccountBilling
7689
- * @summary Update billing configuration
7690
- * @request PUT:/api/accounts/{id}/billing
7691
- * @secure
7692
- * @response `200` `AccountBilling` Success
7693
- * @response `404` `ProblemDetails` Not Found
7694
- * @response `422` `ProblemDetails` Client Error
7695
- */
7696
- updateAccountBilling: (
7697
- id: string,
7698
- data: AccountBillingRequest,
7699
- params: RequestParams = {},
7700
- ) =>
7701
- this.request<AccountBilling, ProblemDetails>({
7702
- path: `/api/accounts/${id}/billing`,
7703
- method: "PUT",
7704
- body: data,
7705
- secure: true,
7706
- type: ContentType.Json,
7707
- format: "json",
7708
- ...params,
7709
- }),
6967
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6968
+ | "ConsumerConnect"
6969
+ | "TheBigPOS"
6970
+ | "POSF";
7710
6971
 
7711
- /**
7712
- * No description
7713
- *
7714
- * @tags AiAdmin
7715
- * @name GetAiAuditLogs
7716
- * @summary Get paginated audit logs
7717
- * @request GET:/api/ai/admin/audit-logs
7718
- * @secure
7719
- * @response `200` `AiAuditLogPaginated` Success
7720
- */
7721
- getAiAuditLogs: (
7722
- query?: {
7723
- eventType?: AiAuditEventType;
7724
- /** @format date-time */
7725
- startDate?: string;
7726
- /** @format date-time */
7727
- endDate?: string;
7728
- /** @format int32 */
7729
- pageSize?: number;
7730
- /** @format int32 */
7731
- pageNumber?: number;
7732
- sortBy?: string;
7733
- sortDirection?: string;
7734
- },
7735
- params: RequestParams = {},
7736
- ) =>
7737
- this.request<AiAuditLogPaginated, any>({
7738
- path: `/api/ai/admin/audit-logs`,
7739
- method: "GET",
7740
- query: query,
7741
- secure: true,
7742
- format: "json",
7743
- ...params,
7744
- }),
6972
+ export type CreateOrReplaceSamlMetadataParamsEnum =
6973
+ | "ConsumerConnect"
6974
+ | "TheBigPOS"
6975
+ | "POSF";
7745
6976
 
7746
- /**
7747
- * No description
7748
- *
7749
- * @tags AiAdmin
7750
- * @name GetAiAdminStats
7751
- * @summary Get AI admin dashboard stats
7752
- * @request GET:/api/ai/admin/stats
7753
- * @secure
7754
- * @response `200` `AiAdminStats` Success
7755
- */
7756
- getAiAdminStats: (
7757
- query?: {
7758
- /** @format date-time */
7759
- startDate?: string;
7760
- /** @format date-time */
7761
- endDate?: string;
7762
- },
7763
- params: RequestParams = {},
7764
- ) =>
7765
- this.request<AiAdminStats, any>({
7766
- path: `/api/ai/admin/stats`,
7767
- method: "GET",
7768
- query: query,
7769
- secure: true,
7770
- format: "json",
7771
- ...params,
7772
- }),
6977
+ import type {
6978
+ AxiosInstance,
6979
+ AxiosRequestConfig,
6980
+ AxiosResponse,
6981
+ HeadersDefaults,
6982
+ ResponseType,
6983
+ } from "axios";
6984
+ import axios from "axios";
7773
6985
 
7774
- /**
7775
- * No description
7776
- *
7777
- * @tags AiAdminPrompt
7778
- * @name GetAiPrompts
7779
- * @summary Get all prompts
7780
- * @request GET:/api/ai/admin/prompts
7781
- * @secure
7782
- * @response `200` `(AiPrompt)[]` Success
7783
- */
7784
- getAiPrompts: (params: RequestParams = {}) =>
7785
- this.request<AiPrompt[], any>({
7786
- path: `/api/ai/admin/prompts`,
7787
- method: "GET",
7788
- secure: true,
7789
- format: "json",
7790
- ...params,
7791
- }),
6986
+ export type QueryParamsType = Record<string | number, any>;
7792
6987
 
7793
- /**
7794
- * No description
7795
- *
7796
- * @tags AiAdminPrompt
7797
- * @name CreateAiPrompt
7798
- * @summary Create custom prompt
7799
- * @request POST:/api/ai/admin/prompts
7800
- * @secure
7801
- * @response `201` `AiPrompt` Created
7802
- * @response `400` `ProblemDetails` Bad Request
7803
- */
7804
- createAiPrompt: (data: CreateAiPromptRequest, params: RequestParams = {}) =>
7805
- this.request<AiPrompt, ProblemDetails>({
7806
- path: `/api/ai/admin/prompts`,
7807
- method: "POST",
7808
- body: data,
7809
- secure: true,
7810
- type: ContentType.Json,
7811
- format: "json",
7812
- ...params,
7813
- }),
6988
+ export interface FullRequestParams
6989
+ extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
6990
+ /** set parameter to `true` for call `securityWorker` for this request */
6991
+ secure?: boolean;
6992
+ /** request path */
6993
+ path: string;
6994
+ /** content type of request body */
6995
+ type?: ContentType;
6996
+ /** query params */
6997
+ query?: QueryParamsType;
6998
+ /** format of response (i.e. response.json() -> format: "json") */
6999
+ format?: ResponseType;
7000
+ /** request body */
7001
+ body?: unknown;
7002
+ }
7814
7003
 
7815
- /**
7816
- * No description
7817
- *
7818
- * @tags AiAdminPrompt
7819
- * @name GetAiPrompt
7820
- * @summary Get prompt by ID
7821
- * @request GET:/api/ai/admin/prompts/{id}
7822
- * @secure
7823
- * @response `200` `AiPrompt` Success
7824
- * @response `404` `ProblemDetails` Not Found
7825
- */
7826
- getAiPrompt: (id: string, params: RequestParams = {}) =>
7827
- this.request<AiPrompt, ProblemDetails>({
7828
- path: `/api/ai/admin/prompts/${id}`,
7829
- method: "GET",
7830
- secure: true,
7831
- format: "json",
7832
- ...params,
7833
- }),
7004
+ export type RequestParams = Omit<
7005
+ FullRequestParams,
7006
+ "body" | "method" | "query" | "path"
7007
+ >;
7834
7008
 
7835
- /**
7836
- * No description
7837
- *
7838
- * @tags AiAdminPrompt
7839
- * @name UpdateAiPrompt
7840
- * @summary Update prompt
7841
- * @request PUT:/api/ai/admin/prompts/{id}
7842
- * @secure
7843
- * @response `200` `AiPrompt` Success
7844
- * @response `400` `ProblemDetails` Bad Request
7845
- * @response `404` `ProblemDetails` Not Found
7846
- */
7847
- updateAiPrompt: (
7848
- id: string,
7849
- data: UpdateAiPromptRequest,
7850
- params: RequestParams = {},
7851
- ) =>
7852
- this.request<AiPrompt, ProblemDetails>({
7853
- path: `/api/ai/admin/prompts/${id}`,
7854
- method: "PUT",
7855
- body: data,
7856
- secure: true,
7857
- type: ContentType.Json,
7858
- format: "json",
7859
- ...params,
7860
- }),
7009
+ export interface ApiConfig<SecurityDataType = unknown>
7010
+ extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
7011
+ securityWorker?: (
7012
+ securityData: SecurityDataType | null,
7013
+ ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
7014
+ secure?: boolean;
7015
+ format?: ResponseType;
7016
+ }
7017
+
7018
+ export enum ContentType {
7019
+ Json = "application/json",
7020
+ JsonApi = "application/vnd.api+json",
7021
+ FormData = "multipart/form-data",
7022
+ UrlEncoded = "application/x-www-form-urlencoded",
7023
+ Text = "text/plain",
7024
+ }
7861
7025
 
7862
- /**
7863
- * No description
7864
- *
7865
- * @tags AiAdminPrompt
7866
- * @name DeleteAiPrompt
7867
- * @summary Delete prompt
7868
- * @request DELETE:/api/ai/admin/prompts/{id}
7869
- * @secure
7870
- * @response `204` `void` No Content
7871
- * @response `400` `ProblemDetails` Bad Request
7872
- * @response `404` `ProblemDetails` Not Found
7873
- */
7874
- deleteAiPrompt: (id: string, params: RequestParams = {}) =>
7875
- this.request<void, ProblemDetails>({
7876
- path: `/api/ai/admin/prompts/${id}`,
7877
- method: "DELETE",
7878
- secure: true,
7879
- ...params,
7880
- }),
7026
+ export class HttpClient<SecurityDataType = unknown> {
7027
+ public instance: AxiosInstance;
7028
+ private securityData: SecurityDataType | null = null;
7029
+ private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
7030
+ private secure?: boolean;
7031
+ private format?: ResponseType;
7881
7032
 
7882
- /**
7883
- * No description
7884
- *
7885
- * @tags AiAdminPrompt
7886
- * @name ToggleAiPrompt
7887
- * @summary Toggle prompt active/inactive
7888
- * @request PATCH:/api/ai/admin/prompts/{id}/toggle
7889
- * @secure
7890
- * @response `200` `AiPrompt` Success
7891
- * @response `404` `ProblemDetails` Not Found
7892
- */
7893
- toggleAiPrompt: (id: string, params: RequestParams = {}) =>
7894
- this.request<AiPrompt, ProblemDetails>({
7895
- path: `/api/ai/admin/prompts/${id}/toggle`,
7896
- method: "PATCH",
7897
- secure: true,
7898
- format: "json",
7899
- ...params,
7900
- }),
7033
+ constructor({
7034
+ securityWorker,
7035
+ secure,
7036
+ format,
7037
+ ...axiosConfig
7038
+ }: ApiConfig<SecurityDataType> = {}) {
7039
+ this.instance = axios.create({
7040
+ ...axiosConfig,
7041
+ baseURL: axiosConfig.baseURL || "",
7042
+ });
7043
+ this.secure = secure;
7044
+ this.format = format;
7045
+ this.securityWorker = securityWorker;
7046
+ }
7901
7047
 
7902
- /**
7903
- * No description
7904
- *
7905
- * @tags AiAdminPrompt
7906
- * @name GenerateAiSystemPrompt
7907
- * @summary Generate a system prompt from description
7908
- * @request POST:/api/ai/admin/prompts/generate
7909
- * @secure
7910
- * @response `200` `GenerateSystemPrompt` Success
7911
- * @response `400` `ProblemDetails` Bad Request
7912
- */
7913
- generateAiSystemPrompt: (
7914
- data: GenerateSystemPromptRequest,
7915
- params: RequestParams = {},
7916
- ) =>
7917
- this.request<GenerateSystemPrompt, ProblemDetails>({
7918
- path: `/api/ai/admin/prompts/generate`,
7919
- method: "POST",
7920
- body: data,
7921
- secure: true,
7922
- type: ContentType.JsonPatch,
7923
- format: "json",
7924
- ...params,
7925
- }),
7048
+ public setSecurityData = (data: SecurityDataType | null) => {
7049
+ this.securityData = data;
7050
+ };
7926
7051
 
7927
- /**
7928
- * No description
7929
- *
7930
- * @tags AiAdminPrompt
7931
- * @name GetSupportedModels
7932
- * @summary Get supported LLM models
7933
- * @request GET:/api/ai/admin/prompts/supported-models
7934
- * @secure
7935
- * @response `200` `(SupportedModel)[]` Success
7936
- */
7937
- getSupportedModels: (params: RequestParams = {}) =>
7938
- this.request<SupportedModel[], any>({
7939
- path: `/api/ai/admin/prompts/supported-models`,
7940
- method: "GET",
7941
- secure: true,
7942
- format: "json",
7943
- ...params,
7944
- }),
7052
+ protected mergeRequestParams(
7053
+ params1: AxiosRequestConfig,
7054
+ params2?: AxiosRequestConfig,
7055
+ ): AxiosRequestConfig {
7056
+ const method = params1.method || (params2 && params2.method);
7945
7057
 
7946
- /**
7947
- * No description
7948
- *
7949
- * @tags AiCanonicalField
7950
- * @name GetAiCanonicalFields
7951
- * @summary Get all canonical fields
7952
- * @request GET:/api/ai/admin/fields
7953
- * @secure
7954
- * @response `200` `(AiCanonicalField)[]` Success
7955
- */
7956
- getAiCanonicalFields: (params: RequestParams = {}) =>
7957
- this.request<AiCanonicalField[], any>({
7958
- path: `/api/ai/admin/fields`,
7959
- method: "GET",
7960
- secure: true,
7961
- format: "json",
7962
- ...params,
7963
- }),
7058
+ return {
7059
+ ...this.instance.defaults,
7060
+ ...params1,
7061
+ ...(params2 || {}),
7062
+ headers: {
7063
+ ...((method &&
7064
+ this.instance.defaults.headers[
7065
+ method.toLowerCase() as keyof HeadersDefaults
7066
+ ]) ||
7067
+ {}),
7068
+ ...(params1.headers || {}),
7069
+ ...((params2 && params2.headers) || {}),
7070
+ },
7071
+ };
7072
+ }
7964
7073
 
7965
- /**
7966
- * No description
7967
- *
7968
- * @tags AiCanonicalField
7969
- * @name CreateAiCanonicalField
7970
- * @summary Create canonical field
7971
- * @request POST:/api/ai/admin/fields
7972
- * @secure
7973
- * @response `201` `AiCanonicalField` Created
7974
- * @response `400` `ProblemDetails` Bad Request
7975
- */
7976
- createAiCanonicalField: (
7977
- data: CreateAiCanonicalFieldRequest,
7978
- params: RequestParams = {},
7979
- ) =>
7980
- this.request<AiCanonicalField, ProblemDetails>({
7981
- path: `/api/ai/admin/fields`,
7982
- method: "POST",
7983
- body: data,
7984
- secure: true,
7985
- type: ContentType.Json,
7986
- format: "json",
7987
- ...params,
7988
- }),
7074
+ protected stringifyFormItem(formItem: unknown) {
7075
+ if (typeof formItem === "object" && formItem !== null) {
7076
+ return JSON.stringify(formItem);
7077
+ } else {
7078
+ return `${formItem}`;
7079
+ }
7080
+ }
7989
7081
 
7990
- /**
7991
- * No description
7992
- *
7993
- * @tags AiCanonicalField
7994
- * @name GetAiCanonicalField
7995
- * @summary Get canonical field by ID
7996
- * @request GET:/api/ai/admin/fields/{id}
7997
- * @secure
7998
- * @response `200` `AiCanonicalField` Success
7999
- * @response `404` `ProblemDetails` Not Found
8000
- */
8001
- getAiCanonicalField: (id: string, params: RequestParams = {}) =>
8002
- this.request<AiCanonicalField, ProblemDetails>({
8003
- path: `/api/ai/admin/fields/${id}`,
8004
- method: "GET",
8005
- secure: true,
8006
- format: "json",
8007
- ...params,
8008
- }),
7082
+ protected createFormData(input: Record<string, unknown>): FormData {
7083
+ if (input instanceof FormData) {
7084
+ return input;
7085
+ }
7086
+ return Object.keys(input || {}).reduce((formData, key) => {
7087
+ const property = input[key];
7088
+ const propertyContent: any[] =
7089
+ property instanceof Array ? property : [property];
8009
7090
 
8010
- /**
8011
- * No description
8012
- *
8013
- * @tags AiCanonicalField
8014
- * @name UpdateAiCanonicalField
8015
- * @summary Update canonical field
8016
- * @request PUT:/api/ai/admin/fields/{id}
8017
- * @secure
8018
- * @response `200` `AiCanonicalField` Success
8019
- * @response `400` `ProblemDetails` Bad Request
8020
- * @response `404` `ProblemDetails` Not Found
8021
- */
8022
- updateAiCanonicalField: (
8023
- id: string,
8024
- data: UpdateAiCanonicalFieldRequest,
8025
- params: RequestParams = {},
8026
- ) =>
8027
- this.request<AiCanonicalField, ProblemDetails>({
8028
- path: `/api/ai/admin/fields/${id}`,
8029
- method: "PUT",
8030
- body: data,
8031
- secure: true,
8032
- type: ContentType.Json,
8033
- format: "json",
8034
- ...params,
8035
- }),
7091
+ for (const formItem of propertyContent) {
7092
+ const isFileType = formItem instanceof Blob || formItem instanceof File;
7093
+ formData.append(
7094
+ key,
7095
+ isFileType ? formItem : this.stringifyFormItem(formItem),
7096
+ );
7097
+ }
8036
7098
 
8037
- /**
8038
- * No description
8039
- *
8040
- * @tags AiCanonicalField
8041
- * @name DeleteAiCanonicalField
8042
- * @summary Delete canonical field
8043
- * @request DELETE:/api/ai/admin/fields/{id}
8044
- * @secure
8045
- * @response `204` `void` No Content
8046
- * @response `404` `ProblemDetails` Not Found
8047
- */
8048
- deleteAiCanonicalField: (id: string, params: RequestParams = {}) =>
8049
- this.request<void, ProblemDetails>({
8050
- path: `/api/ai/admin/fields/${id}`,
8051
- method: "DELETE",
8052
- secure: true,
8053
- ...params,
8054
- }),
7099
+ return formData;
7100
+ }, new FormData());
7101
+ }
8055
7102
 
8056
- /**
8057
- * No description
8058
- *
8059
- * @tags AiCanonicalField
8060
- * @name ToggleAiCanonicalField
8061
- * @summary Toggle canonical field active/inactive
8062
- * @request PATCH:/api/ai/admin/fields/{id}/toggle
8063
- * @secure
8064
- * @response `200` `AiCanonicalField` Success
8065
- * @response `404` `ProblemDetails` Not Found
8066
- */
8067
- toggleAiCanonicalField: (id: string, params: RequestParams = {}) =>
8068
- this.request<AiCanonicalField, ProblemDetails>({
8069
- path: `/api/ai/admin/fields/${id}/toggle`,
8070
- method: "PATCH",
8071
- secure: true,
8072
- format: "json",
8073
- ...params,
8074
- }),
7103
+ public request = async <T = any, _E = any>({
7104
+ secure,
7105
+ path,
7106
+ type,
7107
+ query,
7108
+ format,
7109
+ body,
7110
+ ...params
7111
+ }: FullRequestParams): Promise<AxiosResponse<T>> => {
7112
+ const secureParams =
7113
+ ((typeof secure === "boolean" ? secure : this.secure) &&
7114
+ this.securityWorker &&
7115
+ (await this.securityWorker(this.securityData))) ||
7116
+ {};
7117
+ const requestParams = this.mergeRequestParams(params, secureParams);
7118
+ const responseFormat = format || this.format || undefined;
8075
7119
 
8076
- /**
8077
- * No description
8078
- *
8079
- * @tags AiChat
8080
- * @name AiChat
8081
- * @summary Send AI chat message
8082
- * @request POST:/api/ai/chat
8083
- * @secure
8084
- * @response `200` `AiChat` Success
8085
- * @response `400` `ProblemDetails` Bad Request
8086
- * @response `401` `ProblemDetails` Unauthorized
8087
- */
8088
- aiChat: (data: AiChatRequest, params: RequestParams = {}) =>
8089
- this.request<AiChat, ProblemDetails>({
8090
- path: `/api/ai/chat`,
8091
- method: "POST",
8092
- body: data,
8093
- secure: true,
8094
- type: ContentType.JsonPatch,
8095
- format: "json",
8096
- ...params,
8097
- }),
7120
+ if (
7121
+ type === ContentType.FormData &&
7122
+ body &&
7123
+ body !== null &&
7124
+ typeof body === "object"
7125
+ ) {
7126
+ body = this.createFormData(body as Record<string, unknown>);
7127
+ }
8098
7128
 
8099
- /**
8100
- * No description
8101
- *
8102
- * @tags AiConversation
8103
- * @name GetAiConversations
8104
- * @summary Get user conversations
8105
- * @request GET:/api/ai/conversations
8106
- * @secure
8107
- * @response `200` `AiConversationListItemPaginated` Success
8108
- */
8109
- getAiConversations: (
8110
- query?: {
8111
- /** @format int32 */
8112
- pageSize?: number;
8113
- /** @format int32 */
8114
- pageNumber?: number;
8115
- sortBy?: string;
8116
- sortDirection?: string;
7129
+ if (
7130
+ type === ContentType.Text &&
7131
+ body &&
7132
+ body !== null &&
7133
+ typeof body !== "string"
7134
+ ) {
7135
+ body = JSON.stringify(body);
7136
+ }
7137
+
7138
+ return this.instance.request({
7139
+ ...requestParams,
7140
+ headers: {
7141
+ ...(requestParams.headers || {}),
7142
+ ...(type ? { "Content-Type": type } : {}),
8117
7143
  },
8118
- params: RequestParams = {},
8119
- ) =>
8120
- this.request<AiConversationListItemPaginated, any>({
8121
- path: `/api/ai/conversations`,
8122
- method: "GET",
8123
- query: query,
8124
- secure: true,
8125
- format: "json",
8126
- ...params,
8127
- }),
7144
+ params: query,
7145
+ responseType: responseFormat,
7146
+ data: body,
7147
+ url: path,
7148
+ });
7149
+ };
7150
+ }
8128
7151
 
8129
- /**
8130
- * No description
8131
- *
8132
- * @tags AiConversation
8133
- * @name GetAiConversation
8134
- * @summary Get conversation with messages
8135
- * @request GET:/api/ai/conversations/{id}
8136
- * @secure
8137
- * @response `200` `AiConversationDetail` Success
8138
- * @response `403` `ProblemDetails` Forbidden
8139
- * @response `404` `ProblemDetails` Not Found
8140
- */
8141
- getAiConversation: (id: string, params: RequestParams = {}) =>
8142
- this.request<AiConversationDetail, ProblemDetails>({
8143
- path: `/api/ai/conversations/${id}`,
8144
- method: "GET",
8145
- secure: true,
8146
- format: "json",
8147
- ...params,
8148
- }),
7152
+ /**
7153
+ * @title The Big POS API
7154
+ * @version v2.40.4
7155
+ * @termsOfService https://www.thebigpos.com/terms-of-use/
7156
+ * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7157
+ */
7158
+ export class Api<
7159
+ SecurityDataType extends unknown,
7160
+ > extends HttpClient<SecurityDataType> {
7161
+ /**
7162
+ * No description
7163
+ *
7164
+ * @tags Saml
7165
+ * @name PostRoot
7166
+ * @request POST:/
7167
+ * @secure
7168
+ * @response `200` `void` Success
7169
+ */
7170
+ postRoot = (params: RequestParams = {}) =>
7171
+ this.request<void, any>({
7172
+ path: `/`,
7173
+ method: "POST",
7174
+ secure: true,
7175
+ ...params,
7176
+ });
8149
7177
 
8150
- /**
8151
- * No description
8152
- *
8153
- * @tags AiConversation
8154
- * @name DeleteAiConversation
8155
- * @summary Delete conversation
8156
- * @request DELETE:/api/ai/conversations/{id}
8157
- * @secure
8158
- * @response `204` `void` No Content
8159
- * @response `403` `ProblemDetails` Forbidden
8160
- * @response `404` `ProblemDetails` Not Found
8161
- */
8162
- deleteAiConversation: (id: string, params: RequestParams = {}) =>
8163
- this.request<void, ProblemDetails>({
8164
- path: `/api/ai/conversations/${id}`,
8165
- method: "DELETE",
8166
- secure: true,
8167
- ...params,
8168
- }),
7178
+ /**
7179
+ * No description
7180
+ *
7181
+ * @tags TheBigPOS
7182
+ * @name GetRoot
7183
+ * @request GET:/
7184
+ * @secure
7185
+ * @response `200` `string` Success
7186
+ */
7187
+ getRoot = (params: RequestParams = {}) =>
7188
+ this.request<string, any>({
7189
+ path: `/`,
7190
+ method: "GET",
7191
+ secure: true,
7192
+ ...params,
7193
+ });
8169
7194
 
7195
+ api = {
8170
7196
  /**
8171
7197
  * No description
8172
7198
  *
8173
- * @tags AiGuardrail
8174
- * @name GetAiGuardrails
8175
- * @summary Get all guardrails
8176
- * @request GET:/api/ai/admin/guardrails
7199
+ * @tags Account
7200
+ * @name GetMyAccount
7201
+ * @summary Get
7202
+ * @request GET:/api/account
8177
7203
  * @secure
8178
- * @response `200` `(AiGuardrail)[]` Success
7204
+ * @response `200` `Account` Success
7205
+ * @response `404` `ProblemDetails` Not Found
8179
7206
  */
8180
- getAiGuardrails: (params: RequestParams = {}) =>
8181
- this.request<AiGuardrail[], any>({
8182
- path: `/api/ai/admin/guardrails`,
7207
+ getMyAccount: (params: RequestParams = {}) =>
7208
+ this.request<Account, ProblemDetails>({
7209
+ path: `/api/account`,
8183
7210
  method: "GET",
8184
7211
  secure: true,
8185
7212
  format: "json",
@@ -8189,21 +7216,22 @@ export class Api<
8189
7216
  /**
8190
7217
  * No description
8191
7218
  *
8192
- * @tags AiGuardrail
8193
- * @name CreateAiGuardrail
8194
- * @summary Create custom guardrail
8195
- * @request POST:/api/ai/admin/guardrails
7219
+ * @tags Account
7220
+ * @name ReplaceMyAccount
7221
+ * @summary Replace
7222
+ * @request PUT:/api/account
8196
7223
  * @secure
8197
- * @response `201` `AiGuardrail` Created
8198
- * @response `400` `ProblemDetails` Bad Request
7224
+ * @response `200` `Account` Success
7225
+ * @response `404` `ProblemDetails` Not Found
7226
+ * @response `422` `ProblemDetails` Client Error
8199
7227
  */
8200
- createAiGuardrail: (
8201
- data: CreateAiGuardrailRequest,
7228
+ replaceMyAccount: (
7229
+ data: UpdateAccountRequest,
8202
7230
  params: RequestParams = {},
8203
7231
  ) =>
8204
- this.request<AiGuardrail, ProblemDetails>({
8205
- path: `/api/ai/admin/guardrails`,
8206
- method: "POST",
7232
+ this.request<Account, ProblemDetails>({
7233
+ path: `/api/account`,
7234
+ method: "PUT",
8207
7235
  body: data,
8208
7236
  secure: true,
8209
7237
  type: ContentType.Json,
@@ -8214,17 +7242,16 @@ export class Api<
8214
7242
  /**
8215
7243
  * No description
8216
7244
  *
8217
- * @tags AiGuardrail
8218
- * @name GetAiGuardrail
8219
- * @summary Get guardrail by ID
8220
- * @request GET:/api/ai/admin/guardrails/{id}
7245
+ * @tags Account
7246
+ * @name GetSiteConfigurationByAccount
7247
+ * @summary Get Site Configuration
7248
+ * @request GET:/api/account/site-configurations
8221
7249
  * @secure
8222
- * @response `200` `AiGuardrail` Success
8223
- * @response `404` `ProblemDetails` Not Found
7250
+ * @response `200` `SiteConfiguration` Success
8224
7251
  */
8225
- getAiGuardrail: (id: string, params: RequestParams = {}) =>
8226
- this.request<AiGuardrail, ProblemDetails>({
8227
- path: `/api/ai/admin/guardrails/${id}`,
7252
+ getSiteConfigurationByAccount: (params: RequestParams = {}) =>
7253
+ this.request<SiteConfiguration, any>({
7254
+ path: `/api/account/site-configurations`,
8228
7255
  method: "GET",
8229
7256
  secure: true,
8230
7257
  format: "json",
@@ -8234,22 +7261,20 @@ export class Api<
8234
7261
  /**
8235
7262
  * No description
8236
7263
  *
8237
- * @tags AiGuardrail
8238
- * @name UpdateAiGuardrail
8239
- * @summary Update guardrail
8240
- * @request PUT:/api/ai/admin/guardrails/{id}
7264
+ * @tags Account
7265
+ * @name UpdateSiteConfigurationForAccount
7266
+ * @summary Update Site Configuration
7267
+ * @request PUT:/api/account/site-configurations
8241
7268
  * @secure
8242
- * @response `200` `AiGuardrail` Success
8243
- * @response `400` `ProblemDetails` Bad Request
8244
- * @response `404` `ProblemDetails` Not Found
7269
+ * @response `200` `SiteConfiguration` Success
7270
+ * @response `422` `UnprocessableEntity` Client Error
8245
7271
  */
8246
- updateAiGuardrail: (
8247
- id: string,
8248
- data: UpdateAiGuardrailRequest,
7272
+ updateSiteConfigurationForAccount: (
7273
+ data: SiteConfiguration,
8249
7274
  params: RequestParams = {},
8250
7275
  ) =>
8251
- this.request<AiGuardrail, ProblemDetails>({
8252
- path: `/api/ai/admin/guardrails/${id}`,
7276
+ this.request<SiteConfiguration, UnprocessableEntity>({
7277
+ path: `/api/account/site-configurations`,
8253
7278
  method: "PUT",
8254
7279
  body: data,
8255
7280
  secure: true,
@@ -8261,38 +7286,17 @@ export class Api<
8261
7286
  /**
8262
7287
  * No description
8263
7288
  *
8264
- * @tags AiGuardrail
8265
- * @name DeleteAiGuardrail
8266
- * @summary Delete guardrail
8267
- * @request DELETE:/api/ai/admin/guardrails/{id}
8268
- * @secure
8269
- * @response `204` `void` No Content
8270
- * @response `400` `ProblemDetails` Bad Request
8271
- * @response `404` `ProblemDetails` Not Found
8272
- */
8273
- deleteAiGuardrail: (id: string, params: RequestParams = {}) =>
8274
- this.request<void, ProblemDetails>({
8275
- path: `/api/ai/admin/guardrails/${id}`,
8276
- method: "DELETE",
8277
- secure: true,
8278
- ...params,
8279
- }),
8280
-
8281
- /**
8282
- * No description
8283
- *
8284
- * @tags AiGuardrail
8285
- * @name ToggleAiGuardrail
8286
- * @summary Toggle guardrail enabled/disabled
8287
- * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
7289
+ * @tags Accounts
7290
+ * @name GetAccounts
7291
+ * @summary Get All
7292
+ * @request GET:/api/accounts
8288
7293
  * @secure
8289
- * @response `200` `AiGuardrail` Success
8290
- * @response `404` `ProblemDetails` Not Found
7294
+ * @response `200` `(Account)[]` Success
8291
7295
  */
8292
- toggleAiGuardrail: (id: string, params: RequestParams = {}) =>
8293
- this.request<AiGuardrail, ProblemDetails>({
8294
- path: `/api/ai/admin/guardrails/${id}/toggle`,
8295
- method: "PATCH",
7296
+ getAccounts: (params: RequestParams = {}) =>
7297
+ this.request<Account[], any>({
7298
+ path: `/api/accounts`,
7299
+ method: "GET",
8296
7300
  secure: true,
8297
7301
  format: "json",
8298
7302
  ...params,
@@ -8301,24 +7305,21 @@ export class Api<
8301
7305
  /**
8302
7306
  * No description
8303
7307
  *
8304
- * @tags AiPrompt
8305
- * @name GetAvailablePrompts
8306
- * @summary Get available prompts for current user
8307
- * @request GET:/api/ai/prompts
7308
+ * @tags Accounts
7309
+ * @name CreateAccount
7310
+ * @summary Create
7311
+ * @request POST:/api/accounts
8308
7312
  * @secure
8309
- * @response `200` `(AiPromptSummary)[]` Success
7313
+ * @response `201` `Account` Created
7314
+ * @response `422` `ProblemDetails` Client Error
8310
7315
  */
8311
- getAvailablePrompts: (
8312
- query?: {
8313
- documentType?: string;
8314
- },
8315
- params: RequestParams = {},
8316
- ) =>
8317
- this.request<AiPromptSummary[], any>({
8318
- path: `/api/ai/prompts`,
8319
- method: "GET",
8320
- query: query,
7316
+ createAccount: (data: CreateAccountRequest, params: RequestParams = {}) =>
7317
+ this.request<Account, ProblemDetails>({
7318
+ path: `/api/accounts`,
7319
+ method: "POST",
7320
+ body: data,
8321
7321
  secure: true,
7322
+ type: ContentType.Json,
8322
7323
  format: "json",
8323
7324
  ...params,
8324
7325
  }),
@@ -8326,16 +7327,17 @@ export class Api<
8326
7327
  /**
8327
7328
  * No description
8328
7329
  *
8329
- * @tags AiUrlSource
8330
- * @name GetAiUrlSources
8331
- * @summary Get all URL sources
8332
- * @request GET:/api/ai/admin/url-sources
7330
+ * @tags Accounts
7331
+ * @name GetAccount
7332
+ * @summary Get by ID
7333
+ * @request GET:/api/accounts/{id}
8333
7334
  * @secure
8334
- * @response `200` `(AiUrlSource)[]` Success
7335
+ * @response `201` `Account` Created
7336
+ * @response `422` `ProblemDetails` Client Error
8335
7337
  */
8336
- getAiUrlSources: (params: RequestParams = {}) =>
8337
- this.request<AiUrlSource[], any>({
8338
- path: `/api/ai/admin/url-sources`,
7338
+ getAccount: (id: string, params: RequestParams = {}) =>
7339
+ this.request<Account, ProblemDetails>({
7340
+ path: `/api/accounts/${id}`,
8339
7341
  method: "GET",
8340
7342
  secure: true,
8341
7343
  format: "json",
@@ -8345,44 +7347,27 @@ export class Api<
8345
7347
  /**
8346
7348
  * No description
8347
7349
  *
8348
- * @tags AiUrlSource
8349
- * @name CreateAiUrlSource
8350
- * @summary Create URL source
8351
- * @request POST:/api/ai/admin/url-sources
7350
+ * @tags Accounts
7351
+ * @name DeleteAccount
7352
+ * @summary Delete
7353
+ * @request DELETE:/api/accounts/{id}
8352
7354
  * @secure
8353
- * @response `201` `AiUrlSource` Created
8354
- * @response `400` `ProblemDetails` Bad Request
8355
- * @response `409` `ProblemDetails` Conflict
7355
+ * @response `204` `Account` No Content
7356
+ * @response `404` `ProblemDetails` Not Found
7357
+ * @response `422` `ProblemDetails` Client Error
8356
7358
  */
8357
- createAiUrlSource: (
8358
- data: CreateAiUrlSourceRequest,
7359
+ deleteAccount: (
7360
+ id: string,
7361
+ query?: {
7362
+ /** @default false */
7363
+ hardDelete?: boolean;
7364
+ },
8359
7365
  params: RequestParams = {},
8360
7366
  ) =>
8361
- this.request<AiUrlSource, ProblemDetails>({
8362
- path: `/api/ai/admin/url-sources`,
8363
- method: "POST",
8364
- body: data,
8365
- secure: true,
8366
- type: ContentType.JsonPatch,
8367
- format: "json",
8368
- ...params,
8369
- }),
8370
-
8371
- /**
8372
- * No description
8373
- *
8374
- * @tags AiUrlSource
8375
- * @name GetAiUrlSource
8376
- * @summary Get URL source by ID
8377
- * @request GET:/api/ai/admin/url-sources/{id}
8378
- * @secure
8379
- * @response `200` `AiUrlSource` Success
8380
- * @response `404` `ProblemDetails` Not Found
8381
- */
8382
- getAiUrlSource: (id: string, params: RequestParams = {}) =>
8383
- this.request<AiUrlSource, ProblemDetails>({
8384
- path: `/api/ai/admin/url-sources/${id}`,
8385
- method: "GET",
7367
+ this.request<Account, ProblemDetails>({
7368
+ path: `/api/accounts/${id}`,
7369
+ method: "DELETE",
7370
+ query: query,
8386
7371
  secure: true,
8387
7372
  format: "json",
8388
7373
  ...params,
@@ -8391,23 +7376,22 @@ export class Api<
8391
7376
  /**
8392
7377
  * No description
8393
7378
  *
8394
- * @tags AiUrlSource
8395
- * @name UpdateAiUrlSource
8396
- * @summary Update URL source
8397
- * @request PUT:/api/ai/admin/url-sources/{id}
7379
+ * @tags Accounts
7380
+ * @name UpdateAccountBilling
7381
+ * @summary Update billing configuration
7382
+ * @request PUT:/api/accounts/{id}/billing
8398
7383
  * @secure
8399
- * @response `200` `AiUrlSource` Success
8400
- * @response `400` `ProblemDetails` Bad Request
7384
+ * @response `200` `AccountBilling` Success
8401
7385
  * @response `404` `ProblemDetails` Not Found
8402
- * @response `409` `ProblemDetails` Conflict
7386
+ * @response `422` `ProblemDetails` Client Error
8403
7387
  */
8404
- updateAiUrlSource: (
7388
+ updateAccountBilling: (
8405
7389
  id: string,
8406
- data: UpdateAiUrlSourceRequest,
7390
+ data: AccountBillingRequest,
8407
7391
  params: RequestParams = {},
8408
7392
  ) =>
8409
- this.request<AiUrlSource, ProblemDetails>({
8410
- path: `/api/ai/admin/url-sources/${id}`,
7393
+ this.request<AccountBilling, ProblemDetails>({
7394
+ path: `/api/accounts/${id}/billing`,
8411
7395
  method: "PUT",
8412
7396
  body: data,
8413
7397
  secure: true,
@@ -8416,45 +7400,6 @@ export class Api<
8416
7400
  ...params,
8417
7401
  }),
8418
7402
 
8419
- /**
8420
- * No description
8421
- *
8422
- * @tags AiUrlSource
8423
- * @name DeleteAiUrlSource
8424
- * @summary Delete URL source
8425
- * @request DELETE:/api/ai/admin/url-sources/{id}
8426
- * @secure
8427
- * @response `204` `void` No Content
8428
- * @response `404` `ProblemDetails` Not Found
8429
- */
8430
- deleteAiUrlSource: (id: string, params: RequestParams = {}) =>
8431
- this.request<void, ProblemDetails>({
8432
- path: `/api/ai/admin/url-sources/${id}`,
8433
- method: "DELETE",
8434
- secure: true,
8435
- ...params,
8436
- }),
8437
-
8438
- /**
8439
- * No description
8440
- *
8441
- * @tags AiUrlSource
8442
- * @name ToggleAiUrlSource
8443
- * @summary Toggle URL source active/inactive
8444
- * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
8445
- * @secure
8446
- * @response `200` `AiUrlSource` Success
8447
- * @response `404` `ProblemDetails` Not Found
8448
- */
8449
- toggleAiUrlSource: (id: string, params: RequestParams = {}) =>
8450
- this.request<AiUrlSource, ProblemDetails>({
8451
- path: `/api/ai/admin/url-sources/${id}/toggle`,
8452
- method: "PATCH",
8453
- secure: true,
8454
- format: "json",
8455
- ...params,
8456
- }),
8457
-
8458
7403
  /**
8459
7404
  * No description
8460
7405
  *
@@ -8483,7 +7428,7 @@ export class Api<
8483
7428
  query: query,
8484
7429
  body: data,
8485
7430
  secure: true,
8486
- type: ContentType.JsonPatch,
7431
+ type: ContentType.Json,
8487
7432
  format: "json",
8488
7433
  ...params,
8489
7434
  }),
@@ -9425,7 +8370,7 @@ export class Api<
9425
8370
  */
9426
8371
  getCustomFieldDefinitions: (
9427
8372
  query?: {
9428
- entityType?: "Loan";
8373
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
9429
8374
  },
9430
8375
  params: RequestParams = {},
9431
8376
  ) =>
@@ -10888,7 +9833,7 @@ export class Api<
10888
9833
  method: "PATCH",
10889
9834
  body: data,
10890
9835
  secure: true,
10891
- type: ContentType.JsonPatch,
9836
+ type: ContentType.Json,
10892
9837
  format: "json",
10893
9838
  ...params,
10894
9839
  }),
@@ -10998,7 +9943,7 @@ export class Api<
10998
9943
  method: "PATCH",
10999
9944
  body: data,
11000
9945
  secure: true,
11001
- type: ContentType.JsonPatch,
9946
+ type: ContentType.Json,
11002
9947
  format: "json",
11003
9948
  ...params,
11004
9949
  }),
@@ -11025,7 +9970,7 @@ export class Api<
11025
9970
  method: "PATCH",
11026
9971
  body: data,
11027
9972
  secure: true,
11028
- type: ContentType.JsonPatch,
9973
+ type: ContentType.Json,
11029
9974
  format: "json",
11030
9975
  ...params,
11031
9976
  }),
@@ -11267,7 +10212,7 @@ export class Api<
11267
10212
  method: "PATCH",
11268
10213
  body: data,
11269
10214
  secure: true,
11270
- type: ContentType.JsonPatch,
10215
+ type: ContentType.Json,
11271
10216
  format: "json",
11272
10217
  ...params,
11273
10218
  }),
@@ -11347,7 +10292,7 @@ export class Api<
11347
10292
  method: "PATCH",
11348
10293
  body: data,
11349
10294
  secure: true,
11350
- type: ContentType.JsonPatch,
10295
+ type: ContentType.Json,
11351
10296
  format: "json",
11352
10297
  ...params,
11353
10298
  }),
@@ -13250,7 +12195,7 @@ export class Api<
13250
12195
  method: "POST",
13251
12196
  body: data,
13252
12197
  secure: true,
13253
- type: ContentType.JsonPatch,
12198
+ type: ContentType.Json,
13254
12199
  format: "json",
13255
12200
  ...params,
13256
12201
  }),
@@ -14478,16 +13423,7 @@ export class Api<
14478
13423
  query?: {
14479
13424
  showAll?: boolean;
14480
13425
  /** @default "Realtor" */
14481
- role?:
14482
- | "Borrower"
14483
- | "LoanOfficer"
14484
- | "Admin"
14485
- | "SuperAdmin"
14486
- | "Realtor"
14487
- | "SettlementAgent"
14488
- | "LoanProcessor"
14489
- | "LoanOfficerAssistant"
14490
- | "SystemAdmin";
13426
+ role?: GetPartnersParamsRoleEnum;
14491
13427
  /** @format int32 */
14492
13428
  pageSize?: number;
14493
13429
  /** @format int32 */
@@ -14823,7 +13759,7 @@ export class Api<
14823
13759
  * @response `404` `ProblemDetails` Not Found
14824
13760
  */
14825
13761
  getSamlMetadata: (
14826
- sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
13762
+ sSoIntegration: GetSamlMetadataParamsEnum,
14827
13763
  ssoIntegration: string,
14828
13764
  params: RequestParams = {},
14829
13765
  ) =>
@@ -14845,7 +13781,7 @@ export class Api<
14845
13781
  * @response `200` `File` Success
14846
13782
  */
14847
13783
  createOrReplaceSamlMetadata: (
14848
- sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
13784
+ sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
14849
13785
  ssoIntegration: string,
14850
13786
  params: RequestParams = {},
14851
13787
  ) =>