@matech/thebigpos-sdk 2.40.3-aibi-1 → 2.40.4-rc1
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 +71 -835
- package/dist/index.js +38 -402
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +253 -1428
package/dist/index.d.ts
CHANGED
|
@@ -53,6 +53,7 @@ export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
|
53
53
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
54
54
|
export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
|
|
55
55
|
export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
56
|
+
export type EncompassEnvironment = "Production" | "UAT";
|
|
56
57
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
57
58
|
export type CustomFieldEntityType = "Loan";
|
|
58
59
|
export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
@@ -64,17 +65,7 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
|
64
65
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
65
66
|
export type BorrowerApplicationStatus = "Draft" | "Complete";
|
|
66
67
|
export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
67
|
-
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
|
|
68
|
-
export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
|
|
69
|
-
export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
70
|
-
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
71
|
-
export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans";
|
|
72
|
-
export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
73
|
-
export type AiOutputType = "Text" | "Document";
|
|
74
|
-
export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
|
|
75
|
-
export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
76
|
-
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
77
|
-
export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
|
|
68
|
+
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
78
69
|
export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
|
|
79
70
|
export interface ASOSettings {
|
|
80
71
|
enabled: boolean;
|
|
@@ -133,13 +124,31 @@ export interface AccountBillingRequest {
|
|
|
133
124
|
*/
|
|
134
125
|
contractedRate: number;
|
|
135
126
|
}
|
|
127
|
+
export interface AccountDeactivated {
|
|
128
|
+
accountDeactivated: boolean;
|
|
129
|
+
email: string;
|
|
130
|
+
}
|
|
131
|
+
export interface AccountReactivationCompleteRequest {
|
|
132
|
+
/** @format uuid */
|
|
133
|
+
token: string;
|
|
134
|
+
/** @minLength 8 */
|
|
135
|
+
newPassword: string;
|
|
136
|
+
}
|
|
137
|
+
export interface AccountReactivationRequest {
|
|
138
|
+
/**
|
|
139
|
+
* @format email
|
|
140
|
+
* @minLength 1
|
|
141
|
+
*/
|
|
142
|
+
email: string;
|
|
143
|
+
/** @format uuid */
|
|
144
|
+
siteConfigurationId: string;
|
|
145
|
+
}
|
|
136
146
|
export interface AccountSettings {
|
|
137
147
|
isSmsEnabled: boolean;
|
|
138
148
|
isLoanEditEnabled: boolean;
|
|
139
149
|
smsNumber?: string | null;
|
|
140
150
|
ssoHostOverride?: string | null;
|
|
141
151
|
isEarlyAdopter: boolean;
|
|
142
|
-
isAIEnabled: boolean;
|
|
143
152
|
}
|
|
144
153
|
export interface AccountSettingsRequest {
|
|
145
154
|
isSmsEnabled: boolean;
|
|
@@ -340,220 +349,6 @@ export interface AffordabilityCalculatorRequest {
|
|
|
340
349
|
*/
|
|
341
350
|
annualInsurance: number;
|
|
342
351
|
}
|
|
343
|
-
export interface AiAdminStats {
|
|
344
|
-
/** @format int32 */
|
|
345
|
-
totalRequests: number;
|
|
346
|
-
/** @format int32 */
|
|
347
|
-
blockedRequests: number;
|
|
348
|
-
/** @format double */
|
|
349
|
-
averageResponseTimeMs: number;
|
|
350
|
-
intentDistribution: Record<string, number>;
|
|
351
|
-
topQueryTemplates: Record<string, number>;
|
|
352
|
-
period: string;
|
|
353
|
-
}
|
|
354
|
-
export interface AiAuditLog {
|
|
355
|
-
/** @format uuid */
|
|
356
|
-
id: string;
|
|
357
|
-
/** @format uuid */
|
|
358
|
-
requestId: string;
|
|
359
|
-
/** @format uuid */
|
|
360
|
-
userId: string;
|
|
361
|
-
eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
|
|
362
|
-
details?: any;
|
|
363
|
-
/** @format date-time */
|
|
364
|
-
createdAt: string;
|
|
365
|
-
}
|
|
366
|
-
export interface AiAuditLogPaginated {
|
|
367
|
-
rows: AiAuditLog[];
|
|
368
|
-
pagination: Pagination;
|
|
369
|
-
/** @format int64 */
|
|
370
|
-
count: number;
|
|
371
|
-
}
|
|
372
|
-
export interface AiCanonicalField {
|
|
373
|
-
/** @format uuid */
|
|
374
|
-
id: string;
|
|
375
|
-
canonicalName: string;
|
|
376
|
-
displayName: string;
|
|
377
|
-
description: string;
|
|
378
|
-
allowedRoles: string[];
|
|
379
|
-
efPath?: string | null;
|
|
380
|
-
isPii: boolean;
|
|
381
|
-
isActive: boolean;
|
|
382
|
-
dataSource: string;
|
|
383
|
-
isDefault: boolean;
|
|
384
|
-
category?: string | null;
|
|
385
|
-
jsonPropertyName?: string | null;
|
|
386
|
-
textractKey?: string | null;
|
|
387
|
-
textractKeyAliases?: string | null;
|
|
388
|
-
hasAccountOverride: boolean;
|
|
389
|
-
/** @format date-time */
|
|
390
|
-
createdAt: string;
|
|
391
|
-
/** @format date-time */
|
|
392
|
-
updatedAt?: string | null;
|
|
393
|
-
}
|
|
394
|
-
export interface AiChat {
|
|
395
|
-
/** @format uuid */
|
|
396
|
-
conversationId: string;
|
|
397
|
-
/** @format uuid */
|
|
398
|
-
messageId: string;
|
|
399
|
-
response: AiChatBody;
|
|
400
|
-
metadata: AiChatMetadata;
|
|
401
|
-
}
|
|
402
|
-
export interface AiChatBody {
|
|
403
|
-
text: string;
|
|
404
|
-
data?: AiChatStructuredData | null;
|
|
405
|
-
suggestedFollowUps: string[];
|
|
406
|
-
}
|
|
407
|
-
export interface AiChatMessage {
|
|
408
|
-
/** @format uuid */
|
|
409
|
-
id: string;
|
|
410
|
-
userMessage: string;
|
|
411
|
-
assistantResponse: string;
|
|
412
|
-
intent?: AiIntent | null;
|
|
413
|
-
fieldsAccessed?: string[] | null;
|
|
414
|
-
/** @format date-time */
|
|
415
|
-
createdAt: string;
|
|
416
|
-
}
|
|
417
|
-
export interface AiChatMetadata {
|
|
418
|
-
intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
|
|
419
|
-
fieldsAccessed: string[];
|
|
420
|
-
/** @format int64 */
|
|
421
|
-
queryTimeMs: number;
|
|
422
|
-
/** @format int64 */
|
|
423
|
-
llmTimeMs: number;
|
|
424
|
-
wasBlocked: boolean;
|
|
425
|
-
blockedReason?: string | null;
|
|
426
|
-
}
|
|
427
|
-
export interface AiChatRequest {
|
|
428
|
-
/**
|
|
429
|
-
* @minLength 1
|
|
430
|
-
* @maxLength 2000
|
|
431
|
-
*/
|
|
432
|
-
message: string;
|
|
433
|
-
/** @format uuid */
|
|
434
|
-
conversationId?: string | null;
|
|
435
|
-
/** @format uuid */
|
|
436
|
-
loanId?: string | null;
|
|
437
|
-
documentIds?: string[] | null;
|
|
438
|
-
/** @format uuid */
|
|
439
|
-
promptId?: string | null;
|
|
440
|
-
}
|
|
441
|
-
export interface AiChatStructuredData {
|
|
442
|
-
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
443
|
-
displayHint?: AiDisplayHint | null;
|
|
444
|
-
detectedDocumentType?: string | null;
|
|
445
|
-
columns: string[];
|
|
446
|
-
rows: string[][];
|
|
447
|
-
/** @format uuid */
|
|
448
|
-
generatedDocumentId?: string | null;
|
|
449
|
-
generatedFileName?: string | null;
|
|
450
|
-
}
|
|
451
|
-
export interface AiConversationDetail {
|
|
452
|
-
/** @format uuid */
|
|
453
|
-
id: string;
|
|
454
|
-
/** @format date-time */
|
|
455
|
-
createdAt: string;
|
|
456
|
-
/** @format date-time */
|
|
457
|
-
updatedAt?: string | null;
|
|
458
|
-
messages: AiChatMessage[];
|
|
459
|
-
}
|
|
460
|
-
export interface AiConversationListItem {
|
|
461
|
-
/** @format uuid */
|
|
462
|
-
id: string;
|
|
463
|
-
preview: string;
|
|
464
|
-
/** @format int32 */
|
|
465
|
-
messageCount: number;
|
|
466
|
-
/** @format date-time */
|
|
467
|
-
createdAt: string;
|
|
468
|
-
/** @format date-time */
|
|
469
|
-
updatedAt?: string | null;
|
|
470
|
-
}
|
|
471
|
-
export interface AiConversationListItemPaginated {
|
|
472
|
-
rows: AiConversationListItem[];
|
|
473
|
-
pagination: Pagination;
|
|
474
|
-
/** @format int64 */
|
|
475
|
-
count: number;
|
|
476
|
-
}
|
|
477
|
-
export interface AiGuardrail {
|
|
478
|
-
/** @format uuid */
|
|
479
|
-
id: string;
|
|
480
|
-
name: string;
|
|
481
|
-
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
482
|
-
description?: string | null;
|
|
483
|
-
keywords: string[];
|
|
484
|
-
responseTemplate: string;
|
|
485
|
-
isDefault: boolean;
|
|
486
|
-
isEnabled: boolean;
|
|
487
|
-
hasAccountOverride: boolean;
|
|
488
|
-
/** @format date-time */
|
|
489
|
-
createdAt: string;
|
|
490
|
-
/** @format date-time */
|
|
491
|
-
updatedAt?: string | null;
|
|
492
|
-
}
|
|
493
|
-
export interface AiPrompt {
|
|
494
|
-
/** @format uuid */
|
|
495
|
-
id: string;
|
|
496
|
-
title: string;
|
|
497
|
-
icon: string;
|
|
498
|
-
slug: string;
|
|
499
|
-
description: string;
|
|
500
|
-
documentTypes: string[];
|
|
501
|
-
applicableGuidelines: string[];
|
|
502
|
-
allowedRoles: string[];
|
|
503
|
-
systemPrompt: string;
|
|
504
|
-
userPromptTemplate: string;
|
|
505
|
-
followUpPrompts: string[];
|
|
506
|
-
/** @format int32 */
|
|
507
|
-
sortOrder: number;
|
|
508
|
-
isDefault: boolean;
|
|
509
|
-
/** @format uuid */
|
|
510
|
-
accountId?: string | null;
|
|
511
|
-
isActive: boolean;
|
|
512
|
-
category?: AiPromptCategory | null;
|
|
513
|
-
queryTemplateName?: AiQueryTemplateName | null;
|
|
514
|
-
displayHint?: AiDisplayHint | null;
|
|
515
|
-
bedrockModelId?: string | null;
|
|
516
|
-
requiredDataSources?: string[] | null;
|
|
517
|
-
outputType?: AiOutputType | null;
|
|
518
|
-
hasAccountOverride: boolean;
|
|
519
|
-
/** @format date-time */
|
|
520
|
-
createdAt: string;
|
|
521
|
-
/** @format date-time */
|
|
522
|
-
updatedAt?: string | null;
|
|
523
|
-
}
|
|
524
|
-
export interface AiPromptSummary {
|
|
525
|
-
/** @format uuid */
|
|
526
|
-
id: string;
|
|
527
|
-
title: string;
|
|
528
|
-
icon: string;
|
|
529
|
-
slug: string;
|
|
530
|
-
description: string;
|
|
531
|
-
documentTypes: string[];
|
|
532
|
-
applicableGuidelines: string[];
|
|
533
|
-
followUpPrompts: string[];
|
|
534
|
-
/** @format int32 */
|
|
535
|
-
sortOrder: number;
|
|
536
|
-
category?: AiPromptCategory | null;
|
|
537
|
-
queryTemplateName?: AiQueryTemplateName | null;
|
|
538
|
-
displayHint?: AiDisplayHint | null;
|
|
539
|
-
bedrockModelId?: string | null;
|
|
540
|
-
requiredDataSources?: string[] | null;
|
|
541
|
-
outputType?: AiOutputType | null;
|
|
542
|
-
}
|
|
543
|
-
export interface AiUrlSource {
|
|
544
|
-
/** @format uuid */
|
|
545
|
-
id: string;
|
|
546
|
-
name: string;
|
|
547
|
-
url: string;
|
|
548
|
-
description?: string | null;
|
|
549
|
-
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
550
|
-
scope: "FullDomain" | "SpecificPath";
|
|
551
|
-
isActive: boolean;
|
|
552
|
-
/** @format date-time */
|
|
553
|
-
createdAt: string;
|
|
554
|
-
/** @format date-time */
|
|
555
|
-
updatedAt?: string | null;
|
|
556
|
-
}
|
|
557
352
|
export interface AllowImpersonationRequest {
|
|
558
353
|
/**
|
|
559
354
|
* @format email
|
|
@@ -660,7 +455,7 @@ export interface AuditLogEntry {
|
|
|
660
455
|
/** @format uuid */
|
|
661
456
|
id: string;
|
|
662
457
|
entityType: string;
|
|
663
|
-
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
|
|
458
|
+
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
664
459
|
/** @format uuid */
|
|
665
460
|
entityId: string;
|
|
666
461
|
performedBy?: AuditLogUser | null;
|
|
@@ -971,83 +766,6 @@ export interface CreateAccountRequest {
|
|
|
971
766
|
losIntegration: LOSIntegration;
|
|
972
767
|
billingSettings: AccountBillingRequest;
|
|
973
768
|
}
|
|
974
|
-
export interface CreateAiCanonicalFieldRequest {
|
|
975
|
-
/**
|
|
976
|
-
* @minLength 1
|
|
977
|
-
* @maxLength 200
|
|
978
|
-
*/
|
|
979
|
-
displayName: string;
|
|
980
|
-
/** @minLength 1 */
|
|
981
|
-
description: string;
|
|
982
|
-
/** @minItems 1 */
|
|
983
|
-
allowedRoles: string[];
|
|
984
|
-
isPii: boolean;
|
|
985
|
-
/** @minLength 1 */
|
|
986
|
-
dataSource: string;
|
|
987
|
-
category?: string | null;
|
|
988
|
-
}
|
|
989
|
-
export interface CreateAiGuardrailRequest {
|
|
990
|
-
/**
|
|
991
|
-
* @minLength 1
|
|
992
|
-
* @maxLength 200
|
|
993
|
-
*/
|
|
994
|
-
name: string;
|
|
995
|
-
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
996
|
-
description?: string | null;
|
|
997
|
-
/** @minItems 1 */
|
|
998
|
-
keywords: string[];
|
|
999
|
-
/** @minLength 1 */
|
|
1000
|
-
responseTemplate: string;
|
|
1001
|
-
}
|
|
1002
|
-
export interface CreateAiPromptRequest {
|
|
1003
|
-
/**
|
|
1004
|
-
* @minLength 1
|
|
1005
|
-
* @maxLength 200
|
|
1006
|
-
*/
|
|
1007
|
-
title: string;
|
|
1008
|
-
icon: string;
|
|
1009
|
-
/**
|
|
1010
|
-
* @minLength 1
|
|
1011
|
-
* @maxLength 100
|
|
1012
|
-
*/
|
|
1013
|
-
slug: string;
|
|
1014
|
-
/**
|
|
1015
|
-
* @minLength 1
|
|
1016
|
-
* @maxLength 500
|
|
1017
|
-
*/
|
|
1018
|
-
description: string;
|
|
1019
|
-
documentTypes: string[];
|
|
1020
|
-
applicableGuidelines: string[];
|
|
1021
|
-
allowedRoles: string[];
|
|
1022
|
-
/** @minLength 1 */
|
|
1023
|
-
systemPrompt: string;
|
|
1024
|
-
/** @minLength 1 */
|
|
1025
|
-
userPromptTemplate: string;
|
|
1026
|
-
followUpPrompts: string[];
|
|
1027
|
-
/** @format int32 */
|
|
1028
|
-
sortOrder: number;
|
|
1029
|
-
category?: AiPromptCategory | null;
|
|
1030
|
-
queryTemplateName?: AiQueryTemplateName | null;
|
|
1031
|
-
displayHint?: AiDisplayHint | null;
|
|
1032
|
-
bedrockModelId?: string | null;
|
|
1033
|
-
requiredDataSources?: string[] | null;
|
|
1034
|
-
outputType?: AiOutputType | null;
|
|
1035
|
-
}
|
|
1036
|
-
export interface CreateAiUrlSourceRequest {
|
|
1037
|
-
/**
|
|
1038
|
-
* @minLength 1
|
|
1039
|
-
* @maxLength 200
|
|
1040
|
-
*/
|
|
1041
|
-
name: string;
|
|
1042
|
-
/**
|
|
1043
|
-
* @minLength 1
|
|
1044
|
-
* @maxLength 2048
|
|
1045
|
-
*/
|
|
1046
|
-
url: string;
|
|
1047
|
-
description?: string | null;
|
|
1048
|
-
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
1049
|
-
scope: "FullDomain" | "SpecificPath";
|
|
1050
|
-
}
|
|
1051
769
|
export interface CreateBranchRequest {
|
|
1052
770
|
/**
|
|
1053
771
|
* @minLength 1
|
|
@@ -1291,9 +1009,6 @@ export interface CustomFieldValue {
|
|
|
1291
1009
|
definitionName: string;
|
|
1292
1010
|
dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
1293
1011
|
}
|
|
1294
|
-
export interface CustomLoanData {
|
|
1295
|
-
eConsentInformation?: EConsentInformation | null;
|
|
1296
|
-
}
|
|
1297
1012
|
export interface DetailedUser {
|
|
1298
1013
|
/** @format date-time */
|
|
1299
1014
|
createdAt: string;
|
|
@@ -1570,13 +1285,6 @@ export interface DraftRequest {
|
|
|
1570
1285
|
customData?: any;
|
|
1571
1286
|
isCoBorrower: boolean;
|
|
1572
1287
|
}
|
|
1573
|
-
export interface EConsentInformation {
|
|
1574
|
-
status: string;
|
|
1575
|
-
/** @format date-time */
|
|
1576
|
-
acceptedDate?: string | null;
|
|
1577
|
-
ipAddress?: string | null;
|
|
1578
|
-
source?: string | null;
|
|
1579
|
-
}
|
|
1580
1288
|
export interface EnabledServices {
|
|
1581
1289
|
/** @format date-time */
|
|
1582
1290
|
createdAt: string;
|
|
@@ -1642,6 +1350,8 @@ export interface EncompassCredentialsDetail {
|
|
|
1642
1350
|
defaultLoanOfficerUserName?: string | null;
|
|
1643
1351
|
clearStateIfUnlicensed: boolean;
|
|
1644
1352
|
baseUrl?: string | null;
|
|
1353
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1354
|
+
consumerConnectWidgetHost?: string | null;
|
|
1645
1355
|
signingMethod: "ConsumerConnect" | "POSF";
|
|
1646
1356
|
subscriptionId?: string | null;
|
|
1647
1357
|
environment?: string | null;
|
|
@@ -1657,6 +1367,8 @@ export interface EncompassCredentialsRequest {
|
|
|
1657
1367
|
defaultLoanOfficerUserName?: string | null;
|
|
1658
1368
|
clearStateIfUnlicensed: boolean;
|
|
1659
1369
|
baseUrl?: string | null;
|
|
1370
|
+
encompassEnvironment: "Production" | "UAT";
|
|
1371
|
+
consumerConnectWidgetHost?: string | null;
|
|
1660
1372
|
signingMethod: "ConsumerConnect" | "POSF";
|
|
1661
1373
|
subscriptionId?: string | null;
|
|
1662
1374
|
environment?: string | null;
|
|
@@ -1691,6 +1403,9 @@ export interface EncompassFieldListItem {
|
|
|
1691
1403
|
fieldType: string;
|
|
1692
1404
|
inUse: boolean;
|
|
1693
1405
|
}
|
|
1406
|
+
export interface EncompassIntegrationSettings {
|
|
1407
|
+
consumerConnectWidgetHost?: string | null;
|
|
1408
|
+
}
|
|
1694
1409
|
export interface EncompassLogSearchCriteria {
|
|
1695
1410
|
searchText?: string | null;
|
|
1696
1411
|
operationTypes?: EncompassLogOperationType[] | null;
|
|
@@ -1820,10 +1535,6 @@ export interface FileWithBytes {
|
|
|
1820
1535
|
mimeType?: string | null;
|
|
1821
1536
|
extension?: string | null;
|
|
1822
1537
|
}
|
|
1823
|
-
export interface ForcePasswordReset {
|
|
1824
|
-
forcePasswordReset: boolean;
|
|
1825
|
-
email: string;
|
|
1826
|
-
}
|
|
1827
1538
|
export interface Form {
|
|
1828
1539
|
/** @format date-time */
|
|
1829
1540
|
createdAt: string;
|
|
@@ -2001,17 +1712,6 @@ export interface GenerateDocumentRequest {
|
|
|
2001
1712
|
preview: boolean;
|
|
2002
1713
|
recipients: string[];
|
|
2003
1714
|
}
|
|
2004
|
-
export interface GenerateSystemPrompt {
|
|
2005
|
-
systemPrompt: string;
|
|
2006
|
-
}
|
|
2007
|
-
export interface GenerateSystemPromptRequest {
|
|
2008
|
-
/**
|
|
2009
|
-
* @minLength 1
|
|
2010
|
-
* @maxLength 2000
|
|
2011
|
-
*/
|
|
2012
|
-
description: string;
|
|
2013
|
-
category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
2014
|
-
}
|
|
2015
1715
|
export interface GetApplications {
|
|
2016
1716
|
applications: ApplicationRowData[];
|
|
2017
1717
|
}
|
|
@@ -2163,6 +1863,9 @@ export interface ImportUserLoanTaskRequest {
|
|
|
2163
1863
|
*/
|
|
2164
1864
|
userID: string;
|
|
2165
1865
|
}
|
|
1866
|
+
export interface IntegrationSettings {
|
|
1867
|
+
encompass?: EncompassIntegrationSettings | null;
|
|
1868
|
+
}
|
|
2166
1869
|
export interface Invite {
|
|
2167
1870
|
/** @format uuid */
|
|
2168
1871
|
id: string;
|
|
@@ -5217,13 +4920,6 @@ export interface SocialSurveyRecord {
|
|
|
5217
4920
|
/** @format date-time */
|
|
5218
4921
|
reviewCompletedTimeStamp?: string | null;
|
|
5219
4922
|
}
|
|
5220
|
-
export interface SupportedModel {
|
|
5221
|
-
modelId: string;
|
|
5222
|
-
displayName: string;
|
|
5223
|
-
provider: string;
|
|
5224
|
-
description?: string | null;
|
|
5225
|
-
isDefault: boolean;
|
|
5226
|
-
}
|
|
5227
4923
|
export interface SurveyEmailRequest {
|
|
5228
4924
|
/** @minLength 1 */
|
|
5229
4925
|
loanOfficerEmailAddress: string;
|
|
@@ -5465,75 +5161,6 @@ export interface UpdateAccountRequest {
|
|
|
5465
5161
|
asoSettings?: ASOSettings | null;
|
|
5466
5162
|
settings: AccountSettingsRequest;
|
|
5467
5163
|
}
|
|
5468
|
-
export interface UpdateAiCanonicalFieldRequest {
|
|
5469
|
-
/**
|
|
5470
|
-
* @minLength 1
|
|
5471
|
-
* @maxLength 200
|
|
5472
|
-
*/
|
|
5473
|
-
displayName: string;
|
|
5474
|
-
/** @minLength 1 */
|
|
5475
|
-
description: string;
|
|
5476
|
-
/** @minItems 1 */
|
|
5477
|
-
allowedRoles: string[];
|
|
5478
|
-
isPii: boolean;
|
|
5479
|
-
}
|
|
5480
|
-
export interface UpdateAiGuardrailRequest {
|
|
5481
|
-
/**
|
|
5482
|
-
* @minLength 1
|
|
5483
|
-
* @maxLength 200
|
|
5484
|
-
*/
|
|
5485
|
-
name: string;
|
|
5486
|
-
category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
5487
|
-
description?: string | null;
|
|
5488
|
-
/** @minItems 1 */
|
|
5489
|
-
keywords: string[];
|
|
5490
|
-
/** @minLength 1 */
|
|
5491
|
-
responseTemplate: string;
|
|
5492
|
-
}
|
|
5493
|
-
export interface UpdateAiPromptRequest {
|
|
5494
|
-
/**
|
|
5495
|
-
* @minLength 1
|
|
5496
|
-
* @maxLength 200
|
|
5497
|
-
*/
|
|
5498
|
-
title: string;
|
|
5499
|
-
icon: string;
|
|
5500
|
-
/**
|
|
5501
|
-
* @minLength 1
|
|
5502
|
-
* @maxLength 500
|
|
5503
|
-
*/
|
|
5504
|
-
description: string;
|
|
5505
|
-
documentTypes: string[];
|
|
5506
|
-
applicableGuidelines: string[];
|
|
5507
|
-
allowedRoles: string[];
|
|
5508
|
-
/** @minLength 1 */
|
|
5509
|
-
systemPrompt: string;
|
|
5510
|
-
/** @minLength 1 */
|
|
5511
|
-
userPromptTemplate: string;
|
|
5512
|
-
followUpPrompts: string[];
|
|
5513
|
-
/** @format int32 */
|
|
5514
|
-
sortOrder: number;
|
|
5515
|
-
category?: AiPromptCategory | null;
|
|
5516
|
-
queryTemplateName?: AiQueryTemplateName | null;
|
|
5517
|
-
displayHint?: AiDisplayHint | null;
|
|
5518
|
-
bedrockModelId?: string | null;
|
|
5519
|
-
requiredDataSources?: string[] | null;
|
|
5520
|
-
outputType?: AiOutputType | null;
|
|
5521
|
-
}
|
|
5522
|
-
export interface UpdateAiUrlSourceRequest {
|
|
5523
|
-
/**
|
|
5524
|
-
* @minLength 1
|
|
5525
|
-
* @maxLength 200
|
|
5526
|
-
*/
|
|
5527
|
-
name: string;
|
|
5528
|
-
/**
|
|
5529
|
-
* @minLength 1
|
|
5530
|
-
* @maxLength 2048
|
|
5531
|
-
*/
|
|
5532
|
-
url: string;
|
|
5533
|
-
description?: string | null;
|
|
5534
|
-
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5535
|
-
scope: "FullDomain" | "SpecificPath";
|
|
5536
|
-
}
|
|
5537
5164
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5538
5165
|
isRequired: boolean;
|
|
5539
5166
|
/**
|
|
@@ -5927,7 +5554,6 @@ export interface UserLoan {
|
|
|
5927
5554
|
borrowerPair?: number | null;
|
|
5928
5555
|
/** @format int32 */
|
|
5929
5556
|
borrowerPosition?: number | null;
|
|
5930
|
-
customLoanData?: CustomLoanData | null;
|
|
5931
5557
|
consents: UserLoanConsent[];
|
|
5932
5558
|
}
|
|
5933
5559
|
export interface UserLoanConsent {
|
|
@@ -6157,7 +5783,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6157
5783
|
}
|
|
6158
5784
|
/**
|
|
6159
5785
|
* @title The Big POS API
|
|
6160
|
-
* @version v2.40.
|
|
5786
|
+
* @version v2.40.4
|
|
6161
5787
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6162
5788
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6163
5789
|
*/
|
|
@@ -6231,6 +5857,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6231
5857
|
* @response `422` `UnprocessableEntity` Client Error
|
|
6232
5858
|
*/
|
|
6233
5859
|
updateSiteConfigurationForAccount: (data: SiteConfiguration, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
|
|
5860
|
+
/**
|
|
5861
|
+
* No description
|
|
5862
|
+
*
|
|
5863
|
+
* @tags AccountReactivation
|
|
5864
|
+
* @name RequestAccountReactivation
|
|
5865
|
+
* @summary Request account reactivation
|
|
5866
|
+
* @request POST:/api/account/reactivation/request
|
|
5867
|
+
* @secure
|
|
5868
|
+
* @response `204` `void` No Content
|
|
5869
|
+
*/
|
|
5870
|
+
requestAccountReactivation: (data: AccountReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
5871
|
+
/**
|
|
5872
|
+
* No description
|
|
5873
|
+
*
|
|
5874
|
+
* @tags AccountReactivation
|
|
5875
|
+
* @name CompleteAccountReactivation
|
|
5876
|
+
* @summary Complete account reactivation with new password
|
|
5877
|
+
* @request POST:/api/account/reactivation/complete
|
|
5878
|
+
* @secure
|
|
5879
|
+
* @response `204` `void` No Content
|
|
5880
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
5881
|
+
*/
|
|
5882
|
+
completeAccountReactivation: (data: AccountReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6234
5883
|
/**
|
|
6235
5884
|
* No description
|
|
6236
5885
|
*
|
|
@@ -6295,430 +5944,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6295
5944
|
* @response `422` `ProblemDetails` Client Error
|
|
6296
5945
|
*/
|
|
6297
5946
|
updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
|
|
6298
|
-
/**
|
|
6299
|
-
* No description
|
|
6300
|
-
*
|
|
6301
|
-
* @tags AiAdmin
|
|
6302
|
-
* @name GetAiAuditLogs
|
|
6303
|
-
* @summary Get paginated audit logs
|
|
6304
|
-
* @request GET:/api/ai/admin/audit-logs
|
|
6305
|
-
* @secure
|
|
6306
|
-
* @response `200` `AiAuditLogPaginated` Success
|
|
6307
|
-
*/
|
|
6308
|
-
getAiAuditLogs: (query?: {
|
|
6309
|
-
eventType?: AiAuditEventType;
|
|
6310
|
-
/** @format date-time */
|
|
6311
|
-
startDate?: string;
|
|
6312
|
-
/** @format date-time */
|
|
6313
|
-
endDate?: string;
|
|
6314
|
-
/** @format int32 */
|
|
6315
|
-
pageSize?: number;
|
|
6316
|
-
/** @format int32 */
|
|
6317
|
-
pageNumber?: number;
|
|
6318
|
-
sortBy?: string;
|
|
6319
|
-
sortDirection?: string;
|
|
6320
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
|
|
6321
|
-
/**
|
|
6322
|
-
* No description
|
|
6323
|
-
*
|
|
6324
|
-
* @tags AiAdmin
|
|
6325
|
-
* @name GetAiAdminStats
|
|
6326
|
-
* @summary Get AI admin dashboard stats
|
|
6327
|
-
* @request GET:/api/ai/admin/stats
|
|
6328
|
-
* @secure
|
|
6329
|
-
* @response `200` `AiAdminStats` Success
|
|
6330
|
-
*/
|
|
6331
|
-
getAiAdminStats: (query?: {
|
|
6332
|
-
/** @format date-time */
|
|
6333
|
-
startDate?: string;
|
|
6334
|
-
/** @format date-time */
|
|
6335
|
-
endDate?: string;
|
|
6336
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
|
|
6337
|
-
/**
|
|
6338
|
-
* No description
|
|
6339
|
-
*
|
|
6340
|
-
* @tags AiAdminPrompt
|
|
6341
|
-
* @name GetAiPrompts
|
|
6342
|
-
* @summary Get all prompts
|
|
6343
|
-
* @request GET:/api/ai/admin/prompts
|
|
6344
|
-
* @secure
|
|
6345
|
-
* @response `200` `(AiPrompt)[]` Success
|
|
6346
|
-
*/
|
|
6347
|
-
getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
|
|
6348
|
-
/**
|
|
6349
|
-
* No description
|
|
6350
|
-
*
|
|
6351
|
-
* @tags AiAdminPrompt
|
|
6352
|
-
* @name CreateAiPrompt
|
|
6353
|
-
* @summary Create custom prompt
|
|
6354
|
-
* @request POST:/api/ai/admin/prompts
|
|
6355
|
-
* @secure
|
|
6356
|
-
* @response `201` `AiPrompt` Created
|
|
6357
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6358
|
-
*/
|
|
6359
|
-
createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
|
|
6360
|
-
/**
|
|
6361
|
-
* No description
|
|
6362
|
-
*
|
|
6363
|
-
* @tags AiAdminPrompt
|
|
6364
|
-
* @name GetAiPrompt
|
|
6365
|
-
* @summary Get prompt by ID
|
|
6366
|
-
* @request GET:/api/ai/admin/prompts/{id}
|
|
6367
|
-
* @secure
|
|
6368
|
-
* @response `200` `AiPrompt` Success
|
|
6369
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6370
|
-
*/
|
|
6371
|
-
getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
|
|
6372
|
-
/**
|
|
6373
|
-
* No description
|
|
6374
|
-
*
|
|
6375
|
-
* @tags AiAdminPrompt
|
|
6376
|
-
* @name UpdateAiPrompt
|
|
6377
|
-
* @summary Update prompt
|
|
6378
|
-
* @request PUT:/api/ai/admin/prompts/{id}
|
|
6379
|
-
* @secure
|
|
6380
|
-
* @response `200` `AiPrompt` Success
|
|
6381
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6382
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6383
|
-
*/
|
|
6384
|
-
updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
|
|
6385
|
-
/**
|
|
6386
|
-
* No description
|
|
6387
|
-
*
|
|
6388
|
-
* @tags AiAdminPrompt
|
|
6389
|
-
* @name DeleteAiPrompt
|
|
6390
|
-
* @summary Delete prompt
|
|
6391
|
-
* @request DELETE:/api/ai/admin/prompts/{id}
|
|
6392
|
-
* @secure
|
|
6393
|
-
* @response `204` `void` No Content
|
|
6394
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6395
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6396
|
-
*/
|
|
6397
|
-
deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6398
|
-
/**
|
|
6399
|
-
* No description
|
|
6400
|
-
*
|
|
6401
|
-
* @tags AiAdminPrompt
|
|
6402
|
-
* @name ToggleAiPrompt
|
|
6403
|
-
* @summary Toggle prompt active/inactive
|
|
6404
|
-
* @request PATCH:/api/ai/admin/prompts/{id}/toggle
|
|
6405
|
-
* @secure
|
|
6406
|
-
* @response `200` `AiPrompt` Success
|
|
6407
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6408
|
-
*/
|
|
6409
|
-
toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
|
|
6410
|
-
/**
|
|
6411
|
-
* No description
|
|
6412
|
-
*
|
|
6413
|
-
* @tags AiAdminPrompt
|
|
6414
|
-
* @name GenerateAiSystemPrompt
|
|
6415
|
-
* @summary Generate a system prompt from description
|
|
6416
|
-
* @request POST:/api/ai/admin/prompts/generate
|
|
6417
|
-
* @secure
|
|
6418
|
-
* @response `200` `GenerateSystemPrompt` Success
|
|
6419
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6420
|
-
*/
|
|
6421
|
-
generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
|
|
6422
|
-
/**
|
|
6423
|
-
* No description
|
|
6424
|
-
*
|
|
6425
|
-
* @tags AiAdminPrompt
|
|
6426
|
-
* @name GetSupportedModels
|
|
6427
|
-
* @summary Get supported LLM models
|
|
6428
|
-
* @request GET:/api/ai/admin/prompts/supported-models
|
|
6429
|
-
* @secure
|
|
6430
|
-
* @response `200` `(SupportedModel)[]` Success
|
|
6431
|
-
*/
|
|
6432
|
-
getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
|
|
6433
|
-
/**
|
|
6434
|
-
* No description
|
|
6435
|
-
*
|
|
6436
|
-
* @tags AiCanonicalField
|
|
6437
|
-
* @name GetAiCanonicalFields
|
|
6438
|
-
* @summary Get all canonical fields
|
|
6439
|
-
* @request GET:/api/ai/admin/fields
|
|
6440
|
-
* @secure
|
|
6441
|
-
* @response `200` `(AiCanonicalField)[]` Success
|
|
6442
|
-
*/
|
|
6443
|
-
getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
|
|
6444
|
-
/**
|
|
6445
|
-
* No description
|
|
6446
|
-
*
|
|
6447
|
-
* @tags AiCanonicalField
|
|
6448
|
-
* @name CreateAiCanonicalField
|
|
6449
|
-
* @summary Create canonical field
|
|
6450
|
-
* @request POST:/api/ai/admin/fields
|
|
6451
|
-
* @secure
|
|
6452
|
-
* @response `201` `AiCanonicalField` Created
|
|
6453
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6454
|
-
*/
|
|
6455
|
-
createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
|
|
6456
|
-
/**
|
|
6457
|
-
* No description
|
|
6458
|
-
*
|
|
6459
|
-
* @tags AiCanonicalField
|
|
6460
|
-
* @name GetAiCanonicalField
|
|
6461
|
-
* @summary Get canonical field by ID
|
|
6462
|
-
* @request GET:/api/ai/admin/fields/{id}
|
|
6463
|
-
* @secure
|
|
6464
|
-
* @response `200` `AiCanonicalField` Success
|
|
6465
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6466
|
-
*/
|
|
6467
|
-
getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
|
|
6468
|
-
/**
|
|
6469
|
-
* No description
|
|
6470
|
-
*
|
|
6471
|
-
* @tags AiCanonicalField
|
|
6472
|
-
* @name UpdateAiCanonicalField
|
|
6473
|
-
* @summary Update canonical field
|
|
6474
|
-
* @request PUT:/api/ai/admin/fields/{id}
|
|
6475
|
-
* @secure
|
|
6476
|
-
* @response `200` `AiCanonicalField` Success
|
|
6477
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6478
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6479
|
-
*/
|
|
6480
|
-
updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
|
|
6481
|
-
/**
|
|
6482
|
-
* No description
|
|
6483
|
-
*
|
|
6484
|
-
* @tags AiCanonicalField
|
|
6485
|
-
* @name DeleteAiCanonicalField
|
|
6486
|
-
* @summary Delete canonical field
|
|
6487
|
-
* @request DELETE:/api/ai/admin/fields/{id}
|
|
6488
|
-
* @secure
|
|
6489
|
-
* @response `204` `void` No Content
|
|
6490
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6491
|
-
*/
|
|
6492
|
-
deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6493
|
-
/**
|
|
6494
|
-
* No description
|
|
6495
|
-
*
|
|
6496
|
-
* @tags AiCanonicalField
|
|
6497
|
-
* @name ToggleAiCanonicalField
|
|
6498
|
-
* @summary Toggle canonical field active/inactive
|
|
6499
|
-
* @request PATCH:/api/ai/admin/fields/{id}/toggle
|
|
6500
|
-
* @secure
|
|
6501
|
-
* @response `200` `AiCanonicalField` Success
|
|
6502
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6503
|
-
*/
|
|
6504
|
-
toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
|
|
6505
|
-
/**
|
|
6506
|
-
* No description
|
|
6507
|
-
*
|
|
6508
|
-
* @tags AiChat
|
|
6509
|
-
* @name AiChat
|
|
6510
|
-
* @summary Send AI chat message
|
|
6511
|
-
* @request POST:/api/ai/chat
|
|
6512
|
-
* @secure
|
|
6513
|
-
* @response `200` `AiChat` Success
|
|
6514
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6515
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
6516
|
-
*/
|
|
6517
|
-
aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
|
|
6518
|
-
/**
|
|
6519
|
-
* No description
|
|
6520
|
-
*
|
|
6521
|
-
* @tags AiConversation
|
|
6522
|
-
* @name GetAiConversations
|
|
6523
|
-
* @summary Get user conversations
|
|
6524
|
-
* @request GET:/api/ai/conversations
|
|
6525
|
-
* @secure
|
|
6526
|
-
* @response `200` `AiConversationListItemPaginated` Success
|
|
6527
|
-
*/
|
|
6528
|
-
getAiConversations: (query?: {
|
|
6529
|
-
/** @format int32 */
|
|
6530
|
-
pageSize?: number;
|
|
6531
|
-
/** @format int32 */
|
|
6532
|
-
pageNumber?: number;
|
|
6533
|
-
sortBy?: string;
|
|
6534
|
-
sortDirection?: string;
|
|
6535
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
|
|
6536
|
-
/**
|
|
6537
|
-
* No description
|
|
6538
|
-
*
|
|
6539
|
-
* @tags AiConversation
|
|
6540
|
-
* @name GetAiConversation
|
|
6541
|
-
* @summary Get conversation with messages
|
|
6542
|
-
* @request GET:/api/ai/conversations/{id}
|
|
6543
|
-
* @secure
|
|
6544
|
-
* @response `200` `AiConversationDetail` Success
|
|
6545
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6546
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6547
|
-
*/
|
|
6548
|
-
getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
|
|
6549
|
-
/**
|
|
6550
|
-
* No description
|
|
6551
|
-
*
|
|
6552
|
-
* @tags AiConversation
|
|
6553
|
-
* @name DeleteAiConversation
|
|
6554
|
-
* @summary Delete conversation
|
|
6555
|
-
* @request DELETE:/api/ai/conversations/{id}
|
|
6556
|
-
* @secure
|
|
6557
|
-
* @response `204` `void` No Content
|
|
6558
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6559
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6560
|
-
*/
|
|
6561
|
-
deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6562
|
-
/**
|
|
6563
|
-
* No description
|
|
6564
|
-
*
|
|
6565
|
-
* @tags AiGuardrail
|
|
6566
|
-
* @name GetAiGuardrails
|
|
6567
|
-
* @summary Get all guardrails
|
|
6568
|
-
* @request GET:/api/ai/admin/guardrails
|
|
6569
|
-
* @secure
|
|
6570
|
-
* @response `200` `(AiGuardrail)[]` Success
|
|
6571
|
-
*/
|
|
6572
|
-
getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
|
|
6573
|
-
/**
|
|
6574
|
-
* No description
|
|
6575
|
-
*
|
|
6576
|
-
* @tags AiGuardrail
|
|
6577
|
-
* @name CreateAiGuardrail
|
|
6578
|
-
* @summary Create custom guardrail
|
|
6579
|
-
* @request POST:/api/ai/admin/guardrails
|
|
6580
|
-
* @secure
|
|
6581
|
-
* @response `201` `AiGuardrail` Created
|
|
6582
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6583
|
-
*/
|
|
6584
|
-
createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
|
|
6585
|
-
/**
|
|
6586
|
-
* No description
|
|
6587
|
-
*
|
|
6588
|
-
* @tags AiGuardrail
|
|
6589
|
-
* @name GetAiGuardrail
|
|
6590
|
-
* @summary Get guardrail by ID
|
|
6591
|
-
* @request GET:/api/ai/admin/guardrails/{id}
|
|
6592
|
-
* @secure
|
|
6593
|
-
* @response `200` `AiGuardrail` Success
|
|
6594
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6595
|
-
*/
|
|
6596
|
-
getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
|
|
6597
|
-
/**
|
|
6598
|
-
* No description
|
|
6599
|
-
*
|
|
6600
|
-
* @tags AiGuardrail
|
|
6601
|
-
* @name UpdateAiGuardrail
|
|
6602
|
-
* @summary Update guardrail
|
|
6603
|
-
* @request PUT:/api/ai/admin/guardrails/{id}
|
|
6604
|
-
* @secure
|
|
6605
|
-
* @response `200` `AiGuardrail` Success
|
|
6606
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6607
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6608
|
-
*/
|
|
6609
|
-
updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
|
|
6610
|
-
/**
|
|
6611
|
-
* No description
|
|
6612
|
-
*
|
|
6613
|
-
* @tags AiGuardrail
|
|
6614
|
-
* @name DeleteAiGuardrail
|
|
6615
|
-
* @summary Delete guardrail
|
|
6616
|
-
* @request DELETE:/api/ai/admin/guardrails/{id}
|
|
6617
|
-
* @secure
|
|
6618
|
-
* @response `204` `void` No Content
|
|
6619
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6620
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6621
|
-
*/
|
|
6622
|
-
deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6623
|
-
/**
|
|
6624
|
-
* No description
|
|
6625
|
-
*
|
|
6626
|
-
* @tags AiGuardrail
|
|
6627
|
-
* @name ToggleAiGuardrail
|
|
6628
|
-
* @summary Toggle guardrail enabled/disabled
|
|
6629
|
-
* @request PATCH:/api/ai/admin/guardrails/{id}/toggle
|
|
6630
|
-
* @secure
|
|
6631
|
-
* @response `200` `AiGuardrail` Success
|
|
6632
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6633
|
-
*/
|
|
6634
|
-
toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
|
|
6635
|
-
/**
|
|
6636
|
-
* No description
|
|
6637
|
-
*
|
|
6638
|
-
* @tags AiPrompt
|
|
6639
|
-
* @name GetAvailablePrompts
|
|
6640
|
-
* @summary Get available prompts for current user
|
|
6641
|
-
* @request GET:/api/ai/prompts
|
|
6642
|
-
* @secure
|
|
6643
|
-
* @response `200` `(AiPromptSummary)[]` Success
|
|
6644
|
-
*/
|
|
6645
|
-
getAvailablePrompts: (query?: {
|
|
6646
|
-
documentType?: string;
|
|
6647
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
|
|
6648
|
-
/**
|
|
6649
|
-
* No description
|
|
6650
|
-
*
|
|
6651
|
-
* @tags AiUrlSource
|
|
6652
|
-
* @name GetAiUrlSources
|
|
6653
|
-
* @summary Get all URL sources
|
|
6654
|
-
* @request GET:/api/ai/admin/url-sources
|
|
6655
|
-
* @secure
|
|
6656
|
-
* @response `200` `(AiUrlSource)[]` Success
|
|
6657
|
-
*/
|
|
6658
|
-
getAiUrlSources: (params?: RequestParams) => Promise<AxiosResponse<AiUrlSource[], any, {}>>;
|
|
6659
|
-
/**
|
|
6660
|
-
* No description
|
|
6661
|
-
*
|
|
6662
|
-
* @tags AiUrlSource
|
|
6663
|
-
* @name CreateAiUrlSource
|
|
6664
|
-
* @summary Create URL source
|
|
6665
|
-
* @request POST:/api/ai/admin/url-sources
|
|
6666
|
-
* @secure
|
|
6667
|
-
* @response `201` `AiUrlSource` Created
|
|
6668
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6669
|
-
* @response `409` `ProblemDetails` Conflict
|
|
6670
|
-
*/
|
|
6671
|
-
createAiUrlSource: (data: CreateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
|
|
6672
|
-
/**
|
|
6673
|
-
* No description
|
|
6674
|
-
*
|
|
6675
|
-
* @tags AiUrlSource
|
|
6676
|
-
* @name GetAiUrlSource
|
|
6677
|
-
* @summary Get URL source by ID
|
|
6678
|
-
* @request GET:/api/ai/admin/url-sources/{id}
|
|
6679
|
-
* @secure
|
|
6680
|
-
* @response `200` `AiUrlSource` Success
|
|
6681
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6682
|
-
*/
|
|
6683
|
-
getAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
|
|
6684
|
-
/**
|
|
6685
|
-
* No description
|
|
6686
|
-
*
|
|
6687
|
-
* @tags AiUrlSource
|
|
6688
|
-
* @name UpdateAiUrlSource
|
|
6689
|
-
* @summary Update URL source
|
|
6690
|
-
* @request PUT:/api/ai/admin/url-sources/{id}
|
|
6691
|
-
* @secure
|
|
6692
|
-
* @response `200` `AiUrlSource` Success
|
|
6693
|
-
* @response `400` `ProblemDetails` Bad Request
|
|
6694
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6695
|
-
* @response `409` `ProblemDetails` Conflict
|
|
6696
|
-
*/
|
|
6697
|
-
updateAiUrlSource: (id: string, data: UpdateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
|
|
6698
|
-
/**
|
|
6699
|
-
* No description
|
|
6700
|
-
*
|
|
6701
|
-
* @tags AiUrlSource
|
|
6702
|
-
* @name DeleteAiUrlSource
|
|
6703
|
-
* @summary Delete URL source
|
|
6704
|
-
* @request DELETE:/api/ai/admin/url-sources/{id}
|
|
6705
|
-
* @secure
|
|
6706
|
-
* @response `204` `void` No Content
|
|
6707
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6708
|
-
*/
|
|
6709
|
-
deleteAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
6710
|
-
/**
|
|
6711
|
-
* No description
|
|
6712
|
-
*
|
|
6713
|
-
* @tags AiUrlSource
|
|
6714
|
-
* @name ToggleAiUrlSource
|
|
6715
|
-
* @summary Toggle URL source active/inactive
|
|
6716
|
-
* @request PATCH:/api/ai/admin/url-sources/{id}/toggle
|
|
6717
|
-
* @secure
|
|
6718
|
-
* @response `200` `AiUrlSource` Success
|
|
6719
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6720
|
-
*/
|
|
6721
|
-
toggleAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
|
|
6722
5947
|
/**
|
|
6723
5948
|
* No description
|
|
6724
5949
|
*
|
|
@@ -6781,10 +6006,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6781
6006
|
* @summary Get Token
|
|
6782
6007
|
* @request POST:/api/token
|
|
6783
6008
|
* @secure
|
|
6784
|
-
* @response `200` `
|
|
6009
|
+
* @response `200` `AccountDeactivated` Success
|
|
6785
6010
|
* @response `422` `UnprocessableEntity` Client Error
|
|
6786
6011
|
*/
|
|
6787
|
-
getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
6012
|
+
getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
|
|
6788
6013
|
/**
|
|
6789
6014
|
* No description
|
|
6790
6015
|
*
|
|
@@ -6793,10 +6018,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6793
6018
|
* @summary Get Token From Challenge Code
|
|
6794
6019
|
* @request POST:/api/token/code
|
|
6795
6020
|
* @secure
|
|
6796
|
-
* @response `200` `
|
|
6021
|
+
* @response `200` `AccountDeactivated` Success
|
|
6797
6022
|
* @response `422` `UnprocessableEntity` Client Error
|
|
6798
6023
|
*/
|
|
6799
|
-
getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
6024
|
+
getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
|
|
6800
6025
|
/**
|
|
6801
6026
|
* No description
|
|
6802
6027
|
*
|
|
@@ -8011,6 +7236,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8011
7236
|
* @response `200` `FormVersion` Success
|
|
8012
7237
|
*/
|
|
8013
7238
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
7239
|
+
/**
|
|
7240
|
+
* No description
|
|
7241
|
+
*
|
|
7242
|
+
* @tags IntegrationSettings
|
|
7243
|
+
* @name GetIntegrationSettings
|
|
7244
|
+
* @summary Get Integration Settings
|
|
7245
|
+
* @request GET:/api/integrations/settings
|
|
7246
|
+
* @secure
|
|
7247
|
+
* @response `200` `IntegrationSettings` Success
|
|
7248
|
+
*/
|
|
7249
|
+
getIntegrationSettings: (params?: RequestParams) => Promise<AxiosResponse<IntegrationSettings, any, {}>>;
|
|
8014
7250
|
/**
|
|
8015
7251
|
* No description
|
|
8016
7252
|
*
|