@matech/thebigpos-sdk 2.36.16-rc2 → 2.37.0-aibi-10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +751 -101
- package/dist/index.js +326 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1322 -393
- package/docs/sdk_generation.md +0 -149
package/src/index.ts
CHANGED
|
@@ -340,6 +340,81 @@ export type BorrowerApplicationStatus = "Draft" | "Complete";
|
|
|
340
340
|
|
|
341
341
|
export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
342
342
|
|
|
343
|
+
export type AiStructuredDataType =
|
|
344
|
+
| "Table"
|
|
345
|
+
| "DocumentAnalysis"
|
|
346
|
+
| "DocumentList"
|
|
347
|
+
| "GeneratedDocument";
|
|
348
|
+
|
|
349
|
+
export type AiQueryTemplateName =
|
|
350
|
+
| "PipelineSummary"
|
|
351
|
+
| "LoanDetail"
|
|
352
|
+
| "LoansClosing"
|
|
353
|
+
| "StaleLoans"
|
|
354
|
+
| "LoansByType"
|
|
355
|
+
| "LoansByOfficer"
|
|
356
|
+
| "AverageLoanAmount"
|
|
357
|
+
| "LockedVsUnlocked"
|
|
358
|
+
| "LoansByPurpose"
|
|
359
|
+
| "LoansByPropertyState"
|
|
360
|
+
| "LoansByRate"
|
|
361
|
+
| "DtiLtvRisk"
|
|
362
|
+
| "DisclosureTracking"
|
|
363
|
+
| "NewLoans"
|
|
364
|
+
| "ExpiringLocks"
|
|
365
|
+
| "ClosedLoans";
|
|
366
|
+
|
|
367
|
+
export type AiPromptCategory =
|
|
368
|
+
| "DocumentAnalysis"
|
|
369
|
+
| "DataQuery"
|
|
370
|
+
| "General"
|
|
371
|
+
| "Action";
|
|
372
|
+
|
|
373
|
+
export type AiOutputType = "Text" | "Document";
|
|
374
|
+
|
|
375
|
+
export type AiIntent =
|
|
376
|
+
| "Greeting"
|
|
377
|
+
| "Invalid"
|
|
378
|
+
| "Relevant"
|
|
379
|
+
| "LoanSpecific"
|
|
380
|
+
| "DocumentList"
|
|
381
|
+
| "GeneralKnowledge"
|
|
382
|
+
| "Blocked"
|
|
383
|
+
| "Action";
|
|
384
|
+
|
|
385
|
+
export type AiGuardrailCategory =
|
|
386
|
+
| "ContentSafety"
|
|
387
|
+
| "PromptInjection"
|
|
388
|
+
| "Privacy"
|
|
389
|
+
| "Legal";
|
|
390
|
+
|
|
391
|
+
export type AiDisplayHint =
|
|
392
|
+
| "Table"
|
|
393
|
+
| "SummaryCards"
|
|
394
|
+
| "RankedList"
|
|
395
|
+
| "Comparison"
|
|
396
|
+
| "ExecutiveBrief";
|
|
397
|
+
|
|
398
|
+
export type AiAuditEventType =
|
|
399
|
+
| "Error"
|
|
400
|
+
| "GuardrailBlockedPre"
|
|
401
|
+
| "GuardrailPassedPre"
|
|
402
|
+
| "IntentClassified"
|
|
403
|
+
| "LoanResolvedFromMessage"
|
|
404
|
+
| "DocumentNotFound"
|
|
405
|
+
| "GuardrailBlockedPost"
|
|
406
|
+
| "GuardrailPassedPost"
|
|
407
|
+
| "DocumentAnalyzed"
|
|
408
|
+
| "DocumentList"
|
|
409
|
+
| "DocumentResolutionAmbiguous"
|
|
410
|
+
| "ResponseGenerated"
|
|
411
|
+
| "ParametersExtracted"
|
|
412
|
+
| "QueryExecuted"
|
|
413
|
+
| "LoanContextNotFound"
|
|
414
|
+
| "LoanContextLoaded"
|
|
415
|
+
| "GuardrailBlockedBedrock"
|
|
416
|
+
| "PromptMatched";
|
|
417
|
+
|
|
343
418
|
export type AddressFamily =
|
|
344
419
|
| "Unspecified"
|
|
345
420
|
| "Unix"
|
|
@@ -427,7 +502,7 @@ export interface AccountBilling {
|
|
|
427
502
|
}
|
|
428
503
|
|
|
429
504
|
export interface AccountBillingRequest {
|
|
430
|
-
billingType:
|
|
505
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
431
506
|
/**
|
|
432
507
|
* @format double
|
|
433
508
|
* @min 0
|
|
@@ -442,6 +517,7 @@ export interface AccountSettings {
|
|
|
442
517
|
smsNumber?: string | null;
|
|
443
518
|
ssoHostOverride?: string | null;
|
|
444
519
|
isEarlyAdopter: boolean;
|
|
520
|
+
isAIEnabled: boolean;
|
|
445
521
|
}
|
|
446
522
|
|
|
447
523
|
export interface AccountSettingsRequest {
|
|
@@ -509,7 +585,7 @@ export interface AddressV3 {
|
|
|
509
585
|
|
|
510
586
|
export interface AdminAccessGetForms {
|
|
511
587
|
/** @format date-time */
|
|
512
|
-
createdAt
|
|
588
|
+
createdAt: string;
|
|
513
589
|
/** @format date-time */
|
|
514
590
|
updatedAt?: string | null;
|
|
515
591
|
/** @format date-time */
|
|
@@ -531,7 +607,7 @@ export interface AdminAccessGetForms {
|
|
|
531
607
|
|
|
532
608
|
export interface AdminAccessUser {
|
|
533
609
|
/** @format date-time */
|
|
534
|
-
createdAt
|
|
610
|
+
createdAt: string;
|
|
535
611
|
/** @format date-time */
|
|
536
612
|
updatedAt?: string | null;
|
|
537
613
|
/** @format date-time */
|
|
@@ -652,6 +728,248 @@ export interface AffordabilityCalculatorRequest {
|
|
|
652
728
|
annualInsurance: number;
|
|
653
729
|
}
|
|
654
730
|
|
|
731
|
+
export interface AiAdminStats {
|
|
732
|
+
/** @format int32 */
|
|
733
|
+
totalRequests: number;
|
|
734
|
+
/** @format int32 */
|
|
735
|
+
blockedRequests: number;
|
|
736
|
+
/** @format double */
|
|
737
|
+
averageResponseTimeMs: number;
|
|
738
|
+
intentDistribution: Record<string, number>;
|
|
739
|
+
topQueryTemplates: Record<string, number>;
|
|
740
|
+
period: string;
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
export interface AiAuditLog {
|
|
744
|
+
/** @format uuid */
|
|
745
|
+
id: string;
|
|
746
|
+
/** @format uuid */
|
|
747
|
+
requestId: string;
|
|
748
|
+
/** @format uuid */
|
|
749
|
+
userId: string;
|
|
750
|
+
eventType:
|
|
751
|
+
| "Error"
|
|
752
|
+
| "GuardrailBlockedPre"
|
|
753
|
+
| "GuardrailPassedPre"
|
|
754
|
+
| "IntentClassified"
|
|
755
|
+
| "LoanResolvedFromMessage"
|
|
756
|
+
| "DocumentNotFound"
|
|
757
|
+
| "GuardrailBlockedPost"
|
|
758
|
+
| "GuardrailPassedPost"
|
|
759
|
+
| "DocumentAnalyzed"
|
|
760
|
+
| "DocumentList"
|
|
761
|
+
| "DocumentResolutionAmbiguous"
|
|
762
|
+
| "ResponseGenerated"
|
|
763
|
+
| "ParametersExtracted"
|
|
764
|
+
| "QueryExecuted"
|
|
765
|
+
| "LoanContextNotFound"
|
|
766
|
+
| "LoanContextLoaded"
|
|
767
|
+
| "GuardrailBlockedBedrock"
|
|
768
|
+
| "PromptMatched";
|
|
769
|
+
details?: any;
|
|
770
|
+
/** @format date-time */
|
|
771
|
+
createdAt: string;
|
|
772
|
+
}
|
|
773
|
+
|
|
774
|
+
export interface AiAuditLogPaginated {
|
|
775
|
+
rows: AiAuditLog[];
|
|
776
|
+
pagination: Pagination;
|
|
777
|
+
/** @format int64 */
|
|
778
|
+
count: number;
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
export interface AiCanonicalField {
|
|
782
|
+
/** @format uuid */
|
|
783
|
+
id: string;
|
|
784
|
+
canonicalName: string;
|
|
785
|
+
displayName: string;
|
|
786
|
+
description: string;
|
|
787
|
+
allowedRoles: string[];
|
|
788
|
+
efPath?: string | null;
|
|
789
|
+
isPii: boolean;
|
|
790
|
+
isActive: boolean;
|
|
791
|
+
dataSource: string;
|
|
792
|
+
isDefault: boolean;
|
|
793
|
+
category?: string | null;
|
|
794
|
+
jsonPropertyName?: string | null;
|
|
795
|
+
textractKey?: string | null;
|
|
796
|
+
textractKeyAliases?: string | null;
|
|
797
|
+
hasAccountOverride: boolean;
|
|
798
|
+
/** @format date-time */
|
|
799
|
+
createdAt: string;
|
|
800
|
+
/** @format date-time */
|
|
801
|
+
updatedAt?: string | null;
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
export interface AiChat {
|
|
805
|
+
/** @format uuid */
|
|
806
|
+
conversationId: string;
|
|
807
|
+
/** @format uuid */
|
|
808
|
+
messageId: string;
|
|
809
|
+
response: AiChatBody;
|
|
810
|
+
metadata: AiChatMetadata;
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
export interface AiChatBody {
|
|
814
|
+
text: string;
|
|
815
|
+
data?: AiChatStructuredData | null;
|
|
816
|
+
suggestedFollowUps: string[];
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
export interface AiChatMessage {
|
|
820
|
+
/** @format uuid */
|
|
821
|
+
id: string;
|
|
822
|
+
userMessage: string;
|
|
823
|
+
assistantResponse: string;
|
|
824
|
+
intent?: AiIntent | null;
|
|
825
|
+
fieldsAccessed?: string[] | null;
|
|
826
|
+
/** @format date-time */
|
|
827
|
+
createdAt: string;
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
export interface AiChatMetadata {
|
|
831
|
+
intent:
|
|
832
|
+
| "Greeting"
|
|
833
|
+
| "Invalid"
|
|
834
|
+
| "Relevant"
|
|
835
|
+
| "LoanSpecific"
|
|
836
|
+
| "DocumentList"
|
|
837
|
+
| "GeneralKnowledge"
|
|
838
|
+
| "Blocked"
|
|
839
|
+
| "Action";
|
|
840
|
+
fieldsAccessed: string[];
|
|
841
|
+
/** @format int64 */
|
|
842
|
+
queryTimeMs: number;
|
|
843
|
+
/** @format int64 */
|
|
844
|
+
llmTimeMs: number;
|
|
845
|
+
wasBlocked: boolean;
|
|
846
|
+
blockedReason?: string | null;
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
export interface AiChatRequest {
|
|
850
|
+
/**
|
|
851
|
+
* @minLength 1
|
|
852
|
+
* @maxLength 2000
|
|
853
|
+
*/
|
|
854
|
+
message: string;
|
|
855
|
+
/** @format uuid */
|
|
856
|
+
conversationId?: string | null;
|
|
857
|
+
/** @format uuid */
|
|
858
|
+
loanId?: string | null;
|
|
859
|
+
documentIds?: string[] | null;
|
|
860
|
+
/** @format uuid */
|
|
861
|
+
promptId?: string | null;
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
export interface AiChatStructuredData {
|
|
865
|
+
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
866
|
+
displayHint?: AiDisplayHint | null;
|
|
867
|
+
detectedDocumentType?: string | null;
|
|
868
|
+
columns: string[];
|
|
869
|
+
rows: string[][];
|
|
870
|
+
/** @format uuid */
|
|
871
|
+
generatedDocumentId?: string | null;
|
|
872
|
+
generatedFileName?: string | null;
|
|
873
|
+
}
|
|
874
|
+
|
|
875
|
+
export interface AiConversationDetail {
|
|
876
|
+
/** @format uuid */
|
|
877
|
+
id: string;
|
|
878
|
+
/** @format date-time */
|
|
879
|
+
createdAt: string;
|
|
880
|
+
/** @format date-time */
|
|
881
|
+
updatedAt?: string | null;
|
|
882
|
+
messages: AiChatMessage[];
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
export interface AiConversationListItem {
|
|
886
|
+
/** @format uuid */
|
|
887
|
+
id: string;
|
|
888
|
+
preview: string;
|
|
889
|
+
/** @format int32 */
|
|
890
|
+
messageCount: number;
|
|
891
|
+
/** @format date-time */
|
|
892
|
+
createdAt: string;
|
|
893
|
+
/** @format date-time */
|
|
894
|
+
updatedAt?: string | null;
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
export interface AiConversationListItemPaginated {
|
|
898
|
+
rows: AiConversationListItem[];
|
|
899
|
+
pagination: Pagination;
|
|
900
|
+
/** @format int64 */
|
|
901
|
+
count: number;
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
export interface AiGuardrail {
|
|
905
|
+
/** @format uuid */
|
|
906
|
+
id: string;
|
|
907
|
+
name: string;
|
|
908
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
909
|
+
description?: string | null;
|
|
910
|
+
keywords: string[];
|
|
911
|
+
responseTemplate: string;
|
|
912
|
+
isDefault: boolean;
|
|
913
|
+
isEnabled: boolean;
|
|
914
|
+
hasAccountOverride: boolean;
|
|
915
|
+
/** @format date-time */
|
|
916
|
+
createdAt: string;
|
|
917
|
+
/** @format date-time */
|
|
918
|
+
updatedAt?: string | null;
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
export interface AiPrompt {
|
|
922
|
+
/** @format uuid */
|
|
923
|
+
id: string;
|
|
924
|
+
title: string;
|
|
925
|
+
icon: string;
|
|
926
|
+
slug: string;
|
|
927
|
+
description: string;
|
|
928
|
+
documentTypes: string[];
|
|
929
|
+
applicableGuidelines: string[];
|
|
930
|
+
allowedRoles: string[];
|
|
931
|
+
systemPrompt: string;
|
|
932
|
+
userPromptTemplate: string;
|
|
933
|
+
followUpPrompts: string[];
|
|
934
|
+
/** @format int32 */
|
|
935
|
+
sortOrder: number;
|
|
936
|
+
isDefault: boolean;
|
|
937
|
+
/** @format uuid */
|
|
938
|
+
accountId?: string | null;
|
|
939
|
+
isActive: boolean;
|
|
940
|
+
category?: AiPromptCategory | null;
|
|
941
|
+
queryTemplateName?: AiQueryTemplateName | null;
|
|
942
|
+
displayHint?: AiDisplayHint | null;
|
|
943
|
+
bedrockModelId?: string | null;
|
|
944
|
+
requiredDataSources?: string[] | null;
|
|
945
|
+
outputType?: AiOutputType | null;
|
|
946
|
+
hasAccountOverride: boolean;
|
|
947
|
+
/** @format date-time */
|
|
948
|
+
createdAt: string;
|
|
949
|
+
/** @format date-time */
|
|
950
|
+
updatedAt?: string | null;
|
|
951
|
+
}
|
|
952
|
+
|
|
953
|
+
export interface AiPromptSummary {
|
|
954
|
+
/** @format uuid */
|
|
955
|
+
id: string;
|
|
956
|
+
title: string;
|
|
957
|
+
icon: string;
|
|
958
|
+
slug: string;
|
|
959
|
+
description: string;
|
|
960
|
+
documentTypes: string[];
|
|
961
|
+
applicableGuidelines: string[];
|
|
962
|
+
followUpPrompts: string[];
|
|
963
|
+
/** @format int32 */
|
|
964
|
+
sortOrder: number;
|
|
965
|
+
category?: AiPromptCategory | null;
|
|
966
|
+
queryTemplateName?: AiQueryTemplateName | null;
|
|
967
|
+
displayHint?: AiDisplayHint | null;
|
|
968
|
+
bedrockModelId?: string | null;
|
|
969
|
+
requiredDataSources?: string[] | null;
|
|
970
|
+
outputType?: AiOutputType | null;
|
|
971
|
+
}
|
|
972
|
+
|
|
655
973
|
export interface AllowImpersonationRequest {
|
|
656
974
|
/**
|
|
657
975
|
* @format email
|
|
@@ -792,7 +1110,7 @@ export interface BranchSummary {
|
|
|
792
1110
|
|
|
793
1111
|
export interface BranchUser {
|
|
794
1112
|
/** @format date-time */
|
|
795
|
-
createdAt
|
|
1113
|
+
createdAt: string;
|
|
796
1114
|
/** @format date-time */
|
|
797
1115
|
updatedAt?: string | null;
|
|
798
1116
|
/** @format date-time */
|
|
@@ -956,7 +1274,7 @@ export interface ContactInfo {
|
|
|
956
1274
|
|
|
957
1275
|
export interface Corporate {
|
|
958
1276
|
/** @format date-time */
|
|
959
|
-
createdAt
|
|
1277
|
+
createdAt: string;
|
|
960
1278
|
/** @format date-time */
|
|
961
1279
|
updatedAt?: string | null;
|
|
962
1280
|
/** @format date-time */
|
|
@@ -1002,7 +1320,7 @@ export interface CorporateSearchCriteria {
|
|
|
1002
1320
|
}
|
|
1003
1321
|
|
|
1004
1322
|
export interface CreateAccessScopeRequest {
|
|
1005
|
-
scopeType:
|
|
1323
|
+
scopeType: "User" | "Branch";
|
|
1006
1324
|
/** @format uuid */
|
|
1007
1325
|
userId?: string | null;
|
|
1008
1326
|
/** @format uuid */
|
|
@@ -1026,11 +1344,76 @@ export interface CreateAccountRequest {
|
|
|
1026
1344
|
*/
|
|
1027
1345
|
nlmsid: number;
|
|
1028
1346
|
settings: AccountSettingsRequest;
|
|
1029
|
-
environment:
|
|
1347
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
1030
1348
|
losIntegration: LOSIntegration;
|
|
1031
1349
|
billingSettings: AccountBillingRequest;
|
|
1032
1350
|
}
|
|
1033
1351
|
|
|
1352
|
+
export interface CreateAiCanonicalFieldRequest {
|
|
1353
|
+
/**
|
|
1354
|
+
* @minLength 1
|
|
1355
|
+
* @maxLength 200
|
|
1356
|
+
*/
|
|
1357
|
+
displayName: string;
|
|
1358
|
+
/** @minLength 1 */
|
|
1359
|
+
description: string;
|
|
1360
|
+
/** @minItems 1 */
|
|
1361
|
+
allowedRoles: string[];
|
|
1362
|
+
isPii: boolean;
|
|
1363
|
+
/** @minLength 1 */
|
|
1364
|
+
dataSource: string;
|
|
1365
|
+
category?: string | null;
|
|
1366
|
+
}
|
|
1367
|
+
|
|
1368
|
+
export interface CreateAiGuardrailRequest {
|
|
1369
|
+
/**
|
|
1370
|
+
* @minLength 1
|
|
1371
|
+
* @maxLength 200
|
|
1372
|
+
*/
|
|
1373
|
+
name: string;
|
|
1374
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
1375
|
+
description?: string | null;
|
|
1376
|
+
/** @minItems 1 */
|
|
1377
|
+
keywords: string[];
|
|
1378
|
+
/** @minLength 1 */
|
|
1379
|
+
responseTemplate: string;
|
|
1380
|
+
}
|
|
1381
|
+
|
|
1382
|
+
export interface CreateAiPromptRequest {
|
|
1383
|
+
/**
|
|
1384
|
+
* @minLength 1
|
|
1385
|
+
* @maxLength 200
|
|
1386
|
+
*/
|
|
1387
|
+
title: string;
|
|
1388
|
+
icon: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* @minLength 1
|
|
1391
|
+
* @maxLength 100
|
|
1392
|
+
*/
|
|
1393
|
+
slug: string;
|
|
1394
|
+
/**
|
|
1395
|
+
* @minLength 1
|
|
1396
|
+
* @maxLength 500
|
|
1397
|
+
*/
|
|
1398
|
+
description: string;
|
|
1399
|
+
documentTypes: string[];
|
|
1400
|
+
applicableGuidelines: string[];
|
|
1401
|
+
allowedRoles: string[];
|
|
1402
|
+
/** @minLength 1 */
|
|
1403
|
+
systemPrompt: string;
|
|
1404
|
+
/** @minLength 1 */
|
|
1405
|
+
userPromptTemplate: string;
|
|
1406
|
+
followUpPrompts: string[];
|
|
1407
|
+
/** @format int32 */
|
|
1408
|
+
sortOrder: number;
|
|
1409
|
+
category?: AiPromptCategory | null;
|
|
1410
|
+
queryTemplateName?: AiQueryTemplateName | null;
|
|
1411
|
+
displayHint?: AiDisplayHint | null;
|
|
1412
|
+
bedrockModelId?: string | null;
|
|
1413
|
+
requiredDataSources?: string[] | null;
|
|
1414
|
+
outputType?: AiOutputType | null;
|
|
1415
|
+
}
|
|
1416
|
+
|
|
1034
1417
|
export interface CreateBranchRequest {
|
|
1035
1418
|
/**
|
|
1036
1419
|
* @minLength 1
|
|
@@ -1059,7 +1442,19 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1059
1442
|
export interface CreateGroupMemberRequest {
|
|
1060
1443
|
/** @format uuid */
|
|
1061
1444
|
userId: string;
|
|
1062
|
-
loanRole:
|
|
1445
|
+
loanRole:
|
|
1446
|
+
| "Borrower"
|
|
1447
|
+
| "CoBorrower"
|
|
1448
|
+
| "NonBorrower"
|
|
1449
|
+
| "LoanOfficer"
|
|
1450
|
+
| "LoanProcessor"
|
|
1451
|
+
| "LoanOfficerAssistant"
|
|
1452
|
+
| "SupportingLoanOfficer"
|
|
1453
|
+
| "BuyerAgent"
|
|
1454
|
+
| "SellerAgent"
|
|
1455
|
+
| "TitleInsuranceAgent"
|
|
1456
|
+
| "EscrowAgent"
|
|
1457
|
+
| "SettlementAgent";
|
|
1063
1458
|
}
|
|
1064
1459
|
|
|
1065
1460
|
export interface CreateInviteRequest {
|
|
@@ -1071,7 +1466,7 @@ export interface CreateInviteRequest {
|
|
|
1071
1466
|
emailAddress: string;
|
|
1072
1467
|
phoneNumber?: string | null;
|
|
1073
1468
|
/** @deprecated */
|
|
1074
|
-
relationship:
|
|
1469
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
1075
1470
|
loanID: string;
|
|
1076
1471
|
route?: string | null;
|
|
1077
1472
|
/** @format uuid */
|
|
@@ -1094,7 +1489,7 @@ export interface CreateLoanImportRequest {
|
|
|
1094
1489
|
* @minLength 1
|
|
1095
1490
|
*/
|
|
1096
1491
|
startDate: string;
|
|
1097
|
-
importMode:
|
|
1492
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1098
1493
|
}
|
|
1099
1494
|
|
|
1100
1495
|
export interface CreateSession {
|
|
@@ -1116,7 +1511,19 @@ export interface CreateUserDeviceRequest {
|
|
|
1116
1511
|
}
|
|
1117
1512
|
|
|
1118
1513
|
export interface CreateUserDraft {
|
|
1119
|
-
loanRole:
|
|
1514
|
+
loanRole:
|
|
1515
|
+
| "Borrower"
|
|
1516
|
+
| "CoBorrower"
|
|
1517
|
+
| "NonBorrower"
|
|
1518
|
+
| "LoanOfficer"
|
|
1519
|
+
| "LoanProcessor"
|
|
1520
|
+
| "LoanOfficerAssistant"
|
|
1521
|
+
| "SupportingLoanOfficer"
|
|
1522
|
+
| "BuyerAgent"
|
|
1523
|
+
| "SellerAgent"
|
|
1524
|
+
| "TitleInsuranceAgent"
|
|
1525
|
+
| "EscrowAgent"
|
|
1526
|
+
| "SettlementAgent";
|
|
1120
1527
|
}
|
|
1121
1528
|
|
|
1122
1529
|
export interface CreateUserGroupRequest {
|
|
@@ -1178,7 +1585,7 @@ export interface CustomLoanData {
|
|
|
1178
1585
|
|
|
1179
1586
|
export interface DetailedUser {
|
|
1180
1587
|
/** @format date-time */
|
|
1181
|
-
createdAt
|
|
1588
|
+
createdAt: string;
|
|
1182
1589
|
/** @format date-time */
|
|
1183
1590
|
updatedAt?: string | null;
|
|
1184
1591
|
/** @format date-time */
|
|
@@ -1330,7 +1737,7 @@ export interface DocumentSync {
|
|
|
1330
1737
|
|
|
1331
1738
|
export interface DocumentTemplate {
|
|
1332
1739
|
/** @format date-time */
|
|
1333
|
-
createdAt
|
|
1740
|
+
createdAt: string;
|
|
1334
1741
|
/** @format date-time */
|
|
1335
1742
|
updatedAt?: string | null;
|
|
1336
1743
|
/** @format date-time */
|
|
@@ -1351,7 +1758,7 @@ export interface DocumentTemplate {
|
|
|
1351
1758
|
|
|
1352
1759
|
export interface DocumentTemplateBase {
|
|
1353
1760
|
/** @format date-time */
|
|
1354
|
-
createdAt
|
|
1761
|
+
createdAt: string;
|
|
1355
1762
|
/** @format date-time */
|
|
1356
1763
|
updatedAt?: string | null;
|
|
1357
1764
|
/** @format date-time */
|
|
@@ -1432,7 +1839,7 @@ export interface Draft {
|
|
|
1432
1839
|
siteConfiguration: SiteConfigurationReduced;
|
|
1433
1840
|
/** @format uuid */
|
|
1434
1841
|
loanID?: string | null;
|
|
1435
|
-
type:
|
|
1842
|
+
type: "NewLoan" | "EditLoan";
|
|
1436
1843
|
isCoBorrower: boolean;
|
|
1437
1844
|
}
|
|
1438
1845
|
|
|
@@ -1451,7 +1858,7 @@ export interface DraftContent {
|
|
|
1451
1858
|
siteConfiguration: SiteConfigurationReduced;
|
|
1452
1859
|
/** @format uuid */
|
|
1453
1860
|
loanID?: string | null;
|
|
1454
|
-
type:
|
|
1861
|
+
type: "NewLoan" | "EditLoan";
|
|
1455
1862
|
isCoBorrower: boolean;
|
|
1456
1863
|
applicationPayload: any;
|
|
1457
1864
|
}
|
|
@@ -1483,7 +1890,7 @@ export interface EConsentInformation {
|
|
|
1483
1890
|
|
|
1484
1891
|
export interface EnabledServices {
|
|
1485
1892
|
/** @format date-time */
|
|
1486
|
-
createdAt
|
|
1893
|
+
createdAt: string;
|
|
1487
1894
|
/** @format date-time */
|
|
1488
1895
|
updatedAt?: string | null;
|
|
1489
1896
|
/** @format date-time */
|
|
@@ -1581,8 +1988,15 @@ export interface EncompassRequestLog {
|
|
|
1581
1988
|
losId?: string | null;
|
|
1582
1989
|
/** @format uuid */
|
|
1583
1990
|
accountId: string;
|
|
1584
|
-
operationType:
|
|
1585
|
-
|
|
1991
|
+
operationType:
|
|
1992
|
+
| "FieldUpdate"
|
|
1993
|
+
| "EConsentUpdate"
|
|
1994
|
+
| "DocumentSync"
|
|
1995
|
+
| "MilestoneUpdate"
|
|
1996
|
+
| "DocumentAttachment"
|
|
1997
|
+
| "General"
|
|
1998
|
+
| "FieldReader";
|
|
1999
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1586
2000
|
message: string;
|
|
1587
2001
|
endpoint?: string | null;
|
|
1588
2002
|
httpMethod?: string | null;
|
|
@@ -1653,7 +2067,7 @@ export interface ForcePasswordReset {
|
|
|
1653
2067
|
|
|
1654
2068
|
export interface Form {
|
|
1655
2069
|
/** @format date-time */
|
|
1656
|
-
createdAt
|
|
2070
|
+
createdAt: string;
|
|
1657
2071
|
/** @format date-time */
|
|
1658
2072
|
updatedAt?: string | null;
|
|
1659
2073
|
/** @format date-time */
|
|
@@ -1819,7 +2233,20 @@ export interface FusionFieldDisplay {
|
|
|
1819
2233
|
}
|
|
1820
2234
|
|
|
1821
2235
|
export interface FusionReportFilter {
|
|
1822
|
-
filterType:
|
|
2236
|
+
filterType:
|
|
2237
|
+
| "DateGreaterThanOrEqualTo"
|
|
2238
|
+
| "DateGreaterThan"
|
|
2239
|
+
| "DateLessThan"
|
|
2240
|
+
| "DateLessThanOrEqualTo"
|
|
2241
|
+
| "DateEquals"
|
|
2242
|
+
| "DateDoesntEqual"
|
|
2243
|
+
| "DateNonEmpty"
|
|
2244
|
+
| "DateEmpty"
|
|
2245
|
+
| "StringContains"
|
|
2246
|
+
| "StringEquals"
|
|
2247
|
+
| "StringNotEmpty"
|
|
2248
|
+
| "StringNotEquals"
|
|
2249
|
+
| "StringNotContains";
|
|
1823
2250
|
targetField: string;
|
|
1824
2251
|
targetValue: string;
|
|
1825
2252
|
}
|
|
@@ -1841,13 +2268,26 @@ export interface GenerateDocumentRequest {
|
|
|
1841
2268
|
recipients: string[];
|
|
1842
2269
|
}
|
|
1843
2270
|
|
|
2271
|
+
export interface GenerateSystemPrompt {
|
|
2272
|
+
systemPrompt: string;
|
|
2273
|
+
}
|
|
2274
|
+
|
|
2275
|
+
export interface GenerateSystemPromptRequest {
|
|
2276
|
+
/**
|
|
2277
|
+
* @minLength 1
|
|
2278
|
+
* @maxLength 2000
|
|
2279
|
+
*/
|
|
2280
|
+
description: string;
|
|
2281
|
+
category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
2282
|
+
}
|
|
2283
|
+
|
|
1844
2284
|
export interface GetApplications {
|
|
1845
2285
|
applications: ApplicationRowData[];
|
|
1846
2286
|
}
|
|
1847
2287
|
|
|
1848
2288
|
export interface GetBranch {
|
|
1849
2289
|
/** @format date-time */
|
|
1850
|
-
createdAt
|
|
2290
|
+
createdAt: string;
|
|
1851
2291
|
/** @format date-time */
|
|
1852
2292
|
updatedAt?: string | null;
|
|
1853
2293
|
/** @format date-time */
|
|
@@ -1947,7 +2387,40 @@ export interface GuidPatchOperation {
|
|
|
1947
2387
|
}
|
|
1948
2388
|
|
|
1949
2389
|
export interface IPAddress {
|
|
1950
|
-
addressFamily:
|
|
2390
|
+
addressFamily:
|
|
2391
|
+
| "Unspecified"
|
|
2392
|
+
| "Unix"
|
|
2393
|
+
| "InterNetwork"
|
|
2394
|
+
| "ImpLink"
|
|
2395
|
+
| "Pup"
|
|
2396
|
+
| "Chaos"
|
|
2397
|
+
| "NS"
|
|
2398
|
+
| "Ipx"
|
|
2399
|
+
| "Iso"
|
|
2400
|
+
| "Osi"
|
|
2401
|
+
| "Ecma"
|
|
2402
|
+
| "DataKit"
|
|
2403
|
+
| "Ccitt"
|
|
2404
|
+
| "Sna"
|
|
2405
|
+
| "DecNet"
|
|
2406
|
+
| "DataLink"
|
|
2407
|
+
| "Lat"
|
|
2408
|
+
| "HyperChannel"
|
|
2409
|
+
| "AppleTalk"
|
|
2410
|
+
| "NetBios"
|
|
2411
|
+
| "VoiceView"
|
|
2412
|
+
| "FireFox"
|
|
2413
|
+
| "Banyan"
|
|
2414
|
+
| "Atm"
|
|
2415
|
+
| "InterNetworkV6"
|
|
2416
|
+
| "Cluster"
|
|
2417
|
+
| "Ieee12844"
|
|
2418
|
+
| "Irda"
|
|
2419
|
+
| "NetworkDesigners"
|
|
2420
|
+
| "Max"
|
|
2421
|
+
| "Packet"
|
|
2422
|
+
| "ControllerAreaNetwork"
|
|
2423
|
+
| "Unknown";
|
|
1951
2424
|
/** @format int64 */
|
|
1952
2425
|
scopeId: number;
|
|
1953
2426
|
isIPv6Multicast: boolean;
|
|
@@ -1965,7 +2438,7 @@ export interface IPAddress {
|
|
|
1965
2438
|
|
|
1966
2439
|
export interface ImpersonatedDetailedUser {
|
|
1967
2440
|
/** @format date-time */
|
|
1968
|
-
createdAt
|
|
2441
|
+
createdAt: string;
|
|
1969
2442
|
/** @format date-time */
|
|
1970
2443
|
updatedAt?: string | null;
|
|
1971
2444
|
/** @format date-time */
|
|
@@ -2211,7 +2684,6 @@ export interface Loan {
|
|
|
2211
2684
|
financial?: LoanFinancial | null;
|
|
2212
2685
|
borrowers: LoanBorrower[];
|
|
2213
2686
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2214
|
-
loanLogs: LoanLog[];
|
|
2215
2687
|
userLoans: UserLoan[];
|
|
2216
2688
|
contacts: LoanContact[];
|
|
2217
2689
|
}
|
|
@@ -2271,7 +2743,7 @@ export interface LoanBorrower {
|
|
|
2271
2743
|
citizenship?: LoanCitizenship | null;
|
|
2272
2744
|
maritalStatus?: LoanMaritalStatus | null;
|
|
2273
2745
|
languagePreference?: LoanLanguagePreference | null;
|
|
2274
|
-
applicationStatus:
|
|
2746
|
+
applicationStatus: "Draft" | "Complete";
|
|
2275
2747
|
/** @format int32 */
|
|
2276
2748
|
numberOfDependents?: number | null;
|
|
2277
2749
|
isPrimaryBorrower: boolean;
|
|
@@ -3196,7 +3668,19 @@ export interface LoanContact {
|
|
|
3196
3668
|
email?: string | null;
|
|
3197
3669
|
phone?: string | null;
|
|
3198
3670
|
companyName?: string | null;
|
|
3199
|
-
role:
|
|
3671
|
+
role:
|
|
3672
|
+
| "Borrower"
|
|
3673
|
+
| "CoBorrower"
|
|
3674
|
+
| "NonBorrower"
|
|
3675
|
+
| "LoanOfficer"
|
|
3676
|
+
| "LoanProcessor"
|
|
3677
|
+
| "LoanOfficerAssistant"
|
|
3678
|
+
| "SupportingLoanOfficer"
|
|
3679
|
+
| "BuyerAgent"
|
|
3680
|
+
| "SellerAgent"
|
|
3681
|
+
| "TitleInsuranceAgent"
|
|
3682
|
+
| "EscrowAgent"
|
|
3683
|
+
| "SettlementAgent";
|
|
3200
3684
|
}
|
|
3201
3685
|
|
|
3202
3686
|
export interface LoanContactList {
|
|
@@ -3230,7 +3714,7 @@ export interface LoanDocument {
|
|
|
3230
3714
|
|
|
3231
3715
|
export interface LoanDocumentSearch {
|
|
3232
3716
|
/** @format date-time */
|
|
3233
|
-
createdAt
|
|
3717
|
+
createdAt: string;
|
|
3234
3718
|
/** @format date-time */
|
|
3235
3719
|
updatedAt?: string | null;
|
|
3236
3720
|
/** @format date-time */
|
|
@@ -3332,14 +3816,19 @@ export interface LoanImport {
|
|
|
3332
3816
|
/** @format int32 */
|
|
3333
3817
|
importedCount: number;
|
|
3334
3818
|
statusMessage?: string | null;
|
|
3335
|
-
status:
|
|
3336
|
-
|
|
3819
|
+
status:
|
|
3820
|
+
| "WaitingProcess"
|
|
3821
|
+
| "InProgress"
|
|
3822
|
+
| "Completed"
|
|
3823
|
+
| "Failed"
|
|
3824
|
+
| "Cancelled";
|
|
3825
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
3337
3826
|
/** @format date-time */
|
|
3338
3827
|
createdAt?: string | null;
|
|
3339
3828
|
}
|
|
3340
3829
|
|
|
3341
3830
|
export interface LoanImportLog {
|
|
3342
|
-
level:
|
|
3831
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3343
3832
|
message: string;
|
|
3344
3833
|
/** @format date-time */
|
|
3345
3834
|
createdAt: string;
|
|
@@ -3400,8 +3889,22 @@ export interface LoanListPaginated {
|
|
|
3400
3889
|
export interface LoanLog {
|
|
3401
3890
|
/** @format uuid */
|
|
3402
3891
|
id: string;
|
|
3403
|
-
level:
|
|
3404
|
-
type:
|
|
3892
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3893
|
+
type:
|
|
3894
|
+
| "Loan"
|
|
3895
|
+
| "Queue"
|
|
3896
|
+
| "POSFlagChanged"
|
|
3897
|
+
| "Verification"
|
|
3898
|
+
| "DocumentUploaded"
|
|
3899
|
+
| "LoanCreated"
|
|
3900
|
+
| "WorkflowSubmitted"
|
|
3901
|
+
| "UserInvitationSent"
|
|
3902
|
+
| "CoBorrowerAdded"
|
|
3903
|
+
| "TaskCompleted"
|
|
3904
|
+
| "LoanStatusChanged"
|
|
3905
|
+
| "EConsent"
|
|
3906
|
+
| "SensitiveDataPurge"
|
|
3907
|
+
| "ClosingDateUpdated";
|
|
3405
3908
|
message: string;
|
|
3406
3909
|
/** @format date-time */
|
|
3407
3910
|
createdAt: string;
|
|
@@ -3410,8 +3913,22 @@ export interface LoanLog {
|
|
|
3410
3913
|
export interface LoanLogDetail {
|
|
3411
3914
|
/** @format uuid */
|
|
3412
3915
|
id: string;
|
|
3413
|
-
level:
|
|
3414
|
-
type:
|
|
3916
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3917
|
+
type:
|
|
3918
|
+
| "Loan"
|
|
3919
|
+
| "Queue"
|
|
3920
|
+
| "POSFlagChanged"
|
|
3921
|
+
| "Verification"
|
|
3922
|
+
| "DocumentUploaded"
|
|
3923
|
+
| "LoanCreated"
|
|
3924
|
+
| "WorkflowSubmitted"
|
|
3925
|
+
| "UserInvitationSent"
|
|
3926
|
+
| "CoBorrowerAdded"
|
|
3927
|
+
| "TaskCompleted"
|
|
3928
|
+
| "LoanStatusChanged"
|
|
3929
|
+
| "EConsent"
|
|
3930
|
+
| "SensitiveDataPurge"
|
|
3931
|
+
| "ClosingDateUpdated";
|
|
3415
3932
|
message: string;
|
|
3416
3933
|
/** @format date-time */
|
|
3417
3934
|
createdAt: string;
|
|
@@ -3695,7 +4212,19 @@ export interface LoanUser {
|
|
|
3695
4212
|
email: string;
|
|
3696
4213
|
phone?: string | null;
|
|
3697
4214
|
role: string;
|
|
3698
|
-
loanRole:
|
|
4215
|
+
loanRole:
|
|
4216
|
+
| "Borrower"
|
|
4217
|
+
| "CoBorrower"
|
|
4218
|
+
| "NonBorrower"
|
|
4219
|
+
| "LoanOfficer"
|
|
4220
|
+
| "LoanProcessor"
|
|
4221
|
+
| "LoanOfficerAssistant"
|
|
4222
|
+
| "SupportingLoanOfficer"
|
|
4223
|
+
| "BuyerAgent"
|
|
4224
|
+
| "SellerAgent"
|
|
4225
|
+
| "TitleInsuranceAgent"
|
|
4226
|
+
| "EscrowAgent"
|
|
4227
|
+
| "SettlementAgent";
|
|
3699
4228
|
isUser: boolean;
|
|
3700
4229
|
/** @format date-time */
|
|
3701
4230
|
createdAt: string;
|
|
@@ -3758,7 +4287,7 @@ export interface MilestoneConfigurationRequest {
|
|
|
3758
4287
|
|
|
3759
4288
|
export interface MobileSettings {
|
|
3760
4289
|
/** @format uuid */
|
|
3761
|
-
id
|
|
4290
|
+
id?: string | null;
|
|
3762
4291
|
hasMobile: boolean;
|
|
3763
4292
|
/** @deprecated */
|
|
3764
4293
|
downloadLink?: string | null;
|
|
@@ -3853,7 +4382,7 @@ export interface NoContentResult {
|
|
|
3853
4382
|
|
|
3854
4383
|
export interface NotificationTemplate {
|
|
3855
4384
|
/** @format date-time */
|
|
3856
|
-
createdAt
|
|
4385
|
+
createdAt: string;
|
|
3857
4386
|
/** @format date-time */
|
|
3858
4387
|
updatedAt?: string | null;
|
|
3859
4388
|
/** @format date-time */
|
|
@@ -3878,7 +4407,7 @@ export interface NotificationTemplate {
|
|
|
3878
4407
|
|
|
3879
4408
|
export interface NotificationTemplateBase {
|
|
3880
4409
|
/** @format date-time */
|
|
3881
|
-
createdAt
|
|
4410
|
+
createdAt: string;
|
|
3882
4411
|
/** @format date-time */
|
|
3883
4412
|
updatedAt?: string | null;
|
|
3884
4413
|
/** @format date-time */
|
|
@@ -4340,7 +4869,7 @@ export interface SSOTokenRequest {
|
|
|
4340
4869
|
}
|
|
4341
4870
|
|
|
4342
4871
|
export interface SamlMetadataRequest {
|
|
4343
|
-
ssoIntegration:
|
|
4872
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
4344
4873
|
}
|
|
4345
4874
|
|
|
4346
4875
|
export interface SendForgotPasswordRequest {
|
|
@@ -4372,14 +4901,14 @@ export interface SendNotificationForLoanRequest {
|
|
|
4372
4901
|
|
|
4373
4902
|
export interface SiteConfiguration {
|
|
4374
4903
|
/** @format date-time */
|
|
4375
|
-
createdAt
|
|
4904
|
+
createdAt: string;
|
|
4376
4905
|
/** @format date-time */
|
|
4377
4906
|
updatedAt?: string | null;
|
|
4378
4907
|
/** @format date-time */
|
|
4379
4908
|
deletedAt?: string | null;
|
|
4380
4909
|
/** @format uuid */
|
|
4381
4910
|
id: string;
|
|
4382
|
-
type:
|
|
4911
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4383
4912
|
/** @format uuid */
|
|
4384
4913
|
entityID: string;
|
|
4385
4914
|
/** @format int32 */
|
|
@@ -4567,14 +5096,14 @@ export interface SiteConfiguration {
|
|
|
4567
5096
|
|
|
4568
5097
|
export interface SiteConfigurationByUrl {
|
|
4569
5098
|
/** @format date-time */
|
|
4570
|
-
createdAt
|
|
5099
|
+
createdAt: string;
|
|
4571
5100
|
/** @format date-time */
|
|
4572
5101
|
updatedAt?: string | null;
|
|
4573
5102
|
/** @format date-time */
|
|
4574
5103
|
deletedAt?: string | null;
|
|
4575
5104
|
/** @format uuid */
|
|
4576
5105
|
id: string;
|
|
4577
|
-
type:
|
|
5106
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4578
5107
|
/** @format uuid */
|
|
4579
5108
|
entityID: string;
|
|
4580
5109
|
/** @format int32 */
|
|
@@ -4787,7 +5316,7 @@ export interface SiteConfigurationForm {
|
|
|
4787
5316
|
export interface SiteConfigurationReduced {
|
|
4788
5317
|
/** @format uuid */
|
|
4789
5318
|
id: string;
|
|
4790
|
-
type:
|
|
5319
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4791
5320
|
url?: string | null;
|
|
4792
5321
|
name: string;
|
|
4793
5322
|
/** @format int64 */
|
|
@@ -4805,7 +5334,7 @@ export interface SiteConfigurationRequest {
|
|
|
4805
5334
|
entityID: string;
|
|
4806
5335
|
/** @format int32 */
|
|
4807
5336
|
entityType: number;
|
|
4808
|
-
type:
|
|
5337
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4809
5338
|
url: string;
|
|
4810
5339
|
name: string;
|
|
4811
5340
|
introduction?: string | null;
|
|
@@ -4982,7 +5511,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4982
5511
|
export interface SiteConfigurationSummary {
|
|
4983
5512
|
/** @format uuid */
|
|
4984
5513
|
id: string;
|
|
4985
|
-
type:
|
|
5514
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4986
5515
|
url?: string | null;
|
|
4987
5516
|
name: string;
|
|
4988
5517
|
/** @format int64 */
|
|
@@ -5014,7 +5543,7 @@ export interface SiteConfigurationWithInherited {
|
|
|
5014
5543
|
|
|
5015
5544
|
export interface SocialSurveyRecord {
|
|
5016
5545
|
/** @format date-time */
|
|
5017
|
-
createdAt
|
|
5546
|
+
createdAt: string;
|
|
5018
5547
|
/** @format date-time */
|
|
5019
5548
|
updatedAt?: string | null;
|
|
5020
5549
|
/** @format date-time */
|
|
@@ -5030,6 +5559,14 @@ export interface SocialSurveyRecord {
|
|
|
5030
5559
|
reviewCompletedTimeStamp?: string | null;
|
|
5031
5560
|
}
|
|
5032
5561
|
|
|
5562
|
+
export interface SupportedModel {
|
|
5563
|
+
modelId: string;
|
|
5564
|
+
displayName: string;
|
|
5565
|
+
provider: string;
|
|
5566
|
+
description?: string | null;
|
|
5567
|
+
isDefault: boolean;
|
|
5568
|
+
}
|
|
5569
|
+
|
|
5033
5570
|
export interface SurveyEmailRequest {
|
|
5034
5571
|
/** @minLength 1 */
|
|
5035
5572
|
loanOfficerEmailAddress: string;
|
|
@@ -5290,6 +5827,63 @@ export interface UpdateAccountRequest {
|
|
|
5290
5827
|
settings: AccountSettingsRequest;
|
|
5291
5828
|
}
|
|
5292
5829
|
|
|
5830
|
+
export interface UpdateAiCanonicalFieldRequest {
|
|
5831
|
+
/**
|
|
5832
|
+
* @minLength 1
|
|
5833
|
+
* @maxLength 200
|
|
5834
|
+
*/
|
|
5835
|
+
displayName: string;
|
|
5836
|
+
/** @minLength 1 */
|
|
5837
|
+
description: string;
|
|
5838
|
+
/** @minItems 1 */
|
|
5839
|
+
allowedRoles: string[];
|
|
5840
|
+
isPii: boolean;
|
|
5841
|
+
}
|
|
5842
|
+
|
|
5843
|
+
export interface UpdateAiGuardrailRequest {
|
|
5844
|
+
/**
|
|
5845
|
+
* @minLength 1
|
|
5846
|
+
* @maxLength 200
|
|
5847
|
+
*/
|
|
5848
|
+
name: string;
|
|
5849
|
+
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5850
|
+
description?: string | null;
|
|
5851
|
+
/** @minItems 1 */
|
|
5852
|
+
keywords: string[];
|
|
5853
|
+
/** @minLength 1 */
|
|
5854
|
+
responseTemplate: string;
|
|
5855
|
+
}
|
|
5856
|
+
|
|
5857
|
+
export interface UpdateAiPromptRequest {
|
|
5858
|
+
/**
|
|
5859
|
+
* @minLength 1
|
|
5860
|
+
* @maxLength 200
|
|
5861
|
+
*/
|
|
5862
|
+
title: string;
|
|
5863
|
+
icon: string;
|
|
5864
|
+
/**
|
|
5865
|
+
* @minLength 1
|
|
5866
|
+
* @maxLength 500
|
|
5867
|
+
*/
|
|
5868
|
+
description: string;
|
|
5869
|
+
documentTypes: string[];
|
|
5870
|
+
applicableGuidelines: string[];
|
|
5871
|
+
allowedRoles: string[];
|
|
5872
|
+
/** @minLength 1 */
|
|
5873
|
+
systemPrompt: string;
|
|
5874
|
+
/** @minLength 1 */
|
|
5875
|
+
userPromptTemplate: string;
|
|
5876
|
+
followUpPrompts: string[];
|
|
5877
|
+
/** @format int32 */
|
|
5878
|
+
sortOrder: number;
|
|
5879
|
+
category?: AiPromptCategory | null;
|
|
5880
|
+
queryTemplateName?: AiQueryTemplateName | null;
|
|
5881
|
+
displayHint?: AiDisplayHint | null;
|
|
5882
|
+
bedrockModelId?: string | null;
|
|
5883
|
+
requiredDataSources?: string[] | null;
|
|
5884
|
+
outputType?: AiOutputType | null;
|
|
5885
|
+
}
|
|
5886
|
+
|
|
5293
5887
|
export interface UpdateDocumentTemplateRequest {
|
|
5294
5888
|
/** @minLength 1 */
|
|
5295
5889
|
htmlBody: string;
|
|
@@ -5558,7 +6152,7 @@ export interface UsageReportStatistics {
|
|
|
5558
6152
|
|
|
5559
6153
|
export interface User {
|
|
5560
6154
|
/** @format date-time */
|
|
5561
|
-
createdAt
|
|
6155
|
+
createdAt: string;
|
|
5562
6156
|
/** @format date-time */
|
|
5563
6157
|
updatedAt?: string | null;
|
|
5564
6158
|
/** @format date-time */
|
|
@@ -5608,7 +6202,19 @@ export interface UserDevice {
|
|
|
5608
6202
|
export interface UserDraft {
|
|
5609
6203
|
/** @format uuid */
|
|
5610
6204
|
draftID: string;
|
|
5611
|
-
role:
|
|
6205
|
+
role:
|
|
6206
|
+
| "Borrower"
|
|
6207
|
+
| "CoBorrower"
|
|
6208
|
+
| "NonBorrower"
|
|
6209
|
+
| "LoanOfficer"
|
|
6210
|
+
| "LoanProcessor"
|
|
6211
|
+
| "LoanOfficerAssistant"
|
|
6212
|
+
| "SupportingLoanOfficer"
|
|
6213
|
+
| "BuyerAgent"
|
|
6214
|
+
| "SellerAgent"
|
|
6215
|
+
| "TitleInsuranceAgent"
|
|
6216
|
+
| "EscrowAgent"
|
|
6217
|
+
| "SettlementAgent";
|
|
5612
6218
|
user: User;
|
|
5613
6219
|
}
|
|
5614
6220
|
|
|
@@ -5635,7 +6241,7 @@ export interface UserGroupAccessScope {
|
|
|
5635
6241
|
id: string;
|
|
5636
6242
|
/** @format uuid */
|
|
5637
6243
|
groupId: string;
|
|
5638
|
-
scopeType:
|
|
6244
|
+
scopeType: "User" | "Branch";
|
|
5639
6245
|
/** @format uuid */
|
|
5640
6246
|
userId?: string | null;
|
|
5641
6247
|
/** @format uuid */
|
|
@@ -5671,7 +6277,19 @@ export interface UserLoan {
|
|
|
5671
6277
|
deletedAt?: string | null;
|
|
5672
6278
|
loanID: string;
|
|
5673
6279
|
user: User;
|
|
5674
|
-
role:
|
|
6280
|
+
role:
|
|
6281
|
+
| "Borrower"
|
|
6282
|
+
| "CoBorrower"
|
|
6283
|
+
| "NonBorrower"
|
|
6284
|
+
| "LoanOfficer"
|
|
6285
|
+
| "LoanProcessor"
|
|
6286
|
+
| "LoanOfficerAssistant"
|
|
6287
|
+
| "SupportingLoanOfficer"
|
|
6288
|
+
| "BuyerAgent"
|
|
6289
|
+
| "SellerAgent"
|
|
6290
|
+
| "TitleInsuranceAgent"
|
|
6291
|
+
| "EscrowAgent"
|
|
6292
|
+
| "SettlementAgent";
|
|
5675
6293
|
/** @format int32 */
|
|
5676
6294
|
borrowerPair?: number | null;
|
|
5677
6295
|
/** @format int32 */
|
|
@@ -5684,10 +6302,10 @@ export interface UserLoanConsent {
|
|
|
5684
6302
|
id: string;
|
|
5685
6303
|
/** @format uuid */
|
|
5686
6304
|
userLoanID: string;
|
|
5687
|
-
type:
|
|
6305
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5688
6306
|
providedConsent: boolean;
|
|
5689
6307
|
ipAddress?: string | null;
|
|
5690
|
-
losSyncStatus:
|
|
6308
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
5691
6309
|
/** @format date-time */
|
|
5692
6310
|
createdAt: string;
|
|
5693
6311
|
}
|
|
@@ -5832,7 +6450,16 @@ export interface UserSummary {
|
|
|
5832
6450
|
id: string;
|
|
5833
6451
|
name?: string | null;
|
|
5834
6452
|
email?: string | null;
|
|
5835
|
-
role:
|
|
6453
|
+
role:
|
|
6454
|
+
| "Borrower"
|
|
6455
|
+
| "LoanOfficer"
|
|
6456
|
+
| "Admin"
|
|
6457
|
+
| "SuperAdmin"
|
|
6458
|
+
| "Realtor"
|
|
6459
|
+
| "SettlementAgent"
|
|
6460
|
+
| "LoanProcessor"
|
|
6461
|
+
| "LoanOfficerAssistant"
|
|
6462
|
+
| "SystemAdmin";
|
|
5836
6463
|
}
|
|
5837
6464
|
|
|
5838
6465
|
export interface VerifyPasswordRequest {
|
|
@@ -5868,338 +6495,16 @@ export interface Workflow {
|
|
|
5868
6495
|
icon: string;
|
|
5869
6496
|
}
|
|
5870
6497
|
|
|
5871
|
-
|
|
5872
|
-
|
|
5873
|
-
|
|
6498
|
+
import type {
|
|
6499
|
+
AxiosInstance,
|
|
6500
|
+
AxiosRequestConfig,
|
|
6501
|
+
AxiosResponse,
|
|
6502
|
+
HeadersDefaults,
|
|
6503
|
+
ResponseType,
|
|
6504
|
+
} from "axios";
|
|
6505
|
+
import axios from "axios";
|
|
5874
6506
|
|
|
5875
|
-
export type
|
|
5876
|
-
| "Development"
|
|
5877
|
-
| "Staging"
|
|
5878
|
-
| "UAT"
|
|
5879
|
-
| "Production";
|
|
5880
|
-
|
|
5881
|
-
export type CreateGroupMemberRequestLoanRoleEnum =
|
|
5882
|
-
| "Borrower"
|
|
5883
|
-
| "CoBorrower"
|
|
5884
|
-
| "NonBorrower"
|
|
5885
|
-
| "LoanOfficer"
|
|
5886
|
-
| "LoanProcessor"
|
|
5887
|
-
| "LoanOfficerAssistant"
|
|
5888
|
-
| "SupportingLoanOfficer"
|
|
5889
|
-
| "BuyerAgent"
|
|
5890
|
-
| "SellerAgent"
|
|
5891
|
-
| "TitleInsuranceAgent"
|
|
5892
|
-
| "EscrowAgent"
|
|
5893
|
-
| "SettlementAgent";
|
|
5894
|
-
|
|
5895
|
-
/** @deprecated */
|
|
5896
|
-
export type CreateInviteRequestRelationshipEnum =
|
|
5897
|
-
| "NotApplicable"
|
|
5898
|
-
| "Spouse"
|
|
5899
|
-
| "NonSpouse";
|
|
5900
|
-
|
|
5901
|
-
export type CreateLoanImportRequestImportModeEnum =
|
|
5902
|
-
| "All"
|
|
5903
|
-
| "NewOnly"
|
|
5904
|
-
| "UpdateOnly";
|
|
5905
|
-
|
|
5906
|
-
export type CreateUserDraftLoanRoleEnum =
|
|
5907
|
-
| "Borrower"
|
|
5908
|
-
| "CoBorrower"
|
|
5909
|
-
| "NonBorrower"
|
|
5910
|
-
| "LoanOfficer"
|
|
5911
|
-
| "LoanProcessor"
|
|
5912
|
-
| "LoanOfficerAssistant"
|
|
5913
|
-
| "SupportingLoanOfficer"
|
|
5914
|
-
| "BuyerAgent"
|
|
5915
|
-
| "SellerAgent"
|
|
5916
|
-
| "TitleInsuranceAgent"
|
|
5917
|
-
| "EscrowAgent"
|
|
5918
|
-
| "SettlementAgent";
|
|
5919
|
-
|
|
5920
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5921
|
-
|
|
5922
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5923
|
-
|
|
5924
|
-
export type EncompassRequestLogOperationTypeEnum =
|
|
5925
|
-
| "FieldUpdate"
|
|
5926
|
-
| "EConsentUpdate"
|
|
5927
|
-
| "DocumentSync"
|
|
5928
|
-
| "MilestoneUpdate"
|
|
5929
|
-
| "DocumentAttachment"
|
|
5930
|
-
| "General"
|
|
5931
|
-
| "FieldReader";
|
|
5932
|
-
|
|
5933
|
-
export type EncompassRequestLogOutcomeEnum =
|
|
5934
|
-
| "Success"
|
|
5935
|
-
| "Failure"
|
|
5936
|
-
| "PartialSuccess";
|
|
5937
|
-
|
|
5938
|
-
export type FusionReportFilterFilterTypeEnum =
|
|
5939
|
-
| "DateGreaterThanOrEqualTo"
|
|
5940
|
-
| "DateGreaterThan"
|
|
5941
|
-
| "DateLessThan"
|
|
5942
|
-
| "DateLessThanOrEqualTo"
|
|
5943
|
-
| "DateEquals"
|
|
5944
|
-
| "DateDoesntEqual"
|
|
5945
|
-
| "DateNonEmpty"
|
|
5946
|
-
| "DateEmpty"
|
|
5947
|
-
| "StringContains"
|
|
5948
|
-
| "StringEquals"
|
|
5949
|
-
| "StringNotEmpty"
|
|
5950
|
-
| "StringNotEquals"
|
|
5951
|
-
| "StringNotContains";
|
|
5952
|
-
|
|
5953
|
-
export type IpAddressAddressFamilyEnum =
|
|
5954
|
-
| "Unspecified"
|
|
5955
|
-
| "Unix"
|
|
5956
|
-
| "InterNetwork"
|
|
5957
|
-
| "ImpLink"
|
|
5958
|
-
| "Pup"
|
|
5959
|
-
| "Chaos"
|
|
5960
|
-
| "NS"
|
|
5961
|
-
| "Ipx"
|
|
5962
|
-
| "Iso"
|
|
5963
|
-
| "Osi"
|
|
5964
|
-
| "Ecma"
|
|
5965
|
-
| "DataKit"
|
|
5966
|
-
| "Ccitt"
|
|
5967
|
-
| "Sna"
|
|
5968
|
-
| "DecNet"
|
|
5969
|
-
| "DataLink"
|
|
5970
|
-
| "Lat"
|
|
5971
|
-
| "HyperChannel"
|
|
5972
|
-
| "AppleTalk"
|
|
5973
|
-
| "NetBios"
|
|
5974
|
-
| "VoiceView"
|
|
5975
|
-
| "FireFox"
|
|
5976
|
-
| "Banyan"
|
|
5977
|
-
| "Atm"
|
|
5978
|
-
| "InterNetworkV6"
|
|
5979
|
-
| "Cluster"
|
|
5980
|
-
| "Ieee12844"
|
|
5981
|
-
| "Irda"
|
|
5982
|
-
| "NetworkDesigners"
|
|
5983
|
-
| "Max"
|
|
5984
|
-
| "Packet"
|
|
5985
|
-
| "ControllerAreaNetwork"
|
|
5986
|
-
| "Unknown";
|
|
5987
|
-
|
|
5988
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
5989
|
-
|
|
5990
|
-
export type LoanContactRoleEnum =
|
|
5991
|
-
| "Borrower"
|
|
5992
|
-
| "CoBorrower"
|
|
5993
|
-
| "NonBorrower"
|
|
5994
|
-
| "LoanOfficer"
|
|
5995
|
-
| "LoanProcessor"
|
|
5996
|
-
| "LoanOfficerAssistant"
|
|
5997
|
-
| "SupportingLoanOfficer"
|
|
5998
|
-
| "BuyerAgent"
|
|
5999
|
-
| "SellerAgent"
|
|
6000
|
-
| "TitleInsuranceAgent"
|
|
6001
|
-
| "EscrowAgent"
|
|
6002
|
-
| "SettlementAgent";
|
|
6003
|
-
|
|
6004
|
-
export type LoanImportStatusEnum =
|
|
6005
|
-
| "WaitingProcess"
|
|
6006
|
-
| "InProgress"
|
|
6007
|
-
| "Completed"
|
|
6008
|
-
| "Failed"
|
|
6009
|
-
| "Cancelled";
|
|
6010
|
-
|
|
6011
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6012
|
-
|
|
6013
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6014
|
-
|
|
6015
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6016
|
-
|
|
6017
|
-
export type LoanLogTypeEnum =
|
|
6018
|
-
| "Loan"
|
|
6019
|
-
| "Queue"
|
|
6020
|
-
| "POSFlagChanged"
|
|
6021
|
-
| "Verification"
|
|
6022
|
-
| "DocumentUploaded"
|
|
6023
|
-
| "LoanCreated"
|
|
6024
|
-
| "WorkflowSubmitted"
|
|
6025
|
-
| "UserInvitationSent"
|
|
6026
|
-
| "CoBorrowerAdded"
|
|
6027
|
-
| "TaskCompleted"
|
|
6028
|
-
| "LoanStatusChanged"
|
|
6029
|
-
| "EConsent"
|
|
6030
|
-
| "SensitiveDataPurge"
|
|
6031
|
-
| "ClosingDateUpdated";
|
|
6032
|
-
|
|
6033
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
6034
|
-
|
|
6035
|
-
export type LoanLogDetailTypeEnum =
|
|
6036
|
-
| "Loan"
|
|
6037
|
-
| "Queue"
|
|
6038
|
-
| "POSFlagChanged"
|
|
6039
|
-
| "Verification"
|
|
6040
|
-
| "DocumentUploaded"
|
|
6041
|
-
| "LoanCreated"
|
|
6042
|
-
| "WorkflowSubmitted"
|
|
6043
|
-
| "UserInvitationSent"
|
|
6044
|
-
| "CoBorrowerAdded"
|
|
6045
|
-
| "TaskCompleted"
|
|
6046
|
-
| "LoanStatusChanged"
|
|
6047
|
-
| "EConsent"
|
|
6048
|
-
| "SensitiveDataPurge"
|
|
6049
|
-
| "ClosingDateUpdated";
|
|
6050
|
-
|
|
6051
|
-
export type LoanUserLoanRoleEnum =
|
|
6052
|
-
| "Borrower"
|
|
6053
|
-
| "CoBorrower"
|
|
6054
|
-
| "NonBorrower"
|
|
6055
|
-
| "LoanOfficer"
|
|
6056
|
-
| "LoanProcessor"
|
|
6057
|
-
| "LoanOfficerAssistant"
|
|
6058
|
-
| "SupportingLoanOfficer"
|
|
6059
|
-
| "BuyerAgent"
|
|
6060
|
-
| "SellerAgent"
|
|
6061
|
-
| "TitleInsuranceAgent"
|
|
6062
|
-
| "EscrowAgent"
|
|
6063
|
-
| "SettlementAgent";
|
|
6064
|
-
|
|
6065
|
-
export type SamlMetadataRequestSsoIntegrationEnum =
|
|
6066
|
-
| "ConsumerConnect"
|
|
6067
|
-
| "TheBigPOS"
|
|
6068
|
-
| "POSF";
|
|
6069
|
-
|
|
6070
|
-
export type SiteConfigurationTypeEnum =
|
|
6071
|
-
| "None"
|
|
6072
|
-
| "Account"
|
|
6073
|
-
| "Corporate"
|
|
6074
|
-
| "Branch"
|
|
6075
|
-
| "LoanOfficer"
|
|
6076
|
-
| "Partner";
|
|
6077
|
-
|
|
6078
|
-
export type SiteConfigurationByUrlTypeEnum =
|
|
6079
|
-
| "None"
|
|
6080
|
-
| "Account"
|
|
6081
|
-
| "Corporate"
|
|
6082
|
-
| "Branch"
|
|
6083
|
-
| "LoanOfficer"
|
|
6084
|
-
| "Partner";
|
|
6085
|
-
|
|
6086
|
-
export type SiteConfigurationReducedTypeEnum =
|
|
6087
|
-
| "None"
|
|
6088
|
-
| "Account"
|
|
6089
|
-
| "Corporate"
|
|
6090
|
-
| "Branch"
|
|
6091
|
-
| "LoanOfficer"
|
|
6092
|
-
| "Partner";
|
|
6093
|
-
|
|
6094
|
-
export type SiteConfigurationRequestTypeEnum =
|
|
6095
|
-
| "None"
|
|
6096
|
-
| "Account"
|
|
6097
|
-
| "Corporate"
|
|
6098
|
-
| "Branch"
|
|
6099
|
-
| "LoanOfficer"
|
|
6100
|
-
| "Partner";
|
|
6101
|
-
|
|
6102
|
-
export type SiteConfigurationSummaryTypeEnum =
|
|
6103
|
-
| "None"
|
|
6104
|
-
| "Account"
|
|
6105
|
-
| "Corporate"
|
|
6106
|
-
| "Branch"
|
|
6107
|
-
| "LoanOfficer"
|
|
6108
|
-
| "Partner";
|
|
6109
|
-
|
|
6110
|
-
export type UserDraftRoleEnum =
|
|
6111
|
-
| "Borrower"
|
|
6112
|
-
| "CoBorrower"
|
|
6113
|
-
| "NonBorrower"
|
|
6114
|
-
| "LoanOfficer"
|
|
6115
|
-
| "LoanProcessor"
|
|
6116
|
-
| "LoanOfficerAssistant"
|
|
6117
|
-
| "SupportingLoanOfficer"
|
|
6118
|
-
| "BuyerAgent"
|
|
6119
|
-
| "SellerAgent"
|
|
6120
|
-
| "TitleInsuranceAgent"
|
|
6121
|
-
| "EscrowAgent"
|
|
6122
|
-
| "SettlementAgent";
|
|
6123
|
-
|
|
6124
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6125
|
-
|
|
6126
|
-
export type UserLoanRoleEnum =
|
|
6127
|
-
| "Borrower"
|
|
6128
|
-
| "CoBorrower"
|
|
6129
|
-
| "NonBorrower"
|
|
6130
|
-
| "LoanOfficer"
|
|
6131
|
-
| "LoanProcessor"
|
|
6132
|
-
| "LoanOfficerAssistant"
|
|
6133
|
-
| "SupportingLoanOfficer"
|
|
6134
|
-
| "BuyerAgent"
|
|
6135
|
-
| "SellerAgent"
|
|
6136
|
-
| "TitleInsuranceAgent"
|
|
6137
|
-
| "EscrowAgent"
|
|
6138
|
-
| "SettlementAgent";
|
|
6139
|
-
|
|
6140
|
-
export type UserLoanConsentTypeEnum =
|
|
6141
|
-
| "Econsent"
|
|
6142
|
-
| "CreditAuthorization"
|
|
6143
|
-
| "Tcpa";
|
|
6144
|
-
|
|
6145
|
-
export type UserLoanConsentLosSyncStatusEnum =
|
|
6146
|
-
| "NotStarted"
|
|
6147
|
-
| "Failed"
|
|
6148
|
-
| "Success";
|
|
6149
|
-
|
|
6150
|
-
export type UserSummaryRoleEnum =
|
|
6151
|
-
| "Borrower"
|
|
6152
|
-
| "LoanOfficer"
|
|
6153
|
-
| "Admin"
|
|
6154
|
-
| "SuperAdmin"
|
|
6155
|
-
| "Realtor"
|
|
6156
|
-
| "SettlementAgent"
|
|
6157
|
-
| "LoanProcessor"
|
|
6158
|
-
| "LoanOfficerAssistant"
|
|
6159
|
-
| "SystemAdmin";
|
|
6160
|
-
|
|
6161
|
-
/** @default "Realtor" */
|
|
6162
|
-
export type GetPartnersParamsRoleEnum =
|
|
6163
|
-
| "Borrower"
|
|
6164
|
-
| "LoanOfficer"
|
|
6165
|
-
| "Admin"
|
|
6166
|
-
| "SuperAdmin"
|
|
6167
|
-
| "Realtor"
|
|
6168
|
-
| "SettlementAgent"
|
|
6169
|
-
| "LoanProcessor"
|
|
6170
|
-
| "LoanOfficerAssistant"
|
|
6171
|
-
| "SystemAdmin";
|
|
6172
|
-
|
|
6173
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
6174
|
-
| "ConsumerConnect"
|
|
6175
|
-
| "TheBigPOS"
|
|
6176
|
-
| "POSF";
|
|
6177
|
-
|
|
6178
|
-
export type GetSamlMetadataParamsEnum =
|
|
6179
|
-
| "ConsumerConnect"
|
|
6180
|
-
| "TheBigPOS"
|
|
6181
|
-
| "POSF";
|
|
6182
|
-
|
|
6183
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
|
|
6184
|
-
| "ConsumerConnect"
|
|
6185
|
-
| "TheBigPOS"
|
|
6186
|
-
| "POSF";
|
|
6187
|
-
|
|
6188
|
-
export type CreateOrReplaceSamlMetadataParamsEnum =
|
|
6189
|
-
| "ConsumerConnect"
|
|
6190
|
-
| "TheBigPOS"
|
|
6191
|
-
| "POSF";
|
|
6192
|
-
|
|
6193
|
-
import type {
|
|
6194
|
-
AxiosInstance,
|
|
6195
|
-
AxiosRequestConfig,
|
|
6196
|
-
AxiosResponse,
|
|
6197
|
-
HeadersDefaults,
|
|
6198
|
-
ResponseType,
|
|
6199
|
-
} from "axios";
|
|
6200
|
-
import axios from "axios";
|
|
6201
|
-
|
|
6202
|
-
export type QueryParamsType = Record<string | number, any>;
|
|
6507
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
6203
6508
|
|
|
6204
6509
|
export interface FullRequestParams
|
|
6205
6510
|
extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -6368,7 +6673,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
6368
6673
|
|
|
6369
6674
|
/**
|
|
6370
6675
|
* @title The Big POS API
|
|
6371
|
-
* @version v2.
|
|
6676
|
+
* @version v2.37.0
|
|
6372
6677
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6373
6678
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6374
6679
|
*/
|
|
@@ -6620,8 +6925,623 @@ export class Api<
|
|
|
6620
6925
|
/**
|
|
6621
6926
|
* No description
|
|
6622
6927
|
*
|
|
6623
|
-
* @tags
|
|
6624
|
-
* @name
|
|
6928
|
+
* @tags AiAdmin
|
|
6929
|
+
* @name GetAiAuditLogs
|
|
6930
|
+
* @summary Get paginated audit logs
|
|
6931
|
+
* @request GET:/api/ai/admin/audit-logs
|
|
6932
|
+
* @secure
|
|
6933
|
+
* @response `200` `AiAuditLogPaginated` Success
|
|
6934
|
+
*/
|
|
6935
|
+
getAiAuditLogs: (
|
|
6936
|
+
query?: {
|
|
6937
|
+
eventType?: AiAuditEventType;
|
|
6938
|
+
/** @format date-time */
|
|
6939
|
+
startDate?: string;
|
|
6940
|
+
/** @format date-time */
|
|
6941
|
+
endDate?: string;
|
|
6942
|
+
/** @format int32 */
|
|
6943
|
+
pageSize?: number;
|
|
6944
|
+
/** @format int32 */
|
|
6945
|
+
pageNumber?: number;
|
|
6946
|
+
sortBy?: string;
|
|
6947
|
+
sortDirection?: string;
|
|
6948
|
+
},
|
|
6949
|
+
params: RequestParams = {},
|
|
6950
|
+
) =>
|
|
6951
|
+
this.request<AiAuditLogPaginated, any>({
|
|
6952
|
+
path: `/api/ai/admin/audit-logs`,
|
|
6953
|
+
method: "GET",
|
|
6954
|
+
query: query,
|
|
6955
|
+
secure: true,
|
|
6956
|
+
format: "json",
|
|
6957
|
+
...params,
|
|
6958
|
+
}),
|
|
6959
|
+
|
|
6960
|
+
/**
|
|
6961
|
+
* No description
|
|
6962
|
+
*
|
|
6963
|
+
* @tags AiAdmin
|
|
6964
|
+
* @name GetAiAdminStats
|
|
6965
|
+
* @summary Get AI admin dashboard stats
|
|
6966
|
+
* @request GET:/api/ai/admin/stats
|
|
6967
|
+
* @secure
|
|
6968
|
+
* @response `200` `AiAdminStats` Success
|
|
6969
|
+
*/
|
|
6970
|
+
getAiAdminStats: (
|
|
6971
|
+
query?: {
|
|
6972
|
+
/** @format date-time */
|
|
6973
|
+
startDate?: string;
|
|
6974
|
+
/** @format date-time */
|
|
6975
|
+
endDate?: string;
|
|
6976
|
+
},
|
|
6977
|
+
params: RequestParams = {},
|
|
6978
|
+
) =>
|
|
6979
|
+
this.request<AiAdminStats, any>({
|
|
6980
|
+
path: `/api/ai/admin/stats`,
|
|
6981
|
+
method: "GET",
|
|
6982
|
+
query: query,
|
|
6983
|
+
secure: true,
|
|
6984
|
+
format: "json",
|
|
6985
|
+
...params,
|
|
6986
|
+
}),
|
|
6987
|
+
|
|
6988
|
+
/**
|
|
6989
|
+
* No description
|
|
6990
|
+
*
|
|
6991
|
+
* @tags AiAdminPrompt
|
|
6992
|
+
* @name GetAiPrompts
|
|
6993
|
+
* @summary Get all prompts
|
|
6994
|
+
* @request GET:/api/ai/admin/prompts
|
|
6995
|
+
* @secure
|
|
6996
|
+
* @response `200` `(AiPrompt)[]` Success
|
|
6997
|
+
*/
|
|
6998
|
+
getAiPrompts: (params: RequestParams = {}) =>
|
|
6999
|
+
this.request<AiPrompt[], any>({
|
|
7000
|
+
path: `/api/ai/admin/prompts`,
|
|
7001
|
+
method: "GET",
|
|
7002
|
+
secure: true,
|
|
7003
|
+
format: "json",
|
|
7004
|
+
...params,
|
|
7005
|
+
}),
|
|
7006
|
+
|
|
7007
|
+
/**
|
|
7008
|
+
* No description
|
|
7009
|
+
*
|
|
7010
|
+
* @tags AiAdminPrompt
|
|
7011
|
+
* @name CreateAiPrompt
|
|
7012
|
+
* @summary Create custom prompt
|
|
7013
|
+
* @request POST:/api/ai/admin/prompts
|
|
7014
|
+
* @secure
|
|
7015
|
+
* @response `201` `AiPrompt` Created
|
|
7016
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7017
|
+
*/
|
|
7018
|
+
createAiPrompt: (data: CreateAiPromptRequest, params: RequestParams = {}) =>
|
|
7019
|
+
this.request<AiPrompt, ProblemDetails>({
|
|
7020
|
+
path: `/api/ai/admin/prompts`,
|
|
7021
|
+
method: "POST",
|
|
7022
|
+
body: data,
|
|
7023
|
+
secure: true,
|
|
7024
|
+
type: ContentType.Json,
|
|
7025
|
+
format: "json",
|
|
7026
|
+
...params,
|
|
7027
|
+
}),
|
|
7028
|
+
|
|
7029
|
+
/**
|
|
7030
|
+
* No description
|
|
7031
|
+
*
|
|
7032
|
+
* @tags AiAdminPrompt
|
|
7033
|
+
* @name GetAiPrompt
|
|
7034
|
+
* @summary Get prompt by ID
|
|
7035
|
+
* @request GET:/api/ai/admin/prompts/{id}
|
|
7036
|
+
* @secure
|
|
7037
|
+
* @response `200` `AiPrompt` Success
|
|
7038
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7039
|
+
*/
|
|
7040
|
+
getAiPrompt: (id: string, params: RequestParams = {}) =>
|
|
7041
|
+
this.request<AiPrompt, ProblemDetails>({
|
|
7042
|
+
path: `/api/ai/admin/prompts/${id}`,
|
|
7043
|
+
method: "GET",
|
|
7044
|
+
secure: true,
|
|
7045
|
+
format: "json",
|
|
7046
|
+
...params,
|
|
7047
|
+
}),
|
|
7048
|
+
|
|
7049
|
+
/**
|
|
7050
|
+
* No description
|
|
7051
|
+
*
|
|
7052
|
+
* @tags AiAdminPrompt
|
|
7053
|
+
* @name UpdateAiPrompt
|
|
7054
|
+
* @summary Update prompt
|
|
7055
|
+
* @request PUT:/api/ai/admin/prompts/{id}
|
|
7056
|
+
* @secure
|
|
7057
|
+
* @response `200` `AiPrompt` Success
|
|
7058
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7059
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7060
|
+
*/
|
|
7061
|
+
updateAiPrompt: (
|
|
7062
|
+
id: string,
|
|
7063
|
+
data: UpdateAiPromptRequest,
|
|
7064
|
+
params: RequestParams = {},
|
|
7065
|
+
) =>
|
|
7066
|
+
this.request<AiPrompt, ProblemDetails>({
|
|
7067
|
+
path: `/api/ai/admin/prompts/${id}`,
|
|
7068
|
+
method: "PUT",
|
|
7069
|
+
body: data,
|
|
7070
|
+
secure: true,
|
|
7071
|
+
type: ContentType.Json,
|
|
7072
|
+
format: "json",
|
|
7073
|
+
...params,
|
|
7074
|
+
}),
|
|
7075
|
+
|
|
7076
|
+
/**
|
|
7077
|
+
* No description
|
|
7078
|
+
*
|
|
7079
|
+
* @tags AiAdminPrompt
|
|
7080
|
+
* @name DeleteAiPrompt
|
|
7081
|
+
* @summary Delete prompt
|
|
7082
|
+
* @request DELETE:/api/ai/admin/prompts/{id}
|
|
7083
|
+
* @secure
|
|
7084
|
+
* @response `204` `void` No Content
|
|
7085
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7086
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7087
|
+
*/
|
|
7088
|
+
deleteAiPrompt: (id: string, params: RequestParams = {}) =>
|
|
7089
|
+
this.request<void, ProblemDetails>({
|
|
7090
|
+
path: `/api/ai/admin/prompts/${id}`,
|
|
7091
|
+
method: "DELETE",
|
|
7092
|
+
secure: true,
|
|
7093
|
+
...params,
|
|
7094
|
+
}),
|
|
7095
|
+
|
|
7096
|
+
/**
|
|
7097
|
+
* No description
|
|
7098
|
+
*
|
|
7099
|
+
* @tags AiAdminPrompt
|
|
7100
|
+
* @name ToggleAiPrompt
|
|
7101
|
+
* @summary Toggle prompt active/inactive
|
|
7102
|
+
* @request PATCH:/api/ai/admin/prompts/{id}/toggle
|
|
7103
|
+
* @secure
|
|
7104
|
+
* @response `200` `AiPrompt` Success
|
|
7105
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7106
|
+
*/
|
|
7107
|
+
toggleAiPrompt: (id: string, params: RequestParams = {}) =>
|
|
7108
|
+
this.request<AiPrompt, ProblemDetails>({
|
|
7109
|
+
path: `/api/ai/admin/prompts/${id}/toggle`,
|
|
7110
|
+
method: "PATCH",
|
|
7111
|
+
secure: true,
|
|
7112
|
+
format: "json",
|
|
7113
|
+
...params,
|
|
7114
|
+
}),
|
|
7115
|
+
|
|
7116
|
+
/**
|
|
7117
|
+
* No description
|
|
7118
|
+
*
|
|
7119
|
+
* @tags AiAdminPrompt
|
|
7120
|
+
* @name GenerateAiSystemPrompt
|
|
7121
|
+
* @summary Generate a system prompt from description
|
|
7122
|
+
* @request POST:/api/ai/admin/prompts/generate
|
|
7123
|
+
* @secure
|
|
7124
|
+
* @response `200` `GenerateSystemPrompt` Success
|
|
7125
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7126
|
+
*/
|
|
7127
|
+
generateAiSystemPrompt: (
|
|
7128
|
+
data: GenerateSystemPromptRequest,
|
|
7129
|
+
params: RequestParams = {},
|
|
7130
|
+
) =>
|
|
7131
|
+
this.request<GenerateSystemPrompt, ProblemDetails>({
|
|
7132
|
+
path: `/api/ai/admin/prompts/generate`,
|
|
7133
|
+
method: "POST",
|
|
7134
|
+
body: data,
|
|
7135
|
+
secure: true,
|
|
7136
|
+
type: ContentType.JsonPatch,
|
|
7137
|
+
format: "json",
|
|
7138
|
+
...params,
|
|
7139
|
+
}),
|
|
7140
|
+
|
|
7141
|
+
/**
|
|
7142
|
+
* No description
|
|
7143
|
+
*
|
|
7144
|
+
* @tags AiAdminPrompt
|
|
7145
|
+
* @name GetSupportedModels
|
|
7146
|
+
* @summary Get supported LLM models
|
|
7147
|
+
* @request GET:/api/ai/admin/prompts/supported-models
|
|
7148
|
+
* @secure
|
|
7149
|
+
* @response `200` `(SupportedModel)[]` Success
|
|
7150
|
+
*/
|
|
7151
|
+
getSupportedModels: (params: RequestParams = {}) =>
|
|
7152
|
+
this.request<SupportedModel[], any>({
|
|
7153
|
+
path: `/api/ai/admin/prompts/supported-models`,
|
|
7154
|
+
method: "GET",
|
|
7155
|
+
secure: true,
|
|
7156
|
+
format: "json",
|
|
7157
|
+
...params,
|
|
7158
|
+
}),
|
|
7159
|
+
|
|
7160
|
+
/**
|
|
7161
|
+
* No description
|
|
7162
|
+
*
|
|
7163
|
+
* @tags AiCanonicalField
|
|
7164
|
+
* @name GetAiCanonicalFields
|
|
7165
|
+
* @summary Get all canonical fields
|
|
7166
|
+
* @request GET:/api/ai/admin/fields
|
|
7167
|
+
* @secure
|
|
7168
|
+
* @response `200` `(AiCanonicalField)[]` Success
|
|
7169
|
+
*/
|
|
7170
|
+
getAiCanonicalFields: (params: RequestParams = {}) =>
|
|
7171
|
+
this.request<AiCanonicalField[], any>({
|
|
7172
|
+
path: `/api/ai/admin/fields`,
|
|
7173
|
+
method: "GET",
|
|
7174
|
+
secure: true,
|
|
7175
|
+
format: "json",
|
|
7176
|
+
...params,
|
|
7177
|
+
}),
|
|
7178
|
+
|
|
7179
|
+
/**
|
|
7180
|
+
* No description
|
|
7181
|
+
*
|
|
7182
|
+
* @tags AiCanonicalField
|
|
7183
|
+
* @name CreateAiCanonicalField
|
|
7184
|
+
* @summary Create canonical field
|
|
7185
|
+
* @request POST:/api/ai/admin/fields
|
|
7186
|
+
* @secure
|
|
7187
|
+
* @response `201` `AiCanonicalField` Created
|
|
7188
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7189
|
+
*/
|
|
7190
|
+
createAiCanonicalField: (
|
|
7191
|
+
data: CreateAiCanonicalFieldRequest,
|
|
7192
|
+
params: RequestParams = {},
|
|
7193
|
+
) =>
|
|
7194
|
+
this.request<AiCanonicalField, ProblemDetails>({
|
|
7195
|
+
path: `/api/ai/admin/fields`,
|
|
7196
|
+
method: "POST",
|
|
7197
|
+
body: data,
|
|
7198
|
+
secure: true,
|
|
7199
|
+
type: ContentType.Json,
|
|
7200
|
+
format: "json",
|
|
7201
|
+
...params,
|
|
7202
|
+
}),
|
|
7203
|
+
|
|
7204
|
+
/**
|
|
7205
|
+
* No description
|
|
7206
|
+
*
|
|
7207
|
+
* @tags AiCanonicalField
|
|
7208
|
+
* @name GetAiCanonicalField
|
|
7209
|
+
* @summary Get canonical field by ID
|
|
7210
|
+
* @request GET:/api/ai/admin/fields/{id}
|
|
7211
|
+
* @secure
|
|
7212
|
+
* @response `200` `AiCanonicalField` Success
|
|
7213
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7214
|
+
*/
|
|
7215
|
+
getAiCanonicalField: (id: string, params: RequestParams = {}) =>
|
|
7216
|
+
this.request<AiCanonicalField, ProblemDetails>({
|
|
7217
|
+
path: `/api/ai/admin/fields/${id}`,
|
|
7218
|
+
method: "GET",
|
|
7219
|
+
secure: true,
|
|
7220
|
+
format: "json",
|
|
7221
|
+
...params,
|
|
7222
|
+
}),
|
|
7223
|
+
|
|
7224
|
+
/**
|
|
7225
|
+
* No description
|
|
7226
|
+
*
|
|
7227
|
+
* @tags AiCanonicalField
|
|
7228
|
+
* @name UpdateAiCanonicalField
|
|
7229
|
+
* @summary Update canonical field
|
|
7230
|
+
* @request PUT:/api/ai/admin/fields/{id}
|
|
7231
|
+
* @secure
|
|
7232
|
+
* @response `200` `AiCanonicalField` Success
|
|
7233
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7234
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7235
|
+
*/
|
|
7236
|
+
updateAiCanonicalField: (
|
|
7237
|
+
id: string,
|
|
7238
|
+
data: UpdateAiCanonicalFieldRequest,
|
|
7239
|
+
params: RequestParams = {},
|
|
7240
|
+
) =>
|
|
7241
|
+
this.request<AiCanonicalField, ProblemDetails>({
|
|
7242
|
+
path: `/api/ai/admin/fields/${id}`,
|
|
7243
|
+
method: "PUT",
|
|
7244
|
+
body: data,
|
|
7245
|
+
secure: true,
|
|
7246
|
+
type: ContentType.Json,
|
|
7247
|
+
format: "json",
|
|
7248
|
+
...params,
|
|
7249
|
+
}),
|
|
7250
|
+
|
|
7251
|
+
/**
|
|
7252
|
+
* No description
|
|
7253
|
+
*
|
|
7254
|
+
* @tags AiCanonicalField
|
|
7255
|
+
* @name DeleteAiCanonicalField
|
|
7256
|
+
* @summary Delete canonical field
|
|
7257
|
+
* @request DELETE:/api/ai/admin/fields/{id}
|
|
7258
|
+
* @secure
|
|
7259
|
+
* @response `204` `void` No Content
|
|
7260
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7261
|
+
*/
|
|
7262
|
+
deleteAiCanonicalField: (id: string, params: RequestParams = {}) =>
|
|
7263
|
+
this.request<void, ProblemDetails>({
|
|
7264
|
+
path: `/api/ai/admin/fields/${id}`,
|
|
7265
|
+
method: "DELETE",
|
|
7266
|
+
secure: true,
|
|
7267
|
+
...params,
|
|
7268
|
+
}),
|
|
7269
|
+
|
|
7270
|
+
/**
|
|
7271
|
+
* No description
|
|
7272
|
+
*
|
|
7273
|
+
* @tags AiCanonicalField
|
|
7274
|
+
* @name ToggleAiCanonicalField
|
|
7275
|
+
* @summary Toggle canonical field active/inactive
|
|
7276
|
+
* @request PATCH:/api/ai/admin/fields/{id}/toggle
|
|
7277
|
+
* @secure
|
|
7278
|
+
* @response `200` `AiCanonicalField` Success
|
|
7279
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7280
|
+
*/
|
|
7281
|
+
toggleAiCanonicalField: (id: string, params: RequestParams = {}) =>
|
|
7282
|
+
this.request<AiCanonicalField, ProblemDetails>({
|
|
7283
|
+
path: `/api/ai/admin/fields/${id}/toggle`,
|
|
7284
|
+
method: "PATCH",
|
|
7285
|
+
secure: true,
|
|
7286
|
+
format: "json",
|
|
7287
|
+
...params,
|
|
7288
|
+
}),
|
|
7289
|
+
|
|
7290
|
+
/**
|
|
7291
|
+
* No description
|
|
7292
|
+
*
|
|
7293
|
+
* @tags AiChat
|
|
7294
|
+
* @name AiChat
|
|
7295
|
+
* @summary Send AI chat message
|
|
7296
|
+
* @request POST:/api/ai/chat
|
|
7297
|
+
* @secure
|
|
7298
|
+
* @response `200` `AiChat` Success
|
|
7299
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7300
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
7301
|
+
*/
|
|
7302
|
+
aiChat: (data: AiChatRequest, params: RequestParams = {}) =>
|
|
7303
|
+
this.request<AiChat, ProblemDetails>({
|
|
7304
|
+
path: `/api/ai/chat`,
|
|
7305
|
+
method: "POST",
|
|
7306
|
+
body: data,
|
|
7307
|
+
secure: true,
|
|
7308
|
+
type: ContentType.JsonPatch,
|
|
7309
|
+
format: "json",
|
|
7310
|
+
...params,
|
|
7311
|
+
}),
|
|
7312
|
+
|
|
7313
|
+
/**
|
|
7314
|
+
* No description
|
|
7315
|
+
*
|
|
7316
|
+
* @tags AiConversation
|
|
7317
|
+
* @name GetAiConversations
|
|
7318
|
+
* @summary Get user conversations
|
|
7319
|
+
* @request GET:/api/ai/conversations
|
|
7320
|
+
* @secure
|
|
7321
|
+
* @response `200` `AiConversationListItemPaginated` Success
|
|
7322
|
+
*/
|
|
7323
|
+
getAiConversations: (
|
|
7324
|
+
query?: {
|
|
7325
|
+
/** @format int32 */
|
|
7326
|
+
pageSize?: number;
|
|
7327
|
+
/** @format int32 */
|
|
7328
|
+
pageNumber?: number;
|
|
7329
|
+
sortBy?: string;
|
|
7330
|
+
sortDirection?: string;
|
|
7331
|
+
},
|
|
7332
|
+
params: RequestParams = {},
|
|
7333
|
+
) =>
|
|
7334
|
+
this.request<AiConversationListItemPaginated, any>({
|
|
7335
|
+
path: `/api/ai/conversations`,
|
|
7336
|
+
method: "GET",
|
|
7337
|
+
query: query,
|
|
7338
|
+
secure: true,
|
|
7339
|
+
format: "json",
|
|
7340
|
+
...params,
|
|
7341
|
+
}),
|
|
7342
|
+
|
|
7343
|
+
/**
|
|
7344
|
+
* No description
|
|
7345
|
+
*
|
|
7346
|
+
* @tags AiConversation
|
|
7347
|
+
* @name GetAiConversation
|
|
7348
|
+
* @summary Get conversation with messages
|
|
7349
|
+
* @request GET:/api/ai/conversations/{id}
|
|
7350
|
+
* @secure
|
|
7351
|
+
* @response `200` `AiConversationDetail` Success
|
|
7352
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
7353
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7354
|
+
*/
|
|
7355
|
+
getAiConversation: (id: string, params: RequestParams = {}) =>
|
|
7356
|
+
this.request<AiConversationDetail, ProblemDetails>({
|
|
7357
|
+
path: `/api/ai/conversations/${id}`,
|
|
7358
|
+
method: "GET",
|
|
7359
|
+
secure: true,
|
|
7360
|
+
format: "json",
|
|
7361
|
+
...params,
|
|
7362
|
+
}),
|
|
7363
|
+
|
|
7364
|
+
/**
|
|
7365
|
+
* No description
|
|
7366
|
+
*
|
|
7367
|
+
* @tags AiConversation
|
|
7368
|
+
* @name DeleteAiConversation
|
|
7369
|
+
* @summary Delete conversation
|
|
7370
|
+
* @request DELETE:/api/ai/conversations/{id}
|
|
7371
|
+
* @secure
|
|
7372
|
+
* @response `204` `void` No Content
|
|
7373
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
7374
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7375
|
+
*/
|
|
7376
|
+
deleteAiConversation: (id: string, params: RequestParams = {}) =>
|
|
7377
|
+
this.request<void, ProblemDetails>({
|
|
7378
|
+
path: `/api/ai/conversations/${id}`,
|
|
7379
|
+
method: "DELETE",
|
|
7380
|
+
secure: true,
|
|
7381
|
+
...params,
|
|
7382
|
+
}),
|
|
7383
|
+
|
|
7384
|
+
/**
|
|
7385
|
+
* No description
|
|
7386
|
+
*
|
|
7387
|
+
* @tags AiGuardrail
|
|
7388
|
+
* @name GetAiGuardrails
|
|
7389
|
+
* @summary Get all guardrails
|
|
7390
|
+
* @request GET:/api/ai/admin/guardrails
|
|
7391
|
+
* @secure
|
|
7392
|
+
* @response `200` `(AiGuardrail)[]` Success
|
|
7393
|
+
*/
|
|
7394
|
+
getAiGuardrails: (params: RequestParams = {}) =>
|
|
7395
|
+
this.request<AiGuardrail[], any>({
|
|
7396
|
+
path: `/api/ai/admin/guardrails`,
|
|
7397
|
+
method: "GET",
|
|
7398
|
+
secure: true,
|
|
7399
|
+
format: "json",
|
|
7400
|
+
...params,
|
|
7401
|
+
}),
|
|
7402
|
+
|
|
7403
|
+
/**
|
|
7404
|
+
* No description
|
|
7405
|
+
*
|
|
7406
|
+
* @tags AiGuardrail
|
|
7407
|
+
* @name CreateAiGuardrail
|
|
7408
|
+
* @summary Create custom guardrail
|
|
7409
|
+
* @request POST:/api/ai/admin/guardrails
|
|
7410
|
+
* @secure
|
|
7411
|
+
* @response `201` `AiGuardrail` Created
|
|
7412
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7413
|
+
*/
|
|
7414
|
+
createAiGuardrail: (
|
|
7415
|
+
data: CreateAiGuardrailRequest,
|
|
7416
|
+
params: RequestParams = {},
|
|
7417
|
+
) =>
|
|
7418
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
7419
|
+
path: `/api/ai/admin/guardrails`,
|
|
7420
|
+
method: "POST",
|
|
7421
|
+
body: data,
|
|
7422
|
+
secure: true,
|
|
7423
|
+
type: ContentType.Json,
|
|
7424
|
+
format: "json",
|
|
7425
|
+
...params,
|
|
7426
|
+
}),
|
|
7427
|
+
|
|
7428
|
+
/**
|
|
7429
|
+
* No description
|
|
7430
|
+
*
|
|
7431
|
+
* @tags AiGuardrail
|
|
7432
|
+
* @name GetAiGuardrail
|
|
7433
|
+
* @summary Get guardrail by ID
|
|
7434
|
+
* @request GET:/api/ai/admin/guardrails/{id}
|
|
7435
|
+
* @secure
|
|
7436
|
+
* @response `200` `AiGuardrail` Success
|
|
7437
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7438
|
+
*/
|
|
7439
|
+
getAiGuardrail: (id: string, params: RequestParams = {}) =>
|
|
7440
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
7441
|
+
path: `/api/ai/admin/guardrails/${id}`,
|
|
7442
|
+
method: "GET",
|
|
7443
|
+
secure: true,
|
|
7444
|
+
format: "json",
|
|
7445
|
+
...params,
|
|
7446
|
+
}),
|
|
7447
|
+
|
|
7448
|
+
/**
|
|
7449
|
+
* No description
|
|
7450
|
+
*
|
|
7451
|
+
* @tags AiGuardrail
|
|
7452
|
+
* @name UpdateAiGuardrail
|
|
7453
|
+
* @summary Update guardrail
|
|
7454
|
+
* @request PUT:/api/ai/admin/guardrails/{id}
|
|
7455
|
+
* @secure
|
|
7456
|
+
* @response `200` `AiGuardrail` Success
|
|
7457
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7458
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7459
|
+
*/
|
|
7460
|
+
updateAiGuardrail: (
|
|
7461
|
+
id: string,
|
|
7462
|
+
data: UpdateAiGuardrailRequest,
|
|
7463
|
+
params: RequestParams = {},
|
|
7464
|
+
) =>
|
|
7465
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
7466
|
+
path: `/api/ai/admin/guardrails/${id}`,
|
|
7467
|
+
method: "PUT",
|
|
7468
|
+
body: data,
|
|
7469
|
+
secure: true,
|
|
7470
|
+
type: ContentType.Json,
|
|
7471
|
+
format: "json",
|
|
7472
|
+
...params,
|
|
7473
|
+
}),
|
|
7474
|
+
|
|
7475
|
+
/**
|
|
7476
|
+
* No description
|
|
7477
|
+
*
|
|
7478
|
+
* @tags AiGuardrail
|
|
7479
|
+
* @name DeleteAiGuardrail
|
|
7480
|
+
* @summary Delete guardrail
|
|
7481
|
+
* @request DELETE:/api/ai/admin/guardrails/{id}
|
|
7482
|
+
* @secure
|
|
7483
|
+
* @response `204` `void` No Content
|
|
7484
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7485
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7486
|
+
*/
|
|
7487
|
+
deleteAiGuardrail: (id: string, params: RequestParams = {}) =>
|
|
7488
|
+
this.request<void, ProblemDetails>({
|
|
7489
|
+
path: `/api/ai/admin/guardrails/${id}`,
|
|
7490
|
+
method: "DELETE",
|
|
7491
|
+
secure: true,
|
|
7492
|
+
...params,
|
|
7493
|
+
}),
|
|
7494
|
+
|
|
7495
|
+
/**
|
|
7496
|
+
* No description
|
|
7497
|
+
*
|
|
7498
|
+
* @tags AiGuardrail
|
|
7499
|
+
* @name ToggleAiGuardrail
|
|
7500
|
+
* @summary Toggle guardrail enabled/disabled
|
|
7501
|
+
* @request PATCH:/api/ai/admin/guardrails/{id}/toggle
|
|
7502
|
+
* @secure
|
|
7503
|
+
* @response `200` `AiGuardrail` Success
|
|
7504
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7505
|
+
*/
|
|
7506
|
+
toggleAiGuardrail: (id: string, params: RequestParams = {}) =>
|
|
7507
|
+
this.request<AiGuardrail, ProblemDetails>({
|
|
7508
|
+
path: `/api/ai/admin/guardrails/${id}/toggle`,
|
|
7509
|
+
method: "PATCH",
|
|
7510
|
+
secure: true,
|
|
7511
|
+
format: "json",
|
|
7512
|
+
...params,
|
|
7513
|
+
}),
|
|
7514
|
+
|
|
7515
|
+
/**
|
|
7516
|
+
* No description
|
|
7517
|
+
*
|
|
7518
|
+
* @tags AiPrompt
|
|
7519
|
+
* @name GetAvailablePrompts
|
|
7520
|
+
* @summary Get available prompts for current user
|
|
7521
|
+
* @request GET:/api/ai/prompts
|
|
7522
|
+
* @secure
|
|
7523
|
+
* @response `200` `(AiPromptSummary)[]` Success
|
|
7524
|
+
*/
|
|
7525
|
+
getAvailablePrompts: (
|
|
7526
|
+
query?: {
|
|
7527
|
+
documentType?: string;
|
|
7528
|
+
},
|
|
7529
|
+
params: RequestParams = {},
|
|
7530
|
+
) =>
|
|
7531
|
+
this.request<AiPromptSummary[], any>({
|
|
7532
|
+
path: `/api/ai/prompts`,
|
|
7533
|
+
method: "GET",
|
|
7534
|
+
query: query,
|
|
7535
|
+
secure: true,
|
|
7536
|
+
format: "json",
|
|
7537
|
+
...params,
|
|
7538
|
+
}),
|
|
7539
|
+
|
|
7540
|
+
/**
|
|
7541
|
+
* No description
|
|
7542
|
+
*
|
|
7543
|
+
* @tags Authentication
|
|
7544
|
+
* @name GetTokenFromRefreshToken
|
|
6625
7545
|
* @summary Generate Token From Refresh Token
|
|
6626
7546
|
* @request POST:/api/refresh-token
|
|
6627
7547
|
* @secure
|
|
@@ -6638,7 +7558,7 @@ export class Api<
|
|
|
6638
7558
|
method: "POST",
|
|
6639
7559
|
body: data,
|
|
6640
7560
|
secure: true,
|
|
6641
|
-
type: ContentType.
|
|
7561
|
+
type: ContentType.JsonPatch,
|
|
6642
7562
|
format: "json",
|
|
6643
7563
|
...params,
|
|
6644
7564
|
}),
|
|
@@ -11670,7 +12590,16 @@ export class Api<
|
|
|
11670
12590
|
query?: {
|
|
11671
12591
|
showAll?: boolean;
|
|
11672
12592
|
/** @default "Realtor" */
|
|
11673
|
-
role?:
|
|
12593
|
+
role?:
|
|
12594
|
+
| "Borrower"
|
|
12595
|
+
| "LoanOfficer"
|
|
12596
|
+
| "Admin"
|
|
12597
|
+
| "SuperAdmin"
|
|
12598
|
+
| "Realtor"
|
|
12599
|
+
| "SettlementAgent"
|
|
12600
|
+
| "LoanProcessor"
|
|
12601
|
+
| "LoanOfficerAssistant"
|
|
12602
|
+
| "SystemAdmin";
|
|
11674
12603
|
/** @format int32 */
|
|
11675
12604
|
pageSize?: number;
|
|
11676
12605
|
/** @format int32 */
|
|
@@ -12006,7 +12935,7 @@ export class Api<
|
|
|
12006
12935
|
* @response `404` `ProblemDetails` Not Found
|
|
12007
12936
|
*/
|
|
12008
12937
|
getSamlMetadata: (
|
|
12009
|
-
sSoIntegration:
|
|
12938
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
12010
12939
|
ssoIntegration: string,
|
|
12011
12940
|
params: RequestParams = {},
|
|
12012
12941
|
) =>
|
|
@@ -12028,7 +12957,7 @@ export class Api<
|
|
|
12028
12957
|
* @response `200` `File` Success
|
|
12029
12958
|
*/
|
|
12030
12959
|
createOrReplaceSamlMetadata: (
|
|
12031
|
-
sSoIntegration:
|
|
12960
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
|
|
12032
12961
|
ssoIntegration: string,
|
|
12033
12962
|
params: RequestParams = {},
|
|
12034
12963
|
) =>
|