@cadenya/cadenya 0.124.0 → 0.125.0

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

@@ -21,7 +21,7 @@ export class Tools extends APIResource {
    * Creates a new tool in the tool set
    */
   create(toolSetID: string, params: ToolCreateParams, options?: RequestOptions): APIPromise<Tool> {
-    const { workspaceId, ...body } = params;
+    const { workspaceId = this._client.workspaceID, ...body } = params;
     return this._client.post(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools`, {
       body,
       ...options,
@@ -31,17 +31,27 @@ export class Tools extends APIResource {
   /**
    * Retrieves a tool by ID from the workspace
    */
-  retrieve(id: string, params: ToolRetrieveParams, options?: RequestOptions): APIPromise<Tool> {
-    const { workspaceId, toolSetId } = params;
-    return this._client.get(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetId}/tools/${id}`, options);
+  retrieve(
+    toolSetID: string,
+    id: string,
+    params: ToolRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Tool> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
+    return this._client.get(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools/${id}`, options);
   }
 
   /**
    * Updates a tool in the tool set
    */
-  update(id: string, params: ToolUpdateParams, options?: RequestOptions): APIPromise<Tool> {
-    const { workspaceId, toolSetId, ...body } = params;
-    return this._client.patch(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetId}/tools/${id}`, {
+  update(
+    toolSetID: string,
+    id: string,
+    params: ToolUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<Tool> {
+    const { workspaceId = this._client.workspaceID, ...body } = params;
+    return this._client.patch(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools/${id}`, {
       body,
       ...options,
     });
@@ -52,10 +62,10 @@ export class Tools extends APIResource {
    */
   list(
     toolSetID: string,
-    params: ToolListParams,
+    params: ToolListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ToolsCursorPagination, Tool> {
-    const { workspaceId, ...query } = params;
+    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
     return this._client.getAPIList(
       path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools`,
       CursorPagination<Tool>,
@@ -66,9 +76,14 @@ export class Tools extends APIResource {
   /**
    * Deletes a tool in the tool set
    */
-  delete(id: string, params: ToolDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { workspaceId, toolSetId } = params;
-    return this._client.delete(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetId}/tools/${id}`, {
+  delete(
+    toolSetID: string,
+    id: string,
+    params: ToolDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
+    return this._client.delete(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools/${id}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -78,9 +93,9 @@ export class Tools extends APIResource {
    * Transitions a tool to STATE_OMITTED, excluding it from agent use. Fails if the
    * tool is currently assigned to agent variations.
    */
-  omit(id: string, params: ToolOmitParams, options?: RequestOptions): APIPromise<Tool> {
-    const { workspaceId, toolSetId, ...body } = params;
-    return this._client.post(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetId}/tools/${id}:omit`, {
+  omit(toolSetID: string, id: string, params: ToolOmitParams, options?: RequestOptions): APIPromise<Tool> {
+    const { workspaceId = this._client.workspaceID, ...body } = params;
+    return this._client.post(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools/${id}:omit`, {
       body,
       ...options,
     });
@@ -90,9 +105,14 @@ export class Tools extends APIResource {
    * Transitions an omitted tool back to STATE_AVAILABLE. For managed tool sets, the
    * next sync may omit the tool again if its filters still exclude it.
    */
-  restore(id: string, params: ToolRestoreParams, options?: RequestOptions): APIPromise<Tool> {
-    const { workspaceId, toolSetId, ...body } = params;
-    return this._client.post(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetId}/tools/${id}:restore`, {
+  restore(
+    toolSetID: string,
+    id: string,
+    params: ToolRestoreParams,
+    options?: RequestOptions,
+  ): APIPromise<Tool> {
+    const { workspaceId = this._client.workspaceID, ...body } = params;
+    return this._client.post(path`/v1/workspaces/${workspaceId}/tool_sets/${toolSetID}/tools/${id}:restore`, {
       body,
       ...options,
     });
@@ -125,7 +145,7 @@ export interface ConfigHTTP {
   requestBodyTemplate?: string;
 }
 
-export interface ConfigMcp {
+export interface ConfigMCP {
   /**
    * Behavior hints synced from the MCP server's tool definition (ToolAnnotations in
    * the MCP specification). All hints are advisory: servers are not required to send
@@ -133,7 +153,7 @@ export interface ConfigMcp {
    * keep the MCP spec defaults (destructiveHint and openWorldHint default to true;
    * readOnlyHint and idempotentHint default to false).
    */
-  annotations?: McpAnnotations;
+  annotations?: MCPAnnotations;
 }
 
 export interface ConfigOpenAPI {
@@ -149,7 +169,7 @@ export interface ConfigOpenAPI {
  * keep the MCP spec defaults (destructiveHint and openWorldHint default to true;
  * readOnlyHint and idempotentHint default to false).
  */
-export interface McpAnnotations {
+export interface MCPAnnotations {
   /**
    * If true, the tool may perform destructive updates to its environment. Only
    * meaningful when read_only_hint is false.
@@ -252,26 +272,46 @@ export interface ToolSpec {
  * 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 {
+export type ToolSpecConfig =
+  | ToolSpecConfigHTTP
+  | ToolSpecConfigMCP
+  | ToolSpecConfigOpenAPI
+  | ToolSpecConfigBare;
+
+export interface ToolSpecConfigBare {
   /**
    * Marks the tool as bare: it has no execution adapter of its own and relies on the
    * parent tool set being a Bare tool set. Present so a webhook consumer can tell a
    * tool is bare from the tool data alone, without cross-referencing the tool set.
    */
-  bare?: ConfigBare;
+  bare: ConfigBare;
+
+  type: 'bare';
+}
+
+export interface ToolSpecConfigHTTP {
+  http: ConfigHTTP;
 
-  http?: ConfigHTTP;
+  type: 'http';
+}
+
+export interface ToolSpecConfigMCP {
+  mcp: ConfigMCP;
+
+  type: 'mcp';
+}
 
-  mcp?: ConfigMcp;
+export interface ToolSpecConfigOpenAPI {
+  openapi: ConfigOpenAPI;
 
-  openapi?: ConfigOpenAPI;
+  type: 'openapi';
 }
 
 export interface ToolCreateParams {
   /**
    * Path param: Workspace ID.
    */
-  workspaceId: string;
+  workspaceId?: string;
 
   /**
    * Body param: CreateResourceMetadata contains the user-provided fields for
@@ -291,25 +331,14 @@ export interface ToolRetrieveParams {
   /**
    * Workspace ID.
    */
-  workspaceId: string;
-
-  /**
-   * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
-   */
-  toolSetId: string;
+  workspaceId?: string;
 }
 
 export interface ToolUpdateParams {
   /**
    * Path param: Workspace ID.
    */
-  workspaceId: string;
-
-  /**
-   * Path param: Tool set ID. Accepts the canonical ts\_… form or the
-   * external_id:<value> form.
-   */
-  toolSetId: string;
+  workspaceId?: string;
 
   /**
    * Body param: UpdateResourceMetadata contains the user-provided fields for
@@ -334,7 +363,7 @@ export interface ToolListParams extends CursorPaginationParams {
   /**
    * Path param: Workspace ID.
    */
-  workspaceId: string;
+  workspaceId?: string;
 
   /**
    * Query param: When set to true you may use more of your alloted API rate-limit
@@ -385,49 +414,38 @@ export interface ToolDeleteParams {
   /**
    * Workspace ID.
    */
-  workspaceId: string;
-
-  /**
-   * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
-   */
-  toolSetId: string;
+  workspaceId?: string;
 }
 
 export interface ToolOmitParams {
   /**
    * Workspace ID.
    */
-  workspaceId: string;
-
-  /**
-   * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
-   */
-  toolSetId: string;
+  workspaceId?: string;
 }
 
 export interface ToolRestoreParams {
   /**
    * Workspace ID.
    */
-  workspaceId: string;
-
-  /**
-   * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
-   */
-  toolSetId: string;
+  workspaceId?: string;
 }
 
 export declare namespace Tools {
   export {
     type ConfigBare as ConfigBare,
     type ConfigHTTP as ConfigHTTP,
-    type ConfigMcp as ConfigMcp,
+    type ConfigMCP as ConfigMCP,
     type ConfigOpenAPI as ConfigOpenAPI,
-    type McpAnnotations as McpAnnotations,
+    type MCPAnnotations as MCPAnnotations,
     type Tool as Tool,
     type ToolInfo as ToolInfo,
     type ToolSpec as ToolSpec,
     type ToolSpecConfig as ToolSpecConfig,
+    type ToolSpecConfigBare as ToolSpecConfigBare,
+    type ToolSpecConfigHTTP as ToolSpecConfigHTTP,
+    type ToolSpecConfigMCP as ToolSpecConfigMCP,
+    type ToolSpecConfigOpenAPI as ToolSpecConfigOpenAPI,
     type ToolsCursorPagination as ToolsCursorPagination,
     type ToolCreateParams as ToolCreateParams,
     type ToolRetrieveParams as ToolRetrieveParams,

package/src/resources/uploads.ts

@@ -18,15 +18,20 @@ export class Uploads extends APIResource {
    * returned id is used to reference the upload from resources that accept binary
    * content.
    */
-  create(workspaceID: string, body: UploadCreateParams, options?: RequestOptions): APIPromise<Upload> {
-    return this._client.post(path`/v1/workspaces/${workspaceID}/uploads`, { body, ...options });
+  create(params: UploadCreateParams, options?: RequestOptions): APIPromise<Upload> {
+    const { workspaceId = this._client.workspaceID, ...body } = params;
+    return this._client.post(path`/v1/workspaces/${workspaceId}/uploads`, { body, ...options });
   }
 
   /**
    * Retrieves the current state of an upload, including its lifecycle status
    */
-  retrieve(id: string, params: UploadRetrieveParams, options?: RequestOptions): APIPromise<Upload> {
-    const { workspaceId } = params;
+  retrieve(
+    id: string,
+    params: UploadRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Upload> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
     return this._client.get(path`/v1/workspaces/${workspaceId}/uploads/${id}`, options);
   }
 }
@@ -106,12 +111,21 @@ export interface UploadSpec {
 
 export interface UploadCreateParams {
   /**
-   * 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.
+   * Path param: Workspace ID.
+   */
+  workspaceId?: string;
+
+  /**
+   * Body param: 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;
 
+  /**
+   * Body param
+   */
   spec: UploadSpec;
 }
 
@@ -119,7 +133,7 @@ export interface UploadRetrieveParams {
   /**
    * Workspace ID.
    */
-  workspaceId: string;
+  workspaceId?: string;
 }
 
 export declare namespace Uploads {

package/src/resources/workspace-admin/index.ts

@@ -6,7 +6,9 @@ export {
   WorkspaceAdmin,
   type WorkspaceMember,
   type WorkspaceAdminCreateParams,
+  type WorkspaceAdminRetrieveParams,
   type WorkspaceAdminUpdateParams,
   type WorkspaceAdminListParams,
+  type WorkspaceAdminArchiveParams,
   type WorkspaceMembersCursorPagination,
 } from './workspace-admin';

package/src/resources/workspace-admin/members.ts

@@ -20,14 +20,24 @@ import { path } from '../../internal/utils/path';
 export class Members extends APIResource {
   /**
    * Lists the members of a workspace. Admin only.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const workspaceMember of client.workspaceAdmin.members.list(
+   *   { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
-    workspaceID: string,
-    query: MemberListParams | null | undefined = {},
+    params: MemberListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<WorkspaceMembersCursorPagination, WorkspaceAdminAPI.WorkspaceMember> {
+    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
     return this._client.getAPIList(
-      path`/v1/account/workspaces/${workspaceID}/members`,
+      path`/v1/account/workspaces/${workspaceId}/members`,
       CursorPagination<WorkspaceAdminAPI.WorkspaceMember>,
       { query, ...options },
     );
@@ -38,21 +48,41 @@ export class Members extends APIResource {
    * that links the profile to the workspace. Accepts either an existing profile_id
    * or an email to resolve-or-invite. Idempotent for an already-active member. Admin
    * only.
+   *
+   * @example
+   * ```ts
+   * const workspaceMember =
+   *   await client.workspaceAdmin.members.add({
+   *     workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
+   *   });
+   * ```
    */
   add(
-    workspaceID: string,
-    body: MemberAddParams,
+    params: MemberAddParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<WorkspaceAdminAPI.WorkspaceMember> {
-    return this._client.post(path`/v1/account/workspaces/${workspaceID}/members`, { body, ...options });
+    const { workspaceId = this._client.workspaceID, ...body } = params ?? {};
+    return this._client.post(path`/v1/account/workspaces/${workspaceId}/members`, { body, ...options });
   }
 
   /**
    * Revokes a member's access by deactivating their actor; the member is immediately
    * cut off. The underlying profile is not deleted. Admin only.
+   *
+   * @example
+   * ```ts
+   * await client.workspaceAdmin.members.remove(
+   *   'profile_01HXKD2E5NQM3T9AYWCFS0AP08',
+   *   { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
+   * );
+   * ```
    */
-  remove(profileID: string, params: MemberRemoveParams, options?: RequestOptions): APIPromise<void> {
-    const { workspaceId } = params;
+  remove(
+    profileID: string,
+    params: MemberRemoveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
     return this._client.delete(path`/v1/account/workspaces/${workspaceId}/members/${profileID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
@@ -60,16 +90,27 @@ export class Members extends APIResource {
   }
 }
 
-export interface MemberListParams extends CursorPaginationParams {}
+export interface MemberListParams extends CursorPaginationParams {
+  /**
+   * Path param: The workspace whose members will be listed (path).
+   */
+  workspaceId?: string;
+}
 
 export interface MemberAddParams {
   /**
-   * Email address to add (resolve-or-invite). Mutually exclusive with profile_id.
+   * Path param: The workspace to add the member to (path).
+   */
+  workspaceId?: string;
+
+  /**
+   * Body param: Email address to add (resolve-or-invite). Mutually exclusive with
+   * profile_id.
    */
   email?: string;
 
   /**
-   * An existing account profile to add. Mutually exclusive with email.
+   * Body param: An existing account profile to add. Mutually exclusive with email.
    */
   profileId?: string;
 }
@@ -78,7 +119,7 @@ export interface MemberRemoveParams {
   /**
    * The workspace to remove the member from (path).
    */
-  workspaceId: string;
+  workspaceId?: string;
 }
 
 export declare namespace Members {

package/src/resources/workspace-admin/profiles.ts

@@ -18,6 +18,14 @@ export class Profiles extends APIResource {
   /**
    * Searches the account's profiles for a member picker, with free-form name/email
    * search and an optional type filter. Account-scoped; admin only.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const profile of client.workspaceAdmin.profiles.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: ProfileListParams | null | undefined = {},

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

@@ -27,6 +27,14 @@ export class WorkspaceAdmin extends APIResource {
 
   /**
    * Creates a new workspace in the account. Admin only.
+   *
+   * @example
+   * ```ts
+   * const workspace = await client.workspaceAdmin.create({
+   *   metadata: { name: 'name' },
+   *   spec: {},
+   * });
+   * ```
    */
   create(body: WorkspaceAdminCreateParams, options?: RequestOptions): APIPromise<WorkspacesAPI.Workspace> {
     return this._client.post('/v1/account/workspaces', { body, ...options });
@@ -34,25 +42,51 @@ export class WorkspaceAdmin extends APIResource {
 
   /**
    * Retrieves a workspace in the account by ID. Admin only.
+   *
+   * @example
+   * ```ts
+   * const workspace = await client.workspaceAdmin.retrieve({
+   *   workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
+   * });
+   * ```
    */
-  retrieve(workspaceID: string, options?: RequestOptions): APIPromise<WorkspacesAPI.Workspace> {
-    return this._client.get(path`/v1/account/workspaces/${workspaceID}`, options);
+  retrieve(
+    params: WorkspaceAdminRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WorkspacesAPI.Workspace> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
+    return this._client.get(path`/v1/account/workspaces/${workspaceId}`, options);
   }
 
   /**
    * Updates a workspace's metadata (e.g. name) and spec. Admin only.
+   *
+   * @example
+   * ```ts
+   * const workspace = await client.workspaceAdmin.update({
+   *   workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
+   * });
+   * ```
    */
   update(
-    workspaceID: string,
-    body: WorkspaceAdminUpdateParams,
+    params: WorkspaceAdminUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<WorkspacesAPI.Workspace> {
-    return this._client.patch(path`/v1/account/workspaces/${workspaceID}`, { body, ...options });
+    const { workspaceId = this._client.workspaceID, ...body } = params ?? {};
+    return this._client.patch(path`/v1/account/workspaces/${workspaceId}`, { body, ...options });
   }
 
   /**
    * Lists every workspace in the account, optionally including archived ones. Admin
    * only.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const workspace of client.workspaceAdmin.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: WorkspaceAdminListParams | null | undefined = {},
@@ -69,9 +103,20 @@ export class WorkspaceAdmin extends APIResource {
    * subsequent request scoped to it returns a permission error. Archiving the
    * account's last active (non-archived) workspace is not allowed and returns
    * FailedPrecondition. Admin only.
+   *
+   * @example
+   * ```ts
+   * await client.workspaceAdmin.archive({
+   *   workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
+   * });
+   * ```
    */
-  archive(workspaceID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/v1/account/workspaces/${workspaceID}`, {
+  archive(
+    params: WorkspaceAdminArchiveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { workspaceId = this._client.workspaceID } = params ?? {};
+    return this._client.delete(path`/v1/account/workspaces/${workspaceId}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -151,18 +196,33 @@ export namespace WorkspaceAdminCreateParams {
   }
 }
 
+export interface WorkspaceAdminRetrieveParams {
+  /**
+   * Workspace ID to retrieve (path).
+   */
+  workspaceId?: string;
+}
+
 export interface WorkspaceAdminUpdateParams {
   /**
-   * UpdateAccountResourceMetadata contains the user-provided fields for updating an
-   * account-scoped resource. Read-only fields (id, account_id, profile_id) are
-   * excluded since they are set by the server.
+   * Path param: Workspace ID to update (path).
+   */
+  workspaceId?: string;
+
+  /**
+   * Body param: UpdateAccountResourceMetadata contains the user-provided fields for
+   * updating an account-scoped resource. Read-only fields (id, account_id,
+   * profile_id) are excluded since they are set by the server.
    */
   metadata?: WorkspaceAdminUpdateParams.Metadata;
 
+  /**
+   * Body param
+   */
   spec?: WorkspacesAPI.WorkspaceSpec;
 
   /**
-   * Fields to update.
+   * Body param: Fields to update.
    */
   updateMask?: string;
 }
@@ -211,6 +271,13 @@ export interface WorkspaceAdminListParams extends CursorPaginationParams {
   labels?: string;
 }
 
+export interface WorkspaceAdminArchiveParams {
+  /**
+   * Workspace ID to archive (path).
+   */
+  workspaceId?: string;
+}
+
 WorkspaceAdmin.Members = Members;
 WorkspaceAdmin.Profiles = Profiles;
 
@@ -218,8 +285,10 @@ export declare namespace WorkspaceAdmin {
   export {
     type WorkspaceMember as WorkspaceMember,
     type WorkspaceAdminCreateParams as WorkspaceAdminCreateParams,
+    type WorkspaceAdminRetrieveParams as WorkspaceAdminRetrieveParams,
     type WorkspaceAdminUpdateParams as WorkspaceAdminUpdateParams,
     type WorkspaceAdminListParams as WorkspaceAdminListParams,
+    type WorkspaceAdminArchiveParams as WorkspaceAdminArchiveParams,
   };
 
   export {