@getsupervisor/agents-studio-sdk 1.2.0 → 1.3.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
@@ -21,6 +21,22 @@ type paths = {
21
21
  get: operations["listAgentInstructions"];
22
22
  post: operations["createAgentInstruction"];
23
23
  };
24
+ "/v1/agents/{agentId}/instructions/{instructionId}": {
25
+ patch: operations["updateAgentInstruction"];
26
+ };
27
+ "/v1/agents/{agentId}/schedule": {
28
+ get: operations["getAgentSchedule"];
29
+ put: operations["updateAgentSchedule"];
30
+ };
31
+ "/v1/agents/{agentId}/versions": {
32
+ get: operations["listAgentVersions"];
33
+ post: operations["createAgentVersion"];
34
+ };
35
+ "/v1/agents/{agentId}/versions/{versionId}": {
36
+ get: operations["getAgentVersion"];
37
+ delete: operations["deleteAgentInstruction"];
38
+ patch: operations["updateAgentVersion"];
39
+ };
24
40
  "/v1/agents/{agentId}/phones": {
25
41
  post: operations["connectAgentPhone"];
26
42
  };
@@ -39,6 +55,9 @@ type paths = {
39
55
  "/v1/tools/{toolId}/execute": {
40
56
  post: operations["executeTool"];
41
57
  };
58
+ "/v1/voices": {
59
+ get: operations["listVoices"];
60
+ };
42
61
  };
43
62
  type components = {
44
63
  schemas: {
@@ -65,6 +84,16 @@ type components = {
65
84
  limit: number;
66
85
  hasNext: boolean;
67
86
  };
87
+ QueryValue: string | number | boolean | string[];
88
+ QueryFilterOperators: {
89
+ [key: string]: components["schemas"]["QueryValue"];
90
+ };
91
+ QueryFilters: {
92
+ [key: string]: components["schemas"]["QueryValue"] | components["schemas"]["QueryFilterOperators"];
93
+ };
94
+ QueryOrGroups: {
95
+ [key: string]: components["schemas"]["QueryFilters"];
96
+ };
68
97
  AgentSummary: {
69
98
  agentId: string;
70
99
  name: string;
@@ -149,6 +178,88 @@ type components = {
149
178
  order: number;
150
179
  createdAt: string;
151
180
  };
181
+ UpdateInstructionRequest: {
182
+ order?: number;
183
+ content?: string;
184
+ metadata?: {
185
+ [key: string]: unknown;
186
+ };
187
+ };
188
+ VoiceSummary: {
189
+ id: string;
190
+ providerVoiceId?: string;
191
+ name: string;
192
+ gender?: "female" | "male" | "neutral";
193
+ locale: string;
194
+ tags?: string[];
195
+ previewUrl?: string;
196
+ provider: string;
197
+ };
198
+ VoiceListResponse: {
199
+ data: components["schemas"]["VoiceSummary"][];
200
+ meta: components["schemas"]["PaginationMeta"];
201
+ };
202
+ AgentScheduleSlot: {
203
+ startTime: string;
204
+ endTime: string;
205
+ };
206
+ AgentScheduleRule: {
207
+ dayOfWeek: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
208
+ slots: components["schemas"]["AgentScheduleSlot"][];
209
+ isClosed?: boolean;
210
+ };
211
+ AgentSchedule: {
212
+ agentId: string;
213
+ timezone: string;
214
+ rules: components["schemas"]["AgentScheduleRule"][];
215
+ metadata?: {
216
+ [key: string]: unknown;
217
+ };
218
+ };
219
+ UpdateAgentScheduleRequest: {
220
+ timezone: string;
221
+ rules: components["schemas"]["AgentScheduleRule"][];
222
+ metadata?: {
223
+ [key: string]: unknown;
224
+ };
225
+ };
226
+ AgentVersionSummary: {
227
+ versionId: string;
228
+ agentId: string;
229
+ label: string;
230
+ status: "draft" | "published" | "archived";
231
+ isActive?: boolean;
232
+ createdAt: string;
233
+ updatedAt?: string;
234
+ publishedAt?: string | null;
235
+ };
236
+ AgentVersionDetail: components["schemas"]["AgentVersionSummary"] & {
237
+ description?: string;
238
+ metadata?: {
239
+ [key: string]: unknown;
240
+ };
241
+ instructionsVersionId?: string;
242
+ };
243
+ AgentVersionListResponse: {
244
+ data: components["schemas"]["AgentVersionSummary"][];
245
+ meta?: components["schemas"]["PaginationMeta"];
246
+ };
247
+ CreateAgentVersionRequest: {
248
+ label: string;
249
+ description?: string;
250
+ sourceVersionId?: string;
251
+ metadata?: {
252
+ [key: string]: unknown;
253
+ };
254
+ };
255
+ UpdateAgentVersionRequest: {
256
+ label?: string;
257
+ description?: string;
258
+ status?: "draft" | "published" | "archived";
259
+ metadata?: {
260
+ [key: string]: unknown;
261
+ };
262
+ };
152
263
  ConnectPhoneRequest: {
153
264
  agent_id: string;
154
265
  phone_id: string;
@@ -224,8 +335,18 @@ type components = {
224
335
  XWorkspaceId: string;
225
336
  AgentId: string;
226
337
  PhoneId: string;
338
+ InstructionId: string;
339
+ VersionId: string;
227
340
  WorkspaceId: string;
228
341
  ToolId: string;
342
+ PageParam?: number;
343
+ LimitParam?: number;
344
+ SortParam?: string;
345
+ FieldsParam?: string;
346
+ IncludeParam?: string;
347
+ SearchParam?: string;
348
+ FilterParam?: components["schemas"]["QueryFilters"];
349
+ OrParam?: components["schemas"]["QueryOrGroups"];
229
350
  };
230
351
  requestBodies: never;
231
352
  headers: never;
@@ -234,6 +355,16 @@ type components = {
234
355
  type operations = {
235
356
  listAgents: {
236
357
  parameters: {
358
+ query?: {
359
+ page?: components["parameters"]["PageParam"];
360
+ limit?: components["parameters"]["LimitParam"];
361
+ sort?: components["parameters"]["SortParam"];
362
+ fields?: components["parameters"]["FieldsParam"];
363
+ include?: components["parameters"]["IncludeParam"];
364
+ q?: components["parameters"]["SearchParam"];
365
+ filter?: components["parameters"]["FilterParam"];
366
+ or?: components["parameters"]["OrParam"];
367
+ };
237
368
  header: {
238
369
  "x-workspace-id": components["parameters"]["XWorkspaceId"];
239
370
  };
@@ -393,6 +524,16 @@ type operations = {
393
524
  };
394
525
  listAgentKnowledgeBases: {
395
526
  parameters: {
527
+ query?: {
528
+ page?: components["parameters"]["PageParam"];
529
+ limit?: components["parameters"]["LimitParam"];
530
+ sort?: components["parameters"]["SortParam"];
531
+ fields?: components["parameters"]["FieldsParam"];
532
+ include?: components["parameters"]["IncludeParam"];
533
+ q?: components["parameters"]["SearchParam"];
534
+ filter?: components["parameters"]["FilterParam"];
535
+ or?: components["parameters"]["OrParam"];
536
+ };
396
537
  header: {
397
538
  "x-workspace-id": components["parameters"]["XWorkspaceId"];
398
539
  };
@@ -418,6 +559,16 @@ type operations = {
418
559
  };
419
560
  listAgentKnowledgeUploads: {
420
561
  parameters: {
562
+ query?: {
563
+ page?: components["parameters"]["PageParam"];
564
+ limit?: components["parameters"]["LimitParam"];
565
+ sort?: components["parameters"]["SortParam"];
566
+ fields?: components["parameters"]["FieldsParam"];
567
+ include?: components["parameters"]["IncludeParam"];
568
+ q?: components["parameters"]["SearchParam"];
569
+ filter?: components["parameters"]["FilterParam"];
570
+ or?: components["parameters"]["OrParam"];
571
+ };
421
572
  header: {
422
573
  "x-workspace-id": components["parameters"]["XWorkspaceId"];
423
574
  };
@@ -437,6 +588,13 @@ type operations = {
437
588
  parameters: {
438
589
  query?: {
439
590
  versionId?: string;
591
+ page?: components["parameters"]["PageParam"];
592
+ limit?: components["parameters"]["LimitParam"];
593
+ sort?: components["parameters"]["SortParam"];
594
+ fields?: components["parameters"]["FieldsParam"];
595
+ q?: components["parameters"]["SearchParam"];
596
+ filter?: components["parameters"]["FilterParam"];
597
+ or?: components["parameters"]["OrParam"];
440
598
  };
441
599
  header: {
442
600
  "x-workspace-id": components["parameters"]["XWorkspaceId"];
@@ -493,6 +651,225 @@ type operations = {
493
651
  };
494
652
  };
495
653
  };
654
+ updateAgentInstruction: {
655
+ parameters: {
656
+ header: {
657
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
658
+ };
659
+ path: {
660
+ agentId: components["parameters"]["AgentId"];
661
+ instructionId: components["parameters"]["InstructionId"];
662
+ };
663
+ };
664
+ requestBody: {
665
+ content: {
666
+ "application/json": components["schemas"]["UpdateInstructionRequest"];
667
+ };
668
+ };
669
+ responses: {
670
+ 200: {
671
+ content: {
672
+ "application/json": components["schemas"]["Instruction"];
673
+ };
674
+ };
675
+ 400: {
676
+ content: {
677
+ "application/json": components["schemas"]["ErrorResponse"];
678
+ };
679
+ };
680
+ 404: {
681
+ content: {
682
+ "application/json": components["schemas"]["ErrorResponse"];
683
+ };
684
+ };
685
+ };
686
+ };
687
+ getAgentSchedule: {
688
+ parameters: {
689
+ header: {
690
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
691
+ };
692
+ path: {
693
+ agentId: components["parameters"]["AgentId"];
694
+ };
695
+ };
696
+ responses: {
697
+ 200: {
698
+ content: {
699
+ "application/json": components["schemas"]["AgentSchedule"];
700
+ };
701
+ };
702
+ 404: {
703
+ content: {
704
+ "application/json": components["schemas"]["ErrorResponse"];
705
+ };
706
+ };
707
+ };
708
+ };
709
+ updateAgentSchedule: {
710
+ parameters: {
711
+ header: {
712
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
713
+ };
714
+ path: {
715
+ agentId: components["parameters"]["AgentId"];
716
+ };
717
+ };
718
+ requestBody: {
719
+ content: {
720
+ "application/json": components["schemas"]["UpdateAgentScheduleRequest"];
721
+ };
722
+ };
723
+ responses: {
724
+ 200: {
725
+ content: {
726
+ "application/json": components["schemas"]["AgentSchedule"];
727
+ };
728
+ };
729
+ 400: {
730
+ content: {
731
+ "application/json": components["schemas"]["ErrorResponse"];
732
+ };
733
+ };
734
+ 404: {
735
+ content: {
736
+ "application/json": components["schemas"]["ErrorResponse"];
737
+ };
738
+ };
739
+ };
740
+ };
741
+ listAgentVersions: {
742
+ parameters: {
743
+ query?: {
744
+ status?: "draft" | "published" | "archived";
745
+ page?: components["parameters"]["PageParam"];
746
+ limit?: components["parameters"]["LimitParam"];
747
+ sort?: components["parameters"]["SortParam"];
748
+ fields?: components["parameters"]["FieldsParam"];
749
+ include?: components["parameters"]["IncludeParam"];
750
+ q?: components["parameters"]["SearchParam"];
751
+ filter?: components["parameters"]["FilterParam"];
752
+ or?: components["parameters"]["OrParam"];
753
+ };
754
+ header: {
755
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
756
+ };
757
+ path: {
758
+ agentId: components["parameters"]["AgentId"];
759
+ };
760
+ };
761
+ responses: {
762
+ 200: {
763
+ content: {
764
+ "application/json": components["schemas"]["AgentVersionListResponse"];
765
+ };
766
+ };
767
+ };
768
+ };
769
+ createAgentVersion: {
770
+ parameters: {
771
+ header: {
772
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
773
+ };
774
+ path: {
775
+ agentId: components["parameters"]["AgentId"];
776
+ };
777
+ };
778
+ requestBody: {
779
+ content: {
780
+ "application/json": components["schemas"]["CreateAgentVersionRequest"];
781
+ };
782
+ };
783
+ responses: {
784
+ 201: {
785
+ content: {
786
+ "application/json": components["schemas"]["AgentVersionDetail"];
787
+ };
788
+ };
789
+ 400: {
790
+ content: {
791
+ "application/json": components["schemas"]["ErrorResponse"];
792
+ };
793
+ };
794
+ };
795
+ };
796
+ getAgentVersion: {
797
+ parameters: {
798
+ header: {
799
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
800
+ };
801
+ path: {
802
+ agentId: components["parameters"]["AgentId"];
803
+ versionId: components["parameters"]["VersionId"];
804
+ };
805
+ };
806
+ responses: {
807
+ 200: {
808
+ content: {
809
+ "application/json": components["schemas"]["AgentVersionDetail"];
810
+ };
811
+ };
812
+ 404: {
813
+ content: {
814
+ "application/json": components["schemas"]["ErrorResponse"];
815
+ };
816
+ };
817
+ };
818
+ };
819
+ deleteAgentInstruction: {
820
+ parameters: {
821
+ header: {
822
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
823
+ };
824
+ path: {
825
+ agentId: components["parameters"]["AgentId"];
826
+ instructionId: components["parameters"]["InstructionId"];
827
+ };
828
+ };
829
+ responses: {
830
+ 204: {
831
+ content: never;
832
+ };
833
+ 404: {
834
+ content: {
835
+ "application/json": components["schemas"]["ErrorResponse"];
836
+ };
837
+ };
838
+ };
839
+ };
840
+ updateAgentVersion: {
841
+ parameters: {
842
+ header: {
843
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
844
+ };
845
+ path: {
846
+ agentId: components["parameters"]["AgentId"];
847
+ versionId: components["parameters"]["VersionId"];
848
+ };
849
+ };
850
+ requestBody: {
851
+ content: {
852
+ "application/json": components["schemas"]["UpdateAgentVersionRequest"];
853
+ };
854
+ };
855
+ responses: {
856
+ 200: {
857
+ content: {
858
+ "application/json": components["schemas"]["AgentVersionDetail"];
859
+ };
860
+ };
861
+ 400: {
862
+ content: {
863
+ "application/json": components["schemas"]["ErrorResponse"];
864
+ };
865
+ };
866
+ 404: {
867
+ content: {
868
+ "application/json": components["schemas"]["ErrorResponse"];
869
+ };
870
+ };
871
+ };
872
+ };
496
873
  connectAgentPhone: {
497
874
  parameters: {
498
875
  header: {
@@ -560,6 +937,14 @@ type operations = {
560
937
  parameters: {
561
938
  query?: {
562
939
  channel?: "voice";
940
+ page?: components["parameters"]["PageParam"];
941
+ limit?: components["parameters"]["LimitParam"];
942
+ sort?: components["parameters"]["SortParam"];
943
+ fields?: components["parameters"]["FieldsParam"];
944
+ include?: components["parameters"]["IncludeParam"];
945
+ q?: components["parameters"]["SearchParam"];
946
+ filter?: components["parameters"]["FilterParam"];
947
+ or?: components["parameters"]["OrParam"];
563
948
  };
564
949
  path: {
565
950
  workspaceId: components["parameters"]["WorkspaceId"];
@@ -603,6 +988,18 @@ type operations = {
603
988
  };
604
989
  };
605
990
  listTools: {
991
+ parameters: {
992
+ query?: {
993
+ page?: components["parameters"]["PageParam"];
994
+ limit?: components["parameters"]["LimitParam"];
995
+ sort?: components["parameters"]["SortParam"];
996
+ fields?: components["parameters"]["FieldsParam"];
997
+ include?: components["parameters"]["IncludeParam"];
998
+ q?: components["parameters"]["SearchParam"];
999
+ filter?: components["parameters"]["FilterParam"];
1000
+ or?: components["parameters"]["OrParam"];
1001
+ };
1002
+ };
606
1003
  responses: {
607
1004
  200: {
608
1005
  content: {
@@ -647,8 +1044,61 @@ type operations = {
647
1044
  };
648
1045
  };
649
1046
  };
1047
+ listVoices: {
1048
+ parameters: {
1049
+ query?: {
1050
+ agentId?: string;
1051
+ agentVersionId?: string;
1052
+ gender?: "female" | "male" | "neutral";
1053
+ locale?: string;
1054
+ page?: components["parameters"]["PageParam"];
1055
+ limit?: components["parameters"]["LimitParam"];
1056
+ sort?: components["parameters"]["SortParam"];
1057
+ fields?: components["parameters"]["FieldsParam"];
1058
+ include?: components["parameters"]["IncludeParam"];
1059
+ q?: components["parameters"]["SearchParam"];
1060
+ filter?: components["parameters"]["FilterParam"];
1061
+ or?: components["parameters"]["OrParam"];
1062
+ };
1063
+ header: {
1064
+ "x-workspace-id": components["parameters"]["XWorkspaceId"];
1065
+ };
1066
+ };
1067
+ responses: {
1068
+ 200: {
1069
+ content: {
1070
+ "application/json": components["schemas"]["VoiceListResponse"];
1071
+ };
1072
+ };
1073
+ 400: {
1074
+ content: {
1075
+ "application/json": components["schemas"]["ErrorResponse"];
1076
+ };
1077
+ };
1078
+ };
1079
+ };
650
1080
  };
651
1081
 
1082
+ type QueryValue = components['schemas']['QueryValue'];
1083
+ type QueryFilterOperators = components['schemas']['QueryFilterOperators'];
1084
+ type QueryFilters = components['schemas']['QueryFilters'];
1085
+ type QueryOrGroups = components['schemas']['QueryOrGroups'];
1086
+ type PaginationMeta = components['schemas']['PaginationMeta'];
1087
+ type QueryBuilderSerializable = {
1088
+ build: () => string;
1089
+ toString?: () => string;
1090
+ };
1091
+ type QueryBuilderInput = string | QueryBuilderSerializable | undefined | null;
1092
+ type ListQueryOptions = Partial<{
1093
+ page: number;
1094
+ limit: number;
1095
+ sort: string | string[];
1096
+ fields: string | string[];
1097
+ include: string | string[];
1098
+ search: string;
1099
+ filter: QueryFilters | QueryBuilderInput;
1100
+ or: QueryOrGroups | QueryBuilderInput;
1101
+ }>;
652
1102
  type ClientConfig = {
653
1103
  baseUrl: string;
654
1104
  headers?: Record<string, string>;
@@ -675,6 +1125,7 @@ type Instruction = components['schemas']['Instruction'];
675
1125
  type CreateInstructionRequest = components['schemas']['CreateInstructionRequest'];
676
1126
  type InstructionCreatedResponse = components['schemas']['InstructionCreatedResponse'];
677
1127
  type AgentInstructionsResponse = paths['/v1/agents/{agentId}/instructions']['get']['responses'][200]['content']['application/json'];
1128
+ type UpdateInstructionRequest = components['schemas']['UpdateInstructionRequest'];
678
1129
  type ConnectPhoneRequest = components['schemas']['ConnectPhoneRequest'];
679
1130
  type PhoneAssignmentResponse = components['schemas']['PhoneAssignmentResponse'];
680
1131
  type WorkspacePhone = components['schemas']['WorkspacePhone'];
@@ -682,6 +1133,15 @@ type WorkspacePhonesResponse = components['schemas']['WorkspacePhonesResponse'];
682
1133
  type WorkspacePhoneChannel = 'voice';
683
1134
  type WorkspaceEnableRequest = components['schemas']['WorkspaceEnableRequest'];
684
1135
  type WorkspaceEnableResponse = components['schemas']['WorkspaceEnableResponse'];
1136
+ type VoiceSummary = components['schemas']['VoiceSummary'];
1137
+ type VoiceListResponse = components['schemas']['VoiceListResponse'];
1138
+ type AgentSchedule = components['schemas']['AgentSchedule'];
1139
+ type UpdateAgentScheduleRequest = components['schemas']['UpdateAgentScheduleRequest'];
1140
+ type AgentVersionSummary = components['schemas']['AgentVersionSummary'];
1141
+ type AgentVersionDetail = components['schemas']['AgentVersionDetail'];
1142
+ type AgentVersionListResponse = components['schemas']['AgentVersionListResponse'];
1143
+ type CreateAgentVersionRequest = components['schemas']['CreateAgentVersionRequest'];
1144
+ type UpdateAgentVersionRequest = components['schemas']['UpdateAgentVersionRequest'];
685
1145
  type ToolSummary = components['schemas']['ToolSummary'];
686
1146
  type ExecuteToolRequest = components['schemas']['ExecuteToolRequest'];
687
1147
  type ExecuteToolResponse = components['schemas']['ExecuteToolResponse'];
@@ -712,21 +1172,25 @@ type RetryPolicy = {
712
1172
  retryOn?: (err: unknown, attempt: number) => boolean;
713
1173
  };
714
1174
 
1175
+ type ListAgentInstructionsOptions = ListQueryOptions & {
1176
+ versionId?: string;
1177
+ };
715
1178
  declare function createAgentInstructionsApi(cfg: ClientConfig & {
716
1179
  retry?: RetryPolicy;
717
1180
  }): {
718
- list(agentId: string, opts?: {
719
- versionId?: string;
720
- }): Promise<AgentInstructionsResponse>;
1181
+ list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
721
1182
  create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
1183
+ update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
1184
+ delete(agentId: string, instructionId: string): Promise<void>;
722
1185
  };
723
1186
 
1187
+ type ListAgentKnowledgeOptions = ListQueryOptions;
724
1188
  declare function createAgentKnowledgeApi(cfg: ClientConfig & {
725
1189
  retry?: RetryPolicy;
726
1190
  }): {
727
1191
  upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
728
- listBases(agentId: string): Promise<AgentKnowledgeBasesResponse>;
729
- listUploads(agentId: string): Promise<AgentKnowledgeUploadsResponse>;
1192
+ listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
1193
+ listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
730
1194
  };
731
1195
 
732
1196
  declare function createAgentPhonesApi(cfg: ClientConfig & {
@@ -736,28 +1200,54 @@ declare function createAgentPhonesApi(cfg: ClientConfig & {
736
1200
  disconnect(agentId: string, phoneId: string): Promise<void>;
737
1201
  };
738
1202
 
1203
+ declare function createAgentScheduleApi(cfg: ClientConfig & {
1204
+ retry?: RetryPolicy;
1205
+ }): {
1206
+ get(agentId: string): Promise<AgentSchedule>;
1207
+ update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
1208
+ };
1209
+
1210
+ type ListAgentVersionsOptions = {
1211
+ status?: 'draft' | 'published' | 'archived';
1212
+ } & ListQueryOptions;
1213
+ declare function createAgentVersionsApi(cfg: ClientConfig & {
1214
+ retry?: RetryPolicy;
1215
+ }): {
1216
+ list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
1217
+ get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
1218
+ create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
1219
+ update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
1220
+ };
1221
+
739
1222
  type AgentInstructionsApi = ReturnType<typeof createAgentInstructionsApi>;
740
1223
  type AgentKnowledgeApi = ReturnType<typeof createAgentKnowledgeApi>;
741
1224
  type AgentPhonesApi = ReturnType<typeof createAgentPhonesApi>;
1225
+ type AgentScheduleApi = ReturnType<typeof createAgentScheduleApi>;
1226
+ type AgentVersionsApi = ReturnType<typeof createAgentVersionsApi>;
742
1227
  type AgentInstructionsHelper = ReturnType<typeof bindAgentInstructions>;
743
1228
  type AgentKnowledgeHelper = ReturnType<typeof bindAgentKnowledge>;
744
1229
  type AgentPhonesHelper = ReturnType<typeof bindAgentPhones>;
745
- interface AgentEntity extends AgentDetail {
1230
+ type AgentScheduleHelper = ReturnType<typeof bindAgentSchedule>;
1231
+ type AgentVersionsHelper = ReturnType<typeof bindAgentVersions>;
1232
+ type AgentBase = AgentSummary & Partial<Omit<AgentDetail, keyof AgentSummary>>;
1233
+ interface AgentEntity extends AgentBase {
746
1234
  instructions: AgentInstructionsHelper;
747
1235
  knowledge: AgentKnowledgeHelper;
748
1236
  phones: AgentPhonesHelper;
1237
+ schedule: AgentScheduleHelper;
1238
+ versions: AgentVersionsHelper;
749
1239
  refresh(): Promise<AgentEntity>;
750
1240
  }
751
1241
  type AgentEntityFactoryOptions = {
752
1242
  instructionsApi: AgentInstructionsApi;
753
1243
  knowledgeApi: AgentKnowledgeApi;
754
1244
  phonesApi: AgentPhonesApi;
1245
+ scheduleApi: AgentScheduleApi;
1246
+ versionsApi: AgentVersionsApi;
755
1247
  reload(agentId: string): Promise<AgentEntity>;
756
1248
  };
757
1249
  declare const bindAgentInstructions: (api: AgentInstructionsApi, agentId: string) => {
758
- list(opts?: {
759
- versionId?: string;
760
- }): Promise<{
1250
+ list(opts?: ListAgentInstructionsOptions): Promise<{
761
1251
  data: components["schemas"]["Instruction"][];
762
1252
  versionId?: string;
763
1253
  }>;
@@ -767,6 +1257,15 @@ declare const bindAgentInstructions: (api: AgentInstructionsApi, agentId: string
767
1257
  order: number;
768
1258
  createdAt: string;
769
1259
  }>;
1260
+ update(instructionId: string, payload: UpdateInstructionRequest): Promise<{
1261
+ id: string;
1262
+ versionId: string;
1263
+ order: number;
1264
+ content: string;
1265
+ createdAt?: string;
1266
+ updatedAt?: string;
1267
+ }>;
1268
+ delete(instructionId: string): Promise<void>;
770
1269
  };
771
1270
  declare const bindAgentKnowledge: (api: AgentKnowledgeApi, agentId: string) => {
772
1271
  upload(payload: KnowledgeUploadRequest): Promise<{
@@ -778,11 +1277,11 @@ declare const bindAgentKnowledge: (api: AgentKnowledgeApi, agentId: string) => {
778
1277
  user_id: string;
779
1278
  status: "queued" | "processing" | "completed" | "failed";
780
1279
  }>;
781
- listBases(): Promise<{
1280
+ listBases(opts?: ListAgentKnowledgeOptions): Promise<{
782
1281
  data?: components["schemas"]["KnowledgeBaseSummary"][];
783
1282
  agent_id?: string;
784
1283
  }>;
785
- listUploads(): Promise<{
1284
+ listUploads(opts?: ListAgentKnowledgeOptions): Promise<{
786
1285
  data: ({
787
1286
  document_id: string;
788
1287
  file_path: string;
@@ -805,21 +1304,101 @@ declare const bindAgentPhones: (api: AgentPhonesApi, agentId: string) => {
805
1304
  }>;
806
1305
  disconnect(phoneId: string): Promise<void>;
807
1306
  };
808
- declare const createAgentEntity: (dto: AgentDetail, options: AgentEntityFactoryOptions) => AgentEntity;
1307
+ declare const bindAgentSchedule: (api: AgentScheduleApi, agentId: string) => {
1308
+ get(): Promise<{
1309
+ agentId: string;
1310
+ timezone: string;
1311
+ rules: components["schemas"]["AgentScheduleRule"][];
1312
+ metadata?: {
1313
+ [key: string]: unknown;
1314
+ };
1315
+ }>;
1316
+ update(payload: UpdateAgentScheduleRequest): Promise<{
1317
+ agentId: string;
1318
+ timezone: string;
1319
+ rules: components["schemas"]["AgentScheduleRule"][];
1320
+ metadata?: {
1321
+ [key: string]: unknown;
1322
+ };
1323
+ }>;
1324
+ };
1325
+ declare const bindAgentVersions: (api: AgentVersionsApi, agentId: string) => {
1326
+ list(opts?: ListAgentVersionsOptions): Promise<{
1327
+ data: components["schemas"]["AgentVersionSummary"][];
1328
+ meta?: components["schemas"]["PaginationMeta"];
1329
+ }>;
1330
+ get(versionId: string): Promise<{
1331
+ versionId: string;
1332
+ agentId: string;
1333
+ label: string;
1334
+ status: "draft" | "published" | "archived";
1335
+ isActive?: boolean;
1336
+ createdAt: string;
1337
+ updatedAt?: string;
1338
+ publishedAt?: string | null;
1339
+ } & {
1340
+ description?: string;
1341
+ metadata?: {
1342
+ [key: string]: unknown;
1343
+ };
1344
+ instructionsVersionId?: string;
1345
+ }>;
1346
+ create(payload: CreateAgentVersionRequest): Promise<{
1347
+ versionId: string;
1348
+ agentId: string;
1349
+ label: string;
1350
+ status: "draft" | "published" | "archived";
1351
+ isActive?: boolean;
1352
+ createdAt: string;
1353
+ updatedAt?: string;
1354
+ publishedAt?: string | null;
1355
+ } & {
1356
+ description?: string;
1357
+ metadata?: {
1358
+ [key: string]: unknown;
1359
+ };
1360
+ instructionsVersionId?: string;
1361
+ }>;
1362
+ update(versionId: string, payload: UpdateAgentVersionRequest): Promise<{
1363
+ versionId: string;
1364
+ agentId: string;
1365
+ label: string;
1366
+ status: "draft" | "published" | "archived";
1367
+ isActive?: boolean;
1368
+ createdAt: string;
1369
+ updatedAt?: string;
1370
+ publishedAt?: string | null;
1371
+ } & {
1372
+ description?: string;
1373
+ metadata?: {
1374
+ [key: string]: unknown;
1375
+ };
1376
+ instructionsVersionId?: string;
1377
+ }>;
1378
+ };
1379
+ type AgentSnapshot = AgentDetail | AgentSummary;
1380
+ declare const createAgentEntity: (dto: AgentSnapshot, options: AgentEntityFactoryOptions) => AgentEntity;
809
1381
 
810
1382
  type AgentEntityDependencies = {
811
1383
  instructionsApi: ReturnType<typeof createAgentInstructionsApi>;
812
1384
  knowledgeApi: ReturnType<typeof createAgentKnowledgeApi>;
813
1385
  phonesApi: ReturnType<typeof createAgentPhonesApi>;
1386
+ scheduleApi: ReturnType<typeof createAgentScheduleApi>;
1387
+ versionsApi: ReturnType<typeof createAgentVersionsApi>;
814
1388
  };
1389
+ type ListAgentsOptions = ListQueryOptions;
815
1390
  type AgentsApi = {
816
- list(): Promise<AgentListResponse>;
1391
+ list(options?: ListAgentsOptions): Promise<AgentListResponse>;
817
1392
  get(agentId: string): Promise<AgentDetail>;
818
1393
  create(payload: CreateAgentRequest): Promise<AgentDetail>;
819
1394
  update(agentId: string, payload: UpdateAgentRequest): Promise<AgentDetail>;
820
1395
  delete(agentId: string): Promise<void>;
821
1396
  };
822
- type AgentsApiWithEntities = Omit<AgentsApi, 'get' | 'create' | 'update'> & {
1397
+ type AgentListResponseWithEntities = Omit<AgentListResponse, 'data'> & {
1398
+ data: AgentEntity[];
1399
+ };
1400
+ type AgentsApiWithEntities = Omit<AgentsApi, 'get' | 'create' | 'update' | 'list'> & {
1401
+ list(options?: ListAgentsOptions): Promise<AgentListResponseWithEntities>;
823
1402
  get(agentId: string): Promise<AgentEntity>;
824
1403
  create(payload: CreateAgentRequest): Promise<AgentEntity>;
825
1404
  update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
@@ -828,20 +1407,36 @@ declare function createAgentsApi(cfg: ClientConfig & {
828
1407
  retry?: RetryPolicy;
829
1408
  }, relatedApis?: AgentEntityDependencies): AgentsApi | AgentsApiWithEntities;
830
1409
 
831
- declare function createWorkspacesApi(cfg: ClientConfig & {
1410
+ type ListToolsOptions = ListQueryOptions;
1411
+ declare function createToolsApi(cfg: ClientConfig & {
832
1412
  retry?: RetryPolicy;
833
1413
  }): {
834
- listPhones(workspaceId: string, opts?: {
835
- channel?: WorkspacePhoneChannel;
836
- }): Promise<WorkspacePhonesResponse>;
837
- enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
1414
+ list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
1415
+ execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
838
1416
  };
839
1417
 
840
- declare function createToolsApi(cfg: ClientConfig & {
1418
+ type ListVoicesOptions = ListQueryOptions & {
1419
+ agentId?: string;
1420
+ agentVersionId?: string;
1421
+ gender?: 'female' | 'male' | 'neutral';
1422
+ locale?: string;
1423
+ page?: number;
1424
+ pageSize?: number;
1425
+ };
1426
+ declare function createVoicesApi(cfg: ClientConfig & {
841
1427
  retry?: RetryPolicy;
842
1428
  }): {
843
- list(): Promise<ToolsCatalogResponse>;
844
- execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
1429
+ list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
1430
+ };
1431
+
1432
+ type ListWorkspacePhonesOptions = ListQueryOptions & {
1433
+ channel?: WorkspacePhoneChannel;
1434
+ };
1435
+ declare function createWorkspacesApi(cfg: ClientConfig & {
1436
+ retry?: RetryPolicy;
1437
+ }): {
1438
+ listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
1439
+ enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
845
1440
  };
846
1441
 
847
1442
  declare function createClient(initialCfg: ClientConfig & {
@@ -863,71 +1458,109 @@ declare function createClient(initialCfg: ClientConfig & {
863
1458
  agents: {
864
1459
  knowledge: {
865
1460
  upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
866
- listBases(agentId: string): Promise<AgentKnowledgeBasesResponse>;
867
- listUploads(agentId: string): Promise<AgentKnowledgeUploadsResponse>;
1461
+ listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
1462
+ listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
868
1463
  };
869
1464
  instructions: {
870
- list(agentId: string, opts?: {
871
- versionId?: string;
872
- }): Promise<AgentInstructionsResponse>;
1465
+ list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
873
1466
  create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
1467
+ update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
1468
+ delete(agentId: string, instructionId: string): Promise<void>;
874
1469
  };
875
1470
  phones: {
876
1471
  connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
877
1472
  disconnect(agentId: string, phoneId: string): Promise<void>;
878
1473
  };
879
- list: () => Promise<AgentListResponse>;
1474
+ schedule: {
1475
+ get(agentId: string): Promise<AgentSchedule>;
1476
+ update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
1477
+ };
1478
+ versions: {
1479
+ list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
1480
+ get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
1481
+ create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
1482
+ update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
1483
+ };
880
1484
  delete: (agentId: string) => Promise<void>;
1485
+ list(options?: ListAgentsOptions): Promise<Omit<{
1486
+ data: components["schemas"]["AgentSummary"][];
1487
+ meta: components["schemas"]["PaginationMeta"];
1488
+ }, "data"> & {
1489
+ data: AgentEntity[];
1490
+ }>;
881
1491
  get(agentId: string): Promise<AgentEntity>;
882
1492
  create(payload: CreateAgentRequest): Promise<AgentEntity>;
883
1493
  update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
884
1494
  };
885
1495
  workspaces: {
886
- listPhones(workspaceId: string, opts?: {
887
- channel?: WorkspacePhoneChannel;
888
- }): Promise<WorkspacePhonesResponse>;
1496
+ listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
889
1497
  enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
890
1498
  };
891
1499
  tools: {
892
- list(): Promise<ToolsCatalogResponse>;
1500
+ list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
893
1501
  execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
894
1502
  };
1503
+ voices: {
1504
+ list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
1505
+ };
895
1506
  };
896
1507
  };
897
1508
  agents: {
898
1509
  knowledge: {
899
1510
  upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
900
- listBases(agentId: string): Promise<AgentKnowledgeBasesResponse>;
901
- listUploads(agentId: string): Promise<AgentKnowledgeUploadsResponse>;
1511
+ listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
1512
+ listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
902
1513
  };
903
1514
  instructions: {
904
- list(agentId: string, opts?: {
905
- versionId?: string;
906
- }): Promise<AgentInstructionsResponse>;
1515
+ list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
907
1516
  create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
1517
+ update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
1518
+ delete(agentId: string, instructionId: string): Promise<void>;
908
1519
  };
909
1520
  phones: {
910
1521
  connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
911
1522
  disconnect(agentId: string, phoneId: string): Promise<void>;
912
1523
  };
913
- list: () => Promise<AgentListResponse>;
1524
+ schedule: {
1525
+ get(agentId: string): Promise<AgentSchedule>;
1526
+ update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
1527
+ };
1528
+ versions: {
1529
+ list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
1530
+ get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
1531
+ create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
1532
+ update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
1533
+ };
914
1534
  delete: (agentId: string) => Promise<void>;
1535
+ list(options?: ListAgentsOptions): Promise<Omit<{
1536
+ data: components["schemas"]["AgentSummary"][];
1537
+ meta: components["schemas"]["PaginationMeta"];
1538
+ }, "data"> & {
1539
+ data: AgentEntity[];
1540
+ }>;
915
1541
  get(agentId: string): Promise<AgentEntity>;
916
1542
  create(payload: CreateAgentRequest): Promise<AgentEntity>;
917
1543
  update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
918
1544
  };
919
1545
  workspaces: {
920
- listPhones(workspaceId: string, opts?: {
921
- channel?: WorkspacePhoneChannel;
922
- }): Promise<WorkspacePhonesResponse>;
1546
+ listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
923
1547
  enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
924
1548
  };
925
1549
  tools: {
926
- list(): Promise<ToolsCatalogResponse>;
1550
+ list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
927
1551
  execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
928
1552
  };
1553
+ voices: {
1554
+ list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
1555
+ };
929
1556
  };
930
1557
 
1558
+ type QueryParamPrimitive = string | number | boolean;
1559
+ type QueryParamValue = QueryParamPrimitive | QueryParamPrimitive[] | null | undefined;
1560
+ type QueryInit = string | URLSearchParams | Record<string, QueryParamValue>;
1561
+ type FetchOptions = RequestInit & {
1562
+ query?: QueryInit;
1563
+ };
931
1564
  declare function createHttp(cfg: ClientConfig & {
932
1565
  retry?: RetryPolicy;
933
1566
  }): {
@@ -938,9 +1571,9 @@ declare function createHttp(cfg: ClientConfig & {
938
1571
  error?: (...a: any[]) => void;
939
1572
  };
940
1573
  retry: RetryPolicy;
941
- doFetch: (url: string, init?: RequestInit) => Promise<Response>;
1574
+ doFetch: (url: string, init?: FetchOptions) => Promise<Response>;
942
1575
  buildHeaders: (extra?: HeadersInit) => Record<string, string>;
943
1576
  resolveWorkspaceId: () => string;
944
1577
  };
945
1578
 
946
- export { type AgentDetail, type AgentEntity, type AgentEntityFactoryOptions, type AgentInstructionsResponse, type AgentKnowledgeBasesResponse, type AgentKnowledgeUploadsResponse, type AgentListResponse, type AgentSummary, type AgentsApi, type AgentsApiWithEntities, type ClientConfig, type ConnectPhoneRequest, type CreateAgentRequest, type CreateInstructionRequest, type ErrorResponse, type ExecuteToolRequest, type ExecuteToolResponse, HttpError, type Instruction, type InstructionCreatedResponse, type KnowledgeUploadListResponse, type KnowledgeUploadRequest, type KnowledgeUploadResponse, NetworkError, type PhoneAssignmentResponse, type RetryPolicy, TimeoutError, type ToolSummary, type ToolsCatalogResponse, type UpdateAgentRequest, type WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, bindAgentInstructions, bindAgentKnowledge, bindAgentPhones, createAgentEntity, createAgentInstructionsApi, createAgentKnowledgeApi, createAgentPhonesApi, createAgentsApi, createClient, createHttp, createToolsApi, createWorkspacesApi };
1579
+ export { type AgentDetail, type AgentEntity, type AgentEntityFactoryOptions, type AgentInstructionsResponse, type AgentKnowledgeBasesResponse, type AgentKnowledgeUploadsResponse, type AgentListResponse, type AgentSchedule, type AgentSummary, type AgentVersionDetail, type AgentVersionListResponse, type AgentVersionSummary, type AgentsApi, type AgentsApiWithEntities, type ClientConfig, type ConnectPhoneRequest, type CreateAgentRequest, type CreateAgentVersionRequest, type CreateInstructionRequest, type ErrorResponse, type ExecuteToolRequest, type ExecuteToolResponse, HttpError, type Instruction, type InstructionCreatedResponse, type KnowledgeUploadListResponse, type KnowledgeUploadRequest, type KnowledgeUploadResponse, type ListAgentInstructionsOptions, type ListAgentKnowledgeOptions, type ListAgentVersionsOptions, type ListAgentsOptions, type ListQueryOptions, type ListToolsOptions, type ListVoicesOptions, type ListWorkspacePhonesOptions, NetworkError, type PaginationMeta, type PhoneAssignmentResponse, type QueryBuilderInput, type QueryBuilderSerializable, type QueryFilterOperators, type QueryFilters, type QueryOrGroups, type QueryValue, type RetryPolicy, TimeoutError, type ToolSummary, type ToolsCatalogResponse, type UpdateAgentRequest, type UpdateAgentScheduleRequest, type UpdateAgentVersionRequest, type UpdateInstructionRequest, type VoiceListResponse, type VoiceSummary, type WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, bindAgentInstructions, bindAgentKnowledge, bindAgentPhones, bindAgentSchedule, bindAgentVersions, createAgentEntity, createAgentInstructionsApi, createAgentKnowledgeApi, createAgentPhonesApi, createAgentScheduleApi, createAgentVersionsApi, createAgentsApi, createClient, createHttp, createToolsApi, createVoicesApi, createWorkspacesApi };