@getsupervisor/agents-studio-sdk 1.7.0 → 1.9.0

package/dist/index.d.ts

@@ -1,41 +1,17 @@
 type components = {
     schemas: {
-        AgentDetail: {
-            agentId: string;
-            name: string;
-            agentType: 'chat' | 'voice';
-            workspaceId: string;
-            versionId?: string;
-            status: 'inactive' | 'training' | 'active' | 'archived';
-            languageCode?: string;
-            description?: string | null;
-            toneId?: string | null;
-            messageStyleId?: string | null;
-            ownerUserId?: string | null;
-            knowledgeBaseIds?: string[];
-            tags?: string[];
-            tools?: {
-                identifier: string;
-                displayName: string;
-                enabled: boolean;
-            }[];
-            voiceConfig?: {
-                voiceId?: string;
-                webhookUrl?: string;
-                llmId?: string | null;
-            } | null;
-            createdAt: string;
-            updatedAt: string;
-            metadata?: {
-                [key: string]: unknown;
-            };
+        AgentDetail: components['schemas']['AgentSummary'] & {
+            description?: string;
+            avatarUrl?: string;
+            ownerUserId: string;
+            debounceDelayMs: number;
         };
         PaginationMeta: {
             total: number;
             page: number;
             limit: number;
             hasNext: boolean;
-            hasPrevious?: boolean;
+            hasPrevious: boolean;
         };
         QueryFilters: string;
         QueryOrGroups: string;
@@ -54,15 +30,11 @@ type components = {
         };
         CreateAgentRequest: {
             name: string;
-            description?: string | null;
             agentType: 'chat' | 'voice';
-            languageCode: string;
-            status?: 'inactive' | 'training' | 'active';
-            avatarUrl?: string | null;
-            debounceDelayMs?: number | null;
-            metadata?: {
-                [key: string]: unknown;
-            };
+            description?: string;
+            status: 'inactive' | 'training' | 'active';
+            avatarUrl?: string;
+            debounceDelayMs: number;
         };
         AgentTagRequest: {
             tagId: string;
@@ -74,15 +46,9 @@ type components = {
         UpdateAgentRequest: {
             name?: string;
             status?: 'inactive' | 'training' | 'active' | 'archived';
-            description?: string | null;
-            toneId?: string | null;
-            messageStyleId?: string | null;
-            tags?: string[];
-            debounceDelayMs?: number | null;
-            ownerUserId?: string | null;
-            metadata?: {
-                [key: string]: unknown;
-            };
+            description?: string;
+            avatarUrl?: string;
+            debounceDelayMs?: number;
         };
         Instruction: {
             id: string;
@@ -389,6 +355,8 @@ type ClientConfig = {
     };
     workspaceId?: string;
     getWorkspaceId?: () => string | undefined;
+    apiKey?: string;
+    getApiKey?: () => string | undefined;
 };
 type AgentDetail = components['schemas']['AgentDetail'];
 type AgentSummary = components['schemas']['AgentSummary'];
@@ -679,7 +647,7 @@ type AgentEntityDependencies = {
     scheduleApi: ReturnType<typeof createAgentScheduleApi>;
     versionsApi: ReturnType<typeof createAgentVersionsApi>;
 };
-type ListAgentsOptions = ListQueryOptions;
+type ListAgentsOptions = Pick<ListQueryOptions, 'page' | 'limit' | 'filter'>;
 type AgentsApi = {
     list(options?: ListAgentsOptions): Promise<PaginatedResult<AgentListResponse, ListAgentsOptions>>;
     get(agentId: string): Promise<AgentDetail>;
@@ -748,12 +716,24 @@ declare function createWorkspacesApi(cfg: ClientConfig & {
 declare function createClient(initialCfg: ClientConfig & {
     retry?: RetryPolicy;
 }): {
+    auth: {
+        getApiKey: () => string;
+        setApiKey(key?: string): void;
+        useApiKey(getter?: () => string | undefined): void;
+        clearApiKey(): void;
+    };
     workspace: {
         get: () => string;
         set(id?: string): void;
         useGetter(getter?: () => string | undefined): void;
         clear(): void;
         scoped(id: string): {
+            auth: {
+                getApiKey: () => string;
+                setApiKey(key?: string): void;
+                useApiKey(getter?: () => string | undefined): void;
+                clearApiKey(): void;
+            };
             workspace: {
                 get: () => string;
                 set(id?: string): void;
@@ -767,19 +747,19 @@ declare function createClient(initialCfg: ClientConfig & {
                     create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
                     update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
                     delete(agentId: string, instructionId: string): Promise<void>;
-                };
+                } & ((agentId: string) => ReturnType<typeof bindAgentInstructions>);
                 tags: {
                     readonly add: (agentId: string, payload: AgentTagRequest) => Promise<AgentTagsResponse>;
                     readonly remove: (agentId: string, tagId: string) => Promise<void>;
-                };
+                } & ((agentId: string) => ReturnType<typeof bindAgentTags>);
                 phones: {
                     connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
                     disconnect(agentId: string, phoneId: string): Promise<void>;
-                };
+                } & ((agentId: string) => ReturnType<typeof bindAgentPhones>);
                 schedule: {
                     get(agentId: string): Promise<AgentSchedule>;
                     update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
-                };
+                } & ((agentId: string) => ReturnType<typeof bindAgentSchedule>);
                 versions: {
                     list(agentId: string, opts?: ListAgentVersionsOptions): Promise<PaginatedResult<AgentVersionListResponse, ListAgentVersionsOptions>>;
                     get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
@@ -790,7 +770,7 @@ declare function createClient(initialCfg: ClientConfig & {
                     createInstruction(agentId: string, versionId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
                     updateInstruction(agentId: string, versionId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
                     deleteInstruction(agentId: string, versionId: string, instructionId: string): Promise<void>;
-                };
+                } & ((agentId: string) => ReturnType<typeof bindAgentVersions>);
                 delete: (agent: string | AgentEntity) => Promise<void>;
                 list(options?: ListAgentsOptions): Promise<PaginatedResult<Omit<{
                     data: components["schemas"]["AgentSummary"][];
@@ -835,19 +815,19 @@ declare function createClient(initialCfg: ClientConfig & {
             create(agentId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
             update(agentId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
             delete(agentId: string, instructionId: string): Promise<void>;
-        };
+        } & ((agentId: string) => ReturnType<typeof bindAgentInstructions>);
         tags: {
             readonly add: (agentId: string, payload: AgentTagRequest) => Promise<AgentTagsResponse>;
             readonly remove: (agentId: string, tagId: string) => Promise<void>;
-        };
+        } & ((agentId: string) => ReturnType<typeof bindAgentTags>);
         phones: {
             connect(agentId: string, payload: ConnectPhoneRequest): Promise<PhoneAssignmentResponse>;
             disconnect(agentId: string, phoneId: string): Promise<void>;
-        };
+        } & ((agentId: string) => ReturnType<typeof bindAgentPhones>);
         schedule: {
             get(agentId: string): Promise<AgentSchedule>;
             update(agentId: string, payload: UpdateAgentScheduleRequest): Promise<AgentSchedule>;
-        };
+        } & ((agentId: string) => ReturnType<typeof bindAgentSchedule>);
         versions: {
             list(agentId: string, opts?: ListAgentVersionsOptions): Promise<PaginatedResult<AgentVersionListResponse, ListAgentVersionsOptions>>;
             get(agentId: string, versionId: string): Promise<AgentVersionDetail>;
@@ -858,7 +838,7 @@ declare function createClient(initialCfg: ClientConfig & {
             createInstruction(agentId: string, versionId: string, payload: CreateInstructionRequest): Promise<InstructionCreatedResponse>;
             updateInstruction(agentId: string, versionId: string, instructionId: string, payload: UpdateInstructionRequest): Promise<Instruction>;
             deleteInstruction(agentId: string, versionId: string, instructionId: string): Promise<void>;
-        };
+        } & ((agentId: string) => ReturnType<typeof bindAgentVersions>);
         delete: (agent: string | AgentEntity) => Promise<void>;
         list(options?: ListAgentsOptions): Promise<PaginatedResult<Omit<{
             data: components["schemas"]["AgentSummary"][];
@@ -916,6 +896,7 @@ declare function createHttp(cfg: ClientConfig & {
     doFetch: (url: string, init?: FetchOptions) => Promise<Response>;
     buildHeaders: (extra?: HeadersInit) => Record<string, string>;
     resolveWorkspaceId: () => string;
+    resolveApiKey: () => string;
 };
 
 export { type AgentDetail, type AgentEntity, type AgentEntityFactoryOptions, type AgentListResponse, type AgentSchedule, type AgentSummary, type AgentTagRequest, type AgentTagsResponse, 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 InstructionListResponse, type ListAgentInstructionsOptions, type ListAgentVersionInstructionsOptions, type ListAgentVersionsOptions, type ListAgentsOptions, type ListQueryOptions, type ListToolResourcesOptions, 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 ToolConnectionRequest, type ToolConnectionResponse, type ToolListResponse, type ToolResourceListResponse, type ToolResourceReloadResponse, type ToolResourceSummary, type ToolResourceUploadRequest, type ToolResourceUploadResponse, type ToolSummary, type UpdateAgentRequest, type UpdateAgentScheduleRequest, type UpdateAgentVersionRequest, type UpdateInstructionRequest, type VoiceListResponse, type VoiceSummary, type WorkspaceEnableRequest, type WorkspaceEnableResponse, type WorkspacePhone, type WorkspacePhoneChannel, type WorkspacePhonesResponse, bindAgentInstructions, bindAgentPhones, bindAgentSchedule, bindAgentTags, bindAgentVersions, createAgentEntity, createAgentInstructionsApi, createAgentPhonesApi, createAgentScheduleApi, createAgentTagsApi, createAgentVersionsApi, createAgentsApi, createClient, createHttp, createToolsApi, createVoicesApi, createWorkspacesApi };

package/dist/index.js

@@ -192,7 +192,9 @@ function createHttp(cfg) {
   const log = cfg.logger ?? {};
   const retry = cfg.retry;
   const WORKSPACE_HEADER = "x-workspace-id";
+  const API_KEY_HEADER = "x-api-key";
   const resolveWorkspaceId = () => cfg.getWorkspaceId?.() ?? cfg.workspaceId ?? void 0;
+  const resolveApiKey = () => cfg.getApiKey?.() ?? cfg.apiKey ?? void 0;
   const normalizeHeaders = (headers) => {
     if (!headers) {
       return {};
@@ -216,9 +218,12 @@ function createHttp(cfg) {
     const workspaceId = resolveWorkspaceId();
     const normalizedExtra = normalizeHeaders(extra);
     const headersWithWorkspace = workspaceId ? { [WORKSPACE_HEADER]: workspaceId } : {};
+    const apiKey = resolveApiKey();
+    const headersWithApiKey = apiKey ? { [API_KEY_HEADER]: apiKey } : {};
     return {
       ...baseHeaders,
       ...headersWithWorkspace,
+      ...headersWithApiKey,
       ...normalizedExtra
     };
   };
@@ -259,7 +264,8 @@ function createHttp(cfg) {
     retry,
     doFetch,
     buildHeaders,
-    resolveWorkspaceId
+    resolveWorkspaceId,
+    resolveApiKey
   };
 }
 
@@ -700,7 +706,12 @@ function createAgentsApi(cfg, relatedApis) {
   const { base, doFetch } = createHttp(cfg);
   const jsonHeaders = { "content-type": "application/json" };
   const fetchAgentsPage = async (options = {}) => {
-    const query = serializeListOptions(options);
+    const sanitizedOptions = {
+      page: options.page,
+      limit: options.limit,
+      filter: options.filter
+    };
+    const query = serializeListOptions(sanitizedOptions);
     const res = await doFetch(`${base}/v1/agents`, {
       method: "GET",
       query
@@ -992,12 +1003,19 @@ function createClient(initialCfg) {
     ...initialCfg
   };
   const resolveWorkspaceId = () => runtimeCfg.workspaceId ?? runtimeCfg.getWorkspaceId?.();
+  const resolveApiKey = () => runtimeCfg.apiKey ?? runtimeCfg.getApiKey?.();
   const setWorkspaceId = (workspaceId) => {
     runtimeCfg.workspaceId = workspaceId;
   };
   const setWorkspaceGetter = (getter) => {
     runtimeCfg.getWorkspaceId = getter;
   };
+  const setApiKey = (apiKey) => {
+    runtimeCfg.apiKey = apiKey;
+  };
+  const setApiKeyGetter = (getter) => {
+    runtimeCfg.getApiKey = getter;
+  };
   const instructionsApi = createAgentInstructionsApi(runtimeCfg);
   const tagsApi = createAgentTagsApi(runtimeCfg);
   const phonesApi = createAgentPhonesApi(runtimeCfg);
@@ -1011,14 +1029,34 @@ function createClient(initialCfg) {
     scheduleApi,
     versionsApi
   });
+  const instructionsNamespace = Object.assign(
+    (agentId) => bindAgentInstructions(instructionsApi, agentId),
+    instructionsApi
+  );
+  const tagsNamespace = Object.assign(
+    (agentId) => bindAgentTags(tagsApi, agentId),
+    tagsApi
+  );
+  const phonesNamespace = Object.assign(
+    (agentId) => bindAgentPhones(phonesApi, agentId),
+    phonesApi
+  );
+  const scheduleNamespace = Object.assign(
+    (agentId) => bindAgentSchedule(scheduleApi, agentId),
+    scheduleApi
+  );
+  const versionsNamespace = Object.assign(
+    (agentId) => bindAgentVersions(versionsApi, agentId),
+    versionsApi
+  );
   const apis = {
     agents: {
       ...agentsApi,
-      instructions: instructionsApi,
-      tags: tagsApi,
-      phones: phonesApi,
-      schedule: scheduleApi,
-      versions: versionsApi
+      instructions: instructionsNamespace,
+      tags: tagsNamespace,
+      phones: phonesNamespace,
+      schedule: scheduleNamespace,
+      versions: versionsNamespace
     },
     workspaces: createWorkspacesApi(runtimeCfg),
     tools: createToolsApi(runtimeCfg),
@@ -1026,6 +1064,20 @@ function createClient(initialCfg) {
   };
   return {
     ...apis,
+    auth: {
+      getApiKey: resolveApiKey,
+      setApiKey(key) {
+        setApiKeyGetter(void 0);
+        setApiKey(key);
+      },
+      useApiKey(getter) {
+        setApiKeyGetter(getter);
+      },
+      clearApiKey() {
+        setApiKeyGetter(void 0);
+        setApiKey(void 0);
+      }
+    },
     workspace: {
       get: resolveWorkspaceId,
       set(id) {
@@ -1043,7 +1095,9 @@ function createClient(initialCfg) {
         return createClient({
           ...initialCfg,
           workspaceId: id,
-          getWorkspaceId: void 0
+          getWorkspaceId: void 0,
+          apiKey: runtimeCfg.apiKey,
+          getApiKey: runtimeCfg.getApiKey
         });
       }
     }