@cadenya/cadenya 0.68.0 → 0.69.0

package/src/resources/api-keys/api-keys.ts

@@ -0,0 +1,282 @@
+// 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 AccessAPI from './access';
+import { Access, AccessAddParams, AccessListParams, AccessRemoveParams } from './access';
+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';
+
+/**
+ * Issue, rotate, and revoke API keys for the account, and grant or revoke
+ *  each key's access to individual workspaces.
+ */
+export class APIKeys extends APIResource {
+  access: AccessAPI.Access = new AccessAPI.Access(this._client);
+
+  /**
+   * Creates a new API key on the account. Optionally grants the key access to one or
+   * more workspaces via initial_workspace_ids.
+   */
+  create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.post('/v1/account/api_keys', { body, ...options });
+  }
+
+  /**
+   * Retrieves an API key by ID.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.get(path`/v1/account/api_keys/${id}`, options);
+  }
+
+  /**
+   * Updates an API key.
+   */
+  update(id: string, body: APIKeyUpdateParams, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.patch(path`/v1/account/api_keys/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists all API keys on the account.
+   */
+  list(
+    query: APIKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<APIKeysCursorPagination, APIKey> {
+    return this._client.getAPIList('/v1/account/api_keys', CursorPagination<APIKey>, { query, ...options });
+  }
+
+  /**
+   * Deletes an API key.
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/account/api_keys/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Rotates an API key and returns a new token. All previous tokens for this key are
+   * invalidated.
+   */
+  rotate(id: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.put(path`/v1/account/api_keys/${id}/rotate`, options);
+  }
+}
+
+export type APIKeysCursorPagination = CursorPagination<APIKey>;
+
+/**
+ * An API key for the account. Use workspace-association RPCs to grant the key
+ * access to specific workspaces; a key with zero workspaces is valid but cannot
+ * access workspace-scoped resources.
+ */
+export interface APIKey {
+  /**
+   * AccountResourceMetadata is used to represent a resource that is associated to an
+   * account but not to a workspace.
+   */
+  metadata: Shared.AccountResourceMetadata;
+
+  /**
+   * Configuration for an API key.
+   */
+  spec: APIKeySpec;
+
+  info?: APIKeyInfo;
+}
+
+export interface APIKeyInfo {
+  /**
+   * 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;
+
+  /**
+   * Up to a small number of workspaces this key has access to, intended for display
+   * ("Workspace 1, Workspace 2, and 4 more"). Use ListAPIKeyWorkspaces for the full
+   * paginated list.
+   */
+  workspacesPreview?: Array<Shared.BareMetadata>;
+
+  /**
+   * Total number of workspaces this key has access to.
+   */
+  workspacesTotal?: number;
+}
+
+/**
+ * Configuration for an API key.
+ */
+export interface APIKeySpec {
+  /**
+   * The bearer token used to authenticate as this API key. Returned only on creation
+   * and rotation; subsequent reads omit this field.
+   */
+  token?: string;
+
+  /**
+   * Free-form description of what this API key is used for.
+   */
+  description?: string;
+
+  /**
+   * Permissions granted to this key. Each entry is a colon-separated verb:resource
+   * string (e.g. "manage:agents"). Currently has no enforced effect; reserved for
+   * future fine-grained authorization.
+   */
+  permissions?: Array<string>;
+
+  /**
+   * True when this key is managed by the system (e.g. the auto-provisioned global
+   * account key). System keys cannot be deleted but can be rotated.
+   */
+  system?: boolean;
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * CreateAccountResourceMetadata contains the user-provided fields for creating an
+   * account-scoped resource. Read-only fields (id, account_id, profile_id) are
+   * excluded since they are set by the server.
+   */
+  metadata: APIKeyCreateParams.Metadata;
+
+  /**
+   * Configuration for an API key.
+   */
+  spec: APIKeySpec;
+
+  /**
+   * Workspaces this API key will have access to on creation. Optional — a key can be
+   * created with no workspace access and granted later via AddAPIKeyWorkspace.
+   */
+  initialWorkspaceIds?: Array<string>;
+}
+
+export namespace APIKeyCreateParams {
+  /**
+   * CreateAccountResourceMetadata contains the user-provided fields for creating an
+   * account-scoped resource. Read-only fields (id, account_id, profile_id) are
+   * excluded since they are set by the server.
+   */
+  export interface Metadata {
+    /**
+     * Human-readable name for the resource (e.g., "Production API Key", "Staging
+     * Workspace")
+     */
+    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 };
+  }
+}
+
+export interface APIKeyUpdateParams {
+  /**
+   * 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?: APIKeyUpdateParams.Metadata;
+
+  /**
+   * Configuration for an API key.
+   */
+  spec?: APIKeySpec;
+
+  /**
+   * Fields to update.
+   */
+  updateMask?: string;
+}
+
+export namespace APIKeyUpdateParams {
+  /**
+   * 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.
+   */
+  export interface Metadata {
+    /**
+     * Human-readable name for the resource (e.g., "Production API Key", "Staging
+     * Workspace")
+     */
+    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 };
+  }
+}
+
+export interface APIKeyListParams extends CursorPaginationParams {
+  /**
+   * Filter by bundle_key — return only resources owned by this bundle.
+   */
+  bundleKey?: string;
+
+  /**
+   * When true, included info fields are populated. Requests with this flag count
+   * more against your rate limit.
+   */
+  includeInfo?: boolean;
+
+  /**
+   * Filter by ID prefix.
+   */
+  prefix?: string;
+
+  /**
+   * Free-form search query.
+   */
+  query?: string;
+
+  /**
+   * Sort order for results (asc or desc by creation time).
+   */
+  sortOrder?: string;
+}
+
+APIKeys.Access = Access;
+
+export declare namespace APIKeys {
+  export {
+    type APIKey as APIKey,
+    type APIKeyInfo as APIKeyInfo,
+    type APIKeySpec as APIKeySpec,
+    type APIKeysCursorPagination as APIKeysCursorPagination,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyUpdateParams as APIKeyUpdateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
+
+  export {
+    Access as Access,
+    type AccessListParams as AccessListParams,
+    type AccessAddParams as AccessAddParams,
+    type AccessRemoveParams as AccessRemoveParams,
+  };
+}

package/src/resources/api-keys/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  APIKeys,
+  type APIKey,
+  type APIKeyInfo,
+  type APIKeySpec,
+  type APIKeyCreateParams,
+  type APIKeyUpdateParams,
+  type APIKeyListParams,
+  type APIKeysCursorPagination,
+} from './api-keys';
+export { Access, type AccessListParams, type AccessAddParams, type AccessRemoveParams } from './access';

package/src/resources/api-keys.ts

@@ -1,220 +1,3 @@
 // 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';
-
-/**
- * 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 {
-  /**
-   * Creates a new API key in the workspace.
-   */
-  create(workspaceID: string, body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKey> {
-    return this._client.post(path`/v1/workspaces/${workspaceID}/api_keys`, { body, ...options });
-  }
-
-  /**
-   * Retrieves an API key by ID from the workspace
-   */
-  retrieve(id: string, params: APIKeyRetrieveParams, options?: RequestOptions): APIPromise<APIKey> {
-    const { workspaceId } = params;
-    return this._client.get(path`/v1/workspaces/${workspaceId}/api_keys/${id}`, options);
-  }
-
-  /**
-   * Updates an API key in the workspace
-   */
-  update(id: string, params: APIKeyUpdateParams, options?: RequestOptions): APIPromise<APIKey> {
-    const { workspaceId, ...body } = params;
-    return this._client.patch(path`/v1/workspaces/${workspaceId}/api_keys/${id}`, { body, ...options });
-  }
-
-  /**
-   * Lists all API keys in the workspace
-   */
-  list(
-    workspaceID: string,
-    query: APIKeyListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<APIKeysCursorPagination, APIKey> {
-    return this._client.getAPIList(path`/v1/workspaces/${workspaceID}/api_keys`, CursorPagination<APIKey>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Deletes an API key from the workspace
-   */
-  delete(id: string, params: APIKeyDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { workspaceId } = params;
-    return this._client.delete(path`/v1/workspaces/${workspaceId}/api_keys/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  /**
-   * Rotates an API Key and returns a new token. All previous API Key tokens in use
-   * will be invalidated.
-   */
-  rotate(id: string, params: APIKeyRotateParams, options?: RequestOptions): APIPromise<APIKey> {
-    const { workspaceId } = params;
-    return this._client.put(path`/v1/workspaces/${workspaceId}/api_keys/${id}/rotate`, options);
-  }
-}
-
-export type APIKeysCursorPagination = CursorPagination<APIKey>;
-
-/**
- * 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 {
-  /**
-   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
-   */
-  metadata: Shared.ResourceMetadata;
-
-  /**
-   * Configuration for an API key.
-   */
-  spec: APIKeySpec;
-
-  info?: APIKeyInfo;
-}
-
-export interface APIKeyInfo {
-  /**
-   * 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;
-}
-
-/**
- * Configuration for an API key.
- */
-export interface APIKeySpec {
-  /**
-   * The bearer token used to authenticate as this API key. Returned only on creation
-   * and rotation; subsequent reads omit this field.
-   */
-  token?: string;
-
-  /**
-   * Free-form description of what this API key is used for.
-   */
-  description?: string;
-}
-
-export interface APIKeyCreateParams {
-  /**
-   * 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;
-
-  /**
-   * Configuration for an API key.
-   */
-  spec: APIKeySpec;
-}
-
-export interface APIKeyRetrieveParams {
-  /**
-   * The workspace the API key belongs to.
-   */
-  workspaceId: string;
-}
-
-export interface APIKeyUpdateParams {
-  /**
-   * Path param: The workspace the API key belongs to.
-   */
-  workspaceId: 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: Configuration for an API key.
-   */
-  spec?: APIKeySpec;
-
-  /**
-   * Body param: Fields to update.
-   */
-  updateMask?: string;
-}
-
-export interface APIKeyListParams extends CursorPaginationParams {
-  /**
-   * Filter by bundle_key — return only resources owned by this bundle.
-   */
-  bundleKey?: string;
-
-  /**
-   * When set to true you may use more of your alloted API rate-limit
-   */
-  includeInfo?: boolean;
-
-  /**
-   * Filter expression (query param: prefix)
-   */
-  prefix?: string;
-
-  /**
-   * Free-form search query
-   */
-  query?: string;
-
-  /**
-   * Sort order for results (asc or desc by creation time)
-   */
-  sortOrder?: string;
-}
-
-export interface APIKeyDeleteParams {
-  /**
-   * The workspace the API key belongs to.
-   */
-  workspaceId: string;
-}
-
-export interface APIKeyRotateParams {
-  /**
-   * The workspace the API key belongs to.
-   */
-  workspaceId: string;
-}
-
-export declare namespace APIKeys {
-  export {
-    type APIKey as APIKey,
-    type APIKeyInfo as APIKeyInfo,
-    type APIKeySpec as APIKeySpec,
-    type APIKeysCursorPagination as APIKeysCursorPagination,
-    type APIKeyCreateParams as APIKeyCreateParams,
-    type APIKeyRetrieveParams as APIKeyRetrieveParams,
-    type APIKeyUpdateParams as APIKeyUpdateParams,
-    type APIKeyListParams as APIKeyListParams,
-    type APIKeyDeleteParams as APIKeyDeleteParams,
-    type APIKeyRotateParams as APIKeyRotateParams,
-  };
-}
+export * from './api-keys/index';

package/src/resources/index.ts

@@ -7,16 +7,14 @@ export {
   type APIKeyInfo,
   type APIKeySpec,
   type APIKeyCreateParams,
-  type APIKeyRetrieveParams,
   type APIKeyUpdateParams,
   type APIKeyListParams,
-  type APIKeyDeleteParams,
-  type APIKeyRotateParams,
   type APIKeysCursorPagination,
-} from './api-keys';
+} from './api-keys/api-keys';
 export {
   AccountResource,
   type Account,
+  type AccountInfo,
   type AccountSpec,
   type Profile,
   type ProfileSpec,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.68.0'; // x-release-please-version
+export const VERSION = '0.69.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.68.0";
+export declare const VERSION = "0.69.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.68.0";
+export declare const VERSION = "0.69.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.68.0'; // x-release-please-version
+exports.VERSION = '0.69.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.68.0'; // x-release-please-version
+export const VERSION = '0.69.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map