@getsupervisor/agents-studio-sdk 1.3.0 → 1.4.0

package/dist/index.d.ts

@@ -1099,6 +1099,12 @@ type ListQueryOptions = Partial<{
     filter: QueryFilters | QueryBuilderInput;
     or: QueryOrGroups | QueryBuilderInput;
 }>;
+type PaginatedResult<TResponse, TOptions extends ListQueryOptions> = TResponse & {
+    next(): Promise<PaginatedResult<TResponse, TOptions> | null>;
+    prev(): Promise<PaginatedResult<TResponse, TOptions> | null>;
+    page(page: number): Promise<PaginatedResult<TResponse, TOptions>>;
+    reload(): Promise<PaginatedResult<TResponse, TOptions>>;
+};
 type ClientConfig = {
     baseUrl: string;
     headers?: Record<string, string>;
@@ -1178,7 +1184,7 @@ type ListAgentInstructionsOptions = ListQueryOptions & {
 declare function createAgentInstructionsApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
-    list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
+    list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<PaginatedResult<AgentInstructionsResponse, ListAgentInstructionsOptions>>;
     create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
     update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
     delete(agentId: string, instructionId: string): Promise<void>;
@@ -1189,8 +1195,8 @@ declare function createAgentKnowledgeApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
     upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
-    listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
-    listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
+    listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeBasesResponse, ListAgentKnowledgeOptions>>;
+    listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeUploadsResponse, ListAgentKnowledgeOptions>>;
 };
 
 declare function createAgentPhonesApi(cfg: ClientConfig & {
@@ -1213,7 +1219,7 @@ type ListAgentVersionsOptions = {
 declare function createAgentVersionsApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
-    list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
+    list(agentId: string, opts?: ListAgentVersionsOptions): Promise<PaginatedResult<AgentVersionListResponse, ListAgentVersionsOptions>>;
     get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
     create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
     update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
@@ -1236,6 +1242,8 @@ interface AgentEntity extends AgentBase {
     phones: AgentPhonesHelper;
     schedule: AgentScheduleHelper;
     versions: AgentVersionsHelper;
+    save(patch: UpdateAgentRequest): Promise<AgentEntity>;
+    delete(): Promise<void>;
     refresh(): Promise<AgentEntity>;
 }
 type AgentEntityFactoryOptions = {
@@ -1245,12 +1253,14 @@ type AgentEntityFactoryOptions = {
     scheduleApi: AgentScheduleApi;
     versionsApi: AgentVersionsApi;
     reload(agentId: string): Promise<AgentEntity>;
+    updateAgent(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
+    deleteAgent(agentId: string): Promise<void>;
 };
 declare const bindAgentInstructions: (api: AgentInstructionsApi, agentId: string) => {
-    list(opts?: ListAgentInstructionsOptions): Promise<{
+    list(opts?: ListAgentInstructionsOptions): Promise<PaginatedResult<{
         data: components["schemas"]["Instruction"][];
         versionId?: string;
-    }>;
+    }, ListAgentInstructionsOptions>>;
     create(payload: CreateInstructionRequest): Promise<{
         id: string;
         versionId: string;
@@ -1277,11 +1287,20 @@ declare const bindAgentKnowledge: (api: AgentKnowledgeApi, agentId: string) => {
         user_id: string;
         status: "queued" | "processing" | "completed" | "failed";
     }>;
-    listBases(opts?: ListAgentKnowledgeOptions): Promise<{
+    listBases(opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<{
         data?: components["schemas"]["KnowledgeBaseSummary"][];
         agent_id?: string;
-    }>;
-    listUploads(opts?: ListAgentKnowledgeOptions): Promise<{
+    }, Partial<{
+        page: number;
+        limit: number;
+        sort: string | string[];
+        fields: string | string[];
+        include: string | string[];
+        search: string;
+        filter: QueryFilters | QueryBuilderInput;
+        or: QueryOrGroups | QueryBuilderInput;
+    }>>>;
+    listUploads(opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<{
         data: ({
             document_id: string;
             file_path: string;
@@ -1291,7 +1310,16 @@ declare const bindAgentKnowledge: (api: AgentKnowledgeApi, agentId: string) => {
             user_id: string;
             status: "queued" | "processing" | "completed" | "failed";
         })[];
-    }>;
+    }, Partial<{
+        page: number;
+        limit: number;
+        sort: string | string[];
+        fields: string | string[];
+        include: string | string[];
+        search: string;
+        filter: QueryFilters | QueryBuilderInput;
+        or: QueryOrGroups | QueryBuilderInput;
+    }>>>;
 };
 declare const bindAgentPhones: (api: AgentPhonesApi, agentId: string) => {
     connect(payload: ConnectPhoneRequest): Promise<{
@@ -1323,10 +1351,10 @@ declare const bindAgentSchedule: (api: AgentScheduleApi, agentId: string) => {
     }>;
 };
 declare const bindAgentVersions: (api: AgentVersionsApi, agentId: string) => {
-    list(opts?: ListAgentVersionsOptions): Promise<{
+    list(opts?: ListAgentVersionsOptions): Promise<PaginatedResult<{
         data: components["schemas"]["AgentVersionSummary"][];
         meta?: components["schemas"]["PaginationMeta"];
-    }>;
+    }, ListAgentVersionsOptions>>;
     get(versionId: string): Promise<{
         versionId: string;
         agentId: string;
@@ -1388,17 +1416,17 @@ type AgentEntityDependencies = {
 };
 type ListAgentsOptions = ListQueryOptions;
 type AgentsApi = {
-    list(options?: ListAgentsOptions): Promise<AgentListResponse>;
+    list(options?: ListAgentsOptions): Promise<PaginatedResult<AgentListResponse, ListAgentsOptions>>;
     get(agentId: string): Promise<AgentDetail>;
     create(payload: CreateAgentRequest): Promise<AgentDetail>;
     update(agentId: string, payload: UpdateAgentRequest): Promise<AgentDetail>;
-    delete(agentId: string): Promise<void>;
+    delete(agent: string | AgentEntity): Promise<void>;
 };
 type AgentListResponseWithEntities = Omit<AgentListResponse, 'data'> & {
     data: AgentEntity[];
 };
 type AgentsApiWithEntities = Omit<AgentsApi, 'get' | 'create' | 'update' | 'list'> & {
-    list(options?: ListAgentsOptions): Promise<AgentListResponseWithEntities>;
+    list(options?: ListAgentsOptions): Promise<PaginatedResult<AgentListResponseWithEntities, ListAgentsOptions>>;
     get(agentId: string): Promise<AgentEntity>;
     create(payload: CreateAgentRequest): Promise<AgentEntity>;
     update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
@@ -1411,7 +1439,7 @@ type ListToolsOptions = ListQueryOptions;
 declare function createToolsApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
-    list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
+    list(options?: ListToolsOptions): Promise<PaginatedResult<ToolsCatalogResponse, ListToolsOptions>>;
     execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
 };
 
@@ -1426,7 +1454,7 @@ type ListVoicesOptions = ListQueryOptions & {
 declare function createVoicesApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
-    list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
+    list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
 };
 
 type ListWorkspacePhonesOptions = ListQueryOptions & {
@@ -1435,7 +1463,7 @@ type ListWorkspacePhonesOptions = ListQueryOptions & {
 declare function createWorkspacesApi(cfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
-    listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
+    listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
     enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
 };
 
@@ -1458,11 +1486,11 @@ declare function createClient(initialCfg: ClientConfig & {
             agents: {
                 knowledge: {
                     upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
-                    listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
-                    listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
+                    listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeBasesResponse, ListAgentKnowledgeOptions>>;
+                    listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeUploadsResponse, ListAgentKnowledgeOptions>>;
                 };
                 instructions: {
-                    list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
+                    list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<PaginatedResult<AgentInstructionsResponse, ListAgentInstructionsOptions>>;
                     create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
                     update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
                     delete(agentId: string, instructionId: string): Promise<void>;
@@ -1476,43 +1504,43 @@ declare function createClient(initialCfg: ClientConfig & {
                     update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
                 };
                 versions: {
-                    list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
+                    list(agentId: string, opts?: ListAgentVersionsOptions): Promise<PaginatedResult<AgentVersionListResponse, ListAgentVersionsOptions>>;
                     get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
                     create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
                     update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
                 };
-                delete: (agentId: string) => Promise<void>;
-                list(options?: ListAgentsOptions): Promise<Omit<{
+                delete: (agent: string | AgentEntity) => Promise<void>;
+                list(options?: ListAgentsOptions): Promise<PaginatedResult<Omit<{
                     data: components["schemas"]["AgentSummary"][];
                     meta: components["schemas"]["PaginationMeta"];
                 }, "data"> & {
                     data: AgentEntity[];
-                }>;
+                }, ListAgentsOptions>>;
                 get(agentId: string): Promise<AgentEntity>;
                 create(payload: CreateAgentRequest): Promise<AgentEntity>;
                 update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
             };
             workspaces: {
-                listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
+                listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
                 enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
             };
             tools: {
-                list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
+                list(options?: ListToolsOptions): Promise<PaginatedResult<ToolsCatalogResponse, ListToolsOptions>>;
                 execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
             };
             voices: {
-                list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
+                list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
             };
         };
     };
     agents: {
         knowledge: {
             upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
-            listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeBasesResponse>;
-            listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<AgentKnowledgeUploadsResponse>;
+            listBases(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeBasesResponse, ListAgentKnowledgeOptions>>;
+            listUploads(agentId: string, opts?: ListAgentKnowledgeOptions): Promise<PaginatedResult<AgentKnowledgeUploadsResponse, ListAgentKnowledgeOptions>>;
         };
         instructions: {
-            list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<AgentInstructionsResponse>;
+            list(agentId: string, opts?: ListAgentInstructionsOptions): Promise<PaginatedResult<AgentInstructionsResponse, ListAgentInstructionsOptions>>;
             create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
             update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
             delete(agentId: string, instructionId: string): Promise<void>;
@@ -1526,32 +1554,32 @@ declare function createClient(initialCfg: ClientConfig & {
             update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
         };
         versions: {
-            list(agentId: string, opts?: ListAgentVersionsOptions): Promise<AgentVersionListResponse>;
+            list(agentId: string, opts?: ListAgentVersionsOptions): Promise<PaginatedResult<AgentVersionListResponse, ListAgentVersionsOptions>>;
             get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
             create(agentId: string, payload: CreateAgentVersionRequest): Promise<AgentVersionDetail>;
             update(agentId: string, versionId: string, payload: UpdateAgentVersionRequest): Promise<AgentVersionDetail>;
         };
-        delete: (agentId: string) => Promise<void>;
-        list(options?: ListAgentsOptions): Promise<Omit<{
+        delete: (agent: string | AgentEntity) => Promise<void>;
+        list(options?: ListAgentsOptions): Promise<PaginatedResult<Omit<{
             data: components["schemas"]["AgentSummary"][];
             meta: components["schemas"]["PaginationMeta"];
         }, "data"> & {
             data: AgentEntity[];
-        }>;
+        }, ListAgentsOptions>>;
         get(agentId: string): Promise<AgentEntity>;
         create(payload: CreateAgentRequest): Promise<AgentEntity>;
         update(agentId: string, payload: UpdateAgentRequest): Promise<AgentEntity>;
     };
     workspaces: {
-        listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<WorkspacePhonesResponse>;
+        listPhones(workspaceId: string, opts?: ListWorkspacePhonesOptions): Promise<PaginatedResult<WorkspacePhonesResponse, ListWorkspacePhonesOptions>>;
         enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
     };
     tools: {
-        list(options?: ListToolsOptions): Promise<ToolsCatalogResponse>;
+        list(options?: ListToolsOptions): Promise<PaginatedResult<ToolsCatalogResponse, ListToolsOptions>>;
         execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
     };
     voices: {
-        list(options?: ListVoicesOptions): Promise<VoiceListResponse>;
+        list(options?: ListVoicesOptions): Promise<PaginatedResult<VoiceListResponse, ListVoicesOptions>>;
     };
 };
 
@@ -1576,4 +1604,4 @@ declare function createHttp(cfg: ClientConfig & {
     resolveWorkspaceId: () => string;
 };
 
-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 };
+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 PaginatedResult, 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 };