@cadenya/cadenya 0.67.0 → 0.68.0

package/src/resources/agents/webhook-deliveries.ts

@@ -7,12 +7,7 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * AgentService manages AI agents at the WORKSPACE level.
- *  Agents are workspace-scoped resources that define AI behavior and tool access.
- *  All operations are implicitly scoped to the workspace determined by the JWT token.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Manage AI agents within a workspace. Agents define AI behavior and tool access.
  */
 export class WebhookDeliveries extends APIResource {
   /**
@@ -36,7 +31,7 @@ export type WebhookDeliveriesCursorPagination = CursorPagination<WebhookDelivery
 
 export interface WebhookDelivery {
   /**
-   * Webhook delivery data
+   * Webhook delivery details.
    */
   data: WebhookDeliveryData;
 
@@ -75,7 +70,7 @@ export interface WebhookDeliveryData {
     | 'OBJECTIVE_EVENT_TYPE_CANCELLED';
 
   /**
-   * Response details (no response_body to avoid storing large payloads)
+   * Response details. The response body is not retained.
    */
   httpStatusCode: number;
 
@@ -116,7 +111,7 @@ export interface WebhookDeliveryData {
 
 export interface WebhookDeliveryListParams extends CursorPaginationParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param: Workspace ID.
    */
   workspaceId: string;
 

package/src/resources/api-keys.ts

@@ -10,11 +10,8 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 /**
- * APIKeyService manages workspace-scoped API Keys.
- *  Each API key belongs to a single workspace, ensuring isolation between environments.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Issue, rotate, and revoke API keys for a workspace. Each API key belongs to
+ *  exactly one workspace, ensuring isolation between environments.
  */
 export class APIKeys extends APIResource {
   /**
@@ -78,9 +75,8 @@ export class APIKeys extends APIResource {
 export type APIKeysCursorPagination = CursorPagination<APIKey>;
 
 /**
- * APIKey represents a workspace-scoped API key. Each API key belongs to exactly
- * one workspace, ensuring workspace isolation. Authentication is handled via
- * Cadenya-issued JWTs signed with the key's own signing secret.
+ * An API key scoped to a single workspace. The key's token is used to authenticate
+ * requests against that workspace's resources.
  */
 export interface APIKey {
   /**
@@ -89,7 +85,7 @@ export interface APIKey {
   metadata: Shared.ResourceMetadata;
 
   /**
-   * APIKeySpec contains the API Key-specific fields
+   * Configuration for an API key.
    */
   spec: APIKeySpec;
 
@@ -98,24 +94,25 @@ export interface APIKey {
 
 export interface APIKeyInfo {
   /**
-   * 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).
+   * A profile identifies a user or non-human principal (such as an API key) at the
+   * account level. Profiles are account-scoped and can be granted access to multiple
+   * workspaces.
    */
   createdBy?: AccountAPI.Profile;
 }
 
 /**
- * APIKeySpec contains the API Key-specific fields
+ * Configuration for an API key.
  */
 export interface APIKeySpec {
   /**
-   * The actual token value (only returned on creation and rotation, read-only)
+   * The bearer token used to authenticate as this API key. Returned only on creation
+   * and rotation; subsequent reads omit this field.
    */
   token?: string;
 
   /**
-   * Description of what this API Key is used for
+   * Free-form description of what this API key is used for.
    */
   description?: string;
 }
@@ -129,21 +126,21 @@ export interface APIKeyCreateParams {
   metadata: Shared.CreateResourceMetadata;
 
   /**
-   * APIKeySpec contains the API Key-specific fields
+   * Configuration for an API key.
    */
   spec: APIKeySpec;
 }
 
 export interface APIKeyRetrieveParams {
   /**
-   * Workspace ID (from path).
+   * The workspace the API key belongs to.
    */
   workspaceId: string;
 }
 
 export interface APIKeyUpdateParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param: The workspace the API key belongs to.
    */
   workspaceId: string;
 
@@ -156,12 +153,12 @@ export interface APIKeyUpdateParams {
   metadata?: Shared.UpdateResourceMetadata;
 
   /**
-   * Body param: APIKeySpec contains the API Key-specific fields
+   * Body param: Configuration for an API key.
    */
   spec?: APIKeySpec;
 
   /**
-   * Body param: Fields to update
+   * Body param: Fields to update.
    */
   updateMask?: string;
 }
@@ -195,14 +192,14 @@ export interface APIKeyListParams extends CursorPaginationParams {
 
 export interface APIKeyDeleteParams {
   /**
-   * Workspace ID (from path).
+   * The workspace the API key belongs to.
    */
   workspaceId: string;
 }
 
 export interface APIKeyRotateParams {
   /**
-   * Workspace ID (from path).
+   * The workspace the API key belongs to.
    */
   workspaceId: string;
 }

package/src/resources/bulk-workspace-resources/bulk-workspace-resources.ts

@@ -32,14 +32,9 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * BulkWorkspaceResources is the workspace-scoped service that applies
- *  a declarative bundle of workspace resources (tool sets, memory
- *  layers, agents, variations, assignments, schedules) in one async
- *  operation. See docs/superpowers/specs/2026-05-02-bulk-workspace-resources-design.md
- *  for the full design.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Apply a declarative bundle of workspace resources — tool sets, memory
+ *  layers, agents, variations, assignments, and schedules — in a single
+ *  asynchronous operation.
  */
 export class BulkWorkspaceResources extends APIResource {
   results: ResultsAPI.Results = new ResultsAPI.Results(this._client);
@@ -138,17 +133,15 @@ export interface AgentVariationEntry {
   labels?: { [key: string]: string };
 
   /**
-   * Reconciled list — capped at 10 to match the existing variation
-   * memory-layer-assignment cap.
+   * Reconciled list of memory layer assignments. Up to 10 entries.
    */
   memoryLayers?: Array<VariationMemoryLayerEntry>;
 }
 
 /**
- * BulkWorkspaceApply is the operation resource produced by a call to
- * BulkWorkspaceResources.Apply. It is operation-typed (uses OperationMetadata,
- * like Objective and ObjectiveEvent) and carries the input bundle in `data`, the
- * lifecycle state in `status`, and aggregate counts in `info`.
+ * The operation resource produced by a call to BulkWorkspaceResources.Apply. It
+ * carries the input bundle in `data`, the lifecycle state in `status`, and
+ * aggregate counts in `info`.
  */
 export interface BulkWorkspaceApply {
   data: BulkWorkspaceApplyData;
@@ -213,9 +206,9 @@ export interface BulkWorkspaceApplyInfo {
   completedAt?: 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).
+   * A profile identifies a user or non-human principal (such as an API key) at the
+   * account level. Profiles are account-scoped and can be granted access to multiple
+   * workspaces.
    */
   createdBy?: AccountAPI.Profile;
 
@@ -368,7 +361,7 @@ export interface VariationMemoryLayerEntry {
 
 export interface BulkWorkspaceResourceRetrieveParams {
   /**
-   * Workspace ID (from path).
+   * Workspace ID.
    */
   workspaceId: string;
 }

package/src/resources/bulk-workspace-resources/results.ts

@@ -14,14 +14,9 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * BulkWorkspaceResources is the workspace-scoped service that applies
- *  a declarative bundle of workspace resources (tool sets, memory
- *  layers, agents, variations, assignments, schedules) in one async
- *  operation. See docs/superpowers/specs/2026-05-02-bulk-workspace-resources-design.md
- *  for the full design.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Apply a declarative bundle of workspace resources — tool sets, memory
+ *  layers, agents, variations, assignments, and schedules — in a single
+ *  asynchronous operation.
  */
 export class Results extends APIResource {
   /**
@@ -44,19 +39,17 @@ export class Results extends APIResource {
 export type BulkWorkspaceApplyResultsCursorPagination = CursorPagination<BulkWorkspaceApplyResult>;
 
 /**
- * BulkWorkspaceApplyResult is one row of the per-resource result list for a
- * BulkWorkspaceApply. Each row is itself an operation (OperationMetadata-typed) so
- * it can be paginated, sorted by created_at, and individually addressed. Mirrors
- * the Objective → ObjectiveEvent relationship.
+ * One row of the per-resource result list for a BulkWorkspaceApply. Each row is
+ * itself an operation that can be paginated, sorted by created_at, and addressed
+ * individually.
  */
 export interface BulkWorkspaceApplyResult {
   /**
-   * BulkWorkspaceApplyResultData carries the outcome for a single resource. The
-   * `type` field is the discriminator string that names the populated `outcome`
-   * oneof variant (e.g., "toolSet", "memoryEntry"). Every Outcome shell carries an
-   * `action` enum and either a resulting resource snapshot (for ACTION_CREATED /
-   * ACTION_UPDATED / ACTION_UNCHANGED / ACTION_DELETED) or a google.rpc.Status (for
-   * ACTION_FAILED).
+   * Outcome for a single resource within a bulk apply. The `type` field is the
+   * discriminator string naming the populated `outcome` oneof variant (e.g.,
+   * "toolSet", "memoryEntry"). Every outcome shell carries an `action` enum and
+   * either a resulting resource snapshot (for ACTION_CREATED, ACTION_UPDATED,
+   * ACTION_UNCHANGED, ACTION_DELETED) or a google.rpc.Status (for ACTION_FAILED).
    */
   data: BulkWorkspaceApplyResultData;
 
@@ -68,12 +61,11 @@ export interface BulkWorkspaceApplyResult {
 }
 
 /**
- * BulkWorkspaceApplyResultData carries the outcome for a single resource. The
- * `type` field is the discriminator string that names the populated `outcome`
- * oneof variant (e.g., "toolSet", "memoryEntry"). Every Outcome shell carries an
- * `action` enum and either a resulting resource snapshot (for ACTION_CREATED /
- * ACTION_UPDATED / ACTION_UNCHANGED / ACTION_DELETED) or a google.rpc.Status (for
- * ACTION_FAILED).
+ * Outcome for a single resource within a bulk apply. The `type` field is the
+ * discriminator string naming the populated `outcome` oneof variant (e.g.,
+ * "toolSet", "memoryEntry"). Every outcome shell carries an `action` enum and
+ * either a resulting resource snapshot (for ACTION_CREATED, ACTION_UPDATED,
+ * ACTION_UNCHANGED, ACTION_DELETED) or a google.rpc.Status (for ACTION_FAILED).
  */
 export interface BulkWorkspaceApplyResultData {
   agent?: BulkWorkspaceApplyResultDataAgentOutcome;
@@ -643,15 +635,14 @@ export interface BulkWorkspaceApplyResultDataVariationAssignmentOutcome {
   error?: BulkWorkspaceApplyResultDataVariationAssignmentOutcome.Error;
 
   /**
-   * VariationAssignment is a read-only reference to a single tool, tool set, or
-   * sub-agent attached to a variation. Clients read the full set of assignments via
+   * A read-only reference to a single tool, tool set, or sub-agent attached to a
+   * variation. Read the full set of assignments via
    * `AgentVariationInfo.assignments`; mutations go through the dedicated add/remove
-   * assignment endpoints under
-   * /v1/agents/{agent_id}/variations/{variation_id}/assignments.
+   * assignment endpoints.
    *
-   * The `id` identifies the assignment row itself (not the referenced resource) and
-   * is the handle used to remove the assignment. It is returned by the add endpoint
-   * and present on every entry in AgentVariationInfo.assignments.
+   * The `id` identifies the assignment itself (not the referenced resource) and is
+   * the handle used to remove the assignment. It is returned by the add endpoint and
+   * present on every entry in `AgentVariationInfo.assignments`.
    */
   resource?: VariationsAPI.VariationAssignment;
 }
@@ -782,7 +773,7 @@ export namespace BulkWorkspaceApplyResultDataVariationMemoryLayerOutcome {
 
 export interface ResultListParams extends CursorPaginationParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param: Workspace ID.
    */
   workspaceId: string;
 

package/src/resources/memory-layers/entries.ts

@@ -10,16 +10,10 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * MemoryService manages memory layers and their entries at the WORKSPACE level.
- *  Layers are named containers that can be composed into an objective's memory
- *  stack; entries are the keyed values within a layer.
- *
- *  All operations are implicitly scoped to the workspace determined by the JWT
- *  token. System-managed layers (e.g., episodic layers created by the runtime)
- *  cannot be mutated through this API.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Manage memory layers and their entries. Layers are named containers that can
+ *  be composed into an objective's memory stack; entries are the keyed values
+ *  within a layer. System-managed layers (e.g., episodic layers created by the
+ *  runtime) cannot be mutated through this API.
  */
 export class Entries extends APIResource {
   /**
@@ -175,9 +169,9 @@ export interface MemoryEntryDetail {
 
 export interface MemoryEntryInfo {
   /**
-   * 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).
+   * A profile identifies a user or non-human principal (such as an API key) at the
+   * account level. Profiles are account-scoped and can be granted access to multiple
+   * workspaces.
    */
   createdBy?: AccountAPI.Profile;
 
@@ -240,7 +234,7 @@ export interface MemoryEntryUpdateSpec {
 
 export interface EntryCreateParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 
@@ -261,27 +255,23 @@ export interface EntryCreateParams {
 }
 
 export interface EntryRetrieveParams {
-  /**
-   * Workspace ID (from path).
-   */
   workspaceId: string;
 
   /**
-   * Memory layer ID (from path). Accepts canonical memlyr\_… form or
-   * external_id:<value> form (see common.proto "Path-parameter ID resolution").
+   * Memory layer ID. Accepts canonical memlyr\_… form or external_id:<value> form.
    */
   memoryLayerId: string;
 }
 
 export interface EntryUpdateParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 
   /**
-   * Path param: Memory layer ID (from path). Accepts canonical memlyr\_… form or
-   * external_id:<value> form (see common.proto "Path-parameter ID resolution").
+   * Path param: Memory layer ID. Accepts canonical memlyr\_… form or
+   * external_id:<value> form.
    */
   memoryLayerId: string;
 
@@ -309,7 +299,7 @@ export interface EntryUpdateParams {
 
 export interface EntryListParams extends CursorPaginationParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 
@@ -341,14 +331,10 @@ export interface EntryListParams extends CursorPaginationParams {
 }
 
 export interface EntryDeleteParams {
-  /**
-   * Workspace ID (from path).
-   */
   workspaceId: string;
 
   /**
-   * Memory layer ID (from path). Accepts canonical memlyr\_… form or
-   * external_id:<value> form (see common.proto "Path-parameter ID resolution").
+   * Memory layer ID. Accepts canonical memlyr\_… form or external_id:<value> form.
    */
   memoryLayerId: string;
 }

package/src/resources/memory-layers/memory-layers.ts

@@ -26,16 +26,10 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * MemoryService manages memory layers and their entries at the WORKSPACE level.
- *  Layers are named containers that can be composed into an objective's memory
- *  stack; entries are the keyed values within a layer.
- *
- *  All operations are implicitly scoped to the workspace determined by the JWT
- *  token. System-managed layers (e.g., episodic layers created by the runtime)
- *  cannot be mutated through this API.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Manage memory layers and their entries. Layers are named containers that can
+ *  be composed into an objective's memory stack; entries are the keyed values
+ *  within a layer. System-managed layers (e.g., episodic layers created by the
+ *  runtime) cannot be mutated through this API.
  */
 export class MemoryLayers extends APIResource {
   entries: EntriesAPI.Entries = new EntriesAPI.Entries(this._client);
@@ -117,9 +111,9 @@ export interface MemoryLayer {
 
 export interface MemoryLayerInfo {
   /**
-   * 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).
+   * A profile identifies a user or non-human principal (such as an API key) at the
+   * account level. Profiles are account-scoped and can be granted access to multiple
+   * workspaces.
    */
   createdBy?: AccountAPI.Profile;
 
@@ -171,15 +165,12 @@ export interface MemoryLayerCreateParams {
 }
 
 export interface MemoryLayerRetrieveParams {
-  /**
-   * Workspace ID (from path).
-   */
   workspaceId: string;
 }
 
 export interface MemoryLayerUpdateParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 
@@ -235,9 +226,6 @@ export interface MemoryLayerListParams extends CursorPaginationParams {
 }
 
 export interface MemoryLayerDeleteParams {
-  /**
-   * Workspace ID (from path).
-   */
   workspaceId: string;
 }
 

package/src/resources/models.ts

@@ -8,13 +8,9 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 /**
- * ModelService manages LLM models at the WORKSPACE level.
- *  Models represent available LLM providers and families (e.g., "anthropic/claude-sonnet-4.6").
- *  Models are seeded into workspaces and can be enabled or disabled.
- *  All operations are implicitly scoped to the workspace determined by the JWT token.
- *
- *  Authentication: Bearer token (JWT)
- *  Scope: Workspace-level operations
+ * Manage LLM models available to a workspace. Models represent provider and
+ *  family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
+ *  with the supported models and you can enable or disable each one.
  */
 export class Models extends APIResource {
   /**
@@ -101,7 +97,7 @@ export interface ModelSpec {
 
 export interface ModelRetrieveParams {
   /**
-   * Workspace ID (from path).
+   * Workspace ID.
    */
   workspaceId: string;
 }
@@ -135,7 +131,7 @@ export interface ModelListParams extends CursorPaginationParams {
 
 export interface ModelSetStatusParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param: Workspace ID.
    */
   workspaceId: string;
 

package/src/resources/objectives/feedback.ts

@@ -97,16 +97,16 @@ export interface ObjectiveFeedbackInfo {
   objective?: Shared.BareMetadata;
 
   /**
-   * 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).
+   * A profile identifies a user or non-human principal (such as an API key) at the
+   * account level. Profiles are account-scoped and can be granted access to multiple
+   * workspaces.
    */
   submittedBy?: AccountAPI.Profile;
 }
 
 export interface FeedbackCreateParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 
@@ -125,7 +125,7 @@ export interface FeedbackCreateParams {
 
 export interface FeedbackListParams extends CursorPaginationParams {
   /**
-   * Path param: Workspace ID (from path).
+   * Path param
    */
   workspaceId: string;
 }