boltz-api 0.30.3

package/src/resources/admin/workspaces.ts

@@ -0,0 +1,370 @@
+// 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';
+
+/**
+ * Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
+ */
+export class Workspaces extends APIResource {
+  /**
+   * Create a workspace
+   */
+  create(body: WorkspaceCreateParams, options?: RequestOptions): APIPromise<WorkspaceCreateResponse> {
+    return this._client.post('/compute/v1/admin/workspaces', { body, ...options });
+  }
+
+  /**
+   * Get a workspace
+   */
+  retrieve(workspaceID: string, options?: RequestOptions): APIPromise<WorkspaceRetrieveResponse> {
+    return this._client.get(path`/compute/v1/admin/workspaces/${workspaceID}`, options);
+  }
+
+  /**
+   * Update a workspace
+   */
+  update(
+    workspaceID: string,
+    body: WorkspaceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkspaceUpdateResponse> {
+    return this._client.post(path`/compute/v1/admin/workspaces/${workspaceID}`, { body, ...options });
+  }
+
+  /**
+   * List workspaces
+   */
+  list(
+    query: WorkspaceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WorkspaceListResponsesCursorPage, WorkspaceListResponse> {
+    return this._client.getAPIList('/compute/v1/admin/workspaces', CursorPage<WorkspaceListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Archives a workspace and deactivates all its API keys. This action is
+   * irreversible.
+   */
+  archive(workspaceID: string, options?: RequestOptions): APIPromise<WorkspaceArchiveResponse> {
+    return this._client.post(path`/compute/v1/admin/workspaces/${workspaceID}/archive`, options);
+  }
+}
+
+export type WorkspaceListResponsesCursorPage = CursorPage<WorkspaceListResponse>;
+
+export interface WorkspaceCreateResponse {
+  /**
+   * Workspace ID
+   */
+  id: string;
+
+  archived_at: string | null;
+
+  created_at: string;
+
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention: WorkspaceCreateResponse.DataRetention;
+
+  /**
+   * Whether this is the default workspace
+   */
+  is_default: boolean;
+
+  /**
+   * Workspace name
+   */
+  name: string | null;
+
+  updated_at: string;
+}
+
+export namespace WorkspaceCreateResponse {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceRetrieveResponse {
+  /**
+   * Workspace ID
+   */
+  id: string;
+
+  archived_at: string | null;
+
+  created_at: string;
+
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention: WorkspaceRetrieveResponse.DataRetention;
+
+  /**
+   * Whether this is the default workspace
+   */
+  is_default: boolean;
+
+  /**
+   * Workspace name
+   */
+  name: string | null;
+
+  updated_at: string;
+}
+
+export namespace WorkspaceRetrieveResponse {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceUpdateResponse {
+  /**
+   * Workspace ID
+   */
+  id: string;
+
+  archived_at: string | null;
+
+  created_at: string;
+
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention: WorkspaceUpdateResponse.DataRetention;
+
+  /**
+   * Whether this is the default workspace
+   */
+  is_default: boolean;
+
+  /**
+   * Workspace name
+   */
+  name: string | null;
+
+  updated_at: string;
+}
+
+export namespace WorkspaceUpdateResponse {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceListResponse {
+  /**
+   * Workspace ID
+   */
+  id: string;
+
+  archived_at: string | null;
+
+  created_at: string;
+
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention: WorkspaceListResponse.DataRetention;
+
+  /**
+   * Whether this is the default workspace
+   */
+  is_default: boolean;
+
+  /**
+   * Workspace name
+   */
+  name: string | null;
+
+  updated_at: string;
+}
+
+export namespace WorkspaceListResponse {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceArchiveResponse {
+  /**
+   * Workspace ID
+   */
+  id: string;
+
+  archived_at: string | null;
+
+  created_at: string;
+
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention: WorkspaceArchiveResponse.DataRetention;
+
+  /**
+   * Whether this is the default workspace
+   */
+  is_default: boolean;
+
+  /**
+   * Workspace name
+   */
+  name: string | null;
+
+  updated_at: string;
+}
+
+export namespace WorkspaceArchiveResponse {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceCreateParams {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention?: WorkspaceCreateParams.DataRetention;
+
+  /**
+   * Workspace name
+   */
+  name?: string;
+}
+
+export namespace WorkspaceCreateParams {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceUpdateParams {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  data_retention?: WorkspaceUpdateParams.DataRetention;
+
+  name?: string | null;
+}
+
+export namespace WorkspaceUpdateParams {
+  /**
+   * How long result data is retained before automatic deletion. Defaults to 7 days
+   * if not specified. Maximum retention is 14 days (336 hours).
+   */
+  export interface DataRetention {
+    /**
+     * Time unit for retention duration
+     */
+    unit: 'hours' | 'days';
+
+    /**
+     * Duration value. Maximum retention is 14 days (or 336 hours).
+     */
+    value: number;
+  }
+}
+
+export interface WorkspaceListParams extends CursorPageParams {}
+
+export declare namespace Workspaces {
+  export {
+    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,
+  };
+}

package/src/resources/admin.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './admin/index';

package/src/resources/auth.ts

@@ -0,0 +1,68 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+/**
+ * Inspect the authentication context for the current credential, including the organization or workspace scope for API keys and the available organization memberships for OAuth bearer tokens. OAuth callers can use this information to choose which organization to send with future requests.
+ */
+export class Auth extends APIResource {
+  /**
+   * Returns the organization context available to the current API key or OAuth
+   * bearer token. OAuth callers can use X-Boltz-Organization-Id to select one of
+   * their organizations.
+   *
+   * @example
+   * ```ts
+   * const response = await client.auth.me();
+   * ```
+   */
+  me(options?: RequestOptions): APIPromise<AuthMeResponse> {
+    return this._client.get('/compute/v1/auth/me', options);
+  }
+}
+
+export type AuthMeResponse = AuthMeResponse.AuthMeAPIKeyResponse | AuthMeResponse.AuthMeUserResponse;
+
+export namespace AuthMeResponse {
+  export interface AuthMeAPIKeyResponse {
+    api_key_id: string;
+
+    key_type: 'admin' | 'workspace';
+
+    mode: 'live' | 'test';
+
+    organization_id: string;
+
+    principal_type: 'api_key';
+
+    selected_organization_id: string;
+
+    workspace_id: string | null;
+  }
+
+  export interface AuthMeUserResponse {
+    active_organization_id: string | null;
+
+    organization_memberships: Array<AuthMeUserResponse.OrganizationMembership>;
+
+    principal_type: 'user';
+
+    selected_organization_id: string | null;
+
+    user_id: string;
+  }
+
+  export namespace AuthMeUserResponse {
+    export interface OrganizationMembership {
+      compute_role: 'admin' | 'member';
+
+      organization_id: string;
+    }
+  }
+}
+
+export declare namespace Auth {
+  export { type AuthMeResponse as AuthMeResponse };
+}

package/src/resources/cli.ts

@@ -0,0 +1,57 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+/**
+ * Check the installed boltz-api CLI version against the currently published CLI release and the minimum version supported by the Boltz API.
+ */
+export class Cli extends APIResource {
+  /**
+   * Returns public boltz-api CLI version metadata for lightweight update checks.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cli.version();
+   * ```
+   */
+  version(
+    query: CliVersionParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CliVersionResponse> {
+    return this._client.get('/compute/v1/cli/version', { query, ...options });
+  }
+}
+
+export interface CliVersionResponse {
+  install: CliVersionResponse.Install;
+
+  latest: string;
+
+  message: string | null;
+
+  minimum_supported: string;
+
+  update_available: boolean;
+
+  update_required: boolean;
+}
+
+export namespace CliVersionResponse {
+  export interface Install {
+    macos_linux: string;
+
+    windows: string;
+  }
+}
+
+export interface CliVersionParams {
+  current?: string;
+
+  platform?: string;
+}
+
+export declare namespace Cli {
+  export { type CliVersionResponse as CliVersionResponse, type CliVersionParams as CliVersionParams };
+}

package/src/resources/index.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Admin } from './admin/admin';
+export { Auth, type AuthMeResponse } from './auth';
+export { Cli, type CliVersionResponse, type CliVersionParams } from './cli';
+export { Predictions } from './predictions/predictions';
+export { Protein } from './protein/protein';
+export { SmallMolecule } from './small-molecule/small-molecule';

package/src/resources/predictions/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Predictions } from './predictions';
+export {
+  StructureAndBinding,
+  type StructureAndBindingRetrieveResponse,
+  type StructureAndBindingListResponse,
+  type StructureAndBindingDeleteDataResponse,
+  type StructureAndBindingEstimateCostResponse,
+  type StructureAndBindingStartResponse,
+  type StructureAndBindingRetrieveParams,
+  type StructureAndBindingListParams,
+  type StructureAndBindingEstimateCostParams,
+  type StructureAndBindingStartParams,
+  type StructureAndBindingListResponsesCursorPage,
+} from './structure-and-binding';

package/src/resources/predictions/predictions.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as StructureAndBindingAPI from './structure-and-binding';
+import {
+  StructureAndBinding,
+  StructureAndBindingDeleteDataResponse,
+  StructureAndBindingEstimateCostParams,
+  StructureAndBindingEstimateCostResponse,
+  StructureAndBindingListParams,
+  StructureAndBindingListResponse,
+  StructureAndBindingListResponsesCursorPage,
+  StructureAndBindingRetrieveParams,
+  StructureAndBindingRetrieveResponse,
+  StructureAndBindingStartParams,
+  StructureAndBindingStartResponse,
+} from './structure-and-binding';
+
+/**
+ * Run prediction models on molecular inputs. Each application is available as its own endpoint with application-specific inputs and outputs.
+ */
+export class Predictions extends APIResource {
+  structureAndBinding: StructureAndBindingAPI.StructureAndBinding =
+    new StructureAndBindingAPI.StructureAndBinding(this._client);
+}
+
+Predictions.StructureAndBinding = StructureAndBinding;
+
+export declare namespace Predictions {
+  export {
+    StructureAndBinding as StructureAndBinding,
+    type StructureAndBindingRetrieveResponse as StructureAndBindingRetrieveResponse,
+    type StructureAndBindingListResponse as StructureAndBindingListResponse,
+    type StructureAndBindingDeleteDataResponse as StructureAndBindingDeleteDataResponse,
+    type StructureAndBindingEstimateCostResponse as StructureAndBindingEstimateCostResponse,
+    type StructureAndBindingStartResponse as StructureAndBindingStartResponse,
+    type StructureAndBindingListResponsesCursorPage as StructureAndBindingListResponsesCursorPage,
+    type StructureAndBindingRetrieveParams as StructureAndBindingRetrieveParams,
+    type StructureAndBindingListParams as StructureAndBindingListParams,
+    type StructureAndBindingEstimateCostParams as StructureAndBindingEstimateCostParams,
+    type StructureAndBindingStartParams as StructureAndBindingStartParams,
+  };
+}