@matech/thebigpos-sdk 2.40.0 → 2.40.3-aibi-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +73 -73
- package/dist/index.d.ts +949 -141
- package/dist/index.js +422 -9
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1974 -849
- package/tsconfig.json +27 -27
- package/.claude/settings.local.json +0 -50
package/src/index.ts
CHANGED
|
@@ -392,6 +392,89 @@ 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
|
+
|
|
395
478
|
export type AddressFamily =
|
|
396
479
|
| "Unspecified"
|
|
397
480
|
| "Unix"
|
|
@@ -479,7 +562,7 @@ export interface AccountBilling {
|
|
|
479
562
|
}
|
|
480
563
|
|
|
481
564
|
export interface AccountBillingRequest {
|
|
482
|
-
billingType:
|
|
565
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
483
566
|
/**
|
|
484
567
|
* @format double
|
|
485
568
|
* @min 0
|
|
@@ -494,6 +577,7 @@ export interface AccountSettings {
|
|
|
494
577
|
smsNumber?: string | null;
|
|
495
578
|
ssoHostOverride?: string | null;
|
|
496
579
|
isEarlyAdopter: boolean;
|
|
580
|
+
isAIEnabled: boolean;
|
|
497
581
|
}
|
|
498
582
|
|
|
499
583
|
export interface AccountSettingsRequest {
|
|
@@ -509,7 +593,7 @@ export interface Action {
|
|
|
509
593
|
comments?: string | null;
|
|
510
594
|
/** @format uuid */
|
|
511
595
|
siteConfigurationID: string;
|
|
512
|
-
applicationSettings?: any
|
|
596
|
+
applicationSettings?: any;
|
|
513
597
|
surveysToken?: string | null;
|
|
514
598
|
}
|
|
515
599
|
|
|
@@ -705,6 +789,263 @@ export interface AffordabilityCalculatorRequest {
|
|
|
705
789
|
annualInsurance: number;
|
|
706
790
|
}
|
|
707
791
|
|
|
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
|
+
|
|
708
1049
|
export interface AllowImpersonationRequest {
|
|
709
1050
|
/**
|
|
710
1051
|
* @format email
|
|
@@ -817,14 +1158,19 @@ export interface AuditLogEntry {
|
|
|
817
1158
|
/** @format uuid */
|
|
818
1159
|
id: string;
|
|
819
1160
|
entityType: string;
|
|
820
|
-
changeType:
|
|
1161
|
+
changeType:
|
|
1162
|
+
| "Created"
|
|
1163
|
+
| "Modified"
|
|
1164
|
+
| "SoftDeleted"
|
|
1165
|
+
| "HardDeleted"
|
|
1166
|
+
| "Restored";
|
|
821
1167
|
/** @format uuid */
|
|
822
1168
|
entityId: string;
|
|
823
1169
|
performedBy?: AuditLogUser | null;
|
|
824
1170
|
rootEntityType?: string | null;
|
|
825
1171
|
/** @format uuid */
|
|
826
1172
|
rootEntityId?: string | null;
|
|
827
|
-
changes?: any
|
|
1173
|
+
changes?: any;
|
|
828
1174
|
/** @format date-time */
|
|
829
1175
|
createdAt: string;
|
|
830
1176
|
}
|
|
@@ -1131,7 +1477,7 @@ export interface CorporateSearchCriteria {
|
|
|
1131
1477
|
}
|
|
1132
1478
|
|
|
1133
1479
|
export interface CreateAccessScopeRequest {
|
|
1134
|
-
scopeType:
|
|
1480
|
+
scopeType: "User" | "Branch";
|
|
1135
1481
|
/** @format uuid */
|
|
1136
1482
|
userId?: string | null;
|
|
1137
1483
|
/** @format uuid */
|
|
@@ -1155,11 +1501,92 @@ export interface CreateAccountRequest {
|
|
|
1155
1501
|
*/
|
|
1156
1502
|
nlmsid: number;
|
|
1157
1503
|
settings: AccountSettingsRequest;
|
|
1158
|
-
environment:
|
|
1504
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1159
1505
|
losIntegration: LOSIntegration;
|
|
1160
1506
|
billingSettings: AccountBillingRequest;
|
|
1161
1507
|
}
|
|
1162
1508
|
|
|
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
|
+
|
|
1163
1590
|
export interface CreateBranchRequest {
|
|
1164
1591
|
/**
|
|
1165
1592
|
* @minLength 1
|
|
@@ -1193,8 +1620,15 @@ export interface CreateCustomFieldDefinitionRequest {
|
|
|
1193
1620
|
name: string;
|
|
1194
1621
|
defaultValue?: string | null;
|
|
1195
1622
|
regexPattern?: string | null;
|
|
1196
|
-
dataType:
|
|
1197
|
-
|
|
1623
|
+
dataType:
|
|
1624
|
+
| "String"
|
|
1625
|
+
| "Number"
|
|
1626
|
+
| "Decimal"
|
|
1627
|
+
| "Boolean"
|
|
1628
|
+
| "Date"
|
|
1629
|
+
| "SingleSelect"
|
|
1630
|
+
| "MultiSelect";
|
|
1631
|
+
entityType: "Loan";
|
|
1198
1632
|
options?: CustomFieldOptionRequest[] | null;
|
|
1199
1633
|
permissions?: CustomFieldPermissionRequest[] | null;
|
|
1200
1634
|
}
|
|
@@ -1216,7 +1650,20 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1216
1650
|
export interface CreateGroupMemberRequest {
|
|
1217
1651
|
/** @format uuid */
|
|
1218
1652
|
userId: string;
|
|
1219
|
-
loanRole:
|
|
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";
|
|
1220
1667
|
}
|
|
1221
1668
|
|
|
1222
1669
|
export interface CreateInviteRequest {
|
|
@@ -1228,7 +1675,7 @@ export interface CreateInviteRequest {
|
|
|
1228
1675
|
emailAddress: string;
|
|
1229
1676
|
phoneNumber?: string | null;
|
|
1230
1677
|
/** @deprecated */
|
|
1231
|
-
relationship:
|
|
1678
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1232
1679
|
loanID: string;
|
|
1233
1680
|
route?: string | null;
|
|
1234
1681
|
/** @format uuid */
|
|
@@ -1260,7 +1707,7 @@ export interface CreateLoanImportRequest {
|
|
|
1260
1707
|
* @minLength 1
|
|
1261
1708
|
*/
|
|
1262
1709
|
startDate: string;
|
|
1263
|
-
importMode:
|
|
1710
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1264
1711
|
}
|
|
1265
1712
|
|
|
1266
1713
|
export interface CreateSession {
|
|
@@ -1282,7 +1729,20 @@ export interface CreateUserDeviceRequest {
|
|
|
1282
1729
|
}
|
|
1283
1730
|
|
|
1284
1731
|
export interface CreateUserDraft {
|
|
1285
|
-
loanRole:
|
|
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";
|
|
1286
1746
|
}
|
|
1287
1747
|
|
|
1288
1748
|
export interface CreateUserGroupRequest {
|
|
@@ -1369,8 +1829,15 @@ export interface CustomFieldDefinition {
|
|
|
1369
1829
|
name: string;
|
|
1370
1830
|
defaultValue?: string | null;
|
|
1371
1831
|
regexPattern?: string | null;
|
|
1372
|
-
dataType:
|
|
1373
|
-
|
|
1832
|
+
dataType:
|
|
1833
|
+
| "String"
|
|
1834
|
+
| "Number"
|
|
1835
|
+
| "Decimal"
|
|
1836
|
+
| "Boolean"
|
|
1837
|
+
| "Date"
|
|
1838
|
+
| "SingleSelect"
|
|
1839
|
+
| "MultiSelect";
|
|
1840
|
+
entityType: "Loan";
|
|
1374
1841
|
options: CustomFieldOption[];
|
|
1375
1842
|
permissions: CustomFieldPermission[];
|
|
1376
1843
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1385,7 +1852,14 @@ export interface CustomFieldEntry {
|
|
|
1385
1852
|
displayOrder: number;
|
|
1386
1853
|
name: string;
|
|
1387
1854
|
value: string;
|
|
1388
|
-
dataType:
|
|
1855
|
+
dataType:
|
|
1856
|
+
| "String"
|
|
1857
|
+
| "Number"
|
|
1858
|
+
| "Decimal"
|
|
1859
|
+
| "Boolean"
|
|
1860
|
+
| "Date"
|
|
1861
|
+
| "SingleSelect"
|
|
1862
|
+
| "MultiSelect";
|
|
1389
1863
|
}
|
|
1390
1864
|
|
|
1391
1865
|
export interface CustomFieldOption {
|
|
@@ -1405,13 +1879,31 @@ export interface CustomFieldOptionRequest {
|
|
|
1405
1879
|
export interface CustomFieldPermission {
|
|
1406
1880
|
/** @format uuid */
|
|
1407
1881
|
id: string;
|
|
1408
|
-
role:
|
|
1409
|
-
|
|
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";
|
|
1410
1893
|
}
|
|
1411
1894
|
|
|
1412
1895
|
export interface CustomFieldPermissionRequest {
|
|
1413
|
-
role:
|
|
1414
|
-
|
|
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";
|
|
1415
1907
|
}
|
|
1416
1908
|
|
|
1417
1909
|
export interface CustomFieldValue {
|
|
@@ -1423,7 +1915,14 @@ export interface CustomFieldValue {
|
|
|
1423
1915
|
customFieldDefinitionID: string;
|
|
1424
1916
|
value: string;
|
|
1425
1917
|
definitionName: string;
|
|
1426
|
-
dataType:
|
|
1918
|
+
dataType:
|
|
1919
|
+
| "String"
|
|
1920
|
+
| "Number"
|
|
1921
|
+
| "Decimal"
|
|
1922
|
+
| "Boolean"
|
|
1923
|
+
| "Date"
|
|
1924
|
+
| "SingleSelect"
|
|
1925
|
+
| "MultiSelect";
|
|
1427
1926
|
}
|
|
1428
1927
|
|
|
1429
1928
|
export interface CustomLoanData {
|
|
@@ -1687,7 +2186,7 @@ export interface Draft {
|
|
|
1687
2186
|
siteConfiguration: SiteConfigurationReduced;
|
|
1688
2187
|
/** @format uuid */
|
|
1689
2188
|
loanID?: string | null;
|
|
1690
|
-
type:
|
|
2189
|
+
type: "NewLoan" | "EditLoan";
|
|
1691
2190
|
isCoBorrower: boolean;
|
|
1692
2191
|
}
|
|
1693
2192
|
|
|
@@ -1706,7 +2205,7 @@ export interface DraftContent {
|
|
|
1706
2205
|
siteConfiguration: SiteConfigurationReduced;
|
|
1707
2206
|
/** @format uuid */
|
|
1708
2207
|
loanID?: string | null;
|
|
1709
|
-
type:
|
|
2208
|
+
type: "NewLoan" | "EditLoan";
|
|
1710
2209
|
isCoBorrower: boolean;
|
|
1711
2210
|
applicationPayload: any;
|
|
1712
2211
|
}
|
|
@@ -1725,7 +2224,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1725
2224
|
|
|
1726
2225
|
export interface DraftRequest {
|
|
1727
2226
|
applicationPayload: any;
|
|
1728
|
-
customData?: any
|
|
2227
|
+
customData?: any;
|
|
1729
2228
|
isCoBorrower: boolean;
|
|
1730
2229
|
}
|
|
1731
2230
|
|
|
@@ -1804,7 +2303,7 @@ export interface EncompassCredentialsDetail {
|
|
|
1804
2303
|
defaultLoanOfficerUserName?: string | null;
|
|
1805
2304
|
clearStateIfUnlicensed: boolean;
|
|
1806
2305
|
baseUrl?: string | null;
|
|
1807
|
-
signingMethod:
|
|
2306
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1808
2307
|
subscriptionId?: string | null;
|
|
1809
2308
|
environment?: string | null;
|
|
1810
2309
|
}
|
|
@@ -1820,7 +2319,7 @@ export interface EncompassCredentialsRequest {
|
|
|
1820
2319
|
defaultLoanOfficerUserName?: string | null;
|
|
1821
2320
|
clearStateIfUnlicensed: boolean;
|
|
1822
2321
|
baseUrl?: string | null;
|
|
1823
|
-
signingMethod:
|
|
2322
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1824
2323
|
subscriptionId?: string | null;
|
|
1825
2324
|
environment?: string | null;
|
|
1826
2325
|
clientID?: string | null;
|
|
@@ -1878,12 +2377,34 @@ export interface EncompassMapping {
|
|
|
1878
2377
|
status: string;
|
|
1879
2378
|
}
|
|
1880
2379
|
|
|
2380
|
+
export interface EncompassPackageDocumentStatus {
|
|
2381
|
+
documentId: string;
|
|
2382
|
+
title: string;
|
|
2383
|
+
type?: string | null;
|
|
2384
|
+
signatureType?: string | null;
|
|
2385
|
+
isSigned: boolean;
|
|
2386
|
+
/** @format date-time */
|
|
2387
|
+
viewedAt?: string | null;
|
|
2388
|
+
/** @format date-time */
|
|
2389
|
+
completedAt?: string | null;
|
|
2390
|
+
}
|
|
2391
|
+
|
|
1881
2392
|
export interface EncompassPackageItem {
|
|
1882
2393
|
packageId: string;
|
|
1883
2394
|
status: string;
|
|
1884
2395
|
/** @format date-time */
|
|
1885
2396
|
createdAt: string;
|
|
1886
2397
|
recipientId: string;
|
|
2398
|
+
title?: string | null;
|
|
2399
|
+
/** @format date-time */
|
|
2400
|
+
issuedAt?: string | null;
|
|
2401
|
+
/** @format date-time */
|
|
2402
|
+
expiresAt?: string | null;
|
|
2403
|
+
/** @format int32 */
|
|
2404
|
+
totalDocuments: number;
|
|
2405
|
+
/** @format int32 */
|
|
2406
|
+
signedDocuments: number;
|
|
2407
|
+
documents: EncompassPackageDocumentStatus[];
|
|
1887
2408
|
}
|
|
1888
2409
|
|
|
1889
2410
|
export interface EncompassPackageList {
|
|
@@ -1915,8 +2436,15 @@ export interface EncompassRequestLog {
|
|
|
1915
2436
|
losId?: string | null;
|
|
1916
2437
|
/** @format uuid */
|
|
1917
2438
|
accountId: string;
|
|
1918
|
-
operationType:
|
|
1919
|
-
|
|
2439
|
+
operationType:
|
|
2440
|
+
| "FieldUpdate"
|
|
2441
|
+
| "ConsentUpdate"
|
|
2442
|
+
| "DocumentSync"
|
|
2443
|
+
| "MilestoneUpdate"
|
|
2444
|
+
| "DocumentAttachment"
|
|
2445
|
+
| "General"
|
|
2446
|
+
| "FieldReader";
|
|
2447
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1920
2448
|
message: string;
|
|
1921
2449
|
endpoint?: string | null;
|
|
1922
2450
|
httpMethod?: string | null;
|
|
@@ -1924,7 +2452,7 @@ export interface EncompassRequestLog {
|
|
|
1924
2452
|
httpStatusCode?: number | null;
|
|
1925
2453
|
/** @format int64 */
|
|
1926
2454
|
durationMs?: number | null;
|
|
1927
|
-
context?: any
|
|
2455
|
+
context?: any;
|
|
1928
2456
|
/** @format date-time */
|
|
1929
2457
|
createdAt: string;
|
|
1930
2458
|
}
|
|
@@ -1974,7 +2502,7 @@ export interface FileSearchCriteria {
|
|
|
1974
2502
|
export interface FileWithBytes {
|
|
1975
2503
|
name: string;
|
|
1976
2504
|
/** @format byte */
|
|
1977
|
-
data:
|
|
2505
|
+
data: string;
|
|
1978
2506
|
fileName: string;
|
|
1979
2507
|
mimeType?: string | null;
|
|
1980
2508
|
extension?: string | null;
|
|
@@ -2058,7 +2586,7 @@ export interface FormSubmission {
|
|
|
2058
2586
|
subjectPropertyAddressCounty?: string | null;
|
|
2059
2587
|
subjectPropertyAddressState?: string | null;
|
|
2060
2588
|
subjectPropertyAddressZip?: string | null;
|
|
2061
|
-
data?: any
|
|
2589
|
+
data?: any;
|
|
2062
2590
|
/** @format uuid */
|
|
2063
2591
|
listingID?: string | null;
|
|
2064
2592
|
listing?: Listing | null;
|
|
@@ -2096,7 +2624,7 @@ export interface FormSubmissionRequest {
|
|
|
2096
2624
|
subjectPropertyAddressCounty?: string | null;
|
|
2097
2625
|
subjectPropertyAddressState?: string | null;
|
|
2098
2626
|
subjectPropertyAddressZip?: string | null;
|
|
2099
|
-
data?: any
|
|
2627
|
+
data?: any;
|
|
2100
2628
|
/** @format uuid */
|
|
2101
2629
|
listingID?: string | null;
|
|
2102
2630
|
}
|
|
@@ -2153,7 +2681,20 @@ export interface FusionFieldDisplay {
|
|
|
2153
2681
|
}
|
|
2154
2682
|
|
|
2155
2683
|
export interface FusionReportFilter {
|
|
2156
|
-
filterType:
|
|
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";
|
|
2157
2698
|
targetField: string;
|
|
2158
2699
|
targetValue: string;
|
|
2159
2700
|
}
|
|
@@ -2175,6 +2716,19 @@ export interface GenerateDocumentRequest {
|
|
|
2175
2716
|
recipients: string[];
|
|
2176
2717
|
}
|
|
2177
2718
|
|
|
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
|
+
|
|
2178
2732
|
export interface GetApplications {
|
|
2179
2733
|
applications: ApplicationRowData[];
|
|
2180
2734
|
}
|
|
@@ -2276,12 +2830,45 @@ export interface GetWorkflowRequest {
|
|
|
2276
2830
|
export interface GuidPatchOperation {
|
|
2277
2831
|
op: string;
|
|
2278
2832
|
path: string;
|
|
2279
|
-
value?: any
|
|
2833
|
+
value?: any;
|
|
2280
2834
|
from?: string | null;
|
|
2281
2835
|
}
|
|
2282
2836
|
|
|
2283
2837
|
export interface IPAddress {
|
|
2284
|
-
addressFamily:
|
|
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";
|
|
2285
2872
|
/** @format int64 */
|
|
2286
2873
|
scopeId: number;
|
|
2287
2874
|
isIPv6Multicast: boolean;
|
|
@@ -2549,7 +3136,7 @@ export interface Loan {
|
|
|
2549
3136
|
userLoans: UserLoan[];
|
|
2550
3137
|
contacts: LoanContact[];
|
|
2551
3138
|
customFields: CustomFieldEntry[];
|
|
2552
|
-
signingMethod:
|
|
3139
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
2553
3140
|
}
|
|
2554
3141
|
|
|
2555
3142
|
export interface LoanApplication {
|
|
@@ -2588,7 +3175,7 @@ export interface LoanApplicationRequest {
|
|
|
2588
3175
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2589
3176
|
/** @format uuid */
|
|
2590
3177
|
draftId?: string | null;
|
|
2591
|
-
additionalFields?: Record<string, any
|
|
3178
|
+
additionalFields?: Record<string, any>;
|
|
2592
3179
|
/** @format uuid */
|
|
2593
3180
|
existingLoanId?: string | null;
|
|
2594
3181
|
}
|
|
@@ -2608,7 +3195,7 @@ export interface LoanBorrower {
|
|
|
2608
3195
|
citizenship?: LoanCitizenship | null;
|
|
2609
3196
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2610
3197
|
languagePreference?: LoanLanguagePreference | null;
|
|
2611
|
-
applicationStatus:
|
|
3198
|
+
applicationStatus: "Draft" | "Complete";
|
|
2612
3199
|
/** @format int32 */
|
|
2613
3200
|
numberOfDependents?: number | null;
|
|
2614
3201
|
isPrimaryBorrower: boolean;
|
|
@@ -3514,7 +4101,7 @@ export interface LoanConsentRequest {
|
|
|
3514
4101
|
borrowerEConsent?: boolean | null;
|
|
3515
4102
|
borrowerCreditAuth?: boolean | null;
|
|
3516
4103
|
borrowerTCPAOptIn?: boolean | null;
|
|
3517
|
-
additionalFields?: Record<string, string
|
|
4104
|
+
additionalFields?: Record<string, string>;
|
|
3518
4105
|
}
|
|
3519
4106
|
|
|
3520
4107
|
export interface LoanContact {
|
|
@@ -3533,7 +4120,20 @@ export interface LoanContact {
|
|
|
3533
4120
|
email?: string | null;
|
|
3534
4121
|
phone?: string | null;
|
|
3535
4122
|
companyName?: string | null;
|
|
3536
|
-
role:
|
|
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";
|
|
3537
4137
|
}
|
|
3538
4138
|
|
|
3539
4139
|
export interface LoanContactList {
|
|
@@ -3541,7 +4141,7 @@ export interface LoanContactList {
|
|
|
3541
4141
|
}
|
|
3542
4142
|
|
|
3543
4143
|
export interface LoanCustomFieldsRequest {
|
|
3544
|
-
additionalFields?: Record<string, string
|
|
4144
|
+
additionalFields?: Record<string, string>;
|
|
3545
4145
|
}
|
|
3546
4146
|
|
|
3547
4147
|
export interface LoanDocument {
|
|
@@ -3587,13 +4187,39 @@ export interface LoanDocumentFolderPermission {
|
|
|
3587
4187
|
id: string;
|
|
3588
4188
|
/** @format uuid */
|
|
3589
4189
|
loanDocumentFolderID: string;
|
|
3590
|
-
role:
|
|
3591
|
-
|
|
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";
|
|
3592
4205
|
}
|
|
3593
4206
|
|
|
3594
4207
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3595
|
-
role:
|
|
3596
|
-
|
|
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";
|
|
3597
4223
|
}
|
|
3598
4224
|
|
|
3599
4225
|
export interface LoanDocumentFolderUsage {
|
|
@@ -3711,14 +4337,19 @@ export interface LoanImport {
|
|
|
3711
4337
|
/** @format int32 */
|
|
3712
4338
|
importedCount: number;
|
|
3713
4339
|
statusMessage?: string | null;
|
|
3714
|
-
status:
|
|
3715
|
-
|
|
4340
|
+
status:
|
|
4341
|
+
| "WaitingProcess"
|
|
4342
|
+
| "InProgress"
|
|
4343
|
+
| "Completed"
|
|
4344
|
+
| "Failed"
|
|
4345
|
+
| "Cancelled";
|
|
4346
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3716
4347
|
/** @format date-time */
|
|
3717
4348
|
createdAt?: string | null;
|
|
3718
4349
|
}
|
|
3719
4350
|
|
|
3720
4351
|
export interface LoanImportLog {
|
|
3721
|
-
level:
|
|
4352
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3722
4353
|
message: string;
|
|
3723
4354
|
/** @format date-time */
|
|
3724
4355
|
createdAt: string;
|
|
@@ -3779,8 +4410,24 @@ export interface LoanListPaginated {
|
|
|
3779
4410
|
export interface LoanLog {
|
|
3780
4411
|
/** @format uuid */
|
|
3781
4412
|
id: string;
|
|
3782
|
-
level:
|
|
3783
|
-
type:
|
|
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";
|
|
3784
4431
|
message: string;
|
|
3785
4432
|
/** @format date-time */
|
|
3786
4433
|
createdAt: string;
|
|
@@ -3789,8 +4436,24 @@ export interface LoanLog {
|
|
|
3789
4436
|
export interface LoanLogDetail {
|
|
3790
4437
|
/** @format uuid */
|
|
3791
4438
|
id: string;
|
|
3792
|
-
level:
|
|
3793
|
-
type:
|
|
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";
|
|
3794
4457
|
message: string;
|
|
3795
4458
|
/** @format date-time */
|
|
3796
4459
|
createdAt: string;
|
|
@@ -4042,7 +4705,7 @@ export interface LoanQueueWithData {
|
|
|
4042
4705
|
user: UserPublic;
|
|
4043
4706
|
loanOfficer: LoanOfficerPublic;
|
|
4044
4707
|
siteConfiguration: SiteConfigurationReduced;
|
|
4045
|
-
data?: any
|
|
4708
|
+
data?: any;
|
|
4046
4709
|
}
|
|
4047
4710
|
|
|
4048
4711
|
export interface LoanRecord {
|
|
@@ -4078,7 +4741,7 @@ export interface LoanTaskSearchRequest {
|
|
|
4078
4741
|
}
|
|
4079
4742
|
|
|
4080
4743
|
export interface LoanTaskStatusSummary {
|
|
4081
|
-
status:
|
|
4744
|
+
status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
4082
4745
|
/** @format int32 */
|
|
4083
4746
|
count: number;
|
|
4084
4747
|
}
|
|
@@ -4091,7 +4754,20 @@ export interface LoanUser {
|
|
|
4091
4754
|
email: string;
|
|
4092
4755
|
phone?: string | null;
|
|
4093
4756
|
role: string;
|
|
4094
|
-
loanRole:
|
|
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";
|
|
4095
4771
|
isUser: boolean;
|
|
4096
4772
|
/** @format date-time */
|
|
4097
4773
|
createdAt: string;
|
|
@@ -4127,7 +4803,13 @@ export interface LosOperationTracking {
|
|
|
4127
4803
|
operationType: string;
|
|
4128
4804
|
correlationKey: string;
|
|
4129
4805
|
lastTriggerSource?: string | null;
|
|
4130
|
-
status:
|
|
4806
|
+
status:
|
|
4807
|
+
| "Pending"
|
|
4808
|
+
| "Success"
|
|
4809
|
+
| "Failed"
|
|
4810
|
+
| "ConfigurationError"
|
|
4811
|
+
| "PermanentFailure"
|
|
4812
|
+
| "Locked";
|
|
4131
4813
|
/** @format date-time */
|
|
4132
4814
|
createdAt: string;
|
|
4133
4815
|
/** @format date-time */
|
|
@@ -4194,7 +4876,7 @@ export interface LosSyncStep {
|
|
|
4194
4876
|
/** @format int32 */
|
|
4195
4877
|
order: number;
|
|
4196
4878
|
name: string;
|
|
4197
|
-
severity:
|
|
4879
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
4198
4880
|
message: string;
|
|
4199
4881
|
/** @format date-time */
|
|
4200
4882
|
atUtc: string;
|
|
@@ -4252,6 +4934,31 @@ export interface MilestoneConfigurationRequest {
|
|
|
4252
4934
|
notificationsEnabled: boolean;
|
|
4253
4935
|
}
|
|
4254
4936
|
|
|
4937
|
+
export interface MobileAppReviewSeed {
|
|
4938
|
+
/** @format uuid */
|
|
4939
|
+
userID: string;
|
|
4940
|
+
userCreated: boolean;
|
|
4941
|
+
/** @format uuid */
|
|
4942
|
+
siteConfigurationID: string;
|
|
4943
|
+
siteConfigurationCreated: boolean;
|
|
4944
|
+
/** @format uuid */
|
|
4945
|
+
loanID: string;
|
|
4946
|
+
loanCreated: boolean;
|
|
4947
|
+
/** @format uuid */
|
|
4948
|
+
borrowerID: string;
|
|
4949
|
+
borrowerCompleted: boolean;
|
|
4950
|
+
}
|
|
4951
|
+
|
|
4952
|
+
export interface MobileAppReviewSeedRequest {
|
|
4953
|
+
/**
|
|
4954
|
+
* @format uuid
|
|
4955
|
+
* @minLength 1
|
|
4956
|
+
*/
|
|
4957
|
+
accountID: string;
|
|
4958
|
+
/** @format uuid */
|
|
4959
|
+
branchID?: string | null;
|
|
4960
|
+
}
|
|
4961
|
+
|
|
4255
4962
|
export interface MobileSettings {
|
|
4256
4963
|
/** @format uuid */
|
|
4257
4964
|
id?: string | null;
|
|
@@ -4278,7 +4985,7 @@ export interface ModuleParameterValue {
|
|
|
4278
4985
|
parameterID: string;
|
|
4279
4986
|
parameterName: string;
|
|
4280
4987
|
parameterType: string;
|
|
4281
|
-
value?: any
|
|
4988
|
+
value?: any;
|
|
4282
4989
|
isInherited: boolean;
|
|
4283
4990
|
}
|
|
4284
4991
|
|
|
@@ -4502,7 +5209,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
4502
5209
|
|
|
4503
5210
|
export interface Operation {
|
|
4504
5211
|
op?: string;
|
|
4505
|
-
value?:
|
|
5212
|
+
value?: string | number | boolean | null | object;
|
|
4506
5213
|
path?: string;
|
|
4507
5214
|
}
|
|
4508
5215
|
|
|
@@ -4858,7 +5565,7 @@ export interface SSOTokenRequest {
|
|
|
4858
5565
|
}
|
|
4859
5566
|
|
|
4860
5567
|
export interface SamlMetadataRequest {
|
|
4861
|
-
ssoIntegration:
|
|
5568
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
4862
5569
|
}
|
|
4863
5570
|
|
|
4864
5571
|
export interface SendForgotPasswordRequest {
|
|
@@ -4916,7 +5623,7 @@ export interface SiteConfiguration {
|
|
|
4916
5623
|
deletedAt?: string | null;
|
|
4917
5624
|
/** @format uuid */
|
|
4918
5625
|
id: string;
|
|
4919
|
-
type:
|
|
5626
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4920
5627
|
/** @format uuid */
|
|
4921
5628
|
entityID: string;
|
|
4922
5629
|
/** @format int32 */
|
|
@@ -5111,7 +5818,7 @@ export interface SiteConfigurationByUrl {
|
|
|
5111
5818
|
deletedAt?: string | null;
|
|
5112
5819
|
/** @format uuid */
|
|
5113
5820
|
id: string;
|
|
5114
|
-
type:
|
|
5821
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5115
5822
|
/** @format uuid */
|
|
5116
5823
|
entityID: string;
|
|
5117
5824
|
/** @format int32 */
|
|
@@ -5324,7 +6031,7 @@ export interface SiteConfigurationForm {
|
|
|
5324
6031
|
export interface SiteConfigurationReduced {
|
|
5325
6032
|
/** @format uuid */
|
|
5326
6033
|
id: string;
|
|
5327
|
-
type:
|
|
6034
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5328
6035
|
url?: string | null;
|
|
5329
6036
|
name: string;
|
|
5330
6037
|
/** @format int64 */
|
|
@@ -5342,7 +6049,7 @@ export interface SiteConfigurationRequest {
|
|
|
5342
6049
|
entityID: string;
|
|
5343
6050
|
/** @format int32 */
|
|
5344
6051
|
entityType: number;
|
|
5345
|
-
type:
|
|
6052
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5346
6053
|
url: string;
|
|
5347
6054
|
name: string;
|
|
5348
6055
|
introduction?: string | null;
|
|
@@ -5519,7 +6226,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
5519
6226
|
export interface SiteConfigurationSummary {
|
|
5520
6227
|
/** @format uuid */
|
|
5521
6228
|
id: string;
|
|
5522
|
-
type:
|
|
6229
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5523
6230
|
url?: string | null;
|
|
5524
6231
|
name: string;
|
|
5525
6232
|
/** @format int64 */
|
|
@@ -5567,6 +6274,14 @@ export interface SocialSurveyRecord {
|
|
|
5567
6274
|
reviewCompletedTimeStamp?: string | null;
|
|
5568
6275
|
}
|
|
5569
6276
|
|
|
6277
|
+
export interface SupportedModel {
|
|
6278
|
+
modelId: string;
|
|
6279
|
+
displayName: string;
|
|
6280
|
+
provider: string;
|
|
6281
|
+
description?: string | null;
|
|
6282
|
+
isDefault: boolean;
|
|
6283
|
+
}
|
|
6284
|
+
|
|
5570
6285
|
export interface SurveyEmailRequest {
|
|
5571
6286
|
/** @minLength 1 */
|
|
5572
6287
|
loanOfficerEmailAddress: string;
|
|
@@ -5832,31 +6547,104 @@ export interface UpdateAccountRequest {
|
|
|
5832
6547
|
settings: AccountSettingsRequest;
|
|
5833
6548
|
}
|
|
5834
6549
|
|
|
5835
|
-
export interface
|
|
5836
|
-
isRequired: boolean;
|
|
6550
|
+
export interface UpdateAiCanonicalFieldRequest {
|
|
5837
6551
|
/**
|
|
5838
|
-
* @
|
|
5839
|
-
* @
|
|
6552
|
+
* @minLength 1
|
|
6553
|
+
* @maxLength 200
|
|
5840
6554
|
*/
|
|
5841
|
-
|
|
5842
|
-
/** @
|
|
5843
|
-
|
|
5844
|
-
/** @
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
6555
|
+
displayName: string;
|
|
6556
|
+
/** @minLength 1 */
|
|
6557
|
+
description: string;
|
|
6558
|
+
/** @minItems 1 */
|
|
6559
|
+
allowedRoles: string[];
|
|
6560
|
+
isPii: boolean;
|
|
6561
|
+
}
|
|
6562
|
+
|
|
6563
|
+
export interface UpdateAiGuardrailRequest {
|
|
5850
6564
|
/**
|
|
5851
6565
|
* @minLength 1
|
|
5852
|
-
* @maxLength
|
|
6566
|
+
* @maxLength 200
|
|
5853
6567
|
*/
|
|
5854
6568
|
name: string;
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
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
|
+
export interface UpdateCustomFieldDefinitionRequest {
|
|
6624
|
+
isRequired: boolean;
|
|
6625
|
+
/**
|
|
6626
|
+
* @format int32
|
|
6627
|
+
* @min 0
|
|
6628
|
+
*/
|
|
6629
|
+
displayOrder: number;
|
|
6630
|
+
/** @format int32 */
|
|
6631
|
+
minLength?: number | null;
|
|
6632
|
+
/** @format int32 */
|
|
6633
|
+
maxLength?: number | null;
|
|
6634
|
+
/** @format double */
|
|
6635
|
+
minValue?: number | null;
|
|
6636
|
+
/** @format double */
|
|
6637
|
+
maxValue?: number | null;
|
|
6638
|
+
/**
|
|
6639
|
+
* @minLength 1
|
|
6640
|
+
* @maxLength 250
|
|
6641
|
+
*/
|
|
6642
|
+
name: string;
|
|
6643
|
+
defaultValue?: string | null;
|
|
6644
|
+
regexPattern?: string | null;
|
|
6645
|
+
options?: CustomFieldOptionRequest[] | null;
|
|
6646
|
+
permissions?: CustomFieldPermissionRequest[] | null;
|
|
6647
|
+
}
|
|
5860
6648
|
|
|
5861
6649
|
export interface UpdateDocumentTemplateRequest {
|
|
5862
6650
|
/** @minLength 1 */
|
|
@@ -6187,7 +6975,20 @@ export interface UserDevice {
|
|
|
6187
6975
|
export interface UserDraft {
|
|
6188
6976
|
/** @format uuid */
|
|
6189
6977
|
draftID: string;
|
|
6190
|
-
role:
|
|
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";
|
|
6191
6992
|
user: User;
|
|
6192
6993
|
}
|
|
6193
6994
|
|
|
@@ -6214,7 +7015,7 @@ export interface UserGroupAccessScope {
|
|
|
6214
7015
|
id: string;
|
|
6215
7016
|
/** @format uuid */
|
|
6216
7017
|
groupId: string;
|
|
6217
|
-
scopeType:
|
|
7018
|
+
scopeType: "User" | "Branch";
|
|
6218
7019
|
/** @format uuid */
|
|
6219
7020
|
userId?: string | null;
|
|
6220
7021
|
/** @format uuid */
|
|
@@ -6250,7 +7051,20 @@ export interface UserLoan {
|
|
|
6250
7051
|
deletedAt?: string | null;
|
|
6251
7052
|
loanID: string;
|
|
6252
7053
|
user: User;
|
|
6253
|
-
role:
|
|
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";
|
|
6254
7068
|
/** @format int32 */
|
|
6255
7069
|
borrowerPair?: number | null;
|
|
6256
7070
|
/** @format int32 */
|
|
@@ -6264,10 +7078,10 @@ export interface UserLoanConsent {
|
|
|
6264
7078
|
id: string;
|
|
6265
7079
|
/** @format uuid */
|
|
6266
7080
|
userLoanID: string;
|
|
6267
|
-
type:
|
|
7081
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6268
7082
|
providedConsent: boolean;
|
|
6269
7083
|
ipAddress?: string | null;
|
|
6270
|
-
losSyncStatus:
|
|
7084
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
6271
7085
|
/** @format date-time */
|
|
6272
7086
|
createdAt: string;
|
|
6273
7087
|
/** @format date-time */
|
|
@@ -6422,7 +7236,16 @@ export interface UserSummary {
|
|
|
6422
7236
|
id: string;
|
|
6423
7237
|
name?: string | null;
|
|
6424
7238
|
email?: string | null;
|
|
6425
|
-
role:
|
|
7239
|
+
role:
|
|
7240
|
+
| "Borrower"
|
|
7241
|
+
| "LoanOfficer"
|
|
7242
|
+
| "Admin"
|
|
7243
|
+
| "SuperAdmin"
|
|
7244
|
+
| "Realtor"
|
|
7245
|
+
| "SettlementAgent"
|
|
7246
|
+
| "LoanProcessor"
|
|
7247
|
+
| "LoanOfficerAssistant"
|
|
7248
|
+
| "SystemAdmin";
|
|
6426
7249
|
}
|
|
6427
7250
|
|
|
6428
7251
|
export interface VerifyPasswordRequest {
|
|
@@ -6458,721 +7281,866 @@ export interface Workflow {
|
|
|
6458
7281
|
icon: string;
|
|
6459
7282
|
}
|
|
6460
7283
|
|
|
6461
|
-
|
|
6462
|
-
|
|
6463
|
-
|
|
6464
|
-
|
|
6465
|
-
|
|
6466
|
-
|
|
6467
|
-
|
|
6468
|
-
|
|
7284
|
+
import type {
|
|
7285
|
+
AxiosInstance,
|
|
7286
|
+
AxiosRequestConfig,
|
|
7287
|
+
AxiosResponse,
|
|
7288
|
+
HeadersDefaults,
|
|
7289
|
+
ResponseType,
|
|
7290
|
+
} from "axios";
|
|
7291
|
+
import axios from "axios";
|
|
6469
7292
|
|
|
6470
|
-
export type
|
|
7293
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
6471
7294
|
|
|
6472
|
-
export
|
|
6473
|
-
| "
|
|
6474
|
-
|
|
6475
|
-
|
|
6476
|
-
|
|
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
|
+
}
|
|
6477
7310
|
|
|
6478
|
-
export type
|
|
6479
|
-
|
|
6480
|
-
| "
|
|
6481
|
-
|
|
6482
|
-
| "Boolean"
|
|
6483
|
-
| "Date"
|
|
6484
|
-
| "SingleSelect"
|
|
6485
|
-
| "MultiSelect";
|
|
7311
|
+
export type RequestParams = Omit<
|
|
7312
|
+
FullRequestParams,
|
|
7313
|
+
"body" | "method" | "query" | "path"
|
|
7314
|
+
>;
|
|
6486
7315
|
|
|
6487
|
-
export
|
|
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
|
+
}
|
|
6488
7324
|
|
|
6489
|
-
export
|
|
6490
|
-
|
|
6491
|
-
|
|
6492
|
-
|
|
6493
|
-
|
|
6494
|
-
|
|
6495
|
-
|
|
6496
|
-
|
|
6497
|
-
| "BuyerAgent"
|
|
6498
|
-
| "SellerAgent"
|
|
6499
|
-
| "TitleInsuranceAgent"
|
|
6500
|
-
| "EscrowAgent"
|
|
6501
|
-
| "SettlementAgent"
|
|
6502
|
-
| "Admin";
|
|
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
|
+
}
|
|
6503
7333
|
|
|
6504
|
-
|
|
6505
|
-
|
|
6506
|
-
|
|
|
6507
|
-
|
|
6508
|
-
|
|
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;
|
|
6509
7340
|
|
|
6510
|
-
|
|
6511
|
-
|
|
6512
|
-
|
|
6513
|
-
|
|
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
|
+
}
|
|
6514
7355
|
|
|
6515
|
-
|
|
6516
|
-
|
|
6517
|
-
|
|
6518
|
-
| "NonBorrower"
|
|
6519
|
-
| "LoanOfficer"
|
|
6520
|
-
| "LoanProcessor"
|
|
6521
|
-
| "LoanOfficerAssistant"
|
|
6522
|
-
| "SupportingLoanOfficer"
|
|
6523
|
-
| "BuyerAgent"
|
|
6524
|
-
| "SellerAgent"
|
|
6525
|
-
| "TitleInsuranceAgent"
|
|
6526
|
-
| "EscrowAgent"
|
|
6527
|
-
| "SettlementAgent"
|
|
6528
|
-
| "Admin";
|
|
7356
|
+
public setSecurityData = (data: SecurityDataType | null) => {
|
|
7357
|
+
this.securityData = data;
|
|
7358
|
+
};
|
|
6529
7359
|
|
|
6530
|
-
|
|
6531
|
-
|
|
6532
|
-
|
|
6533
|
-
|
|
6534
|
-
|
|
6535
|
-
| "Date"
|
|
6536
|
-
| "SingleSelect"
|
|
6537
|
-
| "MultiSelect";
|
|
7360
|
+
protected mergeRequestParams(
|
|
7361
|
+
params1: AxiosRequestConfig,
|
|
7362
|
+
params2?: AxiosRequestConfig,
|
|
7363
|
+
): AxiosRequestConfig {
|
|
7364
|
+
const method = params1.method || (params2 && params2.method);
|
|
6538
7365
|
|
|
6539
|
-
|
|
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
|
+
}
|
|
6540
7381
|
|
|
6541
|
-
|
|
6542
|
-
|
|
6543
|
-
|
|
6544
|
-
|
|
6545
|
-
|
|
6546
|
-
|
|
6547
|
-
|
|
6548
|
-
| "MultiSelect";
|
|
7382
|
+
protected stringifyFormItem(formItem: unknown) {
|
|
7383
|
+
if (typeof formItem === "object" && formItem !== null) {
|
|
7384
|
+
return JSON.stringify(formItem);
|
|
7385
|
+
} else {
|
|
7386
|
+
return `${formItem}`;
|
|
7387
|
+
}
|
|
7388
|
+
}
|
|
6549
7389
|
|
|
6550
|
-
|
|
6551
|
-
|
|
6552
|
-
|
|
6553
|
-
|
|
6554
|
-
|
|
6555
|
-
|
|
6556
|
-
|
|
6557
|
-
|
|
6558
|
-
| "LoanOfficerAssistant"
|
|
6559
|
-
| "SystemAdmin";
|
|
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];
|
|
6560
7398
|
|
|
6561
|
-
|
|
6562
|
-
|
|
6563
|
-
|
|
6564
|
-
|
|
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
|
+
}
|
|
6565
7406
|
|
|
6566
|
-
|
|
6567
|
-
|
|
6568
|
-
|
|
6569
|
-
| "Admin"
|
|
6570
|
-
| "SuperAdmin"
|
|
6571
|
-
| "Realtor"
|
|
6572
|
-
| "SettlementAgent"
|
|
6573
|
-
| "LoanProcessor"
|
|
6574
|
-
| "LoanOfficerAssistant"
|
|
6575
|
-
| "SystemAdmin";
|
|
7407
|
+
return formData;
|
|
7408
|
+
}, new FormData());
|
|
7409
|
+
}
|
|
6576
7410
|
|
|
6577
|
-
|
|
6578
|
-
|
|
6579
|
-
|
|
6580
|
-
|
|
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;
|
|
6581
7427
|
|
|
6582
|
-
|
|
6583
|
-
|
|
6584
|
-
|
|
6585
|
-
|
|
6586
|
-
|
|
6587
|
-
|
|
6588
|
-
|
|
6589
|
-
|
|
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
|
+
}
|
|
6590
7436
|
|
|
6591
|
-
|
|
7437
|
+
if (
|
|
7438
|
+
type === ContentType.Text &&
|
|
7439
|
+
body &&
|
|
7440
|
+
body !== null &&
|
|
7441
|
+
typeof body !== "string"
|
|
7442
|
+
) {
|
|
7443
|
+
body = JSON.stringify(body);
|
|
7444
|
+
}
|
|
6592
7445
|
|
|
6593
|
-
|
|
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
|
+
}
|
|
6594
7459
|
|
|
6595
|
-
|
|
6596
|
-
|
|
6597
|
-
|
|
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
|
+
});
|
|
6598
7485
|
|
|
6599
|
-
|
|
6600
|
-
|
|
6601
|
-
|
|
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
|
+
});
|
|
6602
7502
|
|
|
6603
|
-
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6608
|
-
|
|
6609
|
-
|
|
6610
|
-
|
|
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
|
+
}),
|
|
6611
7523
|
|
|
6612
|
-
|
|
6613
|
-
|
|
6614
|
-
|
|
6615
|
-
|
|
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
|
+
}),
|
|
6616
7549
|
|
|
6617
|
-
|
|
6618
|
-
|
|
6619
|
-
|
|
6620
|
-
|
|
6621
|
-
|
|
6622
|
-
|
|
6623
|
-
|
|
6624
|
-
|
|
6625
|
-
|
|
6626
|
-
|
|
6627
|
-
|
|
6628
|
-
|
|
6629
|
-
|
|
6630
|
-
|
|
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
|
+
}),
|
|
6631
7568
|
|
|
6632
|
-
|
|
6633
|
-
|
|
6634
|
-
|
|
6635
|
-
|
|
6636
|
-
|
|
6637
|
-
|
|
6638
|
-
|
|
6639
|
-
|
|
6640
|
-
|
|
6641
|
-
|
|
6642
|
-
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
|
|
6646
|
-
|
|
6647
|
-
|
|
6648
|
-
|
|
6649
|
-
|
|
6650
|
-
|
|
6651
|
-
|
|
6652
|
-
|
|
6653
|
-
|
|
6654
|
-
|
|
6655
|
-
|
|
6656
|
-
| "Atm"
|
|
6657
|
-
| "InterNetworkV6"
|
|
6658
|
-
| "Cluster"
|
|
6659
|
-
| "Ieee12844"
|
|
6660
|
-
| "Irda"
|
|
6661
|
-
| "NetworkDesigners"
|
|
6662
|
-
| "Max"
|
|
6663
|
-
| "Packet"
|
|
6664
|
-
| "ControllerAreaNetwork"
|
|
6665
|
-
| "Unknown";
|
|
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
|
+
}),
|
|
6666
7593
|
|
|
6667
|
-
|
|
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
|
+
}),
|
|
6668
7612
|
|
|
6669
|
-
|
|
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
|
+
}),
|
|
6670
7634
|
|
|
6671
|
-
|
|
6672
|
-
|
|
6673
|
-
|
|
6674
|
-
|
|
6675
|
-
|
|
6676
|
-
|
|
6677
|
-
|
|
6678
|
-
|
|
6679
|
-
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
|
|
6683
|
-
|
|
6684
|
-
|
|
6685
|
-
|
|
6686
|
-
|
|
6687
|
-
|
|
6688
|
-
|
|
6689
|
-
|
|
6690
|
-
| "LoanOfficer"
|
|
6691
|
-
| "LoanProcessor"
|
|
6692
|
-
| "LoanOfficerAssistant"
|
|
6693
|
-
| "SupportingLoanOfficer"
|
|
6694
|
-
| "BuyerAgent"
|
|
6695
|
-
| "SellerAgent"
|
|
6696
|
-
| "TitleInsuranceAgent"
|
|
6697
|
-
| "EscrowAgent"
|
|
6698
|
-
| "SettlementAgent"
|
|
6699
|
-
| "Admin";
|
|
6700
|
-
|
|
6701
|
-
export type LoanDocumentFolderPermissionLevelEnum =
|
|
6702
|
-
| "None"
|
|
6703
|
-
| "Read"
|
|
6704
|
-
| "Write"
|
|
6705
|
-
| "Manage";
|
|
6706
|
-
|
|
6707
|
-
export type LoanDocumentFolderPermissionRequestRoleEnum =
|
|
6708
|
-
| "Borrower"
|
|
6709
|
-
| "CoBorrower"
|
|
6710
|
-
| "NonBorrower"
|
|
6711
|
-
| "LoanOfficer"
|
|
6712
|
-
| "LoanProcessor"
|
|
6713
|
-
| "LoanOfficerAssistant"
|
|
6714
|
-
| "SupportingLoanOfficer"
|
|
6715
|
-
| "BuyerAgent"
|
|
6716
|
-
| "SellerAgent"
|
|
6717
|
-
| "TitleInsuranceAgent"
|
|
6718
|
-
| "EscrowAgent"
|
|
6719
|
-
| "SettlementAgent"
|
|
6720
|
-
| "Admin";
|
|
6721
|
-
|
|
6722
|
-
export type LoanDocumentFolderPermissionRequestLevelEnum =
|
|
6723
|
-
| "None"
|
|
6724
|
-
| "Read"
|
|
6725
|
-
| "Write"
|
|
6726
|
-
| "Manage";
|
|
6727
|
-
|
|
6728
|
-
export type LoanImportStatusEnum =
|
|
6729
|
-
| "WaitingProcess"
|
|
6730
|
-
| "InProgress"
|
|
6731
|
-
| "Completed"
|
|
6732
|
-
| "Failed"
|
|
6733
|
-
| "Cancelled";
|
|
6734
|
-
|
|
6735
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6736
|
-
|
|
6737
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6738
|
-
|
|
6739
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6740
|
-
|
|
6741
|
-
export type LoanLogTypeEnum =
|
|
6742
|
-
| "Loan"
|
|
6743
|
-
| "Queue"
|
|
6744
|
-
| "POSFlagChanged"
|
|
6745
|
-
| "Verification"
|
|
6746
|
-
| "DocumentUploaded"
|
|
6747
|
-
| "LoanCreated"
|
|
6748
|
-
| "WorkflowSubmitted"
|
|
6749
|
-
| "UserInvitationSent"
|
|
6750
|
-
| "CoBorrowerAdded"
|
|
6751
|
-
| "TaskCompleted"
|
|
6752
|
-
| "LoanStatusChanged"
|
|
6753
|
-
| "Consent"
|
|
6754
|
-
| "SensitiveDataPurge"
|
|
6755
|
-
| "ClosingDateUpdated"
|
|
6756
|
-
| "ConsumerConnectAssociation"
|
|
6757
|
-
| "TaskReminderSent";
|
|
6758
|
-
|
|
6759
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6760
|
-
|
|
6761
|
-
export type LoanLogDetailTypeEnum =
|
|
6762
|
-
| "Loan"
|
|
6763
|
-
| "Queue"
|
|
6764
|
-
| "POSFlagChanged"
|
|
6765
|
-
| "Verification"
|
|
6766
|
-
| "DocumentUploaded"
|
|
6767
|
-
| "LoanCreated"
|
|
6768
|
-
| "WorkflowSubmitted"
|
|
6769
|
-
| "UserInvitationSent"
|
|
6770
|
-
| "CoBorrowerAdded"
|
|
6771
|
-
| "TaskCompleted"
|
|
6772
|
-
| "LoanStatusChanged"
|
|
6773
|
-
| "Consent"
|
|
6774
|
-
| "SensitiveDataPurge"
|
|
6775
|
-
| "ClosingDateUpdated"
|
|
6776
|
-
| "ConsumerConnectAssociation"
|
|
6777
|
-
| "TaskReminderSent";
|
|
6778
|
-
|
|
6779
|
-
export type LoanTaskStatusSummaryStatusEnum =
|
|
6780
|
-
| "Outstanding"
|
|
6781
|
-
| "Pending"
|
|
6782
|
-
| "Completed"
|
|
6783
|
-
| "Rejected"
|
|
6784
|
-
| "Unknown";
|
|
6785
|
-
|
|
6786
|
-
export type LoanUserLoanRoleEnum =
|
|
6787
|
-
| "Borrower"
|
|
6788
|
-
| "CoBorrower"
|
|
6789
|
-
| "NonBorrower"
|
|
6790
|
-
| "LoanOfficer"
|
|
6791
|
-
| "LoanProcessor"
|
|
6792
|
-
| "LoanOfficerAssistant"
|
|
6793
|
-
| "SupportingLoanOfficer"
|
|
6794
|
-
| "BuyerAgent"
|
|
6795
|
-
| "SellerAgent"
|
|
6796
|
-
| "TitleInsuranceAgent"
|
|
6797
|
-
| "EscrowAgent"
|
|
6798
|
-
| "SettlementAgent"
|
|
6799
|
-
| "Admin";
|
|
6800
|
-
|
|
6801
|
-
export type LosOperationTrackingStatusEnum =
|
|
6802
|
-
| "Pending"
|
|
6803
|
-
| "Success"
|
|
6804
|
-
| "Failed"
|
|
6805
|
-
| "ConfigurationError"
|
|
6806
|
-
| "PermanentFailure"
|
|
6807
|
-
| "Locked";
|
|
6808
|
-
|
|
6809
|
-
export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
|
|
6810
|
-
|
|
6811
|
-
export type SamlMetadataRequestSsoIntegrationEnum =
|
|
6812
|
-
| "ConsumerConnect"
|
|
6813
|
-
| "TheBigPOS"
|
|
6814
|
-
| "POSF";
|
|
6815
|
-
|
|
6816
|
-
export type SiteConfigurationTypeEnum =
|
|
6817
|
-
| "None"
|
|
6818
|
-
| "Account"
|
|
6819
|
-
| "Corporate"
|
|
6820
|
-
| "Branch"
|
|
6821
|
-
| "LoanOfficer"
|
|
6822
|
-
| "Partner";
|
|
6823
|
-
|
|
6824
|
-
export type SiteConfigurationByUrlTypeEnum =
|
|
6825
|
-
| "None"
|
|
6826
|
-
| "Account"
|
|
6827
|
-
| "Corporate"
|
|
6828
|
-
| "Branch"
|
|
6829
|
-
| "LoanOfficer"
|
|
6830
|
-
| "Partner";
|
|
6831
|
-
|
|
6832
|
-
export type SiteConfigurationReducedTypeEnum =
|
|
6833
|
-
| "None"
|
|
6834
|
-
| "Account"
|
|
6835
|
-
| "Corporate"
|
|
6836
|
-
| "Branch"
|
|
6837
|
-
| "LoanOfficer"
|
|
6838
|
-
| "Partner";
|
|
6839
|
-
|
|
6840
|
-
export type SiteConfigurationRequestTypeEnum =
|
|
6841
|
-
| "None"
|
|
6842
|
-
| "Account"
|
|
6843
|
-
| "Corporate"
|
|
6844
|
-
| "Branch"
|
|
6845
|
-
| "LoanOfficer"
|
|
6846
|
-
| "Partner";
|
|
6847
|
-
|
|
6848
|
-
export type SiteConfigurationSummaryTypeEnum =
|
|
6849
|
-
| "None"
|
|
6850
|
-
| "Account"
|
|
6851
|
-
| "Corporate"
|
|
6852
|
-
| "Branch"
|
|
6853
|
-
| "LoanOfficer"
|
|
6854
|
-
| "Partner";
|
|
6855
|
-
|
|
6856
|
-
export type UserDraftRoleEnum =
|
|
6857
|
-
| "Borrower"
|
|
6858
|
-
| "CoBorrower"
|
|
6859
|
-
| "NonBorrower"
|
|
6860
|
-
| "LoanOfficer"
|
|
6861
|
-
| "LoanProcessor"
|
|
6862
|
-
| "LoanOfficerAssistant"
|
|
6863
|
-
| "SupportingLoanOfficer"
|
|
6864
|
-
| "BuyerAgent"
|
|
6865
|
-
| "SellerAgent"
|
|
6866
|
-
| "TitleInsuranceAgent"
|
|
6867
|
-
| "EscrowAgent"
|
|
6868
|
-
| "SettlementAgent"
|
|
6869
|
-
| "Admin";
|
|
6870
|
-
|
|
6871
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6872
|
-
|
|
6873
|
-
export type UserLoanRoleEnum =
|
|
6874
|
-
| "Borrower"
|
|
6875
|
-
| "CoBorrower"
|
|
6876
|
-
| "NonBorrower"
|
|
6877
|
-
| "LoanOfficer"
|
|
6878
|
-
| "LoanProcessor"
|
|
6879
|
-
| "LoanOfficerAssistant"
|
|
6880
|
-
| "SupportingLoanOfficer"
|
|
6881
|
-
| "BuyerAgent"
|
|
6882
|
-
| "SellerAgent"
|
|
6883
|
-
| "TitleInsuranceAgent"
|
|
6884
|
-
| "EscrowAgent"
|
|
6885
|
-
| "SettlementAgent"
|
|
6886
|
-
| "Admin";
|
|
6887
|
-
|
|
6888
|
-
export type UserLoanConsentTypeEnum =
|
|
6889
|
-
| "Econsent"
|
|
6890
|
-
| "CreditAuthorization"
|
|
6891
|
-
| "Tcpa";
|
|
6892
|
-
|
|
6893
|
-
export type UserLoanConsentLosSyncStatusEnum =
|
|
6894
|
-
| "NotStarted"
|
|
6895
|
-
| "Failed"
|
|
6896
|
-
| "Success";
|
|
6897
|
-
|
|
6898
|
-
export type UserSummaryRoleEnum =
|
|
6899
|
-
| "Borrower"
|
|
6900
|
-
| "LoanOfficer"
|
|
6901
|
-
| "Admin"
|
|
6902
|
-
| "SuperAdmin"
|
|
6903
|
-
| "Realtor"
|
|
6904
|
-
| "SettlementAgent"
|
|
6905
|
-
| "LoanProcessor"
|
|
6906
|
-
| "LoanOfficerAssistant"
|
|
6907
|
-
| "SystemAdmin";
|
|
6908
|
-
|
|
6909
|
-
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6910
|
-
|
|
6911
|
-
/** @default "Realtor" */
|
|
6912
|
-
export type GetPartnersParamsRoleEnum =
|
|
6913
|
-
| "Borrower"
|
|
6914
|
-
| "LoanOfficer"
|
|
6915
|
-
| "Admin"
|
|
6916
|
-
| "SuperAdmin"
|
|
6917
|
-
| "Realtor"
|
|
6918
|
-
| "SettlementAgent"
|
|
6919
|
-
| "LoanProcessor"
|
|
6920
|
-
| "LoanOfficerAssistant"
|
|
6921
|
-
| "SystemAdmin";
|
|
6922
|
-
|
|
6923
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
6924
|
-
| "ConsumerConnect"
|
|
6925
|
-
| "TheBigPOS"
|
|
6926
|
-
| "POSF";
|
|
6927
|
-
|
|
6928
|
-
export type GetSamlMetadataParamsEnum =
|
|
6929
|
-
| "ConsumerConnect"
|
|
6930
|
-
| "TheBigPOS"
|
|
6931
|
-
| "POSF";
|
|
6932
|
-
|
|
6933
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
|
|
6934
|
-
| "ConsumerConnect"
|
|
6935
|
-
| "TheBigPOS"
|
|
6936
|
-
| "POSF";
|
|
6937
|
-
|
|
6938
|
-
export type CreateOrReplaceSamlMetadataParamsEnum =
|
|
6939
|
-
| "ConsumerConnect"
|
|
6940
|
-
| "TheBigPOS"
|
|
6941
|
-
| "POSF";
|
|
6942
|
-
|
|
6943
|
-
import type {
|
|
6944
|
-
AxiosInstance,
|
|
6945
|
-
AxiosRequestConfig,
|
|
6946
|
-
AxiosResponse,
|
|
6947
|
-
HeadersDefaults,
|
|
6948
|
-
ResponseType,
|
|
6949
|
-
} from "axios";
|
|
6950
|
-
import axios from "axios";
|
|
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
|
+
}),
|
|
6951
7654
|
|
|
6952
|
-
|
|
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
|
+
}),
|
|
6953
7683
|
|
|
6954
|
-
|
|
6955
|
-
|
|
6956
|
-
|
|
6957
|
-
|
|
6958
|
-
|
|
6959
|
-
|
|
6960
|
-
|
|
6961
|
-
|
|
6962
|
-
|
|
6963
|
-
|
|
6964
|
-
|
|
6965
|
-
|
|
6966
|
-
|
|
6967
|
-
|
|
6968
|
-
|
|
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
|
+
}),
|
|
6969
7710
|
|
|
6970
|
-
|
|
6971
|
-
|
|
6972
|
-
|
|
6973
|
-
|
|
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
|
+
}),
|
|
6974
7745
|
|
|
6975
|
-
|
|
6976
|
-
|
|
6977
|
-
|
|
6978
|
-
|
|
6979
|
-
|
|
6980
|
-
|
|
6981
|
-
|
|
6982
|
-
|
|
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
|
+
}),
|
|
6983
7773
|
|
|
6984
|
-
|
|
6985
|
-
|
|
6986
|
-
|
|
6987
|
-
|
|
6988
|
-
|
|
6989
|
-
|
|
6990
|
-
|
|
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
|
+
}),
|
|
6991
7792
|
|
|
6992
|
-
|
|
6993
|
-
|
|
6994
|
-
|
|
6995
|
-
|
|
6996
|
-
|
|
6997
|
-
|
|
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
|
+
}),
|
|
6998
7814
|
|
|
6999
|
-
|
|
7000
|
-
|
|
7001
|
-
|
|
7002
|
-
|
|
7003
|
-
|
|
7004
|
-
|
|
7005
|
-
|
|
7006
|
-
|
|
7007
|
-
|
|
7008
|
-
|
|
7009
|
-
|
|
7010
|
-
|
|
7011
|
-
|
|
7012
|
-
|
|
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
|
+
}),
|
|
7013
7834
|
|
|
7014
|
-
|
|
7015
|
-
|
|
7016
|
-
|
|
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
|
+
}),
|
|
7017
7861
|
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7021
|
-
|
|
7022
|
-
|
|
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
|
+
}),
|
|
7023
7881
|
|
|
7024
|
-
|
|
7025
|
-
|
|
7026
|
-
|
|
7027
|
-
|
|
7028
|
-
|
|
7029
|
-
|
|
7030
|
-
|
|
7031
|
-
|
|
7032
|
-
|
|
7033
|
-
|
|
7034
|
-
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
|
|
7038
|
-
|
|
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
|
+
}),
|
|
7039
7901
|
|
|
7040
|
-
|
|
7041
|
-
|
|
7042
|
-
|
|
7043
|
-
|
|
7044
|
-
|
|
7045
|
-
|
|
7046
|
-
|
|
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
|
+
}),
|
|
7047
7926
|
|
|
7048
|
-
|
|
7049
|
-
|
|
7050
|
-
|
|
7051
|
-
|
|
7052
|
-
|
|
7053
|
-
|
|
7054
|
-
|
|
7055
|
-
|
|
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
|
+
}),
|
|
7056
7945
|
|
|
7057
|
-
|
|
7058
|
-
|
|
7059
|
-
|
|
7060
|
-
|
|
7061
|
-
|
|
7062
|
-
|
|
7063
|
-
|
|
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
|
+
}),
|
|
7064
7964
|
|
|
7065
|
-
|
|
7066
|
-
|
|
7067
|
-
|
|
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
|
+
}),
|
|
7068
7989
|
|
|
7069
|
-
|
|
7070
|
-
|
|
7071
|
-
|
|
7072
|
-
|
|
7073
|
-
|
|
7074
|
-
|
|
7075
|
-
|
|
7076
|
-
|
|
7077
|
-
|
|
7078
|
-
|
|
7079
|
-
|
|
7080
|
-
|
|
7081
|
-
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
|
|
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
|
+
}),
|
|
7085
8009
|
|
|
7086
|
-
|
|
7087
|
-
|
|
7088
|
-
|
|
7089
|
-
|
|
7090
|
-
|
|
7091
|
-
|
|
7092
|
-
|
|
7093
|
-
|
|
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
|
+
}),
|
|
7094
8036
|
|
|
7095
|
-
|
|
7096
|
-
|
|
7097
|
-
|
|
7098
|
-
|
|
7099
|
-
|
|
7100
|
-
|
|
7101
|
-
|
|
7102
|
-
|
|
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
|
+
}),
|
|
7103
8055
|
|
|
7104
|
-
|
|
7105
|
-
|
|
7106
|
-
|
|
7107
|
-
|
|
7108
|
-
|
|
7109
|
-
|
|
7110
|
-
|
|
7111
|
-
|
|
7112
|
-
|
|
7113
|
-
|
|
7114
|
-
|
|
7115
|
-
|
|
7116
|
-
|
|
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
|
+
}),
|
|
7117
8075
|
|
|
7118
|
-
/**
|
|
7119
|
-
|
|
7120
|
-
|
|
7121
|
-
|
|
7122
|
-
|
|
7123
|
-
|
|
7124
|
-
|
|
7125
|
-
|
|
7126
|
-
|
|
7127
|
-
|
|
7128
|
-
|
|
7129
|
-
|
|
7130
|
-
|
|
7131
|
-
|
|
7132
|
-
|
|
7133
|
-
|
|
7134
|
-
|
|
7135
|
-
|
|
7136
|
-
|
|
7137
|
-
|
|
7138
|
-
|
|
7139
|
-
|
|
7140
|
-
secure: true,
|
|
7141
|
-
...params,
|
|
7142
|
-
});
|
|
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
|
+
}),
|
|
7143
8098
|
|
|
7144
|
-
|
|
7145
|
-
|
|
7146
|
-
|
|
7147
|
-
|
|
7148
|
-
|
|
7149
|
-
|
|
7150
|
-
|
|
7151
|
-
|
|
7152
|
-
|
|
7153
|
-
|
|
7154
|
-
|
|
7155
|
-
|
|
7156
|
-
|
|
7157
|
-
|
|
7158
|
-
|
|
7159
|
-
|
|
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;
|
|
8117
|
+
},
|
|
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
|
+
}),
|
|
7160
8128
|
|
|
7161
|
-
api = {
|
|
7162
8129
|
/**
|
|
7163
8130
|
* No description
|
|
7164
8131
|
*
|
|
7165
|
-
* @tags
|
|
7166
|
-
* @name
|
|
7167
|
-
* @summary Get
|
|
7168
|
-
* @request GET:/api/
|
|
8132
|
+
* @tags AiConversation
|
|
8133
|
+
* @name GetAiConversation
|
|
8134
|
+
* @summary Get conversation with messages
|
|
8135
|
+
* @request GET:/api/ai/conversations/{id}
|
|
7169
8136
|
* @secure
|
|
7170
|
-
* @response `200` `
|
|
8137
|
+
* @response `200` `AiConversationDetail` Success
|
|
8138
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
7171
8139
|
* @response `404` `ProblemDetails` Not Found
|
|
7172
8140
|
*/
|
|
7173
|
-
|
|
7174
|
-
this.request<
|
|
7175
|
-
path: `/api/
|
|
8141
|
+
getAiConversation: (id: string, params: RequestParams = {}) =>
|
|
8142
|
+
this.request<AiConversationDetail, ProblemDetails>({
|
|
8143
|
+
path: `/api/ai/conversations/${id}`,
|
|
7176
8144
|
method: "GET",
|
|
7177
8145
|
secure: true,
|
|
7178
8146
|
format: "json",
|
|
@@ -7182,22 +8150,60 @@ export class Api<
|
|
|
7182
8150
|
/**
|
|
7183
8151
|
* No description
|
|
7184
8152
|
*
|
|
7185
|
-
* @tags
|
|
7186
|
-
* @name
|
|
7187
|
-
* @summary
|
|
7188
|
-
* @request
|
|
8153
|
+
* @tags AiConversation
|
|
8154
|
+
* @name DeleteAiConversation
|
|
8155
|
+
* @summary Delete conversation
|
|
8156
|
+
* @request DELETE:/api/ai/conversations/{id}
|
|
7189
8157
|
* @secure
|
|
7190
|
-
* @response `
|
|
8158
|
+
* @response `204` `void` No Content
|
|
8159
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
7191
8160
|
* @response `404` `ProblemDetails` Not Found
|
|
7192
|
-
* @response `422` `ProblemDetails` Client Error
|
|
7193
8161
|
*/
|
|
7194
|
-
|
|
7195
|
-
|
|
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
|
+
}),
|
|
8169
|
+
|
|
8170
|
+
/**
|
|
8171
|
+
* No description
|
|
8172
|
+
*
|
|
8173
|
+
* @tags AiGuardrail
|
|
8174
|
+
* @name GetAiGuardrails
|
|
8175
|
+
* @summary Get all guardrails
|
|
8176
|
+
* @request GET:/api/ai/admin/guardrails
|
|
8177
|
+
* @secure
|
|
8178
|
+
* @response `200` `(AiGuardrail)[]` Success
|
|
8179
|
+
*/
|
|
8180
|
+
getAiGuardrails: (params: RequestParams = {}) =>
|
|
8181
|
+
this.request<AiGuardrail[], any>({
|
|
8182
|
+
path: `/api/ai/admin/guardrails`,
|
|
8183
|
+
method: "GET",
|
|
8184
|
+
secure: true,
|
|
8185
|
+
format: "json",
|
|
8186
|
+
...params,
|
|
8187
|
+
}),
|
|
8188
|
+
|
|
8189
|
+
/**
|
|
8190
|
+
* No description
|
|
8191
|
+
*
|
|
8192
|
+
* @tags AiGuardrail
|
|
8193
|
+
* @name CreateAiGuardrail
|
|
8194
|
+
* @summary Create custom guardrail
|
|
8195
|
+
* @request POST:/api/ai/admin/guardrails
|
|
8196
|
+
* @secure
|
|
8197
|
+
* @response `201` `AiGuardrail` Created
|
|
8198
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8199
|
+
*/
|
|
8200
|
+
createAiGuardrail: (
|
|
8201
|
+
data: CreateAiGuardrailRequest,
|
|
7196
8202
|
params: RequestParams = {},
|
|
7197
8203
|
) =>
|
|
7198
|
-
this.request<
|
|
7199
|
-
path: `/api/
|
|
7200
|
-
method: "
|
|
8204
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
8205
|
+
path: `/api/ai/admin/guardrails`,
|
|
8206
|
+
method: "POST",
|
|
7201
8207
|
body: data,
|
|
7202
8208
|
secure: true,
|
|
7203
8209
|
type: ContentType.Json,
|
|
@@ -7208,16 +8214,17 @@ export class Api<
|
|
|
7208
8214
|
/**
|
|
7209
8215
|
* No description
|
|
7210
8216
|
*
|
|
7211
|
-
* @tags
|
|
7212
|
-
* @name
|
|
7213
|
-
* @summary Get
|
|
7214
|
-
* @request GET:/api/
|
|
8217
|
+
* @tags AiGuardrail
|
|
8218
|
+
* @name GetAiGuardrail
|
|
8219
|
+
* @summary Get guardrail by ID
|
|
8220
|
+
* @request GET:/api/ai/admin/guardrails/{id}
|
|
7215
8221
|
* @secure
|
|
7216
|
-
* @response `200` `
|
|
8222
|
+
* @response `200` `AiGuardrail` Success
|
|
8223
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7217
8224
|
*/
|
|
7218
|
-
|
|
7219
|
-
this.request<
|
|
7220
|
-
path: `/api/
|
|
8225
|
+
getAiGuardrail: (id: string, params: RequestParams = {}) =>
|
|
8226
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
8227
|
+
path: `/api/ai/admin/guardrails/${id}`,
|
|
7221
8228
|
method: "GET",
|
|
7222
8229
|
secure: true,
|
|
7223
8230
|
format: "json",
|
|
@@ -7227,20 +8234,22 @@ export class Api<
|
|
|
7227
8234
|
/**
|
|
7228
8235
|
* No description
|
|
7229
8236
|
*
|
|
7230
|
-
* @tags
|
|
7231
|
-
* @name
|
|
7232
|
-
* @summary Update
|
|
7233
|
-
* @request PUT:/api/
|
|
8237
|
+
* @tags AiGuardrail
|
|
8238
|
+
* @name UpdateAiGuardrail
|
|
8239
|
+
* @summary Update guardrail
|
|
8240
|
+
* @request PUT:/api/ai/admin/guardrails/{id}
|
|
7234
8241
|
* @secure
|
|
7235
|
-
* @response `200` `
|
|
7236
|
-
* @response `
|
|
8242
|
+
* @response `200` `AiGuardrail` Success
|
|
8243
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8244
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7237
8245
|
*/
|
|
7238
|
-
|
|
7239
|
-
|
|
8246
|
+
updateAiGuardrail: (
|
|
8247
|
+
id: string,
|
|
8248
|
+
data: UpdateAiGuardrailRequest,
|
|
7240
8249
|
params: RequestParams = {},
|
|
7241
8250
|
) =>
|
|
7242
|
-
this.request<
|
|
7243
|
-
path: `/api/
|
|
8251
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
8252
|
+
path: `/api/ai/admin/guardrails/${id}`,
|
|
7244
8253
|
method: "PUT",
|
|
7245
8254
|
body: data,
|
|
7246
8255
|
secure: true,
|
|
@@ -7252,17 +8261,38 @@ export class Api<
|
|
|
7252
8261
|
/**
|
|
7253
8262
|
* No description
|
|
7254
8263
|
*
|
|
7255
|
-
* @tags
|
|
7256
|
-
* @name
|
|
7257
|
-
* @summary
|
|
7258
|
-
* @request
|
|
8264
|
+
* @tags AiGuardrail
|
|
8265
|
+
* @name DeleteAiGuardrail
|
|
8266
|
+
* @summary Delete guardrail
|
|
8267
|
+
* @request DELETE:/api/ai/admin/guardrails/{id}
|
|
7259
8268
|
* @secure
|
|
7260
|
-
* @response `
|
|
8269
|
+
* @response `204` `void` No Content
|
|
8270
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8271
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7261
8272
|
*/
|
|
7262
|
-
|
|
7263
|
-
this.request<
|
|
7264
|
-
path: `/api/
|
|
7265
|
-
method: "
|
|
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
|
|
8288
|
+
* @secure
|
|
8289
|
+
* @response `200` `AiGuardrail` Success
|
|
8290
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8291
|
+
*/
|
|
8292
|
+
toggleAiGuardrail: (id: string, params: RequestParams = {}) =>
|
|
8293
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
8294
|
+
path: `/api/ai/admin/guardrails/${id}/toggle`,
|
|
8295
|
+
method: "PATCH",
|
|
7266
8296
|
secure: true,
|
|
7267
8297
|
format: "json",
|
|
7268
8298
|
...params,
|
|
@@ -7271,21 +8301,24 @@ export class Api<
|
|
|
7271
8301
|
/**
|
|
7272
8302
|
* No description
|
|
7273
8303
|
*
|
|
7274
|
-
* @tags
|
|
7275
|
-
* @name
|
|
7276
|
-
* @summary
|
|
7277
|
-
* @request
|
|
8304
|
+
* @tags AiPrompt
|
|
8305
|
+
* @name GetAvailablePrompts
|
|
8306
|
+
* @summary Get available prompts for current user
|
|
8307
|
+
* @request GET:/api/ai/prompts
|
|
7278
8308
|
* @secure
|
|
7279
|
-
* @response `
|
|
7280
|
-
* @response `422` `ProblemDetails` Client Error
|
|
8309
|
+
* @response `200` `(AiPromptSummary)[]` Success
|
|
7281
8310
|
*/
|
|
7282
|
-
|
|
7283
|
-
|
|
7284
|
-
|
|
7285
|
-
|
|
7286
|
-
|
|
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,
|
|
7287
8321
|
secure: true,
|
|
7288
|
-
type: ContentType.Json,
|
|
7289
8322
|
format: "json",
|
|
7290
8323
|
...params,
|
|
7291
8324
|
}),
|
|
@@ -7293,17 +8326,16 @@ export class Api<
|
|
|
7293
8326
|
/**
|
|
7294
8327
|
* No description
|
|
7295
8328
|
*
|
|
7296
|
-
* @tags
|
|
7297
|
-
* @name
|
|
7298
|
-
* @summary Get
|
|
7299
|
-
* @request GET:/api/
|
|
8329
|
+
* @tags AiUrlSource
|
|
8330
|
+
* @name GetAiUrlSources
|
|
8331
|
+
* @summary Get all URL sources
|
|
8332
|
+
* @request GET:/api/ai/admin/url-sources
|
|
7300
8333
|
* @secure
|
|
7301
|
-
* @response `
|
|
7302
|
-
* @response `422` `ProblemDetails` Client Error
|
|
8334
|
+
* @response `200` `(AiUrlSource)[]` Success
|
|
7303
8335
|
*/
|
|
7304
|
-
|
|
7305
|
-
this.request<
|
|
7306
|
-
path: `/api/
|
|
8336
|
+
getAiUrlSources: (params: RequestParams = {}) =>
|
|
8337
|
+
this.request<AiUrlSource[], any>({
|
|
8338
|
+
path: `/api/ai/admin/url-sources`,
|
|
7307
8339
|
method: "GET",
|
|
7308
8340
|
secure: true,
|
|
7309
8341
|
format: "json",
|
|
@@ -7313,28 +8345,25 @@ export class Api<
|
|
|
7313
8345
|
/**
|
|
7314
8346
|
* No description
|
|
7315
8347
|
*
|
|
7316
|
-
* @tags
|
|
7317
|
-
* @name
|
|
7318
|
-
* @summary
|
|
7319
|
-
* @request
|
|
8348
|
+
* @tags AiUrlSource
|
|
8349
|
+
* @name CreateAiUrlSource
|
|
8350
|
+
* @summary Create URL source
|
|
8351
|
+
* @request POST:/api/ai/admin/url-sources
|
|
7320
8352
|
* @secure
|
|
7321
|
-
* @response `
|
|
7322
|
-
* @response `
|
|
7323
|
-
* @response `
|
|
8353
|
+
* @response `201` `AiUrlSource` Created
|
|
8354
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8355
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7324
8356
|
*/
|
|
7325
|
-
|
|
7326
|
-
|
|
7327
|
-
query?: {
|
|
7328
|
-
/** @default false */
|
|
7329
|
-
hardDelete?: boolean;
|
|
7330
|
-
},
|
|
8357
|
+
createAiUrlSource: (
|
|
8358
|
+
data: CreateAiUrlSourceRequest,
|
|
7331
8359
|
params: RequestParams = {},
|
|
7332
8360
|
) =>
|
|
7333
|
-
this.request<
|
|
7334
|
-
path: `/api/
|
|
7335
|
-
method: "
|
|
7336
|
-
|
|
8361
|
+
this.request<AiUrlSource, ProblemDetails>({
|
|
8362
|
+
path: `/api/ai/admin/url-sources`,
|
|
8363
|
+
method: "POST",
|
|
8364
|
+
body: data,
|
|
7337
8365
|
secure: true,
|
|
8366
|
+
type: ContentType.JsonPatch,
|
|
7338
8367
|
format: "json",
|
|
7339
8368
|
...params,
|
|
7340
8369
|
}),
|
|
@@ -7342,22 +8371,43 @@ export class Api<
|
|
|
7342
8371
|
/**
|
|
7343
8372
|
* No description
|
|
7344
8373
|
*
|
|
7345
|
-
* @tags
|
|
7346
|
-
* @name
|
|
7347
|
-
* @summary
|
|
7348
|
-
* @request
|
|
8374
|
+
* @tags AiUrlSource
|
|
8375
|
+
* @name GetAiUrlSource
|
|
8376
|
+
* @summary Get URL source by ID
|
|
8377
|
+
* @request GET:/api/ai/admin/url-sources/{id}
|
|
7349
8378
|
* @secure
|
|
7350
|
-
* @response `200` `
|
|
8379
|
+
* @response `200` `AiUrlSource` Success
|
|
7351
8380
|
* @response `404` `ProblemDetails` Not Found
|
|
7352
|
-
* @response `422` `ProblemDetails` Client Error
|
|
7353
8381
|
*/
|
|
7354
|
-
|
|
8382
|
+
getAiUrlSource: (id: string, params: RequestParams = {}) =>
|
|
8383
|
+
this.request<AiUrlSource, ProblemDetails>({
|
|
8384
|
+
path: `/api/ai/admin/url-sources/${id}`,
|
|
8385
|
+
method: "GET",
|
|
8386
|
+
secure: true,
|
|
8387
|
+
format: "json",
|
|
8388
|
+
...params,
|
|
8389
|
+
}),
|
|
8390
|
+
|
|
8391
|
+
/**
|
|
8392
|
+
* No description
|
|
8393
|
+
*
|
|
8394
|
+
* @tags AiUrlSource
|
|
8395
|
+
* @name UpdateAiUrlSource
|
|
8396
|
+
* @summary Update URL source
|
|
8397
|
+
* @request PUT:/api/ai/admin/url-sources/{id}
|
|
8398
|
+
* @secure
|
|
8399
|
+
* @response `200` `AiUrlSource` Success
|
|
8400
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
8401
|
+
* @response `404` `ProblemDetails` Not Found
|
|
8402
|
+
* @response `409` `ProblemDetails` Conflict
|
|
8403
|
+
*/
|
|
8404
|
+
updateAiUrlSource: (
|
|
7355
8405
|
id: string,
|
|
7356
|
-
data:
|
|
8406
|
+
data: UpdateAiUrlSourceRequest,
|
|
7357
8407
|
params: RequestParams = {},
|
|
7358
8408
|
) =>
|
|
7359
|
-
this.request<
|
|
7360
|
-
path: `/api/
|
|
8409
|
+
this.request<AiUrlSource, ProblemDetails>({
|
|
8410
|
+
path: `/api/ai/admin/url-sources/${id}`,
|
|
7361
8411
|
method: "PUT",
|
|
7362
8412
|
body: data,
|
|
7363
8413
|
secure: true,
|
|
@@ -7366,6 +8416,45 @@ export class Api<
|
|
|
7366
8416
|
...params,
|
|
7367
8417
|
}),
|
|
7368
8418
|
|
|
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
|
+
|
|
7369
8458
|
/**
|
|
7370
8459
|
* No description
|
|
7371
8460
|
*
|
|
@@ -7394,7 +8483,7 @@ export class Api<
|
|
|
7394
8483
|
query: query,
|
|
7395
8484
|
body: data,
|
|
7396
8485
|
secure: true,
|
|
7397
|
-
type: ContentType.
|
|
8486
|
+
type: ContentType.JsonPatch,
|
|
7398
8487
|
format: "json",
|
|
7399
8488
|
...params,
|
|
7400
8489
|
}),
|
|
@@ -8336,7 +9425,7 @@ export class Api<
|
|
|
8336
9425
|
*/
|
|
8337
9426
|
getCustomFieldDefinitions: (
|
|
8338
9427
|
query?: {
|
|
8339
|
-
entityType?:
|
|
9428
|
+
entityType?: "Loan";
|
|
8340
9429
|
},
|
|
8341
9430
|
params: RequestParams = {},
|
|
8342
9431
|
) =>
|
|
@@ -9799,7 +10888,7 @@ export class Api<
|
|
|
9799
10888
|
method: "PATCH",
|
|
9800
10889
|
body: data,
|
|
9801
10890
|
secure: true,
|
|
9802
|
-
type: ContentType.
|
|
10891
|
+
type: ContentType.JsonPatch,
|
|
9803
10892
|
format: "json",
|
|
9804
10893
|
...params,
|
|
9805
10894
|
}),
|
|
@@ -9909,7 +10998,7 @@ export class Api<
|
|
|
9909
10998
|
method: "PATCH",
|
|
9910
10999
|
body: data,
|
|
9911
11000
|
secure: true,
|
|
9912
|
-
type: ContentType.
|
|
11001
|
+
type: ContentType.JsonPatch,
|
|
9913
11002
|
format: "json",
|
|
9914
11003
|
...params,
|
|
9915
11004
|
}),
|
|
@@ -9936,7 +11025,7 @@ export class Api<
|
|
|
9936
11025
|
method: "PATCH",
|
|
9937
11026
|
body: data,
|
|
9938
11027
|
secure: true,
|
|
9939
|
-
type: ContentType.
|
|
11028
|
+
type: ContentType.JsonPatch,
|
|
9940
11029
|
format: "json",
|
|
9941
11030
|
...params,
|
|
9942
11031
|
}),
|
|
@@ -10178,7 +11267,7 @@ export class Api<
|
|
|
10178
11267
|
method: "PATCH",
|
|
10179
11268
|
body: data,
|
|
10180
11269
|
secure: true,
|
|
10181
|
-
type: ContentType.
|
|
11270
|
+
type: ContentType.JsonPatch,
|
|
10182
11271
|
format: "json",
|
|
10183
11272
|
...params,
|
|
10184
11273
|
}),
|
|
@@ -10258,7 +11347,7 @@ export class Api<
|
|
|
10258
11347
|
method: "PATCH",
|
|
10259
11348
|
body: data,
|
|
10260
11349
|
secure: true,
|
|
10261
|
-
type: ContentType.
|
|
11350
|
+
type: ContentType.JsonPatch,
|
|
10262
11351
|
format: "json",
|
|
10263
11352
|
...params,
|
|
10264
11353
|
}),
|
|
@@ -11117,7 +12206,7 @@ export class Api<
|
|
|
11117
12206
|
* @summary Download By ID
|
|
11118
12207
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
11119
12208
|
* @secure
|
|
11120
|
-
* @response `200` `
|
|
12209
|
+
* @response `200` `string` Success
|
|
11121
12210
|
* @response `404` `ProblemDetails` Not Found
|
|
11122
12211
|
*/
|
|
11123
12212
|
downloadLoanDocument: (
|
|
@@ -11125,7 +12214,7 @@ export class Api<
|
|
|
11125
12214
|
documentId: string,
|
|
11126
12215
|
params: RequestParams = {},
|
|
11127
12216
|
) =>
|
|
11128
|
-
this.request<
|
|
12217
|
+
this.request<string, ProblemDetails>({
|
|
11129
12218
|
path: `/api/loans/${loanId}/documents/${documentId}/download`,
|
|
11130
12219
|
method: "GET",
|
|
11131
12220
|
secure: true,
|
|
@@ -12161,7 +13250,7 @@ export class Api<
|
|
|
12161
13250
|
method: "POST",
|
|
12162
13251
|
body: data,
|
|
12163
13252
|
secure: true,
|
|
12164
|
-
type: ContentType.
|
|
13253
|
+
type: ContentType.JsonPatch,
|
|
12165
13254
|
format: "json",
|
|
12166
13255
|
...params,
|
|
12167
13256
|
}),
|
|
@@ -12916,6 +14005,33 @@ export class Api<
|
|
|
12916
14005
|
...params,
|
|
12917
14006
|
}),
|
|
12918
14007
|
|
|
14008
|
+
/**
|
|
14009
|
+
* No description
|
|
14010
|
+
*
|
|
14011
|
+
* @tags MobileAppReview
|
|
14012
|
+
* @name SeedMobileAppReview
|
|
14013
|
+
* @summary Idempotently seed the test loan officer, site configuration, loan and completed borrower used by mobile app store reviewers.
|
|
14014
|
+
* @request POST:/api/mobile-app-review/seed
|
|
14015
|
+
* @secure
|
|
14016
|
+
* @response `200` `MobileAppReviewSeed` Success
|
|
14017
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
14018
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14019
|
+
* @response `422` `ProblemDetails` Client Error
|
|
14020
|
+
*/
|
|
14021
|
+
seedMobileAppReview: (
|
|
14022
|
+
data: MobileAppReviewSeedRequest,
|
|
14023
|
+
params: RequestParams = {},
|
|
14024
|
+
) =>
|
|
14025
|
+
this.request<MobileAppReviewSeed, ProblemDetails>({
|
|
14026
|
+
path: `/api/mobile-app-review/seed`,
|
|
14027
|
+
method: "POST",
|
|
14028
|
+
body: data,
|
|
14029
|
+
secure: true,
|
|
14030
|
+
type: ContentType.Json,
|
|
14031
|
+
format: "json",
|
|
14032
|
+
...params,
|
|
14033
|
+
}),
|
|
14034
|
+
|
|
12919
14035
|
/**
|
|
12920
14036
|
* No description
|
|
12921
14037
|
*
|
|
@@ -13362,7 +14478,16 @@ export class Api<
|
|
|
13362
14478
|
query?: {
|
|
13363
14479
|
showAll?: boolean;
|
|
13364
14480
|
/** @default "Realtor" */
|
|
13365
|
-
role?:
|
|
14481
|
+
role?:
|
|
14482
|
+
| "Borrower"
|
|
14483
|
+
| "LoanOfficer"
|
|
14484
|
+
| "Admin"
|
|
14485
|
+
| "SuperAdmin"
|
|
14486
|
+
| "Realtor"
|
|
14487
|
+
| "SettlementAgent"
|
|
14488
|
+
| "LoanProcessor"
|
|
14489
|
+
| "LoanOfficerAssistant"
|
|
14490
|
+
| "SystemAdmin";
|
|
13366
14491
|
/** @format int32 */
|
|
13367
14492
|
pageSize?: number;
|
|
13368
14493
|
/** @format int32 */
|
|
@@ -13698,7 +14823,7 @@ export class Api<
|
|
|
13698
14823
|
* @response `404` `ProblemDetails` Not Found
|
|
13699
14824
|
*/
|
|
13700
14825
|
getSamlMetadata: (
|
|
13701
|
-
sSoIntegration:
|
|
14826
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
13702
14827
|
ssoIntegration: string,
|
|
13703
14828
|
params: RequestParams = {},
|
|
13704
14829
|
) =>
|
|
@@ -13720,7 +14845,7 @@ export class Api<
|
|
|
13720
14845
|
* @response `200` `File` Success
|
|
13721
14846
|
*/
|
|
13722
14847
|
createOrReplaceSamlMetadata: (
|
|
13723
|
-
sSoIntegration:
|
|
14848
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
13724
14849
|
ssoIntegration: string,
|
|
13725
14850
|
params: RequestParams = {},
|
|
13726
14851
|
) =>
|