@cadenya/cadenya 0.135.0 → 1.0.1

package/src/resources/objectives/tools.ts

@@ -1,74 +0,0 @@
-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
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const objectiveTool of client.objectives.tools.list(
-   *   'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
-   *   { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    objectiveID: string,
-    params: ToolListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ObjectiveToolsCursorPagination, ObjectiveTool> {
-    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
-    return this._client.getAPIList(
-      path`/v1/workspaces/${workspaceId}/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: the ID and an
-   * optional human-readable name. These are used for reference fields where the full
-   * metadata (account scoping, timestamps, labels, external IDs) is not needed —
-   * e.g., the tool references inside an agent variation spec or the tools assigned
-   * to an objective. Both fields are server-populated; clients provide IDs through
-   * sibling fields rather than by constructing a BareMetadata themselves.
-   */
-  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 {
-  /**
-   * Path param
-   */
-  workspaceId?: string;
-}
-
-export declare namespace Tools {
-  export {
-    type ObjectiveTool as ObjectiveTool,
-    type ObjectiveToolsCursorPagination as ObjectiveToolsCursorPagination,
-    type ToolListParams as ToolListParams,
-  };
-}

package/src/resources/search.ts

@@ -1,52 +0,0 @@
-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';
-import { path } from '../internal/utils/path';
-
-export class Search extends APIResource {
-  /**
-   * Searches for tools or tool sets in the workspace
-   */
-  searchToolsOrToolSets(
-    params: SearchSearchToolsOrToolSetsParams,
-    options?: RequestOptions,
-  ): APIPromise<SearchSearchToolsOrToolSetsResponse> {
-    const { workspaceId = this._client.workspaceID, ...query } = params;
-    return this._client.get(path`/v1/workspaces/${workspaceId}/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 {
-  /**
-   * Path param: NOTE: `query` is runtime-required (buf.validate min_len), but
-   * gnostic does not propagate message-level schema `required` to GET query
-   * parameters — overlay.yaml marks the parameter required instead.
-   */
-  workspaceId?: string;
-
-  /**
-   * Query param
-   */
-  query: string;
-}
-
-export declare namespace Search {
-  export {
-    type SearchSearchToolsOrToolSetsResponse as SearchSearchToolsOrToolSetsResponse,
-    type SearchSearchToolsOrToolSetsParams as SearchSearchToolsOrToolSetsParams,
-  };
-}

package/src/resources/shared.ts

@@ -1,234 +0,0 @@
-/**
- * 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;
-
-  createdAt?: string;
-
-  /**
-   * External ID for the resource (e.g., a workflow ID from an external system)
-   */
-  externalId?: string;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. Examples: {"environment": "production", "team":
-   * "platform", "version": "v2"}
-   */
-  labels?: { [key: string]: string };
-}
-
-/**
- * BareMetadata contains the minimal metadata for a resource: the ID and an
- * optional human-readable name. These are used for reference fields where the full
- * metadata (account scoping, timestamps, labels, external IDs) is not needed —
- * e.g., the tool references inside an agent variation spec or the tools assigned
- * to an objective. Both fields are server-populated; clients provide IDs through
- * sibling fields rather than by constructing a BareMetadata themselves.
- */
-export interface BareMetadata {
-  id?: string;
-
-  /**
-   * Human-readable name of the referenced resource, populated by the server on reads
-   * for convenience. Absent on references to resources that do not have a name
-   * (e.g., objective tasks).
-   */
-  name?: 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;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. 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;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. 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;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. 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;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. Examples: {"environment": "production", "team":
-   * "platform", "version": "v2"}
-   */
-  labels?: { [key: string]: string };
-
-  /**
-   * Timestamp when this resource was last updated
-   */
-  updatedAt?: 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;
-
-  /**
-   * Key-value pairs for categorization and filtering. Values are 0-63 alphanumeric
-   * characters with "-", "\_", or "." allowed between; keys follow the same shape
-   * and additionally accept an optional DNS-subdomain prefix (e.g. "cadenya.com/")
-   * of at most 253 characters. Examples: {"environment": "production", "team":
-   * "platform", "version": "v2"}
-   */
-  labels?: { [key: string]: string };
-}

package/src/resources/tenants/index.ts

@@ -1,13 +0,0 @@
-export { Subjects, type SubjectListParams } from './subjects';
-export {
-  Tenants,
-  type Subject,
-  type SubjectInfo,
-  type Tenant,
-  type TenantInfo,
-  type TenantRetrieveParams,
-  type TenantListParams,
-  type TenantDeleteParams,
-  type SubjectsCursorPagination,
-  type TenantsCursorPagination,
-} from './tenants';

package/src/resources/tenants/subjects.ts

@@ -1,61 +0,0 @@
-import { APIResource } from '../../core/resource';
-import * as TenantsAPI from './tenants';
-import { SubjectsCursorPagination } from './tenants';
-import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-/**
- * Read and erase tenants and the subjects under them. Tenants and subjects are
- *  created by assertion — on objective creation or widget session mint — never
- *  directly, so this service has no create or update: it exists to enumerate what
- *  assertions have produced, and to destroy it on request.
- */
-export class Subjects extends APIResource {
-  /**
-   * Lists the subjects asserted under a tenant. Subjects are only listable through
-   * their tenant: a subject's external_id is unique within its tenant, not across
-   * the workspace, so the same key can name different people under different
-   * tenants.
-   */
-  list(
-    tenantID: string,
-    params: SubjectListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SubjectsCursorPagination, TenantsAPI.Subject> {
-    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
-    return this._client.getAPIList(
-      path`/v1/workspaces/${workspaceId}/tenants/${tenantID}/subjects`,
-      CursorPagination<TenantsAPI.Subject>,
-      { query, ...options },
-    );
-  }
-}
-
-export interface SubjectListParams extends CursorPaginationParams {
-  /**
-   * Path param: Workspace ID.
-   */
-  workspaceId?: string;
-
-  /**
-   * Query param: When true, the `info` field on each returned subject is populated.
-   */
-  includeInfo?: boolean;
-
-  /**
-   * Query param: Substring match against the subject's name and external_id.
-   */
-  query?: string;
-
-  /**
-   * Query param: Sort order for results (asc or desc by creation time).
-   */
-  sortOrder?: string;
-}
-
-export declare namespace Subjects {
-  export { type SubjectListParams as SubjectListParams };
-}
-
-export { type SubjectsCursorPagination };

package/src/resources/tenants/tenants.ts

@@ -1,218 +0,0 @@
-import { APIResource } from '../../core/resource';
-import * as Shared from '../shared';
-import * as WidgetSessionsAPI from '../widget-sessions';
-import * as SubjectsAPI from './subjects';
-import { SubjectListParams, Subjects } from './subjects';
-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';
-
-/**
- * Read and erase tenants and the subjects under them. Tenants and subjects are
- *  created by assertion — on objective creation or widget session mint — never
- *  directly, so this service has no create or update: it exists to enumerate what
- *  assertions have produced, and to destroy it on request.
- */
-export class Tenants extends APIResource {
-  subjects: SubjectsAPI.Subjects = new SubjectsAPI.Subjects(this._client);
-
-  /**
-   * Retrieves a tenant by its canonical id or by the `external_id:<value>` form the
-   * customer asserted it under.
-   */
-  retrieve(
-    id: string,
-    params: TenantRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Tenant> {
-    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
-    return this._client.get(path`/v1/workspaces/${workspaceId}/tenants/${id}`, { query, ...options });
-  }
-
-  /**
-   * Lists the tenants asserted in a workspace, newest first. `query` matches against
-   * a tenant's name and its external_id, for type-ahead filters.
-   */
-  list(
-    params: TenantListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<TenantsCursorPagination, Tenant> {
-    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
-    return this._client.getAPIList(path`/v1/workspaces/${workspaceId}/tenants`, CursorPagination<Tenant>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Destroys the tenant, its subjects, every objective associated with it and
-   * everything reachable from those objectives, and its widget sessions. This is the
-   * full erasure hammer, wider than `DELETE /widget_sessions`, which removes only
-   * what widget sessions created. The work runs in the background: this returns the
-   * tenant in STATE_ERASING rather than a count of what was removed, since a large
-   * tenant's history cannot be destroyed inside a request. Poll the tenant to follow
-   * it — STATE_ERASING while it runs, NotFound once it finishes. Erasure is
-   * terminal; a tenant cannot be recovered once it starts.
-   */
-  delete(
-    id: string,
-    params: TenantDeleteParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Tenant> {
-    const { workspaceId = this._client.workspaceID } = params ?? {};
-    return this._client.delete(path`/v1/workspaces/${workspaceId}/tenants/${id}`, options);
-  }
-}
-
-export type TenantsCursorPagination = CursorPagination<Tenant>;
-
-export type SubjectsCursorPagination = CursorPagination<Subject>;
-
-/**
- * Subject is a person within a tenant as a readable record. Like Tenant it carries
- * no spec — `metadata.external_id` is the customer's key for them, unique within
- * the tenant rather than the workspace.
- */
-export interface Subject {
-  /**
-   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
-   */
-  metadata: Shared.ResourceMetadata;
-
-  /**
-   * SubjectInfo provides read-only server-derived data about a subject.
-   */
-  info?: SubjectInfo;
-}
-
-/**
- * SubjectInfo provides read-only server-derived data about a subject.
- */
-export interface SubjectInfo {
-  /**
-   * Number of objectives associated with this subject.
-   */
-  objectiveCount?: number;
-
-  /**
-   * TenantReference is the read-only echo of a resource's tenant association,
-   * carrying both Cadenya's canonical id and the customer's own key.
-   */
-  tenant?: WidgetSessionsAPI.TenantReference;
-}
-
-/**
- * Tenant is the customer's organization as a readable record rather than an echo.
- * It carries no spec: a tenant is never configured, only asserted, so everything
- * about it lives in the metadata envelope — `external_id` is the key the customer
- * asserted it under, `name` is the most recent name they asserted, and
- * `updated_at` is therefore when the tenant was last asserted.
- */
-export interface Tenant {
-  /**
-   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
-   */
-  metadata: Shared.ResourceMetadata;
-
-  /**
-   * The current lifecycle state of the tenant. Output only.
-   */
-  state: 'STATE_UNSPECIFIED' | 'STATE_ACTIVE' | 'STATE_ERASING';
-
-  /**
-   * TenantInfo provides read-only server-derived data about a tenant.
-   */
-  info?: TenantInfo;
-}
-
-/**
- * TenantInfo provides read-only server-derived data about a tenant.
- */
-export interface TenantInfo {
-  /**
-   * Number of objectives associated with this tenant, across every surface — widget
-   * conversations and objectives created directly against the API alike. This is the
-   * footprint a delete would destroy, which is why it is worth the count query that
-   * populating `info` costs.
-   */
-  objectiveCount?: number;
-
-  /**
-   * Number of subjects asserted under this tenant.
-   */
-  subjectCount?: number;
-
-  /**
-   * Number of widget sessions minted for this tenant that still exist.
-   */
-  widgetSessionCount?: number;
-}
-
-export interface TenantRetrieveParams {
-  /**
-   * Path param: Workspace ID.
-   */
-  workspaceId?: string;
-
-  /**
-   * Query param: When true, the `info` field is populated.
-   */
-  includeInfo?: boolean;
-}
-
-export interface TenantListParams extends CursorPaginationParams {
-  /**
-   * Path param: Workspace ID.
-   */
-  workspaceId?: string;
-
-  /**
-   * Query param: When true, the `info` field on each returned tenant is populated.
-   * This costs several count queries per tenant, so it is off by default.
-   */
-  includeInfo?: boolean;
-
-  /**
-   * Query param: Filters by metadata labels. Comma-separated key=value pairs, e.g.
-   * "env=prod,team=ai". A resource matches only if every pair matches exactly (AND
-   * semantics).
-   */
-  labels?: string;
-
-  /**
-   * Query param: Substring match against the tenant's name and external_id. Built
-   * for type-ahead filter pickers, where the operator knows the customer's own
-   * identifier rather than Cadenya's.
-   */
-  query?: string;
-
-  /**
-   * Query param: Sort order for results (asc or desc by creation time).
-   */
-  sortOrder?: string;
-}
-
-export interface TenantDeleteParams {
-  /**
-   * Workspace ID.
-   */
-  workspaceId?: string;
-}
-
-Tenants.Subjects = Subjects;
-
-export declare namespace Tenants {
-  export {
-    type Subject as Subject,
-    type SubjectInfo as SubjectInfo,
-    type Tenant as Tenant,
-    type TenantInfo as TenantInfo,
-    type TenantsCursorPagination as TenantsCursorPagination,
-    type TenantRetrieveParams as TenantRetrieveParams,
-    type TenantListParams as TenantListParams,
-    type TenantDeleteParams as TenantDeleteParams,
-  };
-
-  export { Subjects as Subjects, type SubjectListParams as SubjectListParams };
-}