@cadenya/cadenya 0.40.0

package/src/resources/tool-sets/tool-sets.ts

@@ -0,0 +1,430 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ToolSetsAPI from './tool-sets';
+import * as AccountAPI from '../account';
+import * as Shared from '../shared';
+import * as ToolsAPI from './tools';
+import {
+  ConfigHTTP,
+  ConfigMcp,
+  Tool,
+  ToolCreateParams,
+  ToolDeleteParams,
+  ToolInfo,
+  ToolListParams,
+  ToolRetrieveParams,
+  ToolSpec,
+  ToolSpecConfig,
+  ToolUpdateParams,
+  Tools,
+  ToolsCursorPagination,
+} from './tools';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * ToolService manages tool sets and tools at the WORKSPACE level.
+ *  Tool sets group related tools, and tools define specific capabilities for agents.
+ *  All operations are implicitly scoped to the workspace determined by the JWT token.
+ *
+ *  Note: When a ToolSet has managed=true, only API Key actors can modify its tools.
+ *  Profile actors (humans) are restricted from modifying managed tool sets.
+ *
+ *  Authentication: Bearer token (JWT)
+ *  Scope: Workspace-level operations
+ */
+export class ToolSets extends APIResource {
+  tools: ToolsAPI.Tools = new ToolsAPI.Tools(this._client);
+
+  /**
+   * Creates a new tool set in the workspace
+   */
+  create(body: ToolSetCreateParams, options?: RequestOptions): APIPromise<ToolSet> {
+    return this._client.post('/v1/tool_sets', { body, ...options });
+  }
+
+  /**
+   * Retrieves a tool set by ID from the workspace
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ToolSet> {
+    return this._client.get(path`/v1/tool_sets/${id}`, options);
+  }
+
+  /**
+   * Updates a tool set in the workspace
+   */
+  update(id: string, body: ToolSetUpdateParams, options?: RequestOptions): APIPromise<ToolSet> {
+    return this._client.put(path`/v1/tool_sets/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists all tool sets in the workspace
+   */
+  list(
+    query: ToolSetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ToolSetsCursorPagination, ToolSet> {
+    return this._client.getAPIList('/v1/tool_sets', CursorPagination<ToolSet>, { query, ...options });
+  }
+
+  /**
+   * Deletes a tool set in the workspace
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/tool_sets/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Lists all events (including sync status) for a tool set
+   */
+  listEvents(
+    toolSetID: string,
+    query: ToolSetListEventsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ToolSetEventsCursorPagination, ToolSetEvent> {
+    return this._client.getAPIList(path`/v1/tool_sets/${toolSetID}/events`, CursorPagination<ToolSetEvent>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ToolSetsCursorPagination = CursorPagination<ToolSet>;
+
+export type ToolSetEventsCursorPagination = CursorPagination<ToolSetEvent>;
+
+/**
+ * Top-level filter with simple boolean logic (no nesting)
+ */
+export interface McpToolFilter {
+  operator: 'OPERATOR_UNSPECIFIED' | 'OPERATOR_AND' | 'OPERATOR_OR';
+
+  filters?: Array<McpToolFilter.Filter>;
+}
+
+export namespace McpToolFilter {
+  /**
+   * Single attribute filter
+   */
+  export interface Filter {
+    attribute: 'ATTRIBUTE_UNSPECIFIED' | 'ATTRIBUTE_NAME' | 'ATTRIBUTE_TITLE' | 'ATTRIBUTE_DESCRIPTION';
+
+    /**
+     * String matching operations
+     */
+    matcher?: Filter.Matcher;
+  }
+
+  export namespace Filter {
+    /**
+     * String matching operations
+     */
+    export interface Matcher {
+      caseSensitive?: boolean;
+
+      contains?: string;
+
+      endsWith?: string;
+
+      exact?: string;
+
+      regex?: string;
+
+      startsWith?: string;
+    }
+  }
+}
+
+/**
+ * SyncCompleted is emitted when a tool set sync operation completes successfully
+ */
+export interface SyncCompleted {
+  /**
+   * Optional message with additional details
+   */
+  message?: string;
+
+  /**
+   * Number of tools synced
+   */
+  toolsSynced?: number;
+}
+
+/**
+ * SyncFailed is emitted when a tool set sync operation fails
+ */
+export interface SyncFailed {
+  /**
+   * Indicates this is an error event
+   */
+  error?: boolean;
+
+  /**
+   * Optional error type/code for programmatic handling
+   */
+  errorType?: string;
+
+  /**
+   * Error message describing what went wrong
+   */
+  message?: string;
+}
+
+/**
+ * SyncStarted is emitted when a tool set sync operation begins
+ */
+export interface SyncStarted {
+  /**
+   * Timestamp when the sync was initiated
+   */
+  message?: string;
+}
+
+export interface ToolSet {
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  metadata: Shared.ResourceMetadata;
+
+  spec: ToolSetSpec;
+
+  /**
+   * Tool set information
+   */
+  info?: ToolSetInfo;
+}
+
+export interface ToolSetAdapter {
+  http?: ToolSetAdapterHTTP;
+
+  mcp?: ToolSetAdapterMcp;
+}
+
+export interface ToolSetAdapterHTTP {
+  baseUrl?: string;
+
+  headers?: { [key: string]: string };
+}
+
+export interface ToolSetAdapterMcp {
+  /**
+   * Top-level filter with simple boolean logic (no nesting)
+   */
+  excludeTools?: McpToolFilter;
+
+  headers?: { [key: string]: string };
+
+  /**
+   * Top-level filter with simple boolean logic (no nesting)
+   */
+  includeTools?: McpToolFilter;
+
+  /**
+   * Approval filters that will automatically set the approval requirement on the
+   * tools synced from the MCP server
+   */
+  toolApprovals?: ToolSetAdapterMcp.ToolApprovals;
+
+  url?: string;
+}
+
+export namespace ToolSetAdapterMcp {
+  /**
+   * Approval filters that will automatically set the approval requirement on the
+   * tools synced from the MCP server
+   */
+  export interface ToolApprovals {
+    always?: boolean;
+
+    /**
+     * Top-level filter with simple boolean logic (no nesting)
+     */
+    only?: ToolSetsAPI.McpToolFilter;
+  }
+}
+
+/**
+ * ToolSetEvent represents a single event in the tool set's operation timeline
+ */
+export interface ToolSetEvent {
+  /**
+   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
+   * runs)
+   */
+  metadata: Shared.OperationMetadata;
+
+  /**
+   * ToolSetEventData represents the actual event payload for tool set operations
+   */
+  event?: ToolSetEventData;
+
+  info?: ToolSetEvent.Info;
+
+  /**
+   * The tool set this event is associated with
+   */
+  toolSetId?: string;
+}
+
+export namespace ToolSetEvent {
+  export interface Info {
+    /**
+     * Profile represents a human user at the account level. Profiles are
+     * account-scoped resources that can be associated with multiple workspaces through
+     * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
+     */
+    createdBy?: AccountAPI.Profile;
+
+    /**
+     * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+     */
+    toolSet?: Shared.ResourceMetadata;
+  }
+}
+
+/**
+ * ToolSetEventData represents the actual event payload for tool set operations
+ */
+export interface ToolSetEventData {
+  /**
+   * SyncCompleted is emitted when a tool set sync operation completes successfully
+   */
+  syncCompleted?: SyncCompleted;
+
+  /**
+   * SyncFailed is emitted when a tool set sync operation fails
+   */
+  syncFailed?: SyncFailed;
+
+  /**
+   * SyncStarted is emitted when a tool set sync operation begins
+   */
+  syncStarted?: SyncStarted;
+
+  /**
+   * Type of the event (e.g., "sync_started", "sync_completed", "sync_failed")
+   */
+  type?: string;
+}
+
+export interface ToolSetInfo {
+  agentCount?: number;
+
+  /**
+   * Profile represents a human user at the account level. Profiles are
+   * account-scoped resources that can be associated with multiple workspaces through
+   * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
+   */
+  createdBy?: AccountAPI.Profile;
+
+  lastSync?: string;
+
+  toolCount?: number;
+}
+
+export interface ToolSetSpec {
+  adapter?: ToolSetAdapter;
+
+  description?: string;
+}
+
+export interface ToolSetCreateParams {
+  /**
+   * CreateResourceMetadata contains the user-provided fields for creating a
+   * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
+   * profile_id, created_at) are excluded since they are set by the server.
+   */
+  metadata: Shared.CreateResourceMetadata;
+
+  spec: ToolSetSpec;
+}
+
+export interface ToolSetUpdateParams {
+  /**
+   * UpdateResourceMetadata contains the user-provided fields for updating a
+   * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
+   * profile_id, created_at) are excluded since they are set by the server.
+   */
+  metadata?: Shared.UpdateResourceMetadata;
+
+  spec?: ToolSetSpec;
+
+  updateMask?: string;
+}
+
+export interface ToolSetListParams extends CursorPaginationParams {
+  /**
+   * When set to true you may use more of your alloted API rate-limit
+   */
+  includeInfo?: boolean;
+
+  /**
+   * Filter expression (query param: prefix)
+   */
+  prefix?: string;
+
+  /**
+   * Sort order for results (asc or desc by creation time)
+   */
+  sortOrder?: string;
+}
+
+export interface ToolSetListEventsParams extends CursorPaginationParams {
+  /**
+   * When set to true you may use more of your alloted API rate-limit
+   */
+  includeInfo?: boolean;
+
+  /**
+   * Sort order for results (asc or desc by creation time)
+   */
+  sortOrder?: string;
+}
+
+ToolSets.Tools = Tools;
+
+export declare namespace ToolSets {
+  export {
+    type McpToolFilter as McpToolFilter,
+    type SyncCompleted as SyncCompleted,
+    type SyncFailed as SyncFailed,
+    type SyncStarted as SyncStarted,
+    type ToolSet as ToolSet,
+    type ToolSetAdapter as ToolSetAdapter,
+    type ToolSetAdapterHTTP as ToolSetAdapterHTTP,
+    type ToolSetAdapterMcp as ToolSetAdapterMcp,
+    type ToolSetEvent as ToolSetEvent,
+    type ToolSetEventData as ToolSetEventData,
+    type ToolSetInfo as ToolSetInfo,
+    type ToolSetSpec as ToolSetSpec,
+    type ToolSetsCursorPagination as ToolSetsCursorPagination,
+    type ToolSetEventsCursorPagination as ToolSetEventsCursorPagination,
+    type ToolSetCreateParams as ToolSetCreateParams,
+    type ToolSetUpdateParams as ToolSetUpdateParams,
+    type ToolSetListParams as ToolSetListParams,
+    type ToolSetListEventsParams as ToolSetListEventsParams,
+  };
+
+  export {
+    Tools as Tools,
+    type ConfigHTTP as ConfigHTTP,
+    type ConfigMcp as ConfigMcp,
+    type Tool as Tool,
+    type ToolInfo as ToolInfo,
+    type ToolSpec as ToolSpec,
+    type ToolSpecConfig as ToolSpecConfig,
+    type ToolsCursorPagination as ToolsCursorPagination,
+    type ToolCreateParams as ToolCreateParams,
+    type ToolRetrieveParams as ToolRetrieveParams,
+    type ToolUpdateParams as ToolUpdateParams,
+    type ToolListParams as ToolListParams,
+    type ToolDeleteParams as ToolDeleteParams,
+  };
+}

package/src/resources/tool-sets/tools.ts

@@ -0,0 +1,240 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AccountAPI from '../account';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * ToolService manages tool sets and tools at the WORKSPACE level.
+ *  Tool sets group related tools, and tools define specific capabilities for agents.
+ *  All operations are implicitly scoped to the workspace determined by the JWT token.
+ *
+ *  Note: When a ToolSet has managed=true, only API Key actors can modify its tools.
+ *  Profile actors (humans) are restricted from modifying managed tool sets.
+ *
+ *  Authentication: Bearer token (JWT)
+ *  Scope: Workspace-level operations
+ */
+export class Tools extends APIResource {
+  /**
+   * Creates a new tool in the tool set
+   */
+  create(toolSetID: string, body: ToolCreateParams, options?: RequestOptions): APIPromise<Tool> {
+    return this._client.post(path`/v1/tool_sets/${toolSetID}/tools`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a tool by ID from the workspace
+   */
+  retrieve(id: string, params: ToolRetrieveParams, options?: RequestOptions): APIPromise<Tool> {
+    const { toolSetId } = params;
+    return this._client.get(path`/v1/tool_sets/${toolSetId}/tools/${id}`, options);
+  }
+
+  /**
+   * Updates a tool in the tool set
+   */
+  update(id: string, params: ToolUpdateParams, options?: RequestOptions): APIPromise<Tool> {
+    const { toolSetId, ...body } = params;
+    return this._client.put(path`/v1/tool_sets/${toolSetId}/tools/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists all tools in the tool set
+   */
+  list(
+    toolSetID: string,
+    query: ToolListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ToolsCursorPagination, Tool> {
+    return this._client.getAPIList(path`/v1/tool_sets/${toolSetID}/tools`, CursorPagination<Tool>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Deletes a tool in the tool set
+   */
+  delete(id: string, params: ToolDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { toolSetId } = params;
+    return this._client.delete(path`/v1/tool_sets/${toolSetId}/tools/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type ToolsCursorPagination = CursorPagination<Tool>;
+
+export interface ConfigHTTP {
+  requestMethod: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+
+  headers?: { [key: string]: string };
+
+  path?: string;
+
+  query?: string;
+
+  requestBodyContentType?: string;
+
+  /**
+   * These are only used when the request method is a POST, PUT, or PATCH
+   */
+  requestBodyTemplate?: string;
+
+  /**
+   * The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP
+   * adapter. This is used to match the tool spec to the correct endpoint on the HTTP
+   * adapter. it will be derived from the name of the tool if not provided.
+   */
+  toolName?: string;
+}
+
+export interface ConfigMcp {
+  toolDescription?: string;
+
+  toolName?: string;
+
+  toolTitle?: string;
+}
+
+export interface Tool {
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  metadata: Shared.ResourceMetadata;
+
+  spec: ToolSpec;
+
+  info?: ToolInfo;
+}
+
+export interface ToolInfo {
+  /**
+   * Profile represents a human user at the account level. Profiles are
+   * account-scoped resources that can be associated with multiple workspaces through
+   * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
+   */
+  createdBy?: AccountAPI.Profile;
+
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  toolSet?: Shared.ResourceMetadata;
+}
+
+export interface ToolSpec {
+  /**
+   * Config defines the adapter to use for the tool. This is used to determine how
+   * the tool is called. For example, if the tool is an HTTP tool, the adapter will
+   * be Http. If the tool is an inline tool, the adapter will be Inline.
+   */
+  config: ToolSpecConfig;
+
+  description: string;
+
+  parameters: { [key: string]: unknown };
+
+  status:
+    | 'TOOL_STATUS_UNSPECIFIED'
+    | 'TOOL_STATUS_AVAILABLE'
+    | 'TOOL_STATUS_FILTERED'
+    | 'TOOL_STATUS_ARCHIVED';
+
+  requiresApproval?: boolean;
+}
+
+/**
+ * Config defines the adapter to use for the tool. This is used to determine how
+ * the tool is called. For example, if the tool is an HTTP tool, the adapter will
+ * be Http. If the tool is an inline tool, the adapter will be Inline.
+ */
+export interface ToolSpecConfig {
+  http?: ConfigHTTP;
+
+  mcp?: ConfigMcp;
+}
+
+export interface ToolCreateParams {
+  /**
+   * CreateResourceMetadata contains the user-provided fields for creating a
+   * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
+   * profile_id, created_at) are excluded since they are set by the server.
+   */
+  metadata: Shared.CreateResourceMetadata;
+
+  spec: ToolSpec;
+}
+
+export interface ToolRetrieveParams {
+  toolSetId: string;
+}
+
+export interface ToolUpdateParams {
+  /**
+   * Path param
+   */
+  toolSetId: string;
+
+  /**
+   * Body param: UpdateResourceMetadata contains the user-provided fields for
+   * updating a workspace-scoped resource. Read-only fields (id, account_id,
+   * workspace_id, profile_id, created_at) are excluded since they are set by the
+   * server.
+   */
+  metadata?: Shared.UpdateResourceMetadata;
+
+  /**
+   * Body param
+   */
+  spec?: ToolSpec;
+
+  /**
+   * Body param
+   */
+  updateMask?: string;
+}
+
+export interface ToolListParams extends CursorPaginationParams {
+  /**
+   * When set to true you may use more of your alloted API rate-limit
+   */
+  includeInfo?: boolean;
+
+  /**
+   * Filter expression (query param: prefix)
+   */
+  prefix?: string;
+
+  /**
+   * Sort order for results (asc or desc by creation time)
+   */
+  sortOrder?: string;
+}
+
+export interface ToolDeleteParams {
+  toolSetId: string;
+}
+
+export declare namespace Tools {
+  export {
+    type ConfigHTTP as ConfigHTTP,
+    type ConfigMcp as ConfigMcp,
+    type Tool as Tool,
+    type ToolInfo as ToolInfo,
+    type ToolSpec as ToolSpec,
+    type ToolSpecConfig as ToolSpecConfig,
+    type ToolsCursorPagination as ToolsCursorPagination,
+    type ToolCreateParams as ToolCreateParams,
+    type ToolRetrieveParams as ToolRetrieveParams,
+    type ToolUpdateParams as ToolUpdateParams,
+    type ToolListParams as ToolListParams,
+    type ToolDeleteParams as ToolDeleteParams,
+  };
+}

package/src/resources/tool-sets.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './tool-sets/index';