@cadenya/cadenya 0.40.0

package/src/resources/objectives/tasks.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Tasks extends APIResource {
+  /**
+   * Retrieves a task by ID from an objective
+   */
+  retrieve(id: string, params: TaskRetrieveParams, options?: RequestOptions): APIPromise<ObjectiveTask> {
+    const { objectiveId } = params;
+    return this._client.get(path`/v1/objectives/${objectiveId}/tasks/${id}`, options);
+  }
+
+  /**
+   * Lists all tasks for an objective
+   */
+  list(
+    objectiveID: string,
+    query: TaskListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ObjectiveTasksCursorPagination, ObjectiveTask> {
+    return this._client.getAPIList(
+      path`/v1/objectives/${objectiveID}/tasks`,
+      CursorPagination<ObjectiveTask>,
+      { query, ...options },
+    );
+  }
+}
+
+export type ObjectiveTasksCursorPagination = CursorPagination<ObjectiveTask>;
+
+/**
+ * ObjectiveTask represents a task within an objective, typically created and
+ * managed by an AI agent to track progress toward completing the objective.
+ */
+export interface ObjectiveTask {
+  data: ObjectiveTaskData;
+
+  /**
+   * BareMetadata contains the minimal metadata for a resource, including the ID.
+   * These are used sparingly in Cadenya for resources where the full metadata is not
+   * needed. You will come across them in list responses and other places where the
+   * full metadata is not required like listing the tools that were assigned to an
+   * objective. Because these types records are commonly created by other processes
+   * in Cadenya, they do not have things like external IDs, labels, or names.
+   */
+  metadata: Shared.BareMetadata;
+}
+
+export interface ObjectiveTaskData {
+  /**
+   * Whether the task has been completed
+   */
+  completed: boolean;
+
+  /**
+   * The sequential number of this task within the objective (auto-assigned, 1-based)
+   */
+  number: number;
+
+  /**
+   * Description of the task to be completed
+   */
+  task: string;
+
+  /**
+   * Timestamp when the task was marked as completed
+   */
+  completedAt?: string;
+}
+
+export interface TaskRetrieveParams {
+  /**
+   * The ID of the objective. Supports "eid:" prefix for external IDs.
+   */
+  objectiveId: string;
+}
+
+export interface TaskListParams extends CursorPaginationParams {
+  /**
+   * Sort order for results
+   */
+  sortOrder?: string;
+}
+
+export declare namespace Tasks {
+  export {
+    type ObjectiveTask as ObjectiveTask,
+    type ObjectiveTaskData as ObjectiveTaskData,
+    type ObjectiveTasksCursorPagination as ObjectiveTasksCursorPagination,
+    type TaskRetrieveParams as TaskRetrieveParams,
+    type TaskListParams as TaskListParams,
+  };
+}

package/src/resources/objectives/tool-calls.ts

@@ -0,0 +1,185 @@
+// 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 * as ObjectivesAPI from './objectives';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class ToolCalls extends APIResource {
+  /**
+   * Lists all tool calls for an objective
+   */
+  list(
+    objectiveID: string,
+    query: ToolCallListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ObjectiveToolCallsCursorPagination, ObjectiveToolCall> {
+    return this._client.getAPIList(
+      path`/v1/objectives/${objectiveID}/tool_calls`,
+      CursorPagination<ObjectiveToolCall>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * When an agent attempts to use a tool that requires approval, use this endpoint
+   * to mark it as approved.
+   */
+  approve(
+    toolCallID: string,
+    params: ToolCallApproveParams,
+    options?: RequestOptions,
+  ): APIPromise<ObjectiveToolCall> {
+    const { objectiveId, ...body } = params;
+    return this._client.put(path`/v1/objectives/${objectiveId}/tool_calls/${toolCallID}/approve`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * When an agent attempts to use a tool that requires approval, use this endpoint
+   * to mark it as denied. Use a memo to steer the LLM to a different decision or
+   * usage of the tool.
+   */
+  deny(
+    toolCallID: string,
+    params: ToolCallDenyParams,
+    options?: RequestOptions,
+  ): APIPromise<ObjectiveToolCall> {
+    const { objectiveId, ...body } = params;
+    return this._client.put(path`/v1/objectives/${objectiveId}/tool_calls/${toolCallID}/deny`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export type ObjectiveToolCallsCursorPagination = CursorPagination<ObjectiveToolCall>;
+
+/**
+ * ObjectiveToolCall is a record of a tool call made during an objective's
+ * execution. Tool calls are mutable — their status changes as they are approved,
+ * denied, or executed.
+ */
+export interface ObjectiveToolCall {
+  data: ObjectiveToolCallData;
+
+  /**
+   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
+   * runs)
+   */
+  metadata: Shared.OperationMetadata;
+
+  /**
+   * Current status of the tool call
+   */
+  status:
+    | 'TOOL_CALL_STATUS_UNSPECIFIED'
+    | 'TOOL_CALL_STATUS_AUTO_APPROVED'
+    | 'TOOL_CALL_STATUS_WAITING_FOR_APPROVAL'
+    | 'TOOL_CALL_STATUS_APPROVED'
+    | 'TOOL_CALL_STATUS_DENIED';
+
+  info?: ObjectiveToolCallInfo;
+}
+
+export interface ObjectiveToolCallData {
+  /**
+   * CallableTool is a union that represents a tool that can be called by an agent.
+   * In Cadenya, a tool that is used within an agent objective might be a
+   * user-defined tool (IE: MCP, HTTP), another Agent (useful to separate context),
+   * or a Cadenya Tool (one Cadenya provides).
+   */
+  callable: ObjectivesAPI.CallableTool;
+
+  /**
+   * The arguments passed to the tool
+   */
+  arguments?: { [key: string]: unknown };
+
+  /**
+   * A memo supplied by the reviewer when denying the tool call
+   */
+  memo?: string;
+
+  /**
+   * The result content returned by the tool after execution
+   */
+  result?: string;
+
+  /**
+   * 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).
+   */
+  statusChangedBy?: AccountAPI.Profile;
+}
+
+export interface ObjectiveToolCallInfo {
+  /**
+   * 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;
+
+  /**
+   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
+   * runs)
+   */
+  objective?: Shared.OperationMetadata;
+}
+
+export interface ToolCallListParams extends CursorPaginationParams {
+  /**
+   * When set to true you may use more of your alloted API rate-limit
+   */
+  includeInfo?: boolean;
+
+  /**
+   * Filter by tool call status
+   */
+  status?:
+    | 'TOOL_CALL_STATUS_UNSPECIFIED'
+    | 'TOOL_CALL_STATUS_AUTO_APPROVED'
+    | 'TOOL_CALL_STATUS_WAITING_FOR_APPROVAL'
+    | 'TOOL_CALL_STATUS_APPROVED'
+    | 'TOOL_CALL_STATUS_DENIED';
+}
+
+export interface ToolCallApproveParams {
+  /**
+   * The ID of the objective. Supports "eid:" prefix for external IDs.
+   */
+  objectiveId: string;
+}
+
+export interface ToolCallDenyParams {
+  /**
+   * Path param: The ID of the objective. Supports "eid:" prefix for external IDs.
+   */
+  objectiveId: string;
+
+  /**
+   * Body param: A memo to associate to the tool call denial. Use a memo to steer the
+   * LLM to a different decision or usage of the tool.
+   */
+  memo?: string;
+}
+
+export declare namespace ToolCalls {
+  export {
+    type ObjectiveToolCall as ObjectiveToolCall,
+    type ObjectiveToolCallData as ObjectiveToolCallData,
+    type ObjectiveToolCallInfo as ObjectiveToolCallInfo,
+    type ObjectiveToolCallsCursorPagination as ObjectiveToolCallsCursorPagination,
+    type ToolCallListParams as ToolCallListParams,
+    type ToolCallApproveParams as ToolCallApproveParams,
+    type ToolCallDenyParams as ToolCallDenyParams,
+  };
+}

package/src/resources/objectives/tools.ts

@@ -0,0 +1,59 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as ToolSetsToolsAPI from '../tool-sets/tools';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Tools extends APIResource {
+  /**
+   * Lists all tools that were assigned to an objective
+   */
+  list(
+    objectiveID: string,
+    query: ToolListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ObjectiveToolsCursorPagination, ObjectiveTool> {
+    return this._client.getAPIList(
+      path`/v1/objectives/${objectiveID}/tools`,
+      CursorPagination<ObjectiveTool>,
+      { query, ...options },
+    );
+  }
+}
+
+export type ObjectiveToolsCursorPagination = CursorPagination<ObjectiveTool>;
+
+/**
+ * ObjectiveTool represents a tool that was assigned to an objective.
+ */
+export interface ObjectiveTool {
+  /**
+   * BareMetadata contains the minimal metadata for a resource, including the ID.
+   * These are used sparingly in Cadenya for resources where the full metadata is not
+   * needed. You will come across them in list responses and other places where the
+   * full metadata is not required like listing the tools that were assigned to an
+   * objective. Because these types records are commonly created by other processes
+   * in Cadenya, they do not have things like external IDs, labels, or names.
+   */
+  metadata: Shared.BareMetadata;
+
+  /**
+   * Snapshot of the tool at the time it was assigned to the objective. Because tools
+   * can change over time, snapshots are used to ensure tools don't change
+   * unexpectedly during an objective's lifecycle.
+   */
+  snapshot?: ToolSetsToolsAPI.Tool;
+}
+
+export interface ToolListParams extends CursorPaginationParams {}
+
+export declare namespace Tools {
+  export {
+    type ObjectiveTool as ObjectiveTool,
+    type ObjectiveToolsCursorPagination as ObjectiveToolsCursorPagination,
+    type ToolListParams as ToolListParams,
+  };
+}

package/src/resources/objectives.ts

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

package/src/resources/search.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AgentsAPI from './agents/agents';
+import * as ToolSetsAPI from './tool-sets/tool-sets';
+import * as ToolsAPI from './tool-sets/tools';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Search extends APIResource {
+  /**
+   * Searches for tools or tool sets in the workspace
+   */
+  searchToolsOrToolSets(
+    query: SearchSearchToolsOrToolSetsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SearchSearchToolsOrToolSetsResponse> {
+    return this._client.get('/v1/search/tools_or_tool_sets', { query, ...options });
+  }
+}
+
+export interface SearchSearchToolsOrToolSetsResponse {
+  agents?: Array<AgentsAPI.Agent>;
+
+  tools?: Array<ToolsAPI.Tool>;
+
+  toolSets?: Array<ToolSetsAPI.ToolSet>;
+}
+
+export interface SearchSearchToolsOrToolSetsParams {
+  query?: string;
+}
+
+export declare namespace Search {
+  export {
+    type SearchSearchToolsOrToolSetsResponse as SearchSearchToolsOrToolSetsResponse,
+    type SearchSearchToolsOrToolSetsParams as SearchSearchToolsOrToolSetsParams,
+  };
+}

package/src/resources/shared.ts

@@ -0,0 +1,204 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * AccountResourceMetadata is used to represent a resource that is associated to an
+ * account but not to a workspace.
+ */
+export interface AccountResourceMetadata {
+  /**
+   * Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")
+   */
+  id: string;
+
+  /**
+   * Account this resource belongs to for multi-tenant isolation (prefixed ULID)
+   */
+  accountId: string;
+
+  /**
+   * Human-readable name for the resource (e.g., "Customer Support Agent", "Email
+   * Tool") Required for resources that users interact with directly
+   */
+  name: string;
+
+  profileId: string;
+
+  /**
+   * External ID for the resource (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"environment": "production", "team": "platform", "version": "v2"}
+   */
+  labels?: { [key: string]: string };
+}
+
+/**
+ * BareMetadata contains the minimal metadata for a resource, including the ID.
+ * These are used sparingly in Cadenya for resources where the full metadata is not
+ * needed. You will come across them in list responses and other places where the
+ * full metadata is not required like listing the tools that were assigned to an
+ * objective. Because these types records are commonly created by other processes
+ * in Cadenya, they do not have things like external IDs, labels, or names.
+ */
+export interface BareMetadata {
+  id: string;
+}
+
+/**
+ * CreateOperationMetadata contains the user-provided fields for creating an
+ * operation. Read-only fields (id, account_id, workspace_id, created_at,
+ * profile_id) are excluded since they are set by the server.
+ */
+export interface CreateOperationMetadata {
+  /**
+   * External ID for the operation (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"priority": "high", "source": "api", "workflow": "onboarding"}
+   */
+  labels?: { [key: string]: string };
+}
+
+/**
+ * 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.
+ */
+export interface CreateResourceMetadata {
+  /**
+   * Human-readable name for the resource (e.g., "Customer Support Agent", "Email
+   * Tool")
+   */
+  name: string;
+
+  /**
+   * External ID for the resource (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"environment": "production", "team": "platform", "version": "v2"}
+   */
+  labels?: { [key: string]: string };
+}
+
+/**
+ * Metadata for ephemeral operations and activities (e.g., objectives, executions,
+ * runs)
+ */
+export interface OperationMetadata {
+  /**
+   * Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...")
+   */
+  id: string;
+
+  /**
+   * Account this operation belongs to for multi-tenant isolation (prefixed ULID)
+   */
+  accountId: string;
+
+  /**
+   * Timestamp when this operation was created ULID includes timestamp information,
+   * but this explicit field enables easier querying
+   */
+  createdAt: string;
+
+  /**
+   * ID of the actor (user or service account) that created this operation
+   */
+  profileId: string;
+
+  /**
+   * Workspace this operation belongs to for organizational grouping (prefixed ULID)
+   */
+  workspaceId: string;
+
+  /**
+   * External ID for the operation (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"priority": "high", "source": "api", "workflow": "onboarding"}
+   */
+  labels?: { [key: string]: string };
+}
+
+/**
+ * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+ */
+export interface ResourceMetadata {
+  /**
+   * Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")
+   */
+  id: string;
+
+  /**
+   * Account this resource belongs to for multi-tenant isolation (prefixed ULID)
+   */
+  accountId: string;
+
+  /**
+   * Timestamp when this resource was created
+   */
+  createdAt: string;
+
+  /**
+   * Human-readable name for the resource (e.g., "Customer Support Agent", "Email
+   * Tool") Required for resources that users interact with directly
+   */
+  name: string;
+
+  /**
+   * ID of the actor (user or service account) that created this resource
+   */
+  profileId: string;
+
+  /**
+   * Workspace this resource belongs to for organizational grouping (prefixed ULID)
+   */
+  workspaceId: string;
+
+  /**
+   * External ID for the resource (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"environment": "production", "team": "platform", "version": "v2"}
+   */
+  labels?: { [key: string]: string };
+}
+
+/**
+ * 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.
+ */
+export interface UpdateResourceMetadata {
+  /**
+   * Human-readable name for the resource (e.g., "Customer Support Agent", "Email
+   * Tool")
+   */
+  name: string;
+
+  /**
+   * External ID for the resource (e.g., a workflow ID from an external system)
+   */
+  externalId?: string;
+
+  /**
+   * Arbitrary key-value pairs for categorization and filtering Examples:
+   * {"environment": "production", "team": "platform", "version": "v2"}
+   */
+  labels?: { [key: string]: string };
+}

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

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ToolSets,
+  type McpToolFilter,
+  type SyncCompleted,
+  type SyncFailed,
+  type SyncStarted,
+  type ToolSet,
+  type ToolSetAdapter,
+  type ToolSetAdapterHTTP,
+  type ToolSetAdapterMcp,
+  type ToolSetEvent,
+  type ToolSetEventData,
+  type ToolSetInfo,
+  type ToolSetSpec,
+  type ToolSetCreateParams,
+  type ToolSetUpdateParams,
+  type ToolSetListParams,
+  type ToolSetListEventsParams,
+  type ToolSetsCursorPagination,
+  type ToolSetEventsCursorPagination,
+} from './tool-sets';
+export {
+  Tools,
+  type ConfigHTTP,
+  type ConfigMcp,
+  type Tool,
+  type ToolInfo,
+  type ToolSpec,
+  type ToolSpecConfig,
+  type ToolCreateParams,
+  type ToolRetrieveParams,
+  type ToolUpdateParams,
+  type ToolListParams,
+  type ToolDeleteParams,
+  type ToolsCursorPagination,
+} from './tools';