@getsupervisor/agents-studio-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,652 @@
+type paths = {
+    '/v1/agents/{agentId}': {
+        get: operations['getAgentDetail'];
+        delete: operations['deleteAgent'];
+    };
+    '/v1/agents/{agentId}/knowledge/upload': {
+        post: operations['uploadAgentKnowledge'];
+    };
+    '/v1/agents/{agentId}/knowledge/bases': {
+        get: operations['listAgentKnowledgeBases'];
+    };
+    '/v1/agents/{agentId}/knowledge/uploads': {
+        get: operations['listAgentKnowledgeUploads'];
+    };
+    '/v1/agents/{agentId}/instructions': {
+        get: operations['listAgentInstructions'];
+        post: operations['createAgentInstruction'];
+    };
+    '/v1/agents/{agentId}/phones': {
+        post: operations['connectAgentPhone'];
+    };
+    '/v1/agents/{agentId}/phones/{phoneId}': {
+        delete: operations['disconnectAgentPhone'];
+    };
+    '/v1/workspaces/{workspaceId}/phones': {
+        get: operations['listWorkspacePhones'];
+    };
+    '/v1/workspaces/{workspaceId}/enable': {
+        post: operations['enableWorkspace'];
+    };
+    '/v1/tools': {
+        get: operations['listTools'];
+    };
+    '/v1/tools/{toolId}/execute': {
+        post: operations['executeTool'];
+    };
+};
+type components = {
+    schemas: {
+        AgentDetail: {
+            agentId: string;
+            name: string;
+            workspaceId: string;
+            provider: string;
+            versionId?: string;
+            status: 'inactive' | 'training' | 'active' | 'archived';
+            voiceProfile?: {
+                voiceId?: string;
+                llmId?: string;
+                webhookUrl?: string;
+            };
+            knowledgeBaseIds?: string[];
+            tools?: string[];
+            createdAt?: string;
+            updatedAt?: string;
+        };
+        KnowledgeBaseSummary: {
+            id: string;
+            providerId?: string;
+            name: string;
+            documents?: number;
+            lastSyncedAt?: string;
+        };
+        KnowledgeUploadRequest: {
+            document_id: string;
+            file_path: string;
+            file_name: string;
+            source: string;
+            drive_file_id?: string | null;
+            user_id: string;
+        };
+        KnowledgeUploadResponse: {
+            document_id: string;
+            file_path: string;
+            file_name: string;
+            source: string;
+            drive_file_id?: string | null;
+            user_id: string;
+            status: 'queued' | 'processing' | 'completed' | 'failed';
+        };
+        KnowledgeUploadListResponse: {
+            data: {
+                document_id: string;
+                file_path: string;
+                file_name: string;
+                source: string;
+                drive_file_id?: string | null;
+                user_id: string;
+                status: 'queued' | 'processing' | 'completed' | 'failed';
+            }[];
+        };
+        Instruction: {
+            id: string;
+            versionId: string;
+            order: number;
+            content: string;
+            createdAt?: string;
+            updatedAt?: string;
+        };
+        CreateInstructionRequest: {
+            order: number;
+            content: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        InstructionCreatedResponse: {
+            id: string;
+            versionId: string;
+            order: number;
+            createdAt: string;
+        };
+        ConnectPhoneRequest: {
+            agent_id: string;
+            phone_id: string;
+            test_phones?: string[];
+            allow_all?: boolean;
+        };
+        PhoneAssignmentResponse: {
+            agent_id: string;
+            phone_id: string;
+            allow_all: boolean;
+            test_phones?: string[];
+            channel?: string | null;
+            assigned_at?: string | null;
+        };
+        WorkspacePhone: {
+            id: string;
+            external_id: string;
+            channel?: 'voice' | null;
+            supports_outbound?: boolean | null;
+            assigned_to?: string | null;
+            last_used_at?: string | null;
+            requires_qr_reauth?: boolean | null;
+        };
+        WorkspacePhonesResponse: {
+            data: components['schemas']['WorkspacePhone'][];
+        };
+        ToolSummary: {
+            id: string;
+            name: string;
+            identifier: string;
+            description?: string;
+            enabled: boolean;
+        };
+        ExecuteToolRequest: {
+            payload: {
+                [key: string]: unknown;
+            };
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        ExecuteToolResponse: {
+            result: {
+                [key: string]: unknown;
+            };
+            metadata?: {
+                [key: string]: unknown;
+            };
+            toolId: string;
+        };
+        WorkspaceEnableRequest: {
+            provider: 'retell';
+            apiKey: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        WorkspaceEnableResponse: {
+            status: 'enabled';
+            provider: string;
+            workspaceId: string;
+        };
+        ErrorResponse: {
+            code: string;
+            message: string;
+            details?: {
+                [key: string]: unknown;
+            };
+        };
+    };
+    responses: never;
+    parameters: {
+        AgentId: string;
+        PhoneId: string;
+        WorkspaceId: string;
+        ToolId: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+};
+type operations = {
+    getAgentDetail: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['AgentDetail'];
+                };
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    deleteAgent: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        responses: {
+            204: {
+                content: never;
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    uploadAgentKnowledge: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['KnowledgeUploadRequest'];
+            };
+        };
+        responses: {
+            202: {
+                content: {
+                    'application/json': components['schemas']['KnowledgeUploadResponse'];
+                };
+            };
+            400: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    listAgentKnowledgeBases: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': {
+                        data?: components['schemas']['KnowledgeBaseSummary'][];
+                        agent_id?: string;
+                    };
+                };
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    listAgentKnowledgeUploads: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['KnowledgeUploadListResponse'];
+                };
+            };
+        };
+    };
+    listAgentInstructions: {
+        parameters: {
+            query?: {
+                versionId?: string;
+            };
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': {
+                        data?: components['schemas']['Instruction'][];
+                        versionId?: string;
+                    };
+                };
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    createAgentInstruction: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['CreateInstructionRequest'];
+            };
+        };
+        responses: {
+            201: {
+                content: {
+                    'application/json': components['schemas']['InstructionCreatedResponse'];
+                };
+            };
+            400: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    connectAgentPhone: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['ConnectPhoneRequest'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['PhoneAssignmentResponse'];
+                };
+            };
+            400: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    disconnectAgentPhone: {
+        parameters: {
+            path: {
+                agentId: components['parameters']['AgentId'];
+                phoneId: components['parameters']['PhoneId'];
+            };
+        };
+        responses: {
+            204: {
+                content: never;
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    listWorkspacePhones: {
+        parameters: {
+            query?: {
+                channel?: 'voice';
+            };
+            path: {
+                workspaceId: components['parameters']['WorkspaceId'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['WorkspacePhonesResponse'];
+                };
+            };
+        };
+    };
+    enableWorkspace: {
+        parameters: {
+            path: {
+                workspaceId: components['parameters']['WorkspaceId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['WorkspaceEnableRequest'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['WorkspaceEnableResponse'];
+                };
+            };
+            400: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            502: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+    listTools: {
+        responses: {
+            200: {
+                content: {
+                    'application/json': {
+                        data?: components['schemas']['ToolSummary'][];
+                    };
+                };
+            };
+        };
+    };
+    executeTool: {
+        parameters: {
+            path: {
+                toolId: components['parameters']['ToolId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['ExecuteToolRequest'];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    'application/json': components['schemas']['ExecuteToolResponse'];
+                };
+            };
+            400: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            404: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+            409: {
+                content: {
+                    'application/json': components['schemas']['ErrorResponse'];
+                };
+            };
+        };
+    };
+};
+
+type ClientConfig = {
+    baseUrl: string;
+    headers?: Record<string, string>;
+    timeoutMs?: number;
+    fetchImpl?: typeof fetch;
+    logger?: {
+        debug?: (...a: any[]) => void;
+        error?: (...a: any[]) => void;
+    };
+};
+type AgentDetail = components['schemas']['AgentDetail'];
+type KnowledgeUploadRequest = components['schemas']['KnowledgeUploadRequest'];
+type KnowledgeUploadResponse = components['schemas']['KnowledgeUploadResponse'];
+type KnowledgeUploadListResponse = components['schemas']['KnowledgeUploadListResponse'];
+type AgentKnowledgeBasesResponse = paths['/v1/agents/{agentId}/knowledge/bases']['get']['responses'][200]['content']['application/json'];
+type AgentKnowledgeUploadsResponse = paths['/v1/agents/{agentId}/knowledge/uploads']['get']['responses'][200]['content']['application/json'];
+type Instruction = components['schemas']['Instruction'];
+type CreateInstructionRequest = components['schemas']['CreateInstructionRequest'];
+type InstructionCreatedResponse = components['schemas']['InstructionCreatedResponse'];
+type AgentInstructionsResponse = paths['/v1/agents/{agentId}/instructions']['get']['responses'][200]['content']['application/json'];
+type ConnectPhoneRequest = components['schemas']['ConnectPhoneRequest'];
+type PhoneAssignmentResponse = components['schemas']['PhoneAssignmentResponse'];
+type WorkspacePhone = components['schemas']['WorkspacePhone'];
+type WorkspacePhonesResponse = components['schemas']['WorkspacePhonesResponse'];
+type WorkspacePhoneChannel = 'voice';
+type WorkspaceEnableRequest = components['schemas']['WorkspaceEnableRequest'];
+type WorkspaceEnableResponse = components['schemas']['WorkspaceEnableResponse'];
+type ToolSummary = components['schemas']['ToolSummary'];
+type ExecuteToolRequest = components['schemas']['ExecuteToolRequest'];
+type ExecuteToolResponse = components['schemas']['ExecuteToolResponse'];
+type ToolsCatalogResponse = paths['/v1/tools']['get']['responses'][200]['content']['application/json'];
+type ErrorResponse = components['schemas']['ErrorResponse'];
+
+declare class HttpError extends Error {
+    status: number;
+    statusText: string;
+    body?: unknown;
+    url?: string;
+    constructor(status: number, statusText: string, body?: unknown, url?: string);
+}
+declare class TimeoutError extends Error {
+    ms: number;
+    url?: string;
+    constructor(ms: number, url?: string);
+}
+declare class NetworkError extends Error {
+    cause?: unknown;
+    url?: string;
+    constructor(cause?: unknown, url?: string);
+}
+type RetryPolicy = {
+    maxRetries?: number;
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+    retryOn?: (err: unknown, attempt: number) => boolean;
+};
+
+declare function createAgentsApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    get(agentId: string): Promise<AgentDetail>;
+    delete(agentId: string): Promise<void>;
+};
+
+declare function createAgentKnowledgeApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
+    listBases(agentId: string): Promise<AgentKnowledgeBasesResponse>;
+    listUploads(agentId: string): Promise<AgentKnowledgeUploadsResponse>;
+};
+
+declare function createAgentInstructionsApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    list(agentId: string, opts?: {
+        versionId?: string;
+    }): Promise<AgentInstructionsResponse>;
+    create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
+};
+
+declare function createAgentPhonesApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
+    disconnect(agentId: string, phoneId: string): Promise<void>;
+};
+
+declare function createWorkspacesApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    listPhones(workspaceId: string, opts?: {
+        channel?: WorkspacePhoneChannel;
+    }): Promise<WorkspacePhonesResponse>;
+    enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
+};
+
+declare function createToolsApi(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    list(): Promise<ToolsCatalogResponse>;
+    execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
+};
+
+declare function createClient(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    agents: {
+        knowledge: {
+            upload(agentId: string, payload: KnowledgeUploadRequest): Promise<KnowledgeUploadResponse>;
+            listBases(agentId: string): Promise<AgentKnowledgeBasesResponse>;
+            listUploads(agentId: string): Promise<AgentKnowledgeUploadsResponse>;
+        };
+        instructions: {
+            list(agentId: string, opts?: {
+                versionId?: string;
+            }): Promise<AgentInstructionsResponse>;
+            create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
+        };
+        phones: {
+            connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
+            disconnect(agentId: string, phoneId: string): Promise<void>;
+        };
+        get(agentId: string): Promise<AgentDetail>;
+        delete(agentId: string): Promise<void>;
+    };
+    workspaces: {
+        listPhones(workspaceId: string, opts?: {
+            channel?: WorkspacePhoneChannel;
+        }): Promise<WorkspacePhonesResponse>;
+        enable(workspaceId: string, payload: WorkspaceEnableRequest): Promise<WorkspaceEnableResponse>;
+    };
+    tools: {
+        list(): Promise<ToolsCatalogResponse>;
+        execute(toolId: string, payload: ExecuteToolRequest): Promise<ExecuteToolResponse>;
+    };
+};
+
+declare function createHttp(cfg: ClientConfig & {
+    retry?: RetryPolicy;
+}): {
+    base: string;
+    headers: Record<string, string>;
+    timeout: number;
+    log: {
+        debug?: (...a: any[]) => void;
+        error?: (...a: any[]) => void;
+    };
+    retry: RetryPolicy;
+    doFetch: (url: string, init: RequestInit) => Promise<Response>;
+};
+
+export { type AgentDetail, type AgentInstructionsResponse, type AgentKnowledgeBasesResponse, type AgentKnowledgeUploadsResponse, type ClientConfig, type ConnectPhoneRequest, 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 WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, createAgentInstructionsApi, createAgentKnowledgeApi, createAgentPhonesApi, createAgentsApi, createClient, createHttp, createToolsApi, createWorkspacesApi };