@cadenya/cadenya 0.134.0 → 1.0.0

package/src/resources/ai-provider-keys.ts

@@ -1,374 +1,182 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by redwood. Do not edit by hand.
 
-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 { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
+import { HttpClient, RequestOptions, APIPromise, pathSegment, snapshotParams } from '../core/http.js';
+import { Page } from '../core/pagination.js';
+import type { AIProviderKey, AIProviderKeySpec, CreateResourceMetadata, ListAIProviderKeysResponse, UpdateResourceMetadata } from '../types.js';
 
-export class AIProviderKeys extends APIResource {
+export interface AiProviderKeyListParams {
   /**
-   * Creates a new customer-provided AI provider key in the workspace
+   * The workspace whose keys will be listed.
+   * 
+   * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */
-  create(params: AIProviderKeyCreateParams, options?: RequestOptions): APIPromise<AIProviderKey> {
-    const { workspaceId = this._client.workspaceID, ...body } = params;
-    return this._client.post(path`/v1/workspaces/${workspaceId}/ai_provider_keys`, { body, ...options });
-  }
-
-  /**
-   * Retrieves an AI provider key by ID from the workspace
-   */
-  retrieve(
-    id: string,
-    params: AIProviderKeyRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<AIProviderKey> {
-    const { workspaceId = this._client.workspaceID } = params ?? {};
-    return this._client.get(path`/v1/workspaces/${workspaceId}/ai_provider_keys/${id}`, options);
-  }
-
-  /**
-   * Updates an AI provider key's name or key value in the workspace
-   */
-  update(id: string, params: AIProviderKeyUpdateParams, options?: RequestOptions): APIPromise<AIProviderKey> {
-    const { workspaceId = this._client.workspaceID, ...body } = params;
-    return this._client.patch(path`/v1/workspaces/${workspaceId}/ai_provider_keys/${id}`, {
-      body,
-      ...options,
-    });
-  }
-
-  /**
-   * Lists all customer-provided AI provider keys in the workspace
-   */
-  list(
-    params: AIProviderKeyListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<AIProviderKeysCursorPagination, AIProviderKey> {
-    const { workspaceId = this._client.workspaceID, ...query } = params ?? {};
-    return this._client.getAPIList(
-      path`/v1/workspaces/${workspaceId}/ai_provider_keys`,
-      CursorPagination<AIProviderKey>,
-      { query, ...options },
-    );
-  }
-
-  /**
-   * Deletes an AI provider key from the workspace
-   */
-  delete(
-    id: string,
-    params: AIProviderKeyDeleteParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    const { workspaceId = this._client.workspaceID } = params ?? {};
-    return this._client.delete(path`/v1/workspaces/${workspaceId}/ai_provider_keys/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-export type AIProviderKeysCursorPagination = CursorPagination<AIProviderKey>;
-
-export interface AIProviderConfigOpenAI {
-  /**
-   * OpenAIConfig holds OpenAI-specific settings.
-   */
-  openai: AIProviderConfigOpenAI.OpenAI;
-
-  type: 'openai';
-}
-
-export namespace AIProviderConfigOpenAI {
-  /**
-   * OpenAIConfig holds OpenAI-specific settings.
-   */
-  export interface OpenAI {
-    /**
-     * Sent as the OpenAI-Organization header when set.
-     */
-    organizationId?: string;
-
-    /**
-     * Sent as the OpenAI-Project header when set.
-     */
-    projectId?: string;
-  }
-}
-
-export interface AIProviderConfigOpenAICompatible {
+  workspaceId?: string;
   /**
-   * OpenAICompatibleConfig configures a generic endpoint that speaks the OpenAI Chat
-   * Completions API. The base URL is required and its model catalog is discovered
-   * live via GET {base_url}/models.
+   * Maximum number of results to return
    */
-  openaiCompatible: AIProviderConfigOpenAICompatible.OpenAICompatible;
-
-  type: 'openaiCompatible';
-}
-
-export namespace AIProviderConfigOpenAICompatible {
+  limit?: number;
   /**
-   * OpenAICompatibleConfig configures a generic endpoint that speaks the OpenAI Chat
-   * Completions API. The base URL is required and its model catalog is discovered
-   * live via GET {base_url}/models.
+   * Pagination cursor from previous response
    */
-  export interface OpenAICompatible {
-    baseUrl: string;
-  }
-}
-
-export interface AIProviderConfigOpenrouter {
+  cursor?: string;
   /**
-   * OpenRouterConfig holds OpenRouter-specific settings.
+   * Filter expression (query param: prefix)
    */
-  openrouter: AIProviderConfigOpenrouter.Openrouter;
-
-  type: 'openrouter';
-}
-
-export namespace AIProviderConfigOpenrouter {
+  prefix?: string;
   /**
-   * OpenRouterConfig holds OpenRouter-specific settings.
+   * Free-form search query
    */
-  export interface Openrouter {
-    /**
-     * Data-residency region (e.g. "us", "eu"). Empty uses the provider default.
-     */
-    region?: string;
-  }
-}
-
-export interface AIProviderCredentialAPIKey {
+  query?: string;
   /**
-   * CredentialAPIKey carries a single bearer/header API key.
+   * When true, return only promotional keys (provided by Cadenya, e.g. for
+   *  onboarding). Defaults to returning all keys, customer-provided and
+   *  promotional alike.
    */
-  apiKey: AIProviderCredentialAPIKey.APIKey;
-
-  type: 'apiKey';
-}
-
-export namespace AIProviderCredentialAPIKey {
+  promotional?: boolean;
   /**
-   * CredentialAPIKey carries a single bearer/header API key.
+   * 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).
    */
-  export interface APIKey {
-    apiKey?: string;
-  }
-}
-
-export interface AIProviderCredentialHeaders {
+  labels?: string;
   /**
-   * CredentialHeaders carries arbitrary HTTP headers sent with every request to the
-   * provider (e.g. {"Authorization": "Bearer ...", "X-Api-Key": "..."}).
+   * Sort order for results (asc or desc by creation time)
    */
-  headers: AIProviderCredentialHeaders.Headers;
-
-  type: 'headers';
-}
-
-export namespace AIProviderCredentialHeaders {
+  sortOrder?: string;
   /**
-   * CredentialHeaders carries arbitrary HTTP headers sent with every request to the
-   * provider (e.g. {"Authorization": "Bearer ...", "X-Api-Key": "..."}).
+   * When true, populate each item's info (model counts), at the cost of extra
+   *  lookups.
    */
-  export interface Headers {
-    headers?: { [key: string]: string };
-  }
+  includeInfo?: boolean;
 }
 
-/**
- * AIProviderKey is a credential for an AI provider, scoped to a workspace. Most
- * keys are customer-provided (BYOK); Cadenya also provisions promotional keys (see
- * AIProviderKeyInfo.is_promotional), which cannot be modified or deleted by
- * account administrators. The secret value is never returned in responses.
- */
-export interface AIProviderKey {
-  /**
-   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
-   */
-  metadata: Shared.ResourceMetadata;
-
+export interface AiProviderKeyCreateParams {
+  metadata: CreateResourceMetadata;
   spec: AIProviderKeySpec;
-
-  /**
-   * AIProviderKeyInfo carries server-derived, read-only details about a key, for AI
-   * provider management UIs.
-   */
-  info?: AIProviderKey.Info;
-}
-
-export namespace AIProviderKey {
-  /**
-   * AIProviderKeyInfo carries server-derived, read-only details about a key, for AI
-   * provider management UIs.
-   */
-  export interface Info {
-    /**
-     * Number of disabled models provisioned on this key.
-     */
-    disabledModelCount?: number;
-
-    /**
-     * Number of enabled models provisioned on this key.
-     */
-    enabledModelCount?: number;
-
-    /**
-     * Cadenya includes promotional keys (one for onboarding, and potentially more in
-     * the future). These are not added or maintained by account administrators.
-     */
-    isPromotional?: boolean;
-  }
-}
-
-export interface AIProviderKeySpec {
-  /**
-   * AIProviderConfig holds non-secret, provider-specific settings. The set case must
-   * correspond to AIProviderKeySpec.provider. Providers with no settings (Anthropic,
-   * Gemini) simply leave this unset. The endpoint of a named provider is fixed and
-   * intentionally not overridable here; use the OpenAI-compatible provider to target
-   * a custom endpoint.
-   */
-  config?: AIProviderConfigOpenrouter | AIProviderConfigOpenAI | AIProviderConfigOpenAICompatible;
-
   /**
-   * AIProviderCredential is the secret material used to authenticate with a
-   * provider. The set case must correspond to AIProviderKeySpec.provider. The server
-   * encrypts the serialized message at rest and never returns it on reads.
+   * The workspace that will own this key.
+   * 
+   * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */
-  credentials?: AIProviderCredentialAPIKey | AIProviderCredentialHeaders;
-
-  /**
-   * The AI provider this key authenticates against.
-   */
-  provider?:
-    | 'AI_PROVIDER_UNSPECIFIED'
-    | 'AI_PROVIDER_OPENROUTER'
-    | 'AI_PROVIDER_OPENAI'
-    | 'AI_PROVIDER_ANTHROPIC'
-    | 'AI_PROVIDER_GEMINI'
-    | 'AI_PROVIDER_OPENAI_COMPATIBLE';
+  workspaceId?: string;
 }
 
-export interface AIProviderKeyCreateParams {
+export interface AiProviderKeyRetrieveParams {
   /**
-   * Path param: The workspace that will own this key.
+   * The workspace the key belongs to.
+   * 
+   * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */
   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: AIProviderKeySpec;
 }
 
-export interface AIProviderKeyRetrieveParams {
+export interface AiProviderKeyDeleteParams {
   /**
    * The workspace the key belongs to.
+   * 
+   * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */
   workspaceId?: string;
 }
 
-export interface AIProviderKeyUpdateParams {
+export interface AiProviderKeyUpdateParams {
   /**
-   * Path param: The workspace the key belongs to.
+   * The workspace the key belongs to.
+   * 
+   * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */
   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
-   */
+  metadata?: UpdateResourceMetadata;
   spec?: AIProviderKeySpec;
-
   /**
-   * Body param: Fields to update.
+   * Fields to update.
    */
   updateMask?: string;
 }
 
-export interface AIProviderKeyListParams extends CursorPaginationParams {
-  /**
-   * Path param: The workspace whose keys will be listed.
-   */
-  workspaceId?: string;
-
-  /**
-   * Query param: When true, populate each item's info (model counts), at the cost of
-   * extra lookups.
-   */
-  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;
+export class AiProviderKeys {
+  constructor(private readonly _client: HttpClient) {}
 
   /**
-   * Query param: Filter expression (query param: prefix)
+   * List AI provider keys
+   * 
+   * @example
+   * ```ts
+   * const page = await client.aiProviderKeys.list();
+   * for await (const item of page) {
+   *   // auto-fetches every page
+   * }
+   * ```
    */
-  prefix?: string;
+  async list(params?: AiProviderKeyListParams, options?: RequestOptions): Promise<Page<AIProviderKey>> {
+    const workspaceId = String(params?.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
+    if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
+    const _base = snapshotParams(params);
+    const response = await this._client.request<ListAIProviderKeysResponse>({ method: 'GET', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/ai_provider_keys`, query: { limit: params?.limit, cursor: params?.cursor, prefix: params?.prefix, query: params?.query, promotional: params?.promotional, labels: params?.labels, sortOrder: params?.sortOrder, includeInfo: params?.includeInfo } }, options);
+    return new Page(response.items ?? [], response.pagination?.nextCursor, (cursor) => this.list({ ..._base, cursor: cursor }, options));
+  }
 
   /**
-   * Query param: When true, return only promotional keys (provided by Cadenya, e.g.
-   * for onboarding). Defaults to returning all keys, customer-provided and
-   * promotional alike.
+   * Create a new AI provider key
+   * 
+   * @example
+   * ```ts
+   * const aiProviderKey = await client.aiProviderKeys.create({ metadata: { name: 'sample' }, spec: {  } });
+   * ```
    */
-  promotional?: boolean;
+  create(params: AiProviderKeyCreateParams, options?: RequestOptions): APIPromise<AIProviderKey> {
+    return this._client.requestAPI<AIProviderKey>(() => {
+      const workspaceId = String(params.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
+      if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
+      return { method: 'POST', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/ai_provider_keys`, body: { metadata: params.metadata, spec: params.spec } };
+    }, options);
+  }
 
   /**
-   * Query param: Free-form search query
+   * Get an AI provider key by ID
+   * 
+   * @example
+   * ```ts
+   * const aiProviderKey = await client.aiProviderKeys.retrieve('_123');
+   * ```
    */
-  query?: string;
+  retrieve(id: string, params?: AiProviderKeyRetrieveParams, options?: RequestOptions): APIPromise<AIProviderKey> {
+    return this._client.requestAPI<AIProviderKey>(() => {
+      const workspaceId = String(params?.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
+      if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
+      return { method: 'GET', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/ai_provider_keys/${pathSegment('id', id)}` };
+    }, options);
+  }
 
   /**
-   * Query param: Sort order for results (asc or desc by creation time)
+   * Delete an AI provider key
+   * 
+   * @example
+   * ```ts
+   * await client.aiProviderKeys.delete('_123');
+   * ```
    */
-  sortOrder?: string;
-}
+  delete(id: string, params?: AiProviderKeyDeleteParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.requestAPI<void>(() => {
+      const workspaceId = String(params?.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
+      if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
+      return { method: 'DELETE', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/ai_provider_keys/${pathSegment('id', id)}`, void: true };
+    }, options);
+  }
 
-export interface AIProviderKeyDeleteParams {
   /**
-   * The workspace the key belongs to.
+   * Update an AI provider key
+   * 
+   * @example
+   * ```ts
+   * const aiProviderKey = await client.aiProviderKeys.update('_123');
+   * ```
    */
-  workspaceId?: string;
-}
-
-export declare namespace AIProviderKeys {
-  export {
-    type AIProviderConfigOpenAI as AIProviderConfigOpenAI,
-    type AIProviderConfigOpenAICompatible as AIProviderConfigOpenAICompatible,
-    type AIProviderConfigOpenrouter as AIProviderConfigOpenrouter,
-    type AIProviderCredentialAPIKey as AIProviderCredentialAPIKey,
-    type AIProviderCredentialHeaders as AIProviderCredentialHeaders,
-    type AIProviderKey as AIProviderKey,
-    type AIProviderKeySpec as AIProviderKeySpec,
-    type AIProviderKeysCursorPagination as AIProviderKeysCursorPagination,
-    type AIProviderKeyCreateParams as AIProviderKeyCreateParams,
-    type AIProviderKeyRetrieveParams as AIProviderKeyRetrieveParams,
-    type AIProviderKeyUpdateParams as AIProviderKeyUpdateParams,
-    type AIProviderKeyListParams as AIProviderKeyListParams,
-    type AIProviderKeyDeleteParams as AIProviderKeyDeleteParams,
-  };
+  update(id: string, params?: AiProviderKeyUpdateParams, options?: RequestOptions): APIPromise<AIProviderKey> {
+    return this._client.requestAPI<AIProviderKey>(() => {
+      const workspaceId = String(params?.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
+      if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
+      return { method: 'PATCH', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/ai_provider_keys/${pathSegment('id', id)}`, body: { metadata: params?.metadata, spec: params?.spec, updateMask: params?.updateMask } };
+    }, options);
+  }
 }