@getsupervisor/agents-studio-sdk 1.41.2-patch.9 → 1.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,3 +1,11 @@
1
+ type WithRequired<T, K extends keyof T> = T & {
2
+ [P in K]-?: T[P];
3
+ };
4
+ type Without<T, U> = {
5
+ [P in Exclude<keyof T, keyof U>]?: never;
6
+ };
7
+ type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
8
+ type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
1
9
  type components = {
2
10
  schemas: {
3
11
  AgentDetail: {
@@ -27,6 +35,9 @@ type components = {
27
35
  } | null;
28
36
  createdAt: string;
29
37
  updatedAt: string;
38
+ totalCalls: number;
39
+ totalOperationalDays: number;
40
+ goalAchievedPercentage: number;
30
41
  metadata?: {
31
42
  [key: string]: unknown;
32
43
  };
@@ -57,8 +68,8 @@ type components = {
57
68
  CreateAgentRequest: {
58
69
  name: string;
59
70
  description?: string | null;
60
- agentType: 'chat' | 'voice';
61
- status?: 'inactive' | 'training' | 'active' | null;
71
+ agentType: 'voice';
72
+ status?: 'inactive' | 'training' | 'active';
62
73
  avatarUrl?: string | null;
63
74
  debounceDelayMs?: number | null;
64
75
  metadata?: {
@@ -235,9 +246,9 @@ type components = {
235
246
  voiceId?: string | null;
236
247
  startSpeaker: 'user' | 'agent';
237
248
  requiredData: string[];
238
- criticalRules: string[];
239
- topicsAllowed: string[];
240
- topicsForbidden: string[];
249
+ criticalRules?: string[];
250
+ topicsAllowed?: string[];
251
+ topicsForbidden?: string[];
241
252
  contentHash: string | null;
242
253
  contentVariables: string[];
243
254
  variablesCache: string[];
@@ -312,7 +323,7 @@ type components = {
312
323
  name: string;
313
324
  title?: string | null;
314
325
  goalPrompt: string;
315
- promptInstructions: string[];
326
+ promptInstructions?: string[];
316
327
  order?: number | null;
317
328
  triggers?: components['schemas']['BlueprintStageTriggerInput'][] | null;
318
329
  metadata?: {
@@ -323,7 +334,7 @@ type components = {
323
334
  name?: string;
324
335
  title?: string | null;
325
336
  goalPrompt?: string;
326
- promptInstructions: string[];
337
+ promptInstructions?: string[];
327
338
  order?: number | null;
328
339
  metadata?: {
329
340
  [key: string]: unknown;
@@ -359,9 +370,9 @@ type components = {
359
370
  name: string;
360
371
  title?: string | null;
361
372
  goalPrompt: string;
362
- promptInstructions: string[];
373
+ promptInstructions?: string[];
363
374
  order?: number | null;
364
- triggers: components['schemas']['BlueprintStageTriggerInput'][] | null;
375
+ triggers?: components['schemas']['BlueprintStageTriggerInput'][] | null;
365
376
  metadata?: {
366
377
  [key: string]: unknown;
367
378
  } | null;
@@ -370,7 +381,7 @@ type components = {
370
381
  agent_id: string;
371
382
  phone_id: string;
372
383
  test_phones?: string[];
373
- allow_all: boolean;
384
+ allow_all?: boolean;
374
385
  };
375
386
  PhoneAssignmentResponse: {
376
387
  agent_id: string;
@@ -383,7 +394,7 @@ type components = {
383
394
  WorkspacePhone: {
384
395
  id: string;
385
396
  external_id: string;
386
- channel?: 'voice' | null;
397
+ channel?: 'voice';
387
398
  supports_outbound?: boolean | null;
388
399
  assigned_to?: string | null;
389
400
  last_used_at?: string | null;
@@ -502,7 +513,7 @@ type components = {
502
513
  self: string;
503
514
  catalog: string;
504
515
  };
505
- CatalogItemSummary: {
516
+ CatalogItemSummary: WithRequired<{
506
517
  id: string;
507
518
  type: 'language' | 'message_style' | 'tone_style' | 'tag' | 'voice';
508
519
  systemIdentifier: string;
@@ -515,13 +526,13 @@ type components = {
515
526
  createdAt: string;
516
527
  updatedAt: string;
517
528
  links: components['schemas']['CatalogItemLinks'];
518
- } & (unknown & unknown & unknown & unknown & unknown);
529
+ }, 'id' | 'type' | 'systemIdentifier' | 'scope' | 'name' | 'description' | 'isActive' | 'metadata' | 'createdAt' | 'updatedAt' | 'links'>;
519
530
  CatalogItemDetail: components['schemas']['CatalogItemSummary'];
520
531
  CatalogItemListResponse: {
521
532
  data: components['schemas']['CatalogItemSummary'][];
522
533
  meta: components['schemas']['PaginationMeta'];
523
534
  };
524
- CatalogItemCreateRequest: {
535
+ CatalogItemCreateRequest: WithRequired<{
525
536
  type: 'language' | 'message_style' | 'tone_style' | 'tag' | 'voice';
526
537
  scope: 'global' | 'workspace';
527
538
  workspaceId?: string;
@@ -529,8 +540,8 @@ type components = {
529
540
  description: string;
530
541
  systemIdentifier?: string;
531
542
  metadata: Record<string, never>;
532
- isActive: boolean;
533
- } & (unknown & unknown & unknown & unknown & unknown & unknown);
543
+ isActive?: boolean;
544
+ }, 'type' | 'scope' | 'name' | 'description' | 'metadata'>;
534
545
  WorkspaceEnableRequest: {
535
546
  apiKey: string;
536
547
  phone: string;
@@ -547,7 +558,6 @@ type components = {
547
558
  details?: {
548
559
  subcode?: string;
549
560
  workspaceId?: string;
550
- } & {
551
561
  [key: string]: unknown;
552
562
  };
553
563
  };
@@ -556,6 +566,7 @@ type components = {
556
566
  url: string;
557
567
  agentId?: string | null;
558
568
  description?: string | null;
569
+ method?: 'GET' | 'POST';
559
570
  isActive: boolean;
560
571
  secretPreview?: string | null;
561
572
  createdAt: string;
@@ -577,11 +588,12 @@ type components = {
577
588
  url: string;
578
589
  agentId?: string | null;
579
590
  description?: string | null;
580
- isActive: boolean;
591
+ isActive?: boolean;
581
592
  headers?: {
582
593
  [key: string]: string;
583
594
  };
584
595
  secret?: string;
596
+ method?: 'GET' | 'POST';
585
597
  };
586
598
  UpdateWebhookRequest: {
587
599
  url?: string;
@@ -591,6 +603,7 @@ type components = {
591
603
  headers?: {
592
604
  [key: string]: string;
593
605
  };
606
+ method?: 'GET' | 'POST';
594
607
  };
595
608
  EventSubscriptionSummary: {
596
609
  id: string;
@@ -607,7 +620,7 @@ type components = {
607
620
  };
608
621
  CreateEventSubscriptionRequest: {
609
622
  eventKey: string;
610
- isActive: boolean;
623
+ isActive?: boolean;
611
624
  };
612
625
  UpdateEventSubscriptionRequest: {
613
626
  isActive?: boolean;
@@ -625,10 +638,19 @@ type components = {
625
638
  processedRecords: number;
626
639
  successfulRecords: number;
627
640
  failedRecords: number;
641
+ connectedRecords: number;
642
+ goalAchievedRecords: number;
643
+ pendingRetriesCount: number;
644
+ terminalFailures: number;
645
+ pausedFromStatus?: components['schemas']['CampaignStatus'] | null;
646
+ nextRetryAt?: string | null;
647
+ createdBy: string;
628
648
  createdAt: string;
629
649
  updatedAt: string;
630
650
  startedAt?: string | null;
631
651
  completedAt?: string | null;
652
+ pausedAt?: string | null;
653
+ cancelledAt?: string | null;
632
654
  };
633
655
  CampaignListResponse: {
634
656
  data: components['schemas']['Campaign'][];
@@ -637,20 +659,28 @@ type components = {
637
659
  CampaignExecution: {
638
660
  campaignExecutionId: string;
639
661
  campaignId: string;
662
+ workspaceId: string;
640
663
  rowNumber: number;
641
664
  status: 'PENDING' | 'SUCCESS' | 'ERROR';
642
665
  agentExecutionId?: string | null;
643
- inputData: {
666
+ input: {
644
667
  [key: string]: unknown;
645
668
  };
646
- errorMessage?: string | null;
669
+ error?: string | null;
670
+ lastDisconnectionReason?: string | null;
671
+ callDurationMs?: number | null;
672
+ lastCallId?: string | null;
673
+ callGoalAchieved?: boolean | null;
674
+ reasonRetryCount: number;
675
+ capacityRetryCount: number;
676
+ nextRetryAt?: string | null;
647
677
  createdAt: string;
648
678
  };
649
679
  CampaignExecutionListResponse: {
650
680
  data: components['schemas']['CampaignExecution'][];
651
681
  meta: components['schemas']['PaginationMeta'];
652
682
  };
653
- CampaignStatus: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PARTIALLY_COMPLETED';
683
+ CampaignStatus: 'PENDING' | 'PROCESSING' | 'RETRYING' | 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELLED';
654
684
  Call: {
655
685
  id: string;
656
686
  title: string;
@@ -689,18 +719,100 @@ type components = {
689
719
  data: components['schemas']['Call'][];
690
720
  meta: components['schemas']['CallsStreamMeta'];
691
721
  };
722
+ SipTrunk: {
723
+ id: string;
724
+ workspaceId: string;
725
+ name: string;
726
+ username: string;
727
+ domain: string;
728
+ carrierAddress: string;
729
+ carrierPort: number;
730
+ carrierTransport: 'udp' | 'tcp' | 'tls';
731
+ phoneNumbers: string[];
732
+ status: 'active' | 'inactive';
733
+ createdAt: string;
734
+ updatedAt: string;
735
+ };
736
+ SipTrunkWithPassword: components['schemas']['SipTrunk'] & {
737
+ password: string;
738
+ };
739
+ CreateSipTrunkRequest: {
740
+ name: string;
741
+ carrierAddress: string;
742
+ carrierPort?: number;
743
+ carrierTransport?: 'udp' | 'tcp' | 'tls';
744
+ phoneNumbers?: string[];
745
+ };
746
+ UpdateSipTrunkRequest: {
747
+ name?: string;
748
+ carrierAddress?: string;
749
+ carrierPort?: number;
750
+ carrierTransport?: 'udp' | 'tcp' | 'tls';
751
+ phoneNumbers?: string[];
752
+ status?: 'active' | 'inactive';
753
+ };
754
+ ResourceProjection: {
755
+ estimatedAtClose: number;
756
+ dailyBurnRate: number;
757
+ daysRemaining: number | null;
758
+ willExceed: boolean;
759
+ };
760
+ ResourceBalance: {
761
+ resource: string;
762
+ limit: number;
763
+ used: number;
764
+ remaining: number;
765
+ unit: string;
766
+ projection: components['schemas']['ResourceProjection'];
767
+ };
768
+ SubscriptionInfo: {
769
+ id: string;
770
+ status: 'active' | 'paused';
771
+ billingCycle: 'monthly' | 'yearly';
772
+ currentPeriodStart: string;
773
+ currentPeriodEnd: string;
774
+ };
775
+ BillingBalanceResponse: {
776
+ subscription: components['schemas']['SubscriptionInfo'];
777
+ resources: components['schemas']['ResourceBalance'][];
778
+ };
779
+ UsageAgentRow: {
780
+ agentId: string;
781
+ agentName: string | null;
782
+ status: 'inactive' | 'training' | 'active' | 'archived' | null;
783
+ totalQuantity: number;
784
+ totalEvents: number;
785
+ percentOfTotal: number;
786
+ lastActivity: string;
787
+ };
788
+ UsageAgentsMeta: {
789
+ total: number;
790
+ page: number;
791
+ limit: number;
792
+ hasNext: boolean;
793
+ hasPrevious: boolean;
794
+ aggregations: components['schemas']['UsageAgentsAggregations'];
795
+ };
796
+ UsageAgentsAggregations: {
797
+ totalUsage: number;
798
+ planLimit: number | null;
799
+ };
800
+ UsageAgentsResponse: {
801
+ data: components['schemas']['UsageAgentRow'][];
802
+ meta: components['schemas']['UsageAgentsMeta'];
803
+ };
692
804
  ForkAgentFromTemplateRequest: {
693
805
  templateId: string;
694
806
  templateVersionId?: string;
695
807
  name?: string | null;
696
808
  description?: string | null;
697
- status?: 'inactive' | 'training' | 'active' | null;
809
+ status?: 'inactive' | 'training' | 'active';
698
810
  debounceDelayMs?: number | null;
699
811
  };
700
812
  CloneAgentRequest: {
701
813
  name: string;
702
814
  description?: string | null;
703
- status?: 'inactive' | 'training' | 'active' | null;
815
+ status?: 'inactive' | 'training' | 'active';
704
816
  versionId: string;
705
817
  clone: ('instructions' | 'tools' | 'webhooks' | 'stages' | 'triggers' | 'businessHours' | 'businessHourExceptions')[];
706
818
  };
@@ -758,9 +870,12 @@ type components = {
758
870
  description?: string;
759
871
  notes?: string[];
760
872
  prompts?: components['schemas']['ToolConfigSchemaActionPrompts'];
761
- schema: {
762
- [key: string]: unknown;
763
- } | boolean;
873
+ schema: OneOf<[
874
+ {
875
+ [key: string]: unknown;
876
+ },
877
+ boolean
878
+ ]>;
764
879
  };
765
880
  ToolConfigSchema: {
766
881
  schemaVersion: 'json-schema/2020-12';
@@ -850,13 +965,11 @@ type components = {
850
965
  CatalogItemMessageStyleMetadata: {
851
966
  register?: string | null;
852
967
  sample?: string | null;
853
- } & {
854
968
  [key: string]: unknown;
855
969
  };
856
970
  CatalogItemToneStyleMetadata: {
857
971
  mood?: string | null;
858
972
  intensity?: string | null;
859
- } & {
860
973
  [key: string]: unknown;
861
974
  };
862
975
  CatalogItemTagMetadata: {
@@ -869,6 +982,34 @@ type components = {
869
982
  provider?: string | null;
870
983
  previewUrl?: string | null;
871
984
  };
985
+ WebhookDeliveryStatus: 'queued' | 'sending' | 'success' | 'failed';
986
+ WebhookDeliverySummary: {
987
+ id: string;
988
+ webhookId: string;
989
+ subscriptionId: string;
990
+ eventKey: string;
991
+ status: components['schemas']['WebhookDeliveryStatus'];
992
+ attempts: number;
993
+ nextAttemptAt?: string | null;
994
+ lastError?: string | null;
995
+ requestMethod: 'GET' | 'POST';
996
+ responseStatus?: number | null;
997
+ createdAt: string;
998
+ updatedAt: string;
999
+ };
1000
+ WebhookDeliveryListResponse: {
1001
+ data: components['schemas']['WebhookDeliverySummary'][];
1002
+ meta: components['schemas']['PaginationMeta'];
1003
+ };
1004
+ WebhookDeliveryDetail: components['schemas']['WebhookDeliverySummary'] & {
1005
+ requestHeaders?: {
1006
+ [key: string]: string;
1007
+ };
1008
+ requestBody?: {
1009
+ [key: string]: unknown;
1010
+ } | null;
1011
+ responseBody?: string | null;
1012
+ };
872
1013
  };
873
1014
  responses: never;
874
1015
  parameters: {
@@ -886,34 +1027,39 @@ type components = {
886
1027
  ToolId: string;
887
1028
  ResourceId: string;
888
1029
  CatalogItemId: string;
889
- PageParam: number;
890
- LimitParam: number;
891
- Page: number;
892
- Limit: number;
893
- SortParam: string;
894
- FieldsParam: string;
895
- IncludeParam: string;
896
- SearchParam: string;
897
- FilterParam: components['schemas']['QueryFilters'];
1030
+ PageParam?: number;
1031
+ LimitParam?: number;
1032
+ Page?: number;
1033
+ Limit?: number;
1034
+ SortParam?: string;
1035
+ FieldsParam?: string;
1036
+ IncludeParam?: string;
1037
+ SearchParam?: string;
1038
+ FilterParam?: components['schemas']['QueryFilters'];
898
1039
  WebhookId: string;
899
1040
  SubscriptionId: string;
900
1041
  CallId: string;
901
- AgentBatchIdQuery: string;
902
- AgentIdQuery: string;
903
- ExecutionIdQuery: string;
904
- RecordedAfterParam: string;
905
- RecordedBeforeParam: string;
1042
+ SipTrunkId: string;
1043
+ AgentBatchIdQuery?: string;
1044
+ AgentIdQuery?: string;
1045
+ ExecutionIdQuery?: string;
1046
+ RecordedAfterParam?: string;
1047
+ RecordedBeforeParam?: string;
906
1048
  CallsAfterParam: string;
907
- CallsStreamLimitParam: number;
908
- OrParam: components['schemas']['QueryOrGroups'];
1049
+ CallsStreamLimitParam?: number;
1050
+ UsageResourceQuery?: string;
1051
+ UsageFromQuery?: string;
1052
+ UsageToQuery?: string;
1053
+ OrParam?: components['schemas']['QueryOrGroups'];
909
1054
  ScheduleId: string;
910
1055
  ApiKeyId: string;
911
- XCacheRefresh: boolean;
1056
+ XCacheRefresh?: boolean;
912
1057
  IdempotencyKey: string;
913
- XApiKey: string;
914
- DurationBucketQuery: 'short' | 'medium' | 'long';
915
- GoalStatusQuery: 'achieved' | 'not_achieved';
916
- SearchQuery: string;
1058
+ XApiKey?: string;
1059
+ DurationBucketQuery?: 'short' | 'medium' | 'long';
1060
+ GoalStatusQuery?: 'achieved' | 'not_achieved';
1061
+ SearchQuery?: string;
1062
+ DeliveryId: string;
917
1063
  };
918
1064
  requestBodies: never;
919
1065
  headers: never;
@@ -952,8 +1098,8 @@ type ClientConfig = {
952
1098
  timeoutMs?: number;
953
1099
  fetchImpl?: typeof fetch;
954
1100
  logger?: {
955
- debug?: (...a: any[]) => void;
956
- error?: (...a: any[]) => void;
1101
+ debug?: (...a: unknown[]) => void;
1102
+ error?: (...a: unknown[]) => void;
957
1103
  };
958
1104
  workspaceId?: string;
959
1105
  getWorkspaceId?: () => string | undefined;
@@ -1095,6 +1241,13 @@ type AgentBlueprint = {
1095
1241
  contentHash: string | null;
1096
1242
  contentVariables: string[];
1097
1243
  variablesCache: string[];
1244
+ outputVariables: Array<{
1245
+ type: 'string' | 'enum' | 'boolean' | 'number';
1246
+ name: string;
1247
+ description: string;
1248
+ required: boolean;
1249
+ choices?: string[];
1250
+ }>;
1098
1251
  createdAt: string;
1099
1252
  updatedAt: string;
1100
1253
  };
@@ -1122,6 +1275,13 @@ type CreateAgentBlueprintRequest = {
1122
1275
  criticalRules?: string[];
1123
1276
  topicsAllowed?: string[];
1124
1277
  topicsForbidden?: string[];
1278
+ outputVariables?: Array<{
1279
+ type: 'string' | 'text' | 'enum' | 'boolean' | 'number';
1280
+ name: string;
1281
+ description: string;
1282
+ required?: boolean;
1283
+ choices?: string[];
1284
+ }>;
1125
1285
  };
1126
1286
  type UpdateAgentBlueprintRequest = {
1127
1287
  languageId?: string;
@@ -1137,6 +1297,13 @@ type UpdateAgentBlueprintRequest = {
1137
1297
  criticalRules?: string[];
1138
1298
  topicsAllowed?: string[];
1139
1299
  topicsForbidden?: string[];
1300
+ outputVariables?: Array<{
1301
+ type: 'string' | 'text' | 'enum' | 'boolean' | 'number';
1302
+ name: string;
1303
+ description: string;
1304
+ required?: boolean;
1305
+ choices?: string[];
1306
+ }>;
1140
1307
  };
1141
1308
  type BlueprintStageSchema = components['schemas']['BlueprintStage'];
1142
1309
  type BlueprintStage = Omit<BlueprintStageSchema, 'prompt'> & {
@@ -1181,6 +1348,18 @@ type ToolConnectionListItem = components['schemas']['ToolConnectionListItem'];
1181
1348
  type ToolConnectionListResponse = components['schemas']['ToolConnectionListResponse'];
1182
1349
  type ExecuteToolConnectionRequest = components['schemas']['ExecuteToolConnectionRequest'];
1183
1350
  type ErrorResponse = components['schemas']['ErrorResponse'];
1351
+ type ResourceProjection = components['schemas']['ResourceProjection'];
1352
+ type ResourceBalance = components['schemas']['ResourceBalance'];
1353
+ type SubscriptionInfo = components['schemas']['SubscriptionInfo'];
1354
+ type BillingBalanceResponse = components['schemas']['BillingBalanceResponse'];
1355
+ type UsageAgentRow = components['schemas']['UsageAgentRow'];
1356
+ type UsageAgentsAggregations = components['schemas']['UsageAgentsAggregations'];
1357
+ type UsageAgentsMeta = components['schemas']['UsageAgentsMeta'];
1358
+ type UsageAgentsResponse = components['schemas']['UsageAgentsResponse'];
1359
+ type SipTrunk = components['schemas']['SipTrunk'];
1360
+ type SipTrunkWithPassword = components['schemas']['SipTrunkWithPassword'];
1361
+ type CreateSipTrunkRequest = components['schemas']['CreateSipTrunkRequest'];
1362
+ type UpdateSipTrunkRequest = components['schemas']['UpdateSipTrunkRequest'];
1184
1363
  type CampaignStatus = components['schemas']['CampaignStatus'];
1185
1364
  type Campaign = components['schemas']['Campaign'];
1186
1365
  type CampaignListResponse = components['schemas']['CampaignListResponse'];
@@ -1194,6 +1373,9 @@ type CallsStreamResponse = components['schemas']['CallsStreamResponse'];
1194
1373
  type WebhookSummary = components['schemas']['WebhookSummary'];
1195
1374
  type WebhookDetail = components['schemas']['WebhookDetail'];
1196
1375
  type WebhookListResponse = components['schemas']['WebhookListResponse'];
1376
+ type WebhookDeliverySummary = components['schemas']['WebhookDeliverySummary'];
1377
+ type WebhookDeliveryDetail = components['schemas']['WebhookDeliveryDetail'];
1378
+ type WebhookDeliveryListResponse = components['schemas']['WebhookDeliveryListResponse'];
1197
1379
  type CreateWebhookRequest = components['schemas']['CreateWebhookRequest'];
1198
1380
  type UpdateWebhookRequest = components['schemas']['UpdateWebhookRequest'];
1199
1381
  type EventSubscriptionSummary = components['schemas']['EventSubscriptionSummary'];
@@ -1776,6 +1958,12 @@ declare function createApiKeysApi(cfg: ClientConfig & {
1776
1958
  retry?: RetryPolicy;
1777
1959
  }): ApiKeysApi;
1778
1960
 
1961
+ declare function createBillingApi(cfg: ClientConfig & {
1962
+ retry?: RetryPolicy;
1963
+ }): {
1964
+ getBalance(): Promise<BillingBalanceResponse>;
1965
+ };
1966
+
1779
1967
  type ListCallsOptions = ListQueryOptions & Partial<{
1780
1968
  agentBatchId: string;
1781
1969
  agentId: string;
@@ -1805,7 +1993,7 @@ declare function createCallsApi(cfg: ClientConfig & {
1805
1993
  };
1806
1994
 
1807
1995
  type ListCampaignsOptions = ListQueryOptions;
1808
- type ListCampaignExecutionsOptions = Pick<ListQueryOptions, 'page' | 'limit'>;
1996
+ type ListCampaignExecutionsOptions = ListQueryOptions;
1809
1997
  type CreateCampaignPayload = {
1810
1998
  name: string;
1811
1999
  file: unknown;
@@ -1818,6 +2006,16 @@ declare function createCampaignsApi(cfg: ClientConfig & {
1818
2006
  get(campaignId: string): Promise<Campaign>;
1819
2007
  create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
1820
2008
  listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
2009
+ pause(campaignId: string): Promise<{
2010
+ status: "paused";
2011
+ }>;
2012
+ resume(campaignId: string): Promise<{
2013
+ status: "resumed";
2014
+ }>;
2015
+ cancel(campaignId: string): Promise<{
2016
+ status: "cancelled";
2017
+ }>;
2018
+ exportExecutions(campaignId: string): Promise<Blob>;
1821
2019
  };
1822
2020
 
1823
2021
  type ListCatalogTemplatesOptions = {
@@ -1841,6 +2039,16 @@ declare function createCatalogsApi(cfg: ClientConfig & {
1841
2039
  remove(itemId: string): Promise<void>;
1842
2040
  };
1843
2041
 
2042
+ declare function createSipTrunksApi(cfg: ClientConfig & {
2043
+ retry?: RetryPolicy;
2044
+ }): {
2045
+ list(): Promise<SipTrunk[]>;
2046
+ get(trunkId: string): Promise<SipTrunk>;
2047
+ create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
2048
+ update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
2049
+ delete(trunkId: string): Promise<void>;
2050
+ };
2051
+
1844
2052
  type IdempotentRequestOptions = {
1845
2053
  idempotencyKey?: string;
1846
2054
  };
@@ -1877,6 +2085,17 @@ declare function createToolsApi(cfg: ClientConfig & {
1877
2085
  executeConnection(toolAgentConnectionId: string, payload: ExecuteToolConnectionRequest, options?: IdempotentRequestOptions): Promise<ExecuteToolResponse>;
1878
2086
  };
1879
2087
 
2088
+ type ListUsageAgentsOptions = ListQueryOptions & Partial<{
2089
+ resource: string;
2090
+ from: string;
2091
+ to: string;
2092
+ }>;
2093
+ declare function createUsageApi(cfg: ClientConfig & {
2094
+ retry?: RetryPolicy;
2095
+ }): {
2096
+ agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
2097
+ };
2098
+
1880
2099
  type ListVoicesOptions = ListQueryOptions & {
1881
2100
  agentId?: string;
1882
2101
  agentVersionId?: string;
@@ -1905,6 +2124,8 @@ declare function createWebhooksApi(cfg: ClientConfig & {
1905
2124
  getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
1906
2125
  updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
1907
2126
  deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
2127
+ listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
2128
+ getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
1908
2129
  };
1909
2130
 
1910
2131
  type ListWorkspacePhonesOptions = ListQueryOptions & {
@@ -2078,16 +2299,39 @@ declare function createClient(initialCfg: ClientConfig & {
2078
2299
  get(campaignId: string): Promise<Campaign>;
2079
2300
  create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
2080
2301
  listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
2302
+ pause(campaignId: string): Promise<{
2303
+ status: "paused";
2304
+ }>;
2305
+ resume(campaignId: string): Promise<{
2306
+ status: "resumed";
2307
+ }>;
2308
+ cancel(campaignId: string): Promise<{
2309
+ status: "cancelled";
2310
+ }>;
2311
+ exportExecutions(campaignId: string): Promise<Blob>;
2081
2312
  };
2082
2313
  voices: {
2083
2314
  list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
2084
2315
  };
2085
2316
  apiKeys: ApiKeysApi;
2317
+ billing: {
2318
+ getBalance(): Promise<BillingBalanceResponse>;
2319
+ };
2086
2320
  calls: {
2087
2321
  list(options?: ListCallsOptions): Promise<PaginatedResult<CallsListResponse, ListCallsOptions>>;
2088
2322
  stream(options: StreamCallsOptions): Promise<CallsStreamResponse>;
2089
2323
  get(callId: string): Promise<Call>;
2090
2324
  };
2325
+ usage: {
2326
+ agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
2327
+ };
2328
+ sip: {
2329
+ list(): Promise<SipTrunk[]>;
2330
+ get(trunkId: string): Promise<SipTrunk>;
2331
+ create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
2332
+ update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
2333
+ delete(trunkId: string): Promise<void>;
2334
+ };
2091
2335
  webhooks: {
2092
2336
  list(options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookListResponse, ListWebhooksOptions>>;
2093
2337
  create(payload: CreateWebhookRequest): Promise<WebhookDetail>;
@@ -2099,6 +2343,8 @@ declare function createClient(initialCfg: ClientConfig & {
2099
2343
  getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
2100
2344
  updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
2101
2345
  deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
2346
+ listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
2347
+ getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
2102
2348
  };
2103
2349
  };
2104
2350
  };
@@ -2223,16 +2469,39 @@ declare function createClient(initialCfg: ClientConfig & {
2223
2469
  get(campaignId: string): Promise<Campaign>;
2224
2470
  create(agentId: string, versionId: string, payload: CreateCampaignPayload): Promise<Campaign>;
2225
2471
  listExecutions(campaignId: string, options?: ListCampaignExecutionsOptions): Promise<PaginatedResult<CampaignExecutionListResponse, ListCampaignExecutionsOptions>>;
2472
+ pause(campaignId: string): Promise<{
2473
+ status: "paused";
2474
+ }>;
2475
+ resume(campaignId: string): Promise<{
2476
+ status: "resumed";
2477
+ }>;
2478
+ cancel(campaignId: string): Promise<{
2479
+ status: "cancelled";
2480
+ }>;
2481
+ exportExecutions(campaignId: string): Promise<Blob>;
2226
2482
  };
2227
2483
  voices: {
2228
2484
  list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
2229
2485
  };
2230
2486
  apiKeys: ApiKeysApi;
2487
+ billing: {
2488
+ getBalance(): Promise<BillingBalanceResponse>;
2489
+ };
2231
2490
  calls: {
2232
2491
  list(options?: ListCallsOptions): Promise<PaginatedResult<CallsListResponse, ListCallsOptions>>;
2233
2492
  stream(options: StreamCallsOptions): Promise<CallsStreamResponse>;
2234
2493
  get(callId: string): Promise<Call>;
2235
2494
  };
2495
+ usage: {
2496
+ agents(options?: ListUsageAgentsOptions): Promise<PaginatedResult<UsageAgentsResponse, ListUsageAgentsOptions>>;
2497
+ };
2498
+ sip: {
2499
+ list(): Promise<SipTrunk[]>;
2500
+ get(trunkId: string): Promise<SipTrunk>;
2501
+ create(body: CreateSipTrunkRequest): Promise<SipTrunkWithPassword>;
2502
+ update(trunkId: string, body: UpdateSipTrunkRequest): Promise<SipTrunk>;
2503
+ delete(trunkId: string): Promise<void>;
2504
+ };
2236
2505
  webhooks: {
2237
2506
  list(options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookListResponse, ListWebhooksOptions>>;
2238
2507
  create(payload: CreateWebhookRequest): Promise<WebhookDetail>;
@@ -2244,6 +2513,8 @@ declare function createClient(initialCfg: ClientConfig & {
2244
2513
  getSubscription(webhookId: string, subscriptionId: string): Promise<EventSubscriptionDetail>;
2245
2514
  updateSubscription(webhookId: string, subscriptionId: string, payload: UpdateEventSubscriptionRequest): Promise<EventSubscriptionDetail>;
2246
2515
  deleteSubscription(webhookId: string, subscriptionId: string): Promise<void>;
2516
+ listDeliveries(webhookId: string, options?: ListWebhooksOptions): Promise<PaginatedResult<WebhookDeliveryListResponse, ListWebhooksOptions>>;
2517
+ getDelivery(webhookId: string, deliveryId: string): Promise<WebhookDeliveryDetail>;
2247
2518
  };
2248
2519
  };
2249
2520
 
@@ -2259,8 +2530,8 @@ declare function createHttp(cfg: ClientConfig & {
2259
2530
  base: string;
2260
2531
  timeout: number;
2261
2532
  log: {
2262
- debug?: (...a: any[]) => void;
2263
- error?: (...a: any[]) => void;
2533
+ debug?: (...a: unknown[]) => void;
2534
+ error?: (...a: unknown[]) => void;
2264
2535
  };
2265
2536
  retry: RetryPolicy;
2266
2537
  doFetch: (url: string, init?: FetchOptions) => Promise<Response>;
@@ -2270,4 +2541,4 @@ declare function createHttp(cfg: ClientConfig & {
2270
2541
  resolveAccessToken: () => string;
2271
2542
  };
2272
2543
 
2273
- 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 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 CreateToolConnectionRequest, type CreateWebhookRequest, 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 ListVoicesOptions, type ListWebhooksOptions, type ListWorkspacePhonesOptions, type ListWorkspacesOptions, NetworkError, type PaginatedResult, type PaginationMeta, type PhoneAssignmentResponse, type PublishAgentVersionRequest, type QueryBuilderInput, type QueryBuilderSerializable, type QueryFilterOperators, type QueryFilters, type QueryOrGroups, type QueryValue, type RetryPolicy, type StreamCallsOptions, 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 UpdateWebhookRequest, type VoiceListResponse, type VoiceSummary, 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, createCallsApi, createCampaignsApi, createCatalogTemplatesApi, createCatalogsApi, createClient, createHttp, createToolsApi, createVoicesApi, createWebhooksApi, createWorkspacesApi, isApiErrorBody, isApiHttpError };
2544
+ 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 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 PublishAgentVersionRequest, type QueryBuilderInput, type QueryBuilderSerializable, type QueryFilterOperators, type QueryFilters, type QueryOrGroups, type QueryValue, type ResourceBalance, type ResourceProjection, type RetryPolicy, type SipTrunk, type SipTrunkWithPassword, 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, createHttp, createSipTrunksApi, createToolsApi, createUsageApi, createVoicesApi, createWebhooksApi, createWorkspacesApi, isApiErrorBody, isApiHttpError };