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