boltz-api 0.30.3

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { BoltzError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new BoltzError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new BoltzError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new BoltzError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new BoltzError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new BoltzError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';
+export * from './utils/query';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/admin/admin.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from './api-keys';
+import {
+  APIKeyCreateParams,
+  APIKeyCreateResponse,
+  APIKeyListParams,
+  APIKeyListResponse,
+  APIKeyListResponsesCursorPage,
+  APIKeyRevokeResponse,
+  APIKeys,
+} from './api-keys';
+import * as UsageAPI from './usage';
+import { Usage, UsageListParams, UsageListResponse, UsageListResponsesOpaqueCursorPage } from './usage';
+import * as WorkspacesAPI from './workspaces';
+import {
+  WorkspaceArchiveResponse,
+  WorkspaceCreateParams,
+  WorkspaceCreateResponse,
+  WorkspaceListParams,
+  WorkspaceListResponse,
+  WorkspaceListResponsesCursorPage,
+  WorkspaceRetrieveResponse,
+  WorkspaceUpdateParams,
+  WorkspaceUpdateResponse,
+  Workspaces,
+} from './workspaces';
+
+/**
+ * Manage workspaces and API keys. Requires an admin API key. Admin keys have full access to all management and compute operations across all workspaces in the organization.
+ */
+export class Admin extends APIResource {
+  workspaces: WorkspacesAPI.Workspaces = new WorkspacesAPI.Workspaces(this._client);
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
+}
+
+Admin.Workspaces = Workspaces;
+Admin.APIKeys = APIKeys;
+Admin.Usage = Usage;
+
+export declare namespace Admin {
+  export {
+    Workspaces as Workspaces,
+    type WorkspaceCreateResponse as WorkspaceCreateResponse,
+    type WorkspaceRetrieveResponse as WorkspaceRetrieveResponse,
+    type WorkspaceUpdateResponse as WorkspaceUpdateResponse,
+    type WorkspaceListResponse as WorkspaceListResponse,
+    type WorkspaceArchiveResponse as WorkspaceArchiveResponse,
+    type WorkspaceListResponsesCursorPage as WorkspaceListResponsesCursorPage,
+    type WorkspaceCreateParams as WorkspaceCreateParams,
+    type WorkspaceUpdateParams as WorkspaceUpdateParams,
+    type WorkspaceListParams as WorkspaceListParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyRevokeResponse as APIKeyRevokeResponse,
+    type APIKeyListResponsesCursorPage as APIKeyListResponsesCursorPage,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
+
+  export {
+    Usage as Usage,
+    type UsageListResponse as UsageListResponse,
+    type UsageListResponsesOpaqueCursorPage as UsageListResponsesOpaqueCursorPage,
+    type UsageListParams as UsageListParams,
+  };
+}

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

@@ -0,0 +1,233 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * API keys authenticate requests to the Boltz API. There are two key types: admin keys have full access to all management and compute operations across the organization, while workspace keys are scoped to a single workspace and can only perform compute operations (predictions, protein design, small molecule design) within that workspace. Keys can be created in live or test mode. Test keys (prefixed `sk_bc_*_test_`) create test-mode resources with synthetic data and no GPU cost. Every resource includes a `livemode` field indicating its mode.
+ */
+export class APIKeys extends APIResource {
+  /**
+   * Create a workspace API key
+   */
+  create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse> {
+    return this._client.post('/compute/v1/admin/api-keys', { body, ...options });
+  }
+
+  /**
+   * List API keys
+   */
+  list(
+    query: APIKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<APIKeyListResponsesCursorPage, APIKeyListResponse> {
+    return this._client.getAPIList('/compute/v1/admin/api-keys', CursorPage<APIKeyListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Revoke an API key
+   */
+  revoke(apiKeyID: string, options?: RequestOptions): APIPromise<APIKeyRevokeResponse> {
+    return this._client.post(path`/compute/v1/admin/api-keys/${apiKeyID}/revoke`, options);
+  }
+}
+
+export type APIKeyListResponsesCursorPage = CursorPage<APIKeyListResponse>;
+
+export interface APIKeyCreateResponse {
+  /**
+   * The full API key. This is only shown once — store it securely.
+   */
+  key: string;
+
+  key_details: APIKeyCreateResponse.KeyDetails;
+}
+
+export namespace APIKeyCreateResponse {
+  export interface KeyDetails {
+    /**
+     * API key ID
+     */
+    id: string;
+
+    /**
+     * IP addresses allowed to use this key. An empty array means all IPs are allowed.
+     */
+    allowed_ips: Array<string>;
+
+    created_at: string;
+
+    /**
+     * When the key expires. Null if the key does not expire.
+     */
+    expires_at: string | null;
+
+    is_active: boolean;
+
+    /**
+     * First 12 characters of the key
+     */
+    key_prefix: string;
+
+    key_type: 'workspace';
+
+    last_used_at: string | null;
+
+    /**
+     * Whether this is a live API key (false for test keys).
+     */
+    livemode: boolean;
+
+    /**
+     * API key name
+     */
+    name: string;
+
+    /**
+     * Workspace this key is scoped to
+     */
+    workspace_id: string;
+  }
+}
+
+export interface APIKeyListResponse {
+  /**
+   * API key ID
+   */
+  id: string;
+
+  /**
+   * IP addresses allowed to use this key. An empty array means all IPs are allowed.
+   */
+  allowed_ips: Array<string>;
+
+  created_at: string;
+
+  /**
+   * When the key expires. Null if the key does not expire.
+   */
+  expires_at: string | null;
+
+  is_active: boolean;
+
+  /**
+   * First 12 characters of the key
+   */
+  key_prefix: string;
+
+  key_type: 'admin' | 'workspace';
+
+  last_used_at: string | null;
+
+  /**
+   * Whether this is a live API key (false for test keys).
+   */
+  livemode: boolean;
+
+  /**
+   * API key name
+   */
+  name: string;
+
+  /**
+   * Workspace ID if workspace-scoped
+   */
+  workspace_id: string | null;
+}
+
+export interface APIKeyRevokeResponse {
+  /**
+   * API key ID
+   */
+  id: string;
+
+  /**
+   * IP addresses allowed to use this key. An empty array means all IPs are allowed.
+   */
+  allowed_ips: Array<string>;
+
+  created_at: string;
+
+  /**
+   * When the key expires. Null if the key does not expire.
+   */
+  expires_at: string | null;
+
+  is_active: boolean;
+
+  /**
+   * First 12 characters of the key
+   */
+  key_prefix: string;
+
+  key_type: 'admin' | 'workspace';
+
+  last_used_at: string | null;
+
+  /**
+   * Whether this is a live API key (false for test keys).
+   */
+  livemode: boolean;
+
+  /**
+   * API key name
+   */
+  name: string;
+
+  /**
+   * Workspace ID if workspace-scoped
+   */
+  workspace_id: string | null;
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * API key name
+   */
+  name: string;
+
+  /**
+   * IP addresses allowed to use this key (IPv4 or IPv6). An empty array (the
+   * default) means all IPs are allowed.
+   */
+  allowed_ips?: Array<string>;
+
+  /**
+   * Days until the key expires. Omit for a key that does not expire.
+   */
+  expires_in_days?: number;
+
+  /**
+   * Key mode. Test keys create test-mode resources with synthetic data.
+   */
+  mode?: 'live' | 'test';
+
+  /**
+   * Workspace ID to scope this key to. Omit for default workspace.
+   */
+  workspace_id?: string;
+}
+
+export interface APIKeyListParams extends CursorPageParams {
+  /**
+   * Filter by workspace ID. If not provided, returns keys across all workspaces.
+   */
+  workspace_id?: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyRevokeResponse as APIKeyRevokeResponse,
+    type APIKeyListResponsesCursorPage as APIKeyListResponsesCursorPage,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
+}

package/src/resources/admin/index.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  APIKeys,
+  type APIKeyCreateResponse,
+  type APIKeyListResponse,
+  type APIKeyRevokeResponse,
+  type APIKeyCreateParams,
+  type APIKeyListParams,
+  type APIKeyListResponsesCursorPage,
+} from './api-keys';
+export { Admin } from './admin';
+export {
+  Usage,
+  type UsageListResponse,
+  type UsageListParams,
+  type UsageListResponsesOpaqueCursorPage,
+} from './usage';
+export {
+  Workspaces,
+  type WorkspaceCreateResponse,
+  type WorkspaceRetrieveResponse,
+  type WorkspaceUpdateResponse,
+  type WorkspaceListResponse,
+  type WorkspaceArchiveResponse,
+  type WorkspaceCreateParams,
+  type WorkspaceUpdateParams,
+  type WorkspaceListParams,
+  type WorkspaceListResponsesCursorPage,
+} from './workspaces';

package/src/resources/admin/usage.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { OpaqueCursorPage, type OpaqueCursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Retrieve aggregated usage data for the organization. Usage can be grouped by workspace and/or application, and filtered by time range, workspace, and application.
+ */
+export class Usage extends APIResource {
+  /**
+   * Retrieve aggregated usage data across the organization, optionally grouped by
+   * workspace and/or application.
+   */
+  list(
+    query: UsageListParams,
+    options?: RequestOptions,
+  ): PagePromise<UsageListResponsesOpaqueCursorPage, UsageListResponse> {
+    return this._client.getAPIList('/compute/v1/admin/usage', OpaqueCursorPage<UsageListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type UsageListResponsesOpaqueCursorPage = OpaqueCursorPage<UsageListResponse>;
+
+export interface UsageListResponse {
+  end_time: string;
+
+  /**
+   * Aggregated billed quantity for this bucket
+   */
+  quantity: number;
+
+  start_time: string;
+
+  application?:
+    | 'structure_and_binding'
+    | 'small_molecule_design'
+    | 'small_molecule_library_screen'
+    | 'protein_design'
+    | 'protein_library_screen'
+    | 'adme';
+
+  /**
+   * Present when grouped by workspace_id
+   */
+  workspace_id?: string;
+}
+
+export interface UsageListParams extends OpaqueCursorPageParams {
+  /**
+   * End of the time range as an ISO 8601 date-time with timezone, for example
+   * 2026-04-08T18:56:46Z
+   */
+  ending_at: string;
+
+  /**
+   * Start of the time range as an ISO 8601 date-time with timezone, for example
+   * 2026-04-08T18:56:46Z
+   */
+  starting_at: string;
+
+  /**
+   * Time window size. HOUR supports up to 31 days per query; DAY supports up to 365
+   * days per query.
+   */
+  window_size: 'HOUR' | 'DAY';
+
+  /**
+   * Filter to specific applications
+   */
+  'applications[]'?:
+    | 'structure_and_binding'
+    | 'small_molecule_design'
+    | 'small_molecule_library_screen'
+    | 'protein_design'
+    | 'protein_library_screen'
+    | 'adme'
+    | Array<
+        | 'structure_and_binding'
+        | 'small_molecule_design'
+        | 'small_molecule_library_screen'
+        | 'protein_design'
+        | 'protein_library_screen'
+        | 'adme'
+      >;
+
+  /**
+   * Group results by workspace_id and/or application
+   */
+  'group_by[]'?: 'workspace_id' | 'application' | Array<'workspace_id' | 'application'>;
+
+  /**
+   * Filter to specific workspace IDs
+   */
+  'workspace_ids[]'?: string | Array<string>;
+}
+
+export declare namespace Usage {
+  export {
+    type UsageListResponse as UsageListResponse,
+    type UsageListResponsesOpaqueCursorPage as UsageListResponsesOpaqueCursorPage,
+    type UsageListParams as UsageListParams,
+  };
+}