@getsupervisor/agents-studio-sdk 1.41.0 → 1.41.1-beta.163
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/CHANGELOG.md +104 -90
- package/README.md +89 -20
- package/dist/index.cjs +717 -97
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +696 -40
- package/dist/index.d.ts +696 -40
- package/dist/index.js +708 -96
- package/dist/index.js.map +1 -1
- package/package.json +11 -6
package/dist/index.d.cts
CHANGED
|
@@ -14,7 +14,7 @@ type components = {
|
|
|
14
14
|
agentType: 'chat' | 'voice';
|
|
15
15
|
workspaceId: string;
|
|
16
16
|
versionId?: string;
|
|
17
|
-
status: 'inactive' | 'training' | 'active' | 'archived';
|
|
17
|
+
status: 'inactive' | 'training' | 'active' | 'archived' | 'building' | 'failed';
|
|
18
18
|
description?: string | null;
|
|
19
19
|
avatarUrl?: string | null;
|
|
20
20
|
debounceDelayMs?: number | null;
|
|
@@ -35,6 +35,9 @@ type components = {
|
|
|
35
35
|
} | null;
|
|
36
36
|
createdAt: string;
|
|
37
37
|
updatedAt: string;
|
|
38
|
+
totalCalls: number;
|
|
39
|
+
totalOperationalDays: number;
|
|
40
|
+
goalAchievedPercentage: number;
|
|
38
41
|
metadata?: {
|
|
39
42
|
[key: string]: unknown;
|
|
40
43
|
};
|
|
@@ -51,8 +54,9 @@ type components = {
|
|
|
51
54
|
AgentSummary: {
|
|
52
55
|
agentId: string;
|
|
53
56
|
name: string;
|
|
57
|
+
description?: string | null;
|
|
54
58
|
agentType: 'chat' | 'voice';
|
|
55
|
-
status: 'inactive' | 'training' | 'active' | 'archived';
|
|
59
|
+
status: 'inactive' | 'training' | 'active' | 'archived' | 'building' | 'failed';
|
|
56
60
|
workspaceId: string;
|
|
57
61
|
createdAt: string;
|
|
58
62
|
updatedAt: string;
|
|
@@ -64,10 +68,13 @@ type components = {
|
|
|
64
68
|
CreateAgentRequest: {
|
|
65
69
|
name: string;
|
|
66
70
|
description?: string | null;
|
|
67
|
-
agentType: '
|
|
71
|
+
agentType: 'voice' | 'chat';
|
|
68
72
|
status?: 'inactive' | 'training' | 'active';
|
|
69
73
|
avatarUrl?: string | null;
|
|
70
74
|
debounceDelayMs?: number | null;
|
|
75
|
+
brief?: string | null;
|
|
76
|
+
researchUrl?: string | null;
|
|
77
|
+
voiceId?: string | null;
|
|
71
78
|
metadata?: {
|
|
72
79
|
[key: string]: unknown;
|
|
73
80
|
};
|
|
@@ -81,7 +88,7 @@ type components = {
|
|
|
81
88
|
};
|
|
82
89
|
UpdateAgentRequest: {
|
|
83
90
|
name?: string;
|
|
84
|
-
status?: 'inactive' | 'training' | 'active' | 'archived';
|
|
91
|
+
status?: 'inactive' | 'training' | 'active' | 'archived' | 'building' | 'failed';
|
|
85
92
|
description?: string | null;
|
|
86
93
|
toneId?: string | null;
|
|
87
94
|
messageStyleId?: string | null;
|
|
@@ -405,10 +412,12 @@ type components = {
|
|
|
405
412
|
identifier: string;
|
|
406
413
|
description?: string | null;
|
|
407
414
|
enabled: boolean;
|
|
415
|
+
visible: boolean;
|
|
408
416
|
category?: string | null;
|
|
409
417
|
auth: 'none' | 'oauth2' | 'api_key' | 'custom';
|
|
410
418
|
requiresUserAuth: boolean;
|
|
411
419
|
configSchema?: components['schemas']['ToolConfigSchema'] | null;
|
|
420
|
+
catalogMetadata: components['schemas']['ToolCatalogMetadata'];
|
|
412
421
|
};
|
|
413
422
|
ToolListResponse: {
|
|
414
423
|
data: components['schemas']['ToolSummary'][];
|
|
@@ -452,14 +461,17 @@ type components = {
|
|
|
452
461
|
message?: string;
|
|
453
462
|
};
|
|
454
463
|
ToolConnectionRequest: {
|
|
464
|
+
connectionKey?: string;
|
|
455
465
|
agentId: string;
|
|
456
466
|
metadata?: {
|
|
457
467
|
[key: string]: unknown;
|
|
458
468
|
};
|
|
469
|
+
descriptionUsage?: string;
|
|
470
|
+
usageExample?: string;
|
|
459
471
|
auth?: components['schemas']['ToolConnectionAuth'];
|
|
460
472
|
};
|
|
461
473
|
ToolConnectionResponse: {
|
|
462
|
-
status: 'connected' | 'pending' | 'error';
|
|
474
|
+
status: 'connected' | 'pending' | 'error' | 'revoked';
|
|
463
475
|
toolAgentConnectionId?: string | null;
|
|
464
476
|
toolId: string;
|
|
465
477
|
workspaceId: string;
|
|
@@ -470,9 +482,11 @@ type components = {
|
|
|
470
482
|
metadata?: {
|
|
471
483
|
[key: string]: unknown;
|
|
472
484
|
};
|
|
485
|
+
descriptionUsage?: string | null;
|
|
486
|
+
usageExample?: string | null;
|
|
473
487
|
};
|
|
474
488
|
ToolConnectionAuth: {
|
|
475
|
-
type: 'none' | 'oauth2' | 'api_key';
|
|
489
|
+
type: 'none' | 'oauth2' | 'api_key' | 'custom';
|
|
476
490
|
data?: {
|
|
477
491
|
[key: string]: unknown;
|
|
478
492
|
};
|
|
@@ -495,6 +509,7 @@ type components = {
|
|
|
495
509
|
toolId: string;
|
|
496
510
|
toolAgentConnectionId?: string | null;
|
|
497
511
|
providerRef?: string | null;
|
|
512
|
+
toolExecutionId: string;
|
|
498
513
|
message?: string | null;
|
|
499
514
|
};
|
|
500
515
|
CatalogItemLinks: {
|
|
@@ -532,9 +547,8 @@ type components = {
|
|
|
532
547
|
}, 'type' | 'scope' | 'name' | 'description' | 'metadata'>;
|
|
533
548
|
WorkspaceEnableRequest: {
|
|
534
549
|
apiKey: string;
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
};
|
|
550
|
+
phone: string;
|
|
551
|
+
speechAnalyticsAgentId: string;
|
|
538
552
|
};
|
|
539
553
|
WorkspaceEnableResponse: {
|
|
540
554
|
status: 'enabled';
|
|
@@ -545,14 +559,36 @@ type components = {
|
|
|
545
559
|
code: string;
|
|
546
560
|
message: string;
|
|
547
561
|
details?: {
|
|
562
|
+
subcode?: string;
|
|
563
|
+
workspaceId?: string;
|
|
548
564
|
[key: string]: unknown;
|
|
549
565
|
};
|
|
550
566
|
};
|
|
567
|
+
DocumentFileItem: {
|
|
568
|
+
filename: string;
|
|
569
|
+
contentType: string;
|
|
570
|
+
};
|
|
571
|
+
CreateDocumentSlotsRequest: {
|
|
572
|
+
files: components['schemas']['DocumentFileItem'][];
|
|
573
|
+
};
|
|
574
|
+
DocumentSlot: {
|
|
575
|
+
key: string;
|
|
576
|
+
uploadUrl: string;
|
|
577
|
+
filename: string;
|
|
578
|
+
};
|
|
579
|
+
CreateDocumentSlotsResponse: {
|
|
580
|
+
documents: components['schemas']['DocumentSlot'][];
|
|
581
|
+
};
|
|
582
|
+
DocumentRef: {
|
|
583
|
+
key: string;
|
|
584
|
+
description: string;
|
|
585
|
+
};
|
|
551
586
|
WebhookSummary: {
|
|
552
587
|
id: string;
|
|
553
588
|
url: string;
|
|
554
589
|
agentId?: string | null;
|
|
555
590
|
description?: string | null;
|
|
591
|
+
method?: 'GET' | 'POST';
|
|
556
592
|
isActive: boolean;
|
|
557
593
|
secretPreview?: string | null;
|
|
558
594
|
createdAt: string;
|
|
@@ -579,6 +615,7 @@ type components = {
|
|
|
579
615
|
[key: string]: string;
|
|
580
616
|
};
|
|
581
617
|
secret?: string;
|
|
618
|
+
method?: 'GET' | 'POST';
|
|
582
619
|
};
|
|
583
620
|
UpdateWebhookRequest: {
|
|
584
621
|
url?: string;
|
|
@@ -588,6 +625,7 @@ type components = {
|
|
|
588
625
|
headers?: {
|
|
589
626
|
[key: string]: string;
|
|
590
627
|
};
|
|
628
|
+
method?: 'GET' | 'POST';
|
|
591
629
|
};
|
|
592
630
|
EventSubscriptionSummary: {
|
|
593
631
|
id: string;
|
|
@@ -622,10 +660,19 @@ type components = {
|
|
|
622
660
|
processedRecords: number;
|
|
623
661
|
successfulRecords: number;
|
|
624
662
|
failedRecords: number;
|
|
663
|
+
connectedRecords: number;
|
|
664
|
+
goalAchievedRecords: number;
|
|
665
|
+
pendingRetriesCount: number;
|
|
666
|
+
terminalFailures: number;
|
|
667
|
+
pausedFromStatus?: components['schemas']['CampaignStatus'] | null;
|
|
668
|
+
nextRetryAt?: string | null;
|
|
669
|
+
createdBy: string;
|
|
625
670
|
createdAt: string;
|
|
626
671
|
updatedAt: string;
|
|
627
672
|
startedAt?: string | null;
|
|
628
673
|
completedAt?: string | null;
|
|
674
|
+
pausedAt?: string | null;
|
|
675
|
+
cancelledAt?: string | null;
|
|
629
676
|
};
|
|
630
677
|
CampaignListResponse: {
|
|
631
678
|
data: components['schemas']['Campaign'][];
|
|
@@ -634,20 +681,148 @@ type components = {
|
|
|
634
681
|
CampaignExecution: {
|
|
635
682
|
campaignExecutionId: string;
|
|
636
683
|
campaignId: string;
|
|
684
|
+
workspaceId: string;
|
|
637
685
|
rowNumber: number;
|
|
638
686
|
status: 'PENDING' | 'SUCCESS' | 'ERROR';
|
|
639
687
|
agentExecutionId?: string | null;
|
|
640
|
-
|
|
688
|
+
input: {
|
|
641
689
|
[key: string]: unknown;
|
|
642
690
|
};
|
|
643
|
-
|
|
691
|
+
error?: string | null;
|
|
692
|
+
lastDisconnectionReason?: string | null;
|
|
693
|
+
callDurationMs?: number | null;
|
|
694
|
+
lastCallId?: string | null;
|
|
695
|
+
callGoalAchieved?: boolean | null;
|
|
696
|
+
reasonRetryCount: number;
|
|
697
|
+
capacityRetryCount: number;
|
|
698
|
+
nextRetryAt?: string | null;
|
|
644
699
|
createdAt: string;
|
|
645
700
|
};
|
|
646
701
|
CampaignExecutionListResponse: {
|
|
647
702
|
data: components['schemas']['CampaignExecution'][];
|
|
648
703
|
meta: components['schemas']['PaginationMeta'];
|
|
649
704
|
};
|
|
650
|
-
CampaignStatus: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | '
|
|
705
|
+
CampaignStatus: 'PENDING' | 'PROCESSING' | 'RETRYING' | 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELLED';
|
|
706
|
+
Call: {
|
|
707
|
+
id: string;
|
|
708
|
+
title: string;
|
|
709
|
+
customerPhone: string | null;
|
|
710
|
+
durationSeconds: number | null;
|
|
711
|
+
supervisors: components['schemas']['CallSupervisors'];
|
|
712
|
+
goal: components['schemas']['CallGoal'];
|
|
713
|
+
startedAt: string;
|
|
714
|
+
recordingUrl: string | null;
|
|
715
|
+
agentBatchId: string | null;
|
|
716
|
+
agentId: string | null;
|
|
717
|
+
executionId: string | null;
|
|
718
|
+
};
|
|
719
|
+
CallGoal: {
|
|
720
|
+
achieved: boolean;
|
|
721
|
+
reason: string | null;
|
|
722
|
+
};
|
|
723
|
+
CallSupervisors: {
|
|
724
|
+
evaluations: number | null;
|
|
725
|
+
discoveries: number | null;
|
|
726
|
+
risks: number | null;
|
|
727
|
+
};
|
|
728
|
+
CallsListMeta: components['schemas']['PaginationMeta'] & {
|
|
729
|
+
sort: string[];
|
|
730
|
+
appliedFilters: string[];
|
|
731
|
+
};
|
|
732
|
+
CallsListResponse: {
|
|
733
|
+
data: components['schemas']['Call'][];
|
|
734
|
+
meta: components['schemas']['CallsListMeta'];
|
|
735
|
+
};
|
|
736
|
+
CallsStreamMeta: {
|
|
737
|
+
limit: number;
|
|
738
|
+
nextAfter: string | null;
|
|
739
|
+
};
|
|
740
|
+
CallsStreamResponse: {
|
|
741
|
+
data: components['schemas']['Call'][];
|
|
742
|
+
meta: components['schemas']['CallsStreamMeta'];
|
|
743
|
+
};
|
|
744
|
+
SipTrunk: {
|
|
745
|
+
id: string;
|
|
746
|
+
workspaceId: string;
|
|
747
|
+
name: string;
|
|
748
|
+
username: string;
|
|
749
|
+
domain: string;
|
|
750
|
+
carrierAddress: string;
|
|
751
|
+
carrierPort: number;
|
|
752
|
+
carrierTransport: 'udp' | 'tcp' | 'tls';
|
|
753
|
+
phoneNumbers: string[];
|
|
754
|
+
status: 'active' | 'inactive';
|
|
755
|
+
createdAt: string;
|
|
756
|
+
updatedAt: string;
|
|
757
|
+
};
|
|
758
|
+
SipTrunkWithPassword: components['schemas']['SipTrunk'] & {
|
|
759
|
+
password: string;
|
|
760
|
+
};
|
|
761
|
+
CreateSipTrunkRequest: {
|
|
762
|
+
name: string;
|
|
763
|
+
carrierAddress: string;
|
|
764
|
+
carrierPort?: number;
|
|
765
|
+
carrierTransport?: 'udp' | 'tcp' | 'tls';
|
|
766
|
+
phoneNumbers?: string[];
|
|
767
|
+
};
|
|
768
|
+
UpdateSipTrunkRequest: {
|
|
769
|
+
name?: string;
|
|
770
|
+
carrierAddress?: string;
|
|
771
|
+
carrierPort?: number;
|
|
772
|
+
carrierTransport?: 'udp' | 'tcp' | 'tls';
|
|
773
|
+
phoneNumbers?: string[];
|
|
774
|
+
status?: 'active' | 'inactive';
|
|
775
|
+
};
|
|
776
|
+
ResourceProjection: {
|
|
777
|
+
estimatedAtClose: number;
|
|
778
|
+
dailyBurnRate: number;
|
|
779
|
+
daysRemaining: number | null;
|
|
780
|
+
willExceed: boolean;
|
|
781
|
+
};
|
|
782
|
+
ResourceBalance: {
|
|
783
|
+
resource: string;
|
|
784
|
+
limit: number;
|
|
785
|
+
used: number;
|
|
786
|
+
remaining: number;
|
|
787
|
+
unit: string;
|
|
788
|
+
projection: components['schemas']['ResourceProjection'];
|
|
789
|
+
};
|
|
790
|
+
SubscriptionInfo: {
|
|
791
|
+
id: string;
|
|
792
|
+
status: 'active' | 'paused';
|
|
793
|
+
billingCycle: 'monthly' | 'yearly';
|
|
794
|
+
currentPeriodStart: string;
|
|
795
|
+
currentPeriodEnd: string;
|
|
796
|
+
};
|
|
797
|
+
BillingBalanceResponse: {
|
|
798
|
+
subscription: components['schemas']['SubscriptionInfo'];
|
|
799
|
+
resources: components['schemas']['ResourceBalance'][];
|
|
800
|
+
};
|
|
801
|
+
UsageAgentRow: {
|
|
802
|
+
agentId: string;
|
|
803
|
+
agentName: string | null;
|
|
804
|
+
status: 'inactive' | 'training' | 'active' | 'archived' | 'building' | 'failed' | null;
|
|
805
|
+
totalQuantity: number;
|
|
806
|
+
totalEvents: number;
|
|
807
|
+
percentOfTotal: number;
|
|
808
|
+
lastActivity: string;
|
|
809
|
+
};
|
|
810
|
+
UsageAgentsMeta: {
|
|
811
|
+
total: number;
|
|
812
|
+
page: number;
|
|
813
|
+
limit: number;
|
|
814
|
+
hasNext: boolean;
|
|
815
|
+
hasPrevious: boolean;
|
|
816
|
+
aggregations: components['schemas']['UsageAgentsAggregations'];
|
|
817
|
+
};
|
|
818
|
+
UsageAgentsAggregations: {
|
|
819
|
+
totalUsage: number;
|
|
820
|
+
planLimit: number | null;
|
|
821
|
+
};
|
|
822
|
+
UsageAgentsResponse: {
|
|
823
|
+
data: components['schemas']['UsageAgentRow'][];
|
|
824
|
+
meta: components['schemas']['UsageAgentsMeta'];
|
|
825
|
+
};
|
|
651
826
|
ForkAgentFromTemplateRequest: {
|
|
652
827
|
templateId: string;
|
|
653
828
|
templateVersionId?: string;
|
|
@@ -655,6 +830,17 @@ type components = {
|
|
|
655
830
|
description?: string | null;
|
|
656
831
|
status?: 'inactive' | 'training' | 'active';
|
|
657
832
|
debounceDelayMs?: number | null;
|
|
833
|
+
brief?: string | null;
|
|
834
|
+
researchUrl?: string | null;
|
|
835
|
+
voiceId?: string | null;
|
|
836
|
+
documentRefs?: components['schemas']['DocumentRef'][] | null;
|
|
837
|
+
};
|
|
838
|
+
CloneAgentRequest: {
|
|
839
|
+
name: string;
|
|
840
|
+
description?: string | null;
|
|
841
|
+
status?: 'inactive' | 'training' | 'active';
|
|
842
|
+
versionId: string;
|
|
843
|
+
clone: ('instructions' | 'tools' | 'webhooks' | 'stages' | 'triggers' | 'businessHours' | 'businessHourExceptions')[];
|
|
658
844
|
};
|
|
659
845
|
AgentScheduleListResponse: {
|
|
660
846
|
data: components['schemas']['AgentSchedule'][];
|
|
@@ -692,6 +878,14 @@ type components = {
|
|
|
692
878
|
CreateApiKeyResponse: components['schemas']['ApiKeySummary'] & {
|
|
693
879
|
key: string;
|
|
694
880
|
};
|
|
881
|
+
WorkspaceSummary: {
|
|
882
|
+
id: string;
|
|
883
|
+
name: string;
|
|
884
|
+
};
|
|
885
|
+
WorkspaceListResponse: {
|
|
886
|
+
data: components['schemas']['WorkspaceSummary'][];
|
|
887
|
+
meta: components['schemas']['PaginationMeta'];
|
|
888
|
+
};
|
|
695
889
|
ToolConfigSchemaActionPrompts: {
|
|
696
890
|
assistant?: string;
|
|
697
891
|
user?: string;
|
|
@@ -715,6 +909,81 @@ type components = {
|
|
|
715
909
|
[key: string]: components['schemas']['ToolConfigSchemaAction'];
|
|
716
910
|
};
|
|
717
911
|
};
|
|
912
|
+
ToolCatalogAuthor: {
|
|
913
|
+
name: string;
|
|
914
|
+
url?: string | null;
|
|
915
|
+
};
|
|
916
|
+
ToolCatalogMedia: {
|
|
917
|
+
iconUrl: string | null;
|
|
918
|
+
coverImageUrl: string | null;
|
|
919
|
+
};
|
|
920
|
+
ToolCatalogDescription: {
|
|
921
|
+
short: string | null;
|
|
922
|
+
markdown: string | null;
|
|
923
|
+
};
|
|
924
|
+
ToolCatalogInstallation: {
|
|
925
|
+
requirements: string[];
|
|
926
|
+
permissions: string[];
|
|
927
|
+
steps: string[];
|
|
928
|
+
notes: string[];
|
|
929
|
+
};
|
|
930
|
+
ToolCatalogAppliesTo: {
|
|
931
|
+
chat: boolean | null;
|
|
932
|
+
voice: boolean | null;
|
|
933
|
+
};
|
|
934
|
+
ToolCatalogLinks: {
|
|
935
|
+
docsUrl: string | null;
|
|
936
|
+
privacyUrl: string | null;
|
|
937
|
+
termsUrl: string | null;
|
|
938
|
+
};
|
|
939
|
+
ToolCatalogCard: {
|
|
940
|
+
author: components['schemas']['ToolCatalogAuthor'];
|
|
941
|
+
media: components['schemas']['ToolCatalogMedia'];
|
|
942
|
+
description: components['schemas']['ToolCatalogDescription'];
|
|
943
|
+
features: string[];
|
|
944
|
+
useCases: string[];
|
|
945
|
+
installation: components['schemas']['ToolCatalogInstallation'];
|
|
946
|
+
appliesTo: components['schemas']['ToolCatalogAppliesTo'];
|
|
947
|
+
links: components['schemas']['ToolCatalogLinks'];
|
|
948
|
+
};
|
|
949
|
+
ToolCatalogMetadata: {
|
|
950
|
+
version: 1;
|
|
951
|
+
i18n: {
|
|
952
|
+
[key: string]: components['schemas']['ToolCatalogCard'];
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
ToolConnectionListItem: {
|
|
956
|
+
toolAgentConnectionId: string;
|
|
957
|
+
toolId: string;
|
|
958
|
+
workspaceId: string;
|
|
959
|
+
agentId: string;
|
|
960
|
+
connectionKey: string;
|
|
961
|
+
status: 'connected' | 'pending' | 'error' | 'revoked';
|
|
962
|
+
providerRef?: string | null;
|
|
963
|
+
descriptionUsage?: string | null;
|
|
964
|
+
usageExample?: string | null;
|
|
965
|
+
};
|
|
966
|
+
ToolConnectionListResponse: {
|
|
967
|
+
data: components['schemas']['ToolConnectionListItem'][];
|
|
968
|
+
meta: components['schemas']['PaginationMeta'];
|
|
969
|
+
};
|
|
970
|
+
CreateToolConnectionRequest: {
|
|
971
|
+
toolId: string;
|
|
972
|
+
agentId: string;
|
|
973
|
+
connectionKey?: string;
|
|
974
|
+
metadata?: {
|
|
975
|
+
[key: string]: unknown;
|
|
976
|
+
};
|
|
977
|
+
descriptionUsage?: string;
|
|
978
|
+
usageExample?: string;
|
|
979
|
+
auth?: components['schemas']['ToolConnectionAuth'];
|
|
980
|
+
};
|
|
981
|
+
ExecuteToolConnectionRequest: {
|
|
982
|
+
action: string;
|
|
983
|
+
args?: {
|
|
984
|
+
[key: string]: unknown;
|
|
985
|
+
};
|
|
986
|
+
};
|
|
718
987
|
CatalogItemLanguageMetadata: {
|
|
719
988
|
code: string;
|
|
720
989
|
locale?: string | null;
|
|
@@ -739,6 +1008,34 @@ type components = {
|
|
|
739
1008
|
provider?: string | null;
|
|
740
1009
|
previewUrl?: string | null;
|
|
741
1010
|
};
|
|
1011
|
+
WebhookDeliveryStatus: 'queued' | 'sending' | 'success' | 'failed';
|
|
1012
|
+
WebhookDeliverySummary: {
|
|
1013
|
+
id: string;
|
|
1014
|
+
webhookId: string;
|
|
1015
|
+
subscriptionId: string;
|
|
1016
|
+
eventKey: string;
|
|
1017
|
+
status: components['schemas']['WebhookDeliveryStatus'];
|
|
1018
|
+
attempts: number;
|
|
1019
|
+
nextAttemptAt?: string | null;
|
|
1020
|
+
lastError?: string | null;
|
|
1021
|
+
requestMethod: 'GET' | 'POST';
|
|
1022
|
+
responseStatus?: number | null;
|
|
1023
|
+
createdAt: string;
|
|
1024
|
+
updatedAt: string;
|
|
1025
|
+
};
|
|
1026
|
+
WebhookDeliveryListResponse: {
|
|
1027
|
+
data: components['schemas']['WebhookDeliverySummary'][];
|
|
1028
|
+
meta: components['schemas']['PaginationMeta'];
|
|
1029
|
+
};
|
|
1030
|
+
WebhookDeliveryDetail: components['schemas']['WebhookDeliverySummary'] & {
|
|
1031
|
+
requestHeaders?: {
|
|
1032
|
+
[key: string]: string;
|
|
1033
|
+
};
|
|
1034
|
+
requestBody?: {
|
|
1035
|
+
[key: string]: unknown;
|
|
1036
|
+
} | null;
|
|
1037
|
+
responseBody?: string | null;
|
|
1038
|
+
};
|
|
742
1039
|
};
|
|
743
1040
|
responses: never;
|
|
744
1041
|
parameters: {
|
|
@@ -767,10 +1064,28 @@ type components = {
|
|
|
767
1064
|
FilterParam?: components['schemas']['QueryFilters'];
|
|
768
1065
|
WebhookId: string;
|
|
769
1066
|
SubscriptionId: string;
|
|
1067
|
+
CallId: string;
|
|
1068
|
+
SipTrunkId: string;
|
|
1069
|
+
AgentBatchIdQuery?: string;
|
|
1070
|
+
AgentIdQuery?: string;
|
|
1071
|
+
ExecutionIdQuery?: string;
|
|
1072
|
+
RecordedAfterParam?: string;
|
|
1073
|
+
RecordedBeforeParam?: string;
|
|
1074
|
+
CallsAfterParam: string;
|
|
1075
|
+
CallsStreamLimitParam?: number;
|
|
1076
|
+
UsageResourceQuery?: string;
|
|
1077
|
+
UsageFromQuery?: string;
|
|
1078
|
+
UsageToQuery?: string;
|
|
770
1079
|
OrParam?: components['schemas']['QueryOrGroups'];
|
|
771
1080
|
ScheduleId: string;
|
|
772
1081
|
ApiKeyId: string;
|
|
1082
|
+
XCacheRefresh?: boolean;
|
|
773
1083
|
IdempotencyKey: string;
|
|
1084
|
+
XApiKey?: string;
|
|
1085
|
+
DurationBucketQuery?: 'short' | 'medium' | 'long';
|
|
1086
|
+
GoalStatusQuery?: 'achieved' | 'not_achieved';
|
|
1087
|
+
SearchQuery?: string;
|
|
1088
|
+
DeliveryId: string;
|
|
774
1089
|
};
|
|
775
1090
|
requestBodies: never;
|
|
776
1091
|
headers: never;
|
|
@@ -809,8 +1124,8 @@ type ClientConfig = {
|
|
|
809
1124
|
timeoutMs?: number;
|
|
810
1125
|
fetchImpl?: typeof fetch;
|
|
811
1126
|
logger?: {
|
|
812
|
-
debug?: (...a:
|
|
813
|
-
error?: (...a:
|
|
1127
|
+
debug?: (...a: unknown[]) => void;
|
|
1128
|
+
error?: (...a: unknown[]) => void;
|
|
814
1129
|
};
|
|
815
1130
|
workspaceId?: string;
|
|
816
1131
|
getWorkspaceId?: () => string | undefined;
|
|
@@ -822,9 +1137,75 @@ type ClientConfig = {
|
|
|
822
1137
|
type AgentDetail = components['schemas']['AgentDetail'];
|
|
823
1138
|
type AgentSummary = components['schemas']['AgentSummary'];
|
|
824
1139
|
type AgentListResponse = components['schemas']['AgentListResponse'];
|
|
825
|
-
type CreateAgentRequest = components['schemas']['CreateAgentRequest']
|
|
826
|
-
|
|
1140
|
+
type CreateAgentRequest = components['schemas']['CreateAgentRequest'] & {
|
|
1141
|
+
documentRefs?: DocumentRef[];
|
|
1142
|
+
};
|
|
1143
|
+
type CloneAgentRequest = components['schemas']['CloneAgentRequest'];
|
|
1144
|
+
type CloneAgentComponent = CloneAgentRequest['clone'][number];
|
|
1145
|
+
type CloneAgentSelection = CloneAgentComponent[] | Partial<Record<CloneAgentComponent, boolean>>;
|
|
1146
|
+
type CloneAgentPayload = Omit<CloneAgentRequest, 'clone'> & {
|
|
1147
|
+
clone?: CloneAgentSelection;
|
|
1148
|
+
};
|
|
1149
|
+
type ForkAgentFromTemplateRequest = components['schemas']['ForkAgentFromTemplateRequest'] & {
|
|
1150
|
+
documentRefs?: DocumentRef[];
|
|
1151
|
+
};
|
|
827
1152
|
type UpdateAgentRequest = components['schemas']['UpdateAgentRequest'];
|
|
1153
|
+
type RuntimeUsage = {
|
|
1154
|
+
totalCostUsd: number;
|
|
1155
|
+
inputTokens: number;
|
|
1156
|
+
outputTokens: number;
|
|
1157
|
+
cacheReadInputTokens: number;
|
|
1158
|
+
cacheCreationInputTokens: number;
|
|
1159
|
+
peakMemoryMb: number;
|
|
1160
|
+
};
|
|
1161
|
+
type PresignDocumentItem = {
|
|
1162
|
+
filename: string;
|
|
1163
|
+
contentType: string;
|
|
1164
|
+
};
|
|
1165
|
+
type PresignDocumentsRequest = {
|
|
1166
|
+
files: PresignDocumentItem[];
|
|
1167
|
+
};
|
|
1168
|
+
type PresignedDocument = {
|
|
1169
|
+
key: string;
|
|
1170
|
+
uploadUrl: string;
|
|
1171
|
+
filename: string;
|
|
1172
|
+
};
|
|
1173
|
+
type PresignDocumentsResponse = {
|
|
1174
|
+
documents: PresignedDocument[];
|
|
1175
|
+
};
|
|
1176
|
+
type DocumentRef = {
|
|
1177
|
+
key: string;
|
|
1178
|
+
description: string;
|
|
1179
|
+
};
|
|
1180
|
+
type RuntimeProgressEvent = {
|
|
1181
|
+
messageType: string;
|
|
1182
|
+
summary: string;
|
|
1183
|
+
};
|
|
1184
|
+
type RuntimeCompleteEvent = {
|
|
1185
|
+
success: boolean;
|
|
1186
|
+
durationMs: number;
|
|
1187
|
+
usage?: RuntimeUsage;
|
|
1188
|
+
};
|
|
1189
|
+
type RuntimeErrorEvent = {
|
|
1190
|
+
error: string;
|
|
1191
|
+
code?: number | null;
|
|
1192
|
+
};
|
|
1193
|
+
type RuntimeSseEvent = {
|
|
1194
|
+
event: 'agent-created';
|
|
1195
|
+
data: AgentDetail;
|
|
1196
|
+
} | {
|
|
1197
|
+
event: 'agent';
|
|
1198
|
+
data: AgentDetail;
|
|
1199
|
+
} | {
|
|
1200
|
+
event: 'runtime-progress';
|
|
1201
|
+
data: RuntimeProgressEvent;
|
|
1202
|
+
} | {
|
|
1203
|
+
event: 'runtime-complete';
|
|
1204
|
+
data: RuntimeCompleteEvent;
|
|
1205
|
+
} | {
|
|
1206
|
+
event: 'runtime-error';
|
|
1207
|
+
data: RuntimeErrorEvent;
|
|
1208
|
+
};
|
|
828
1209
|
type AgentTagRequest = components['schemas']['AgentTagRequest'];
|
|
829
1210
|
type AgentTagsResponse = components['schemas']['AgentTagsResponse'];
|
|
830
1211
|
type Instruction = components['schemas']['Instruction'];
|
|
@@ -839,6 +1220,8 @@ type WorkspacePhonesResponse = components['schemas']['WorkspacePhonesResponse'];
|
|
|
839
1220
|
type WorkspacePhoneChannel = 'voice';
|
|
840
1221
|
type WorkspaceEnableRequest = components['schemas']['WorkspaceEnableRequest'];
|
|
841
1222
|
type WorkspaceEnableResponse = components['schemas']['WorkspaceEnableResponse'];
|
|
1223
|
+
type WorkspaceSummary = components['schemas']['WorkspaceSummary'];
|
|
1224
|
+
type WorkspaceListResponse = components['schemas']['WorkspaceListResponse'];
|
|
842
1225
|
type VoiceSummary = components['schemas']['VoiceSummary'];
|
|
843
1226
|
type VoiceListResponse = components['schemas']['VoiceListResponse'];
|
|
844
1227
|
type CatalogItemLinks = components['schemas']['CatalogItemLinks'];
|
|
@@ -944,6 +1327,13 @@ type AgentBlueprint = {
|
|
|
944
1327
|
contentHash: string | null;
|
|
945
1328
|
contentVariables: string[];
|
|
946
1329
|
variablesCache: string[];
|
|
1330
|
+
outputVariables: Array<{
|
|
1331
|
+
type: 'string' | 'enum' | 'boolean' | 'number';
|
|
1332
|
+
name: string;
|
|
1333
|
+
description: string;
|
|
1334
|
+
required: boolean;
|
|
1335
|
+
choices?: string[];
|
|
1336
|
+
}>;
|
|
947
1337
|
createdAt: string;
|
|
948
1338
|
updatedAt: string;
|
|
949
1339
|
};
|
|
@@ -966,11 +1356,19 @@ type CreateAgentBlueprintRequest = {
|
|
|
966
1356
|
personalityInitialGreeting: string;
|
|
967
1357
|
personalityMessageStyleId: string;
|
|
968
1358
|
personalityToneStyleId: string;
|
|
1359
|
+
voiceId?: string;
|
|
969
1360
|
startSpeaker: 'user' | 'agent';
|
|
970
1361
|
requiredData?: string[];
|
|
971
1362
|
criticalRules?: string[];
|
|
972
1363
|
topicsAllowed?: string[];
|
|
973
1364
|
topicsForbidden?: string[];
|
|
1365
|
+
outputVariables?: Array<{
|
|
1366
|
+
type: 'string' | 'text' | 'enum' | 'boolean' | 'number';
|
|
1367
|
+
name: string;
|
|
1368
|
+
description: string;
|
|
1369
|
+
required?: boolean;
|
|
1370
|
+
choices?: string[];
|
|
1371
|
+
}>;
|
|
974
1372
|
};
|
|
975
1373
|
type UpdateAgentBlueprintRequest = {
|
|
976
1374
|
languageId?: string;
|
|
@@ -981,11 +1379,19 @@ type UpdateAgentBlueprintRequest = {
|
|
|
981
1379
|
personalityInitialGreeting?: string;
|
|
982
1380
|
personalityMessageStyleId?: string;
|
|
983
1381
|
personalityToneStyleId?: string;
|
|
1382
|
+
voiceId?: string;
|
|
984
1383
|
startSpeaker?: 'user' | 'agent';
|
|
985
1384
|
requiredData?: string[];
|
|
986
1385
|
criticalRules?: string[];
|
|
987
1386
|
topicsAllowed?: string[];
|
|
988
1387
|
topicsForbidden?: string[];
|
|
1388
|
+
outputVariables?: Array<{
|
|
1389
|
+
type: 'string' | 'text' | 'enum' | 'boolean' | 'number';
|
|
1390
|
+
name: string;
|
|
1391
|
+
description: string;
|
|
1392
|
+
required?: boolean;
|
|
1393
|
+
choices?: string[];
|
|
1394
|
+
}>;
|
|
989
1395
|
};
|
|
990
1396
|
type BlueprintStageSchema = components['schemas']['BlueprintStage'];
|
|
991
1397
|
type BlueprintStage = Omit<BlueprintStageSchema, 'prompt'> & {
|
|
@@ -1023,17 +1429,41 @@ type ToolResourceUploadRequest = components['schemas']['ToolResourceUploadReques
|
|
|
1023
1429
|
type ToolResourceUploadResponse = components['schemas']['ToolResourceUploadResponse'];
|
|
1024
1430
|
type ToolResourceReloadResponse = components['schemas']['ToolResourceReloadResponse'];
|
|
1025
1431
|
type ToolConnectionAuth = components['schemas']['ToolConnectionAuth'];
|
|
1432
|
+
type CreateToolConnectionRequest = components['schemas']['CreateToolConnectionRequest'];
|
|
1026
1433
|
type ToolConnectionRequest = components['schemas']['ToolConnectionRequest'];
|
|
1027
1434
|
type ToolConnectionResponse = components['schemas']['ToolConnectionResponse'];
|
|
1435
|
+
type ToolConnectionListItem = components['schemas']['ToolConnectionListItem'];
|
|
1436
|
+
type ToolConnectionListResponse = components['schemas']['ToolConnectionListResponse'];
|
|
1437
|
+
type ExecuteToolConnectionRequest = components['schemas']['ExecuteToolConnectionRequest'];
|
|
1028
1438
|
type ErrorResponse = components['schemas']['ErrorResponse'];
|
|
1439
|
+
type ResourceProjection = components['schemas']['ResourceProjection'];
|
|
1440
|
+
type ResourceBalance = components['schemas']['ResourceBalance'];
|
|
1441
|
+
type SubscriptionInfo = components['schemas']['SubscriptionInfo'];
|
|
1442
|
+
type BillingBalanceResponse = components['schemas']['BillingBalanceResponse'];
|
|
1443
|
+
type UsageAgentRow = components['schemas']['UsageAgentRow'];
|
|
1444
|
+
type UsageAgentsAggregations = components['schemas']['UsageAgentsAggregations'];
|
|
1445
|
+
type UsageAgentsMeta = components['schemas']['UsageAgentsMeta'];
|
|
1446
|
+
type UsageAgentsResponse = components['schemas']['UsageAgentsResponse'];
|
|
1447
|
+
type SipTrunk = components['schemas']['SipTrunk'];
|
|
1448
|
+
type SipTrunkWithPassword = components['schemas']['SipTrunkWithPassword'];
|
|
1449
|
+
type CreateSipTrunkRequest = components['schemas']['CreateSipTrunkRequest'];
|
|
1450
|
+
type UpdateSipTrunkRequest = components['schemas']['UpdateSipTrunkRequest'];
|
|
1029
1451
|
type CampaignStatus = components['schemas']['CampaignStatus'];
|
|
1030
1452
|
type Campaign = components['schemas']['Campaign'];
|
|
1031
1453
|
type CampaignListResponse = components['schemas']['CampaignListResponse'];
|
|
1032
1454
|
type CampaignExecution = components['schemas']['CampaignExecution'];
|
|
1033
1455
|
type CampaignExecutionListResponse = components['schemas']['CampaignExecutionListResponse'];
|
|
1456
|
+
type Call = components['schemas']['Call'];
|
|
1457
|
+
type CallsListMeta = components['schemas']['CallsListMeta'];
|
|
1458
|
+
type CallsListResponse = components['schemas']['CallsListResponse'];
|
|
1459
|
+
type CallsStreamMeta = components['schemas']['CallsStreamMeta'];
|
|
1460
|
+
type CallsStreamResponse = components['schemas']['CallsStreamResponse'];
|
|
1034
1461
|
type WebhookSummary = components['schemas']['WebhookSummary'];
|
|
1035
1462
|
type WebhookDetail = components['schemas']['WebhookDetail'];
|
|
1036
1463
|
type WebhookListResponse = components['schemas']['WebhookListResponse'];
|
|
1464
|
+
type WebhookDeliverySummary = components['schemas']['WebhookDeliverySummary'];
|
|
1465
|
+
type WebhookDeliveryDetail = components['schemas']['WebhookDeliveryDetail'];
|
|
1466
|
+
type WebhookDeliveryListResponse = components['schemas']['WebhookDeliveryListResponse'];
|
|
1037
1467
|
type CreateWebhookRequest = components['schemas']['CreateWebhookRequest'];
|
|
1038
1468
|
type UpdateWebhookRequest = components['schemas']['UpdateWebhookRequest'];
|
|
1039
1469
|
type EventSubscriptionSummary = components['schemas']['EventSubscriptionSummary'];
|
|
@@ -1042,13 +1472,17 @@ type EventSubscriptionListResponse = components['schemas']['EventSubscriptionLis
|
|
|
1042
1472
|
type CreateEventSubscriptionRequest = components['schemas']['CreateEventSubscriptionRequest'];
|
|
1043
1473
|
type UpdateEventSubscriptionRequest = components['schemas']['UpdateEventSubscriptionRequest'];
|
|
1044
1474
|
|
|
1045
|
-
declare class HttpError extends Error {
|
|
1475
|
+
declare class HttpError<TBody = unknown> extends Error {
|
|
1046
1476
|
status: number;
|
|
1047
1477
|
statusText: string;
|
|
1048
|
-
body?:
|
|
1478
|
+
body?: TBody;
|
|
1049
1479
|
url?: string;
|
|
1050
|
-
constructor(status: number, statusText: string, body?:
|
|
1480
|
+
constructor(status: number, statusText: string, body?: TBody, url?: string);
|
|
1051
1481
|
}
|
|
1482
|
+
type ApiErrorBody = ErrorResponse;
|
|
1483
|
+
type ApiHttpError = HttpError<ApiErrorBody>;
|
|
1484
|
+
declare function isApiErrorBody(body: unknown): body is ApiErrorBody;
|
|
1485
|
+
declare function isApiHttpError(err: unknown): err is ApiHttpError;
|
|
1052
1486
|
declare class TimeoutError extends Error {
|
|
1053
1487
|
ms: number;
|
|
1054
1488
|
url?: string;
|
|
@@ -1059,6 +1493,9 @@ declare class NetworkError extends Error {
|
|
|
1059
1493
|
url?: string;
|
|
1060
1494
|
constructor(cause?: unknown, url?: string);
|
|
1061
1495
|
}
|
|
1496
|
+
declare class WorkspaceNotSelectedError extends Error {
|
|
1497
|
+
constructor();
|
|
1498
|
+
}
|
|
1062
1499
|
type RetryPolicy = {
|
|
1063
1500
|
maxRetries?: number;
|
|
1064
1501
|
baseDelayMs?: number;
|
|
@@ -1123,7 +1560,7 @@ type AgentStagesApi$1 = {
|
|
|
1123
1560
|
list(agentId: string, blueprintId: string, options?: ListAgentStagesOptions): Promise<PaginatedResult<BlueprintStageListResponse, ListAgentStagesOptions>>;
|
|
1124
1561
|
get(agentId: string, blueprintId: string, stageId: string): Promise<BlueprintStage>;
|
|
1125
1562
|
create(agentId: string, blueprintId: string, payload: CreateBlueprintStageRequest): Promise<BlueprintStage>;
|
|
1126
|
-
update(agentId: string, blueprintId: string, stageId: string, payload: UpdateBlueprintStageRequest): Promise<BlueprintStage>;
|
|
1563
|
+
update(agentId: string, blueprintId: string, stageId: string, payload: Partial<UpdateBlueprintStageRequest>): Promise<BlueprintStage>;
|
|
1127
1564
|
delete(agentId: string, blueprintId: string, stageId: string): Promise<void>;
|
|
1128
1565
|
reorder(agentId: string, blueprintId: string, payload: BlueprintStageReorderRequest): Promise<BlueprintStageListResponse>;
|
|
1129
1566
|
};
|
|
@@ -1181,6 +1618,7 @@ interface AgentEntity extends AgentBase {
|
|
|
1181
1618
|
blueprints: AgentBlueprintsHelper;
|
|
1182
1619
|
stages: AgentStagesHelper;
|
|
1183
1620
|
save(patch: UpdateAgentRequest): Promise<AgentEntity>;
|
|
1621
|
+
clone(payload: CloneAgentPayload): Promise<AgentEntity>;
|
|
1184
1622
|
delete(): Promise<void>;
|
|
1185
1623
|
refresh(): Promise<AgentEntity>;
|
|
1186
1624
|
}
|
|
@@ -1196,6 +1634,7 @@ type AgentEntityFactoryOptions = {
|
|
|
1196
1634
|
reload(agentId: string): Promise<AgentEntity>;
|
|
1197
1635
|
updateAgent(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
|
|
1198
1636
|
deleteAgent(agentId: string): Promise<void>;
|
|
1637
|
+
cloneAgent(agentId: string, payload: CloneAgentPayload): Promise<AgentEntity>;
|
|
1199
1638
|
};
|
|
1200
1639
|
declare const bindAgentStageTriggers: (api: AgentStageTriggersApi, agentId: string, blueprintId: string, stageId: string) => {
|
|
1201
1640
|
list(opts?: ListAgentStageTriggersOptions): Promise<PaginatedResult<{
|
|
@@ -1572,11 +2011,19 @@ type AgentEntityDependencies = {
|
|
|
1572
2011
|
stageTriggersApi: ReturnType<typeof createAgentStageTriggersApi>;
|
|
1573
2012
|
};
|
|
1574
2013
|
type ListAgentsOptions = Pick<ListQueryOptions, 'page' | 'limit' | 'filter'>;
|
|
2014
|
+
type SseCallbacks = {
|
|
2015
|
+
onAgentCreated?: (agent: AgentDetail) => void;
|
|
2016
|
+
onProgress?: (data: RuntimeProgressEvent) => void;
|
|
2017
|
+
onComplete?: (data: RuntimeCompleteEvent) => void;
|
|
2018
|
+
onError?: (data: RuntimeErrorEvent) => void;
|
|
2019
|
+
};
|
|
1575
2020
|
type AgentsApi = {
|
|
1576
2021
|
list(options?: ListAgentsOptions): Promise<PaginatedResult<AgentListResponse, ListAgentsOptions>>;
|
|
1577
|
-
get(agentId: string): Promise<AgentDetail>;
|
|
1578
|
-
create(payload: CreateAgentRequest): Promise<AgentDetail>;
|
|
1579
|
-
|
|
2022
|
+
get(agentId: string, callbacks?: SseCallbacks): Promise<AgentDetail>;
|
|
2023
|
+
create(payload: CreateAgentRequest, callbacks?: SseCallbacks): Promise<AgentDetail>;
|
|
2024
|
+
clone(agentId: string, payload: CloneAgentPayload): Promise<AgentDetail>;
|
|
2025
|
+
forkFromTemplate(payload: ForkAgentFromTemplateRequest, callbacks?: SseCallbacks): Promise<AgentDetail>;
|
|
2026
|
+
rebuild(agentId: string, callbacks?: SseCallbacks): Promise<AgentDetail>;
|
|
1580
2027
|
update(agentId: string, payload: UpdateAgentRequest): Promise<AgentDetail>;
|
|
1581
2028
|
delete(agent: string | AgentEntity): Promise<void>;
|
|
1582
2029
|
};
|
|
@@ -1584,11 +2031,12 @@ type AgentListResponseWithEntities = {
|
|
|
1584
2031
|
data: AgentEntity[];
|
|
1585
2032
|
meta: AgentListResponse['meta'];
|
|
1586
2033
|
};
|
|
1587
|
-
type AgentsApiWithEntities = Omit<AgentsApi, 'get' | 'create' | 'update' | 'list' | 'forkFromTemplate'> & {
|
|
2034
|
+
type AgentsApiWithEntities = Omit<AgentsApi, 'get' | 'create' | 'clone' | 'update' | 'list' | 'forkFromTemplate'> & {
|
|
1588
2035
|
list(options?: ListAgentsOptions): Promise<PaginatedResult<AgentListResponseWithEntities, ListAgentsOptions>>;
|
|
1589
|
-
get(agentId: string): Promise<AgentEntity>;
|
|
1590
|
-
create(payload: CreateAgentRequest): Promise<AgentEntity>;
|
|
1591
|
-
|
|
2036
|
+
get(agentId: string, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2037
|
+
create(payload: CreateAgentRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2038
|
+
clone(agentId: string, payload: CloneAgentPayload): Promise<AgentEntity>;
|
|
2039
|
+
forkFromTemplate(payload: ForkAgentFromTemplateRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
1592
2040
|
update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
|
|
1593
2041
|
};
|
|
1594
2042
|
declare function createAgentsApi(cfg: ClientConfig & {
|
|
@@ -1605,8 +2053,42 @@ declare function createApiKeysApi(cfg: ClientConfig & {
|
|
|
1605
2053
|
retry?: RetryPolicy;
|
|
1606
2054
|
}): ApiKeysApi;
|
|
1607
2055
|
|
|
2056
|
+
declare function createBillingApi(cfg: ClientConfig & {
|
|
2057
|
+
retry?: RetryPolicy;
|
|
2058
|
+
}): {
|
|
2059
|
+
getBalance(): Promise<BillingBalanceResponse>;
|
|
2060
|
+
};
|
|
2061
|
+
|
|
2062
|
+
type ListCallsOptions = ListQueryOptions & Partial<{
|
|
2063
|
+
agentBatchId: string;
|
|
2064
|
+
agentId: string;
|
|
2065
|
+
executionId: string;
|
|
2066
|
+
recordedAfter: string | Date;
|
|
2067
|
+
recordedBefore: string | Date;
|
|
2068
|
+
durationBucket: 'short' | 'medium' | 'long';
|
|
2069
|
+
goalStatus: 'achieved' | 'not_achieved';
|
|
2070
|
+
query: string;
|
|
2071
|
+
}>;
|
|
2072
|
+
type StreamCallsOptions = {
|
|
2073
|
+
after: string | Date;
|
|
2074
|
+
limit?: number;
|
|
2075
|
+
agentBatchId?: string;
|
|
2076
|
+
agentId?: string;
|
|
2077
|
+
executionId?: string;
|
|
2078
|
+
durationBucket?: 'short' | 'medium' | 'long';
|
|
2079
|
+
goalStatus?: 'achieved' | 'not_achieved';
|
|
2080
|
+
query?: string;
|
|
2081
|
+
};
|
|
2082
|
+
declare function createCallsApi(cfg: ClientConfig & {
|
|
2083
|
+
retry?: RetryPolicy;
|
|
2084
|
+
}): {
|
|
2085
|
+
list(options?: ListCallsOptions): Promise<PaginatedResult<CallsListResponse, ListCallsOptions>>;
|
|
2086
|
+
stream(options: StreamCallsOptions): Promise<CallsStreamResponse>;
|
|
2087
|
+
get(callId: string): Promise<Call>;
|
|
2088
|
+
};
|
|
2089
|
+
|
|
1608
2090
|
type ListCampaignsOptions = ListQueryOptions;
|
|
1609
|
-
type ListCampaignExecutionsOptions =
|
|
2091
|
+
type ListCampaignExecutionsOptions = ListQueryOptions;
|
|
1610
2092
|
type CreateCampaignPayload = {
|
|
1611
2093
|
name: string;
|
|
1612
2094
|
file: unknown;
|
|
@@ -1619,6 +2101,16 @@ declare function createCampaignsApi(cfg: ClientConfig & {
|
|
|
1619
2101
|
get(campaignId: string): Promise<Campaign>;
|
|
1620
2102
|
create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
|
|
1621
2103
|
listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
|
|
2104
|
+
pause(campaignId: string): Promise<{
|
|
2105
|
+
status: "paused";
|
|
2106
|
+
}>;
|
|
2107
|
+
resume(campaignId: string): Promise<{
|
|
2108
|
+
status: "resumed";
|
|
2109
|
+
}>;
|
|
2110
|
+
cancel(campaignId: string): Promise<{
|
|
2111
|
+
status: "cancelled";
|
|
2112
|
+
}>;
|
|
2113
|
+
exportExecutions(campaignId: string): Promise<Blob>;
|
|
1622
2114
|
};
|
|
1623
2115
|
|
|
1624
2116
|
type ListCatalogTemplatesOptions = {
|
|
@@ -1642,6 +2134,23 @@ declare function createCatalogsApi(cfg: ClientConfig & {
|
|
|
1642
2134
|
remove(itemId: string): Promise<void>;
|
|
1643
2135
|
};
|
|
1644
2136
|
|
|
2137
|
+
type DocumentsApi = {
|
|
2138
|
+
create(files: PresignDocumentItem[]): Promise<PresignDocumentsResponse>;
|
|
2139
|
+
};
|
|
2140
|
+
declare function createDocumentsApi(cfg: ClientConfig & {
|
|
2141
|
+
retry?: RetryPolicy;
|
|
2142
|
+
}): DocumentsApi;
|
|
2143
|
+
|
|
2144
|
+
declare function createSipTrunksApi(cfg: ClientConfig & {
|
|
2145
|
+
retry?: RetryPolicy;
|
|
2146
|
+
}): {
|
|
2147
|
+
list(): Promise<SipTrunk[]>;
|
|
2148
|
+
get(trunkId: string): Promise<SipTrunk>;
|
|
2149
|
+
create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
|
|
2150
|
+
update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
|
|
2151
|
+
delete(trunkId: string): Promise<void>;
|
|
2152
|
+
};
|
|
2153
|
+
|
|
1645
2154
|
type IdempotentRequestOptions = {
|
|
1646
2155
|
idempotencyKey?: string;
|
|
1647
2156
|
};
|
|
@@ -1651,19 +2160,42 @@ type ListToolsOptions = ListQueryOptions & {
|
|
|
1651
2160
|
type ListToolResourcesOptions = Pick<ListQueryOptions, 'page' | 'limit'> & {
|
|
1652
2161
|
type?: 'document' | 'media' | 'file';
|
|
1653
2162
|
};
|
|
2163
|
+
type ListToolConnectionsOptions = ListQueryOptions;
|
|
1654
2164
|
type UploadToolResourcePayload = FormData | (Omit<ToolResourceUploadRequest, 'file'> & {
|
|
1655
2165
|
file: unknown;
|
|
1656
2166
|
});
|
|
1657
2167
|
declare function createToolsApi(cfg: ClientConfig & {
|
|
1658
2168
|
retry?: RetryPolicy;
|
|
1659
2169
|
}): {
|
|
2170
|
+
connections: {
|
|
2171
|
+
readonly connect: (toolId: string, payload: ToolConnectionRequest, options?: IdempotentRequestOptions) => Promise<ToolConnectionResponse>;
|
|
2172
|
+
readonly create: (payload: CreateToolConnectionRequest, options?: IdempotentRequestOptions) => Promise<ToolConnectionResponse>;
|
|
2173
|
+
readonly execute: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: IdempotentRequestOptions) => Promise<ExecuteToolResponse>;
|
|
2174
|
+
readonly list: (options?: ListToolConnectionsOptions) => Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
2175
|
+
readonly createConnection: (payload: CreateToolConnectionRequest, options?: IdempotentRequestOptions) => Promise<ToolConnectionResponse>;
|
|
2176
|
+
readonly executeConnection: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: IdempotentRequestOptions) => Promise<ExecuteToolResponse>;
|
|
2177
|
+
};
|
|
1660
2178
|
list(options?: ListToolsOptions): Promise<PaginatedResult<ToolListResponse, ListToolsOptions>>;
|
|
1661
2179
|
listResources(toolId: string, options?: ListToolResourcesOptions): Promise<PaginatedResult<ToolResourceListResponse, ListToolResourcesOptions>>;
|
|
2180
|
+
listConnections(options?: ListToolConnectionsOptions): Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
1662
2181
|
uploadResource(toolId: string, payload: UploadToolResourcePayload): Promise<ToolResourceUploadResponse>;
|
|
1663
2182
|
deleteResource(toolId: string, resourceId: string): Promise<void>;
|
|
1664
2183
|
reloadResource(toolId: string, resourceId: string): Promise<ToolResourceReloadResponse>;
|
|
1665
2184
|
execute(toolId: string, payload: ExecuteToolRequest, options?: IdempotentRequestOptions): Promise<ExecuteToolResponse>;
|
|
1666
2185
|
connect(toolId: string, payload: ToolConnectionRequest, options?: IdempotentRequestOptions): Promise<ToolConnectionResponse>;
|
|
2186
|
+
createConnection(payload: CreateToolConnectionRequest, options?: IdempotentRequestOptions): Promise<ToolConnectionResponse>;
|
|
2187
|
+
executeConnection(toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: IdempotentRequestOptions): Promise<ExecuteToolResponse>;
|
|
2188
|
+
};
|
|
2189
|
+
|
|
2190
|
+
type ListUsageAgentsOptions = ListQueryOptions & Partial<{
|
|
2191
|
+
resource: string;
|
|
2192
|
+
from: string;
|
|
2193
|
+
to: string;
|
|
2194
|
+
}>;
|
|
2195
|
+
declare function createUsageApi(cfg: ClientConfig & {
|
|
2196
|
+
retry?: RetryPolicy;
|
|
2197
|
+
}): {
|
|
2198
|
+
agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
|
|
1667
2199
|
};
|
|
1668
2200
|
|
|
1669
2201
|
type ListVoicesOptions = ListQueryOptions & {
|
|
@@ -1694,16 +2226,22 @@ declare function createWebhooksApi(cfg: ClientConfig & {
|
|
|
1694
2226
|
getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
|
|
1695
2227
|
updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
|
|
1696
2228
|
deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
|
|
2229
|
+
listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
|
|
2230
|
+
getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
|
|
1697
2231
|
};
|
|
1698
2232
|
|
|
1699
2233
|
type ListWorkspacePhonesOptions = ListQueryOptions & {
|
|
1700
2234
|
channel?: WorkspacePhoneChannel;
|
|
1701
2235
|
};
|
|
2236
|
+
type ListWorkspacesOptions = ListQueryOptions & {
|
|
2237
|
+
refreshCache?: boolean;
|
|
2238
|
+
};
|
|
1702
2239
|
declare function createWorkspacesApi(cfg: ClientConfig & {
|
|
1703
2240
|
retry?: RetryPolicy;
|
|
1704
2241
|
}): {
|
|
2242
|
+
list(options?: ListWorkspacesOptions): Promise<PaginatedResult<WorkspaceListResponse, ListWorkspacesOptions>>;
|
|
1705
2243
|
listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
|
|
1706
|
-
enable(
|
|
2244
|
+
enable(payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
|
|
1707
2245
|
};
|
|
1708
2246
|
|
|
1709
2247
|
declare function createClient(initialCfg: ClientConfig & {
|
|
@@ -1786,22 +2324,44 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1786
2324
|
triggers: AgentStageTriggersApi$1 & ((agentId: string, blueprintId: string, stageId: string) => ReturnType<typeof bindAgentStageTriggers>);
|
|
1787
2325
|
};
|
|
1788
2326
|
delete: (agent: string | AgentEntity) => Promise<void>;
|
|
2327
|
+
rebuild: (agentId: string, callbacks?: SseCallbacks) => Promise<AgentDetail>;
|
|
1789
2328
|
list(options?: ListAgentsOptions): Promise<PaginatedResult<{
|
|
1790
2329
|
data: AgentEntity[];
|
|
1791
2330
|
meta: AgentListResponse["meta"];
|
|
1792
2331
|
}, ListAgentsOptions>>;
|
|
1793
|
-
get(agentId: string): Promise<AgentEntity>;
|
|
1794
|
-
create(payload: CreateAgentRequest): Promise<AgentEntity>;
|
|
1795
|
-
|
|
2332
|
+
get(agentId: string, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2333
|
+
create(payload: CreateAgentRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2334
|
+
clone(agentId: string, payload: CloneAgentPayload): Promise<AgentEntity>;
|
|
2335
|
+
forkFromTemplate(payload: ForkAgentFromTemplateRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
1796
2336
|
update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
|
|
1797
2337
|
};
|
|
1798
2338
|
workspaces: {
|
|
2339
|
+
list(options?: ListWorkspacesOptions): Promise<PaginatedResult<WorkspaceListResponse, ListWorkspacesOptions>>;
|
|
1799
2340
|
listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
|
|
1800
|
-
enable(
|
|
2341
|
+
enable(payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
|
|
1801
2342
|
};
|
|
1802
2343
|
tools: {
|
|
2344
|
+
connections: {
|
|
2345
|
+
readonly connect: (toolId: string, payload: ToolConnectionRequest, options?: {
|
|
2346
|
+
idempotencyKey?: string;
|
|
2347
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2348
|
+
readonly create: (payload: CreateToolConnectionRequest, options?: {
|
|
2349
|
+
idempotencyKey?: string;
|
|
2350
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2351
|
+
readonly execute: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2352
|
+
idempotencyKey?: string;
|
|
2353
|
+
}) => Promise<ExecuteToolResponse>;
|
|
2354
|
+
readonly list: (options?: ListToolConnectionsOptions) => Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
2355
|
+
readonly createConnection: (payload: CreateToolConnectionRequest, options?: {
|
|
2356
|
+
idempotencyKey?: string;
|
|
2357
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2358
|
+
readonly executeConnection: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2359
|
+
idempotencyKey?: string;
|
|
2360
|
+
}) => Promise<ExecuteToolResponse>;
|
|
2361
|
+
};
|
|
1803
2362
|
list(options?: ListToolsOptions): Promise<PaginatedResult<ToolListResponse, ListToolsOptions>>;
|
|
1804
2363
|
listResources(toolId: string, options?: ListToolResourcesOptions): Promise<PaginatedResult<ToolResourceListResponse, ListToolResourcesOptions>>;
|
|
2364
|
+
listConnections(options?: ListToolConnectionsOptions): Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
1805
2365
|
uploadResource(toolId: string, payload: FormData | (Omit<{
|
|
1806
2366
|
file: string;
|
|
1807
2367
|
type?: "document" | "media" | "file";
|
|
@@ -1820,6 +2380,12 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1820
2380
|
connect(toolId: string, payload: ToolConnectionRequest, options?: {
|
|
1821
2381
|
idempotencyKey?: string;
|
|
1822
2382
|
}): Promise<ToolConnectionResponse>;
|
|
2383
|
+
createConnection(payload: CreateToolConnectionRequest, options?: {
|
|
2384
|
+
idempotencyKey?: string;
|
|
2385
|
+
}): Promise<ToolConnectionResponse>;
|
|
2386
|
+
executeConnection(toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2387
|
+
idempotencyKey?: string;
|
|
2388
|
+
}): Promise<ExecuteToolResponse>;
|
|
1823
2389
|
};
|
|
1824
2390
|
catalogs: {
|
|
1825
2391
|
templates: {
|
|
@@ -1831,16 +2397,45 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1831
2397
|
create(payload: CatalogItemCreateRequest): Promise<CatalogItemDetail>;
|
|
1832
2398
|
remove(itemId: string): Promise<void>;
|
|
1833
2399
|
};
|
|
2400
|
+
documents: DocumentsApi;
|
|
1834
2401
|
campaigns: {
|
|
1835
2402
|
list(options?: ListCampaignsOptions): Promise<PaginatedResult<CampaignListResponse, ListCampaignsOptions>>;
|
|
1836
2403
|
get(campaignId: string): Promise<Campaign>;
|
|
1837
2404
|
create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
|
|
1838
2405
|
listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
|
|
2406
|
+
pause(campaignId: string): Promise<{
|
|
2407
|
+
status: "paused";
|
|
2408
|
+
}>;
|
|
2409
|
+
resume(campaignId: string): Promise<{
|
|
2410
|
+
status: "resumed";
|
|
2411
|
+
}>;
|
|
2412
|
+
cancel(campaignId: string): Promise<{
|
|
2413
|
+
status: "cancelled";
|
|
2414
|
+
}>;
|
|
2415
|
+
exportExecutions(campaignId: string): Promise<Blob>;
|
|
1839
2416
|
};
|
|
1840
2417
|
voices: {
|
|
1841
2418
|
list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
|
|
1842
2419
|
};
|
|
1843
2420
|
apiKeys: ApiKeysApi;
|
|
2421
|
+
billing: {
|
|
2422
|
+
getBalance(): Promise<BillingBalanceResponse>;
|
|
2423
|
+
};
|
|
2424
|
+
calls: {
|
|
2425
|
+
list(options?: ListCallsOptions): Promise<PaginatedResult<CallsListResponse, ListCallsOptions>>;
|
|
2426
|
+
stream(options: StreamCallsOptions): Promise<CallsStreamResponse>;
|
|
2427
|
+
get(callId: string): Promise<Call>;
|
|
2428
|
+
};
|
|
2429
|
+
usage: {
|
|
2430
|
+
agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
|
|
2431
|
+
};
|
|
2432
|
+
sip: {
|
|
2433
|
+
list(): Promise<SipTrunk[]>;
|
|
2434
|
+
get(trunkId: string): Promise<SipTrunk>;
|
|
2435
|
+
create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
|
|
2436
|
+
update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
|
|
2437
|
+
delete(trunkId: string): Promise<void>;
|
|
2438
|
+
};
|
|
1844
2439
|
webhooks: {
|
|
1845
2440
|
list(options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookListResponse, ListWebhooksOptions>>;
|
|
1846
2441
|
create(payload: CreateWebhookRequest): Promise<WebhookDetail>;
|
|
@@ -1852,6 +2447,8 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1852
2447
|
getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
|
|
1853
2448
|
updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
|
|
1854
2449
|
deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
|
|
2450
|
+
listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
|
|
2451
|
+
getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
|
|
1855
2452
|
};
|
|
1856
2453
|
};
|
|
1857
2454
|
};
|
|
@@ -1899,22 +2496,44 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1899
2496
|
triggers: AgentStageTriggersApi$1 & ((agentId: string, blueprintId: string, stageId: string) => ReturnType<typeof bindAgentStageTriggers>);
|
|
1900
2497
|
};
|
|
1901
2498
|
delete: (agent: string | AgentEntity) => Promise<void>;
|
|
2499
|
+
rebuild: (agentId: string, callbacks?: SseCallbacks) => Promise<AgentDetail>;
|
|
1902
2500
|
list(options?: ListAgentsOptions): Promise<PaginatedResult<{
|
|
1903
2501
|
data: AgentEntity[];
|
|
1904
2502
|
meta: AgentListResponse["meta"];
|
|
1905
2503
|
}, ListAgentsOptions>>;
|
|
1906
|
-
get(agentId: string): Promise<AgentEntity>;
|
|
1907
|
-
create(payload: CreateAgentRequest): Promise<AgentEntity>;
|
|
1908
|
-
|
|
2504
|
+
get(agentId: string, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2505
|
+
create(payload: CreateAgentRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
2506
|
+
clone(agentId: string, payload: CloneAgentPayload): Promise<AgentEntity>;
|
|
2507
|
+
forkFromTemplate(payload: ForkAgentFromTemplateRequest, callbacks?: SseCallbacks): Promise<AgentEntity>;
|
|
1909
2508
|
update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
|
|
1910
2509
|
};
|
|
1911
2510
|
workspaces: {
|
|
2511
|
+
list(options?: ListWorkspacesOptions): Promise<PaginatedResult<WorkspaceListResponse, ListWorkspacesOptions>>;
|
|
1912
2512
|
listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
|
|
1913
|
-
enable(
|
|
2513
|
+
enable(payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
|
|
1914
2514
|
};
|
|
1915
2515
|
tools: {
|
|
2516
|
+
connections: {
|
|
2517
|
+
readonly connect: (toolId: string, payload: ToolConnectionRequest, options?: {
|
|
2518
|
+
idempotencyKey?: string;
|
|
2519
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2520
|
+
readonly create: (payload: CreateToolConnectionRequest, options?: {
|
|
2521
|
+
idempotencyKey?: string;
|
|
2522
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2523
|
+
readonly execute: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2524
|
+
idempotencyKey?: string;
|
|
2525
|
+
}) => Promise<ExecuteToolResponse>;
|
|
2526
|
+
readonly list: (options?: ListToolConnectionsOptions) => Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
2527
|
+
readonly createConnection: (payload: CreateToolConnectionRequest, options?: {
|
|
2528
|
+
idempotencyKey?: string;
|
|
2529
|
+
}) => Promise<ToolConnectionResponse>;
|
|
2530
|
+
readonly executeConnection: (toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2531
|
+
idempotencyKey?: string;
|
|
2532
|
+
}) => Promise<ExecuteToolResponse>;
|
|
2533
|
+
};
|
|
1916
2534
|
list(options?: ListToolsOptions): Promise<PaginatedResult<ToolListResponse, ListToolsOptions>>;
|
|
1917
2535
|
listResources(toolId: string, options?: ListToolResourcesOptions): Promise<PaginatedResult<ToolResourceListResponse, ListToolResourcesOptions>>;
|
|
2536
|
+
listConnections(options?: ListToolConnectionsOptions): Promise<PaginatedResult<ToolConnectionListResponse, ListToolConnectionsOptions>>;
|
|
1918
2537
|
uploadResource(toolId: string, payload: FormData | (Omit<{
|
|
1919
2538
|
file: string;
|
|
1920
2539
|
type?: "document" | "media" | "file";
|
|
@@ -1933,6 +2552,12 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1933
2552
|
connect(toolId: string, payload: ToolConnectionRequest, options?: {
|
|
1934
2553
|
idempotencyKey?: string;
|
|
1935
2554
|
}): Promise<ToolConnectionResponse>;
|
|
2555
|
+
createConnection(payload: CreateToolConnectionRequest, options?: {
|
|
2556
|
+
idempotencyKey?: string;
|
|
2557
|
+
}): Promise<ToolConnectionResponse>;
|
|
2558
|
+
executeConnection(toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: {
|
|
2559
|
+
idempotencyKey?: string;
|
|
2560
|
+
}): Promise<ExecuteToolResponse>;
|
|
1936
2561
|
};
|
|
1937
2562
|
catalogs: {
|
|
1938
2563
|
templates: {
|
|
@@ -1944,16 +2569,45 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1944
2569
|
create(payload: CatalogItemCreateRequest): Promise<CatalogItemDetail>;
|
|
1945
2570
|
remove(itemId: string): Promise<void>;
|
|
1946
2571
|
};
|
|
2572
|
+
documents: DocumentsApi;
|
|
1947
2573
|
campaigns: {
|
|
1948
2574
|
list(options?: ListCampaignsOptions): Promise<PaginatedResult<CampaignListResponse, ListCampaignsOptions>>;
|
|
1949
2575
|
get(campaignId: string): Promise<Campaign>;
|
|
1950
2576
|
create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
|
|
1951
2577
|
listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
|
|
2578
|
+
pause(campaignId: string): Promise<{
|
|
2579
|
+
status: "paused";
|
|
2580
|
+
}>;
|
|
2581
|
+
resume(campaignId: string): Promise<{
|
|
2582
|
+
status: "resumed";
|
|
2583
|
+
}>;
|
|
2584
|
+
cancel(campaignId: string): Promise<{
|
|
2585
|
+
status: "cancelled";
|
|
2586
|
+
}>;
|
|
2587
|
+
exportExecutions(campaignId: string): Promise<Blob>;
|
|
1952
2588
|
};
|
|
1953
2589
|
voices: {
|
|
1954
2590
|
list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
|
|
1955
2591
|
};
|
|
1956
2592
|
apiKeys: ApiKeysApi;
|
|
2593
|
+
billing: {
|
|
2594
|
+
getBalance(): Promise<BillingBalanceResponse>;
|
|
2595
|
+
};
|
|
2596
|
+
calls: {
|
|
2597
|
+
list(options?: ListCallsOptions): Promise<PaginatedResult<CallsListResponse, ListCallsOptions>>;
|
|
2598
|
+
stream(options: StreamCallsOptions): Promise<CallsStreamResponse>;
|
|
2599
|
+
get(callId: string): Promise<Call>;
|
|
2600
|
+
};
|
|
2601
|
+
usage: {
|
|
2602
|
+
agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
|
|
2603
|
+
};
|
|
2604
|
+
sip: {
|
|
2605
|
+
list(): Promise<SipTrunk[]>;
|
|
2606
|
+
get(trunkId: string): Promise<SipTrunk>;
|
|
2607
|
+
create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
|
|
2608
|
+
update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
|
|
2609
|
+
delete(trunkId: string): Promise<void>;
|
|
2610
|
+
};
|
|
1957
2611
|
webhooks: {
|
|
1958
2612
|
list(options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookListResponse, ListWebhooksOptions>>;
|
|
1959
2613
|
create(payload: CreateWebhookRequest): Promise<WebhookDetail>;
|
|
@@ -1965,6 +2619,8 @@ declare function createClient(initialCfg: ClientConfig & {
|
|
|
1965
2619
|
getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
|
|
1966
2620
|
updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
|
|
1967
2621
|
deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
|
|
2622
|
+
listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
|
|
2623
|
+
getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
|
|
1968
2624
|
};
|
|
1969
2625
|
};
|
|
1970
2626
|
|
|
@@ -1980,8 +2636,8 @@ declare function createHttp(cfg: ClientConfig & {
|
|
|
1980
2636
|
base: string;
|
|
1981
2637
|
timeout: number;
|
|
1982
2638
|
log: {
|
|
1983
|
-
debug?: (...a:
|
|
1984
|
-
error?: (...a:
|
|
2639
|
+
debug?: (...a: unknown[]) => void;
|
|
2640
|
+
error?: (...a: unknown[]) => void;
|
|
1985
2641
|
};
|
|
1986
2642
|
retry: RetryPolicy;
|
|
1987
2643
|
doFetch: (url: string, init?: FetchOptions) => Promise<Response>;
|
|
@@ -1991,4 +2647,4 @@ declare function createHttp(cfg: ClientConfig & {
|
|
|
1991
2647
|
resolveAccessToken: () => string;
|
|
1992
2648
|
};
|
|
1993
2649
|
|
|
1994
|
-
export { type AgentBlueprint, type AgentBlueprintListItem, type AgentBlueprintListResponse, type AgentBlueprintsApi$1 as AgentBlueprintsApi, type AgentDetail, type AgentEntity, type AgentEntityFactoryOptions, type AgentListResponse, type AgentSchedule, type AgentScheduleApi, type AgentScheduleException, type AgentScheduleExceptionListResponse, type AgentScheduleListResponse, type AgentStageTriggersApi$1 as AgentStageTriggersApi, type AgentStagesApi$1 as AgentStagesApi, type AgentSummary, type AgentTagRequest, type AgentTagsResponse, type AgentVersionDetail, type AgentVersionListResponse, type AgentVersionSummary, type AgentsApi, type AgentsApiWithEntities, type ApiKeyListResponse, type ApiKeySummary, type ApiKeysApi, type BlueprintStage, type BlueprintStageListResponse, type BlueprintStageReorderRequest, type BlueprintStageTrigger, type BlueprintStageTriggerListResponse, type Campaign, type CampaignExecution, type CampaignExecutionListResponse, type CampaignListResponse, type CampaignStatus, type CatalogItemCreateRequest, type CatalogItemDetail, type CatalogItemLinks, type CatalogItemListResponse, type CatalogItemSummary, type CatalogTemplateDetail, type CatalogTemplateListResponse, type CatalogTemplateSummary, type CatalogTemplateVisibility, type ClientConfig, type ConnectPhoneRequest, type CreateAgentBlueprintRequest, type CreateAgentRequest, type CreateAgentScheduleExceptionRequest, type CreateAgentVersionRequest, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateBlueprintStageRequest, type CreateBlueprintStageTriggerRequest, type CreateCampaignPayload, type CreateEventSubscriptionRequest, type CreateInstructionRequest, type CreateWebhookRequest, type ErrorResponse, type EventSubscriptionDetail, type EventSubscriptionListResponse, type EventSubscriptionSummary, type ExecuteToolRequest, type ExecuteToolResponse, type ForkAgentFromTemplateRequest, HttpError, type Instruction, type InstructionCreatedResponse, type InstructionListResponse, type ListAgentBlueprintsOptions, type ListAgentScheduleExceptionsOptions, type ListAgentSchedulesOptions, type ListAgentStageTriggersOptions, type ListAgentStagesOptions, type ListAgentVersionInstructionsOptions, type ListAgentVersionsOptions, type ListAgentsOptions, type ListCampaignExecutionsOptions, type ListCampaignsOptions, type ListCatalogItemsOptions, type ListCatalogTemplatesOptions, type ListQueryOptions, type ListToolResourcesOptions, type ListToolsOptions, type ListVoicesOptions, type ListWebhooksOptions, type ListWorkspacePhonesOptions, NetworkError, type PaginatedResult, type PaginationMeta, type PhoneAssignmentResponse, type PublishAgentVersionRequest, type QueryBuilderInput, type QueryBuilderSerializable, type QueryFilterOperators, type QueryFilters, type QueryOrGroups, type QueryValue, type RetryPolicy, TimeoutError, type ToolConnectionAuth, type ToolConnectionRequest, type ToolConnectionResponse, type ToolListResponse, type ToolResourceListResponse, type ToolResourceReloadResponse, type ToolResourceSummary, type ToolResourceUploadRequest, type ToolResourceUploadResponse, type ToolSummary, type UpdateAgentBlueprintRequest, type UpdateAgentRequest, type UpdateAgentScheduleExceptionRequest, type UpdateAgentScheduleRequest, type UpdateAgentVersionNotesRequest, type UpdateBlueprintStageRequest, type UpdateBlueprintStageTriggerRequest, type UpdateEventSubscriptionRequest, type UpdateInstructionRequest, type UpdateWebhookRequest, type VoiceListResponse, type VoiceSummary, type WebhookDetail, type WebhookListResponse, type WebhookSummary, type WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, bindAgentBlueprints, bindAgentPhones, bindAgentSchedule, bindAgentScheduleExceptions, bindAgentSchedules, bindAgentStageTriggers, bindAgentStages, bindAgentTags, bindAgentVersions, createAgentBlueprintsApi, createAgentEntity, createAgentPhonesApi, createAgentScheduleApi, createAgentScheduleExceptionsApi, createAgentStageTriggersApi, createAgentStagesApi, createAgentTagsApi, createAgentVersionsApi, createAgentsApi, createApiKeysApi, createCampaignsApi, createCatalogTemplatesApi, createCatalogsApi, createClient, createHttp, createToolsApi, createVoicesApi, createWebhooksApi, createWorkspacesApi };
|
|
2650
|
+
export { type AgentBlueprint, type AgentBlueprintListItem, type AgentBlueprintListResponse, type AgentBlueprintsApi$1 as AgentBlueprintsApi, type AgentDetail, type AgentEntity, type AgentEntityFactoryOptions, type AgentListResponse, type AgentSchedule, type AgentScheduleApi, type AgentScheduleException, type AgentScheduleExceptionListResponse, type AgentScheduleListResponse, type AgentStageTriggersApi$1 as AgentStageTriggersApi, type AgentStagesApi$1 as AgentStagesApi, type AgentSummary, type AgentTagRequest, type AgentTagsResponse, type AgentVersionDetail, type AgentVersionListResponse, type AgentVersionSummary, type AgentsApi, type AgentsApiWithEntities, type ApiErrorBody, type ApiHttpError, type ApiKeyListResponse, type ApiKeySummary, type ApiKeysApi, type BillingBalanceResponse, type BlueprintStage, type BlueprintStageListResponse, type BlueprintStageReorderRequest, type BlueprintStageTrigger, type BlueprintStageTriggerListResponse, type Call, type CallsListMeta, type CallsListResponse, type CallsStreamMeta, type CallsStreamResponse, type Campaign, type CampaignExecution, type CampaignExecutionListResponse, type CampaignListResponse, type CampaignStatus, type CatalogItemCreateRequest, type CatalogItemDetail, type CatalogItemLinks, type CatalogItemListResponse, type CatalogItemSummary, type CatalogTemplateDetail, type CatalogTemplateListResponse, type CatalogTemplateSummary, type CatalogTemplateVisibility, type ClientConfig, type CloneAgentComponent, type CloneAgentPayload, type CloneAgentRequest, type CloneAgentSelection, type ConnectPhoneRequest, type CreateAgentBlueprintRequest, type CreateAgentRequest, type CreateAgentScheduleExceptionRequest, type CreateAgentVersionRequest, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateBlueprintStageRequest, type CreateBlueprintStageTriggerRequest, type CreateCampaignPayload, type CreateEventSubscriptionRequest, type CreateInstructionRequest, type CreateSipTrunkRequest, type CreateToolConnectionRequest, type CreateWebhookRequest, type DocumentRef, type DocumentsApi, type ErrorResponse, type EventSubscriptionDetail, type EventSubscriptionListResponse, type EventSubscriptionSummary, type ExecuteToolConnectionRequest, type ExecuteToolRequest, type ExecuteToolResponse, type ForkAgentFromTemplateRequest, HttpError, type Instruction, type InstructionCreatedResponse, type InstructionListResponse, type ListAgentBlueprintsOptions, type ListAgentScheduleExceptionsOptions, type ListAgentSchedulesOptions, type ListAgentStageTriggersOptions, type ListAgentStagesOptions, type ListAgentVersionInstructionsOptions, type ListAgentVersionsOptions, type ListAgentsOptions, type ListCallsOptions, type ListCampaignExecutionsOptions, type ListCampaignsOptions, type ListCatalogItemsOptions, type ListCatalogTemplatesOptions, type ListQueryOptions, type ListToolConnectionsOptions, type ListToolResourcesOptions, type ListToolsOptions, type ListUsageAgentsOptions, type ListVoicesOptions, type ListWebhooksOptions, type ListWorkspacePhonesOptions, type ListWorkspacesOptions, NetworkError, type PaginatedResult, type PaginationMeta, type PhoneAssignmentResponse, type PresignDocumentItem, type PresignDocumentsRequest, type PresignDocumentsResponse, type PresignedDocument, type PublishAgentVersionRequest, type QueryBuilderInput, type QueryBuilderSerializable, type QueryFilterOperators, type QueryFilters, type QueryOrGroups, type QueryValue, type ResourceBalance, type ResourceProjection, type RetryPolicy, type RuntimeCompleteEvent, type RuntimeErrorEvent, type RuntimeProgressEvent, type RuntimeSseEvent, type RuntimeUsage, type SipTrunk, type SipTrunkWithPassword, type SseCallbacks, type StreamCallsOptions, type SubscriptionInfo, TimeoutError, type ToolConnectionAuth, type ToolConnectionListItem, type ToolConnectionListResponse, type ToolConnectionRequest, type ToolConnectionResponse, type ToolListResponse, type ToolResourceListResponse, type ToolResourceReloadResponse, type ToolResourceSummary, type ToolResourceUploadRequest, type ToolResourceUploadResponse, type ToolSummary, type UpdateAgentBlueprintRequest, type UpdateAgentRequest, type UpdateAgentScheduleExceptionRequest, type UpdateAgentScheduleRequest, type UpdateAgentVersionNotesRequest, type UpdateBlueprintStageRequest, type UpdateBlueprintStageTriggerRequest, type UpdateEventSubscriptionRequest, type UpdateInstructionRequest, type UpdateSipTrunkRequest, type UpdateWebhookRequest, type UsageAgentRow, type UsageAgentsAggregations, type UsageAgentsMeta, type UsageAgentsResponse, type VoiceListResponse, type VoiceSummary, type WebhookDeliveryDetail, type WebhookDeliveryListResponse, type WebhookDeliverySummary, type WebhookDetail, type WebhookListResponse, type WebhookSummary, type WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspaceListResponse, WorkspaceNotSelectedError, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, type WorkspaceSummary, bindAgentBlueprints, bindAgentPhones, bindAgentSchedule, bindAgentScheduleExceptions, bindAgentSchedules, bindAgentStageTriggers, bindAgentStages, bindAgentTags, bindAgentVersions, createAgentBlueprintsApi, createAgentEntity, createAgentPhonesApi, createAgentScheduleApi, createAgentScheduleExceptionsApi, createAgentStageTriggersApi, createAgentStagesApi, createAgentTagsApi, createAgentVersionsApi, createAgentsApi, createApiKeysApi, createBillingApi, createCallsApi, createCampaignsApi, createCatalogTemplatesApi, createCatalogsApi, createClient, createDocumentsApi, createHttp, createSipTrunksApi, createToolsApi, createUsageApi, createVoicesApi, createWebhooksApi, createWorkspacesApi, isApiErrorBody, isApiHttpError };
|