@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/projects/projects.ts

@@ -0,0 +1,1478 @@
+// 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,
+  APIKeyDeleteParams,
+  APIKeyDeleteResponse,
+  APIKeys,
+} from './api-keys';
+import * as BriefAPI from './brief';
+import {
+  Brief,
+  BriefDeleteResponse,
+  BriefRetrieveResponse,
+  BriefUpdateParams,
+  BriefUpdateResponse,
+} from './brief';
+import * as InstructionsAPI from './instructions';
+import {
+  InstructionRetrieveResponse,
+  InstructionUpdateParams,
+  InstructionUpdateResponse,
+  Instructions,
+} from './instructions';
+import * as MembersAPI from './members';
+import {
+  MemberCreateParams,
+  MemberCreateResponse,
+  MemberDeleteParams,
+  MemberDeleteResponse,
+  MemberUpdateParams,
+  MemberUpdateResponse,
+  Members,
+} from './members';
+import * as MemoryAPI from './memory';
+import { Memory, MemoryRetrieveResponse, MemoryUpdateParams, MemoryUpdateResponse } from './memory';
+import * as WatermarkAPI from './watermark';
+import {
+  Watermark,
+  WatermarkDeleteLogoResponse,
+  WatermarkDeleteResponse,
+  WatermarkPreviewParams,
+  WatermarkPreviewResponse,
+  WatermarkRetrieveResponse,
+  WatermarkUpdateLogoParams,
+  WatermarkUpdateLogoResponse,
+  WatermarkUpdateParams,
+  WatermarkUpdateResponse,
+} from './watermark';
+import * as WebhookEndpointsAPI from './webhook-endpoints/webhook-endpoints';
+import {
+  WebhookEndpointCreateParams,
+  WebhookEndpointCreateResponse,
+  WebhookEndpointDeleteParams,
+  WebhookEndpointDeleteResponse,
+  WebhookEndpointListResponse,
+  WebhookEndpointUpdateParams,
+  WebhookEndpointUpdateResponse,
+  WebhookEndpoints,
+} from './webhook-endpoints/webhook-endpoints';
+import { APIPromise } from '../../core/api-promise';
+import { PagePromise, ProjectsCursor, type ProjectsCursorParams } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
+
+export class Projects extends APIResource {
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+  brief: BriefAPI.Brief = new BriefAPI.Brief(this._client);
+  instructions: InstructionsAPI.Instructions = new InstructionsAPI.Instructions(this._client);
+  members: MembersAPI.Members = new MembersAPI.Members(this._client);
+  memory: MemoryAPI.Memory = new MemoryAPI.Memory(this._client);
+  watermark: WatermarkAPI.Watermark = new WatermarkAPI.Watermark(this._client);
+  webhookEndpoints: WebhookEndpointsAPI.WebhookEndpoints = new WebhookEndpointsAPI.WebhookEndpoints(
+    this._client,
+  );
+
+  /**
+   * Create a new project
+   */
+  create(params: ProjectCreateParams, options?: RequestOptions): APIPromise<ProjectCreateResponse> {
+    const { teamId, ...body } = params;
+    return this._client.post('/projects', {
+      body,
+      ...options,
+      query: { teamId, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Get a project by projectId
+   */
+  retrieve(projectID: string, options?: RequestOptions): APIPromise<ProjectRetrieveResponse> {
+    return this._client.get(path`/projects/${projectID}`, options);
+  }
+
+  /**
+   * Update the name of a Project
+   */
+  update(
+    projectID: string,
+    body: ProjectUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectUpdateResponse> {
+    return this._client.put(path`/projects/${projectID}`, { body, ...options });
+  }
+
+  /**
+   * List projects of a team
+   */
+  list(
+    query: ProjectListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectListResponsesProjectsCursor, ProjectListResponse> {
+    return this._client.getAPIList('/projects', ProjectsCursor<ProjectListResponse>, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Delete a particular project
+   */
+  delete(projectID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/projects/${projectID}`, options);
+  }
+}
+
+export type ProjectListResponsesProjectsCursor = ProjectsCursor<ProjectListResponse>;
+
+export interface ProjectCreateResponse {
+  project: ProjectCreateResponse.Project;
+}
+
+export namespace ProjectCreateResponse {
+  export interface Project {
+    /**
+     * The project ID (example: "project_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    createdAt: string;
+
+    /**
+     * The keys of the project (get from the ProjectRoles table)
+     */
+    keys: Array<Project.Key>;
+
+    /**
+     * The project name (example: "Default Project")
+     */
+    name: string;
+
+    /**
+     * Whether the project is privacyMode In a privacyMode project, users can only see
+     * their own generated assets (except admins)
+     */
+    privacyMode: boolean;
+
+    /**
+     * The team ID (example: "team_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    teamId: string;
+
+    updatedAt: string;
+
+    /**
+     * The users of the project (get from the ProjectRoles table)
+     */
+    users: Array<Project.User>;
+
+    /**
+     * The project's avatar
+     */
+    avatar?: Project.Avatar;
+
+    /**
+     * Consumption (CU) used by this project over the current billing period.
+     */
+    consumption?: number;
+
+    /**
+     * High-level markdown description of the project Only returned on single project
+     * GET, not on list
+     */
+    description?: string;
+
+    /**
+     * ISO string date when the description was last updated Only returned on single
+     * project GET, not on list
+     */
+    descriptionDate?: string;
+
+    /**
+     * When true, IP detection is switched off for this project even if the team has an
+     * active posture. Absent means the team posture applies. The posture itself
+     * (disabled / active-fail-open / active-fail-closed) is a team-level setting, see
+     * the team's ipDetectionEnforcement.
+     */
+    disableIpDetection?: boolean;
+
+    /**
+     * The project's consumption (CU) cap for the period. Absent when uncapped.
+     */
+    maxConsumption?: number;
+
+    /**
+     * Whether Quality Gate auto-detection runs on generation for this project.
+     */
+    qualityGateAutoDetect?: boolean;
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    settings?: Project.Settings;
+  }
+
+  export namespace Project {
+    export interface Key {
+      /**
+       * The key's member id (its API user id, `apiu_...`), taken by the member and usage
+       * routes (example: "apiu_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The API key id (`api_...`), taken by the api-keys routes (example:
+       * "api_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      apiKeyId: string;
+
+      /**
+       * The status of the API key
+       */
+      apiKeyStatus: 'active' | 'inactive';
+
+      /**
+       * The API key creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The API key name (example: "eurv-scenario")
+       */
+      name: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The scope of the API key: 'project' for project-scoped keys, 'team' for
+       * team-scoped keys
+       */
+      scope: 'project' | 'team';
+
+      /**
+       * The API key last update date as an ISO string (example:
+       * "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The member who created the key: a human, or the member id (`apiu_...`) of the
+       * team API key that created it.
+       */
+      authorId?: string;
+
+      /**
+       * Consumption (CU) used by this key over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The date the API key was last used to authenticate a request, as an ISO string
+       * (example: "2023-02-03T11:19:41.579Z"). Absent if the key has never been used.
+       */
+      lastUsedAt?: string;
+
+      /**
+       * The key's effective consumption (CU) cap for the period (per-key override, else
+       * the team-wide default). Absent when the key is uncapped.
+       */
+      maxConsumption?: number;
+
+      /**
+       * For a PROJECT key: the project it was created on (the team id on some legacy
+       * keys). Absent for team keys.
+       */
+      ownerId?: string;
+
+      /**
+       * For a PROJECT key: the projects it has access to and its role on each. Empty
+       * when the key is currently not a member of any (live) project. Absent for team
+       * keys.
+       */
+      projects?: Array<Key.Project>;
+    }
+
+    export namespace Key {
+      /**
+       * A project a `project`-scoped API key has access to, with its role on that
+       * project. A key can be granted roles on several projects, potentially with
+       * different roles — one entry per project.
+       */
+      export interface Project {
+        /**
+         * The project the key has a role on
+         */
+        projectId: string;
+
+        /**
+         * The key's role on this project: a built-in role (`admin`/`editor`/`reader`) or a
+         * custom `;`-separated scope list (example: `"asset.read;model.read"`).
+         */
+        role: string;
+      }
+    }
+
+    export interface User {
+      /**
+       * The user ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The user email (example: "herve@scenario.com")
+       */
+      email: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The user last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The user's avatar
+       */
+      avatar?: User.Avatar;
+
+      /**
+       * Consumption (CU) used by this member over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The member's effective consumption (CU) cap for the period (per-user override,
+       * else the team-wide default). Absent when the member is uncapped.
+       */
+      maxConsumption?: number;
+    }
+
+    export namespace User {
+      /**
+       * The user's avatar
+       */
+      export interface Avatar {
+        /**
+         * ID of the asset used as thumbnail if provided, otherwise undefined
+         */
+        assetId?: string;
+
+        /**
+         * Signed URL of the assetId or free url if assetId is undefined
+         */
+        url?: string;
+      }
+    }
+
+    /**
+     * The project's avatar
+     */
+    export interface Avatar {
+      /**
+       * ID of the asset used as thumbnail if provided, otherwise undefined
+       */
+      assetId?: string;
+
+      /**
+       * Signed URL of the assetId or free url if assetId is undefined
+       */
+      url?: string;
+    }
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    export interface Settings {
+      /**
+       * Published homepage layout.
+       */
+      homepage?: { [key: string]: unknown };
+    }
+  }
+}
+
+export interface ProjectRetrieveResponse {
+  project: ProjectRetrieveResponse.Project;
+}
+
+export namespace ProjectRetrieveResponse {
+  export interface Project {
+    /**
+     * The project ID (example: "project_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    createdAt: string;
+
+    /**
+     * The keys of the project (get from the ProjectRoles table)
+     */
+    keys: Array<Project.Key>;
+
+    /**
+     * The project name (example: "Default Project")
+     */
+    name: string;
+
+    /**
+     * Whether the project is privacyMode In a privacyMode project, users can only see
+     * their own generated assets (except admins)
+     */
+    privacyMode: boolean;
+
+    /**
+     * The team ID (example: "team_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    teamId: string;
+
+    updatedAt: string;
+
+    /**
+     * The users of the project (get from the ProjectRoles table)
+     */
+    users: Array<Project.User>;
+
+    /**
+     * The project's avatar
+     */
+    avatar?: Project.Avatar;
+
+    /**
+     * Consumption (CU) used by this project over the current billing period.
+     */
+    consumption?: number;
+
+    /**
+     * High-level markdown description of the project Only returned on single project
+     * GET, not on list
+     */
+    description?: string;
+
+    /**
+     * ISO string date when the description was last updated Only returned on single
+     * project GET, not on list
+     */
+    descriptionDate?: string;
+
+    /**
+     * When true, IP detection is switched off for this project even if the team has an
+     * active posture. Absent means the team posture applies. The posture itself
+     * (disabled / active-fail-open / active-fail-closed) is a team-level setting, see
+     * the team's ipDetectionEnforcement.
+     */
+    disableIpDetection?: boolean;
+
+    /**
+     * The project's consumption (CU) cap for the period. Absent when uncapped.
+     */
+    maxConsumption?: number;
+
+    /**
+     * Whether Quality Gate auto-detection runs on generation for this project.
+     */
+    qualityGateAutoDetect?: boolean;
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    settings?: Project.Settings;
+  }
+
+  export namespace Project {
+    export interface Key {
+      /**
+       * The key's member id (its API user id, `apiu_...`), taken by the member and usage
+       * routes (example: "apiu_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The API key id (`api_...`), taken by the api-keys routes (example:
+       * "api_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      apiKeyId: string;
+
+      /**
+       * The status of the API key
+       */
+      apiKeyStatus: 'active' | 'inactive';
+
+      /**
+       * The API key creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The API key name (example: "eurv-scenario")
+       */
+      name: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The scope of the API key: 'project' for project-scoped keys, 'team' for
+       * team-scoped keys
+       */
+      scope: 'project' | 'team';
+
+      /**
+       * The API key last update date as an ISO string (example:
+       * "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The member who created the key: a human, or the member id (`apiu_...`) of the
+       * team API key that created it.
+       */
+      authorId?: string;
+
+      /**
+       * Consumption (CU) used by this key over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The date the API key was last used to authenticate a request, as an ISO string
+       * (example: "2023-02-03T11:19:41.579Z"). Absent if the key has never been used.
+       */
+      lastUsedAt?: string;
+
+      /**
+       * The key's effective consumption (CU) cap for the period (per-key override, else
+       * the team-wide default). Absent when the key is uncapped.
+       */
+      maxConsumption?: number;
+
+      /**
+       * For a PROJECT key: the project it was created on (the team id on some legacy
+       * keys). Absent for team keys.
+       */
+      ownerId?: string;
+
+      /**
+       * For a PROJECT key: the projects it has access to and its role on each. Empty
+       * when the key is currently not a member of any (live) project. Absent for team
+       * keys.
+       */
+      projects?: Array<Key.Project>;
+    }
+
+    export namespace Key {
+      /**
+       * A project a `project`-scoped API key has access to, with its role on that
+       * project. A key can be granted roles on several projects, potentially with
+       * different roles — one entry per project.
+       */
+      export interface Project {
+        /**
+         * The project the key has a role on
+         */
+        projectId: string;
+
+        /**
+         * The key's role on this project: a built-in role (`admin`/`editor`/`reader`) or a
+         * custom `;`-separated scope list (example: `"asset.read;model.read"`).
+         */
+        role: string;
+      }
+    }
+
+    export interface User {
+      /**
+       * The user ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The user email (example: "herve@scenario.com")
+       */
+      email: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The user last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The user's avatar
+       */
+      avatar?: User.Avatar;
+
+      /**
+       * Consumption (CU) used by this member over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The member's effective consumption (CU) cap for the period (per-user override,
+       * else the team-wide default). Absent when the member is uncapped.
+       */
+      maxConsumption?: number;
+    }
+
+    export namespace User {
+      /**
+       * The user's avatar
+       */
+      export interface Avatar {
+        /**
+         * ID of the asset used as thumbnail if provided, otherwise undefined
+         */
+        assetId?: string;
+
+        /**
+         * Signed URL of the assetId or free url if assetId is undefined
+         */
+        url?: string;
+      }
+    }
+
+    /**
+     * The project's avatar
+     */
+    export interface Avatar {
+      /**
+       * ID of the asset used as thumbnail if provided, otherwise undefined
+       */
+      assetId?: string;
+
+      /**
+       * Signed URL of the assetId or free url if assetId is undefined
+       */
+      url?: string;
+    }
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    export interface Settings {
+      /**
+       * Published homepage layout.
+       */
+      homepage?: { [key: string]: unknown };
+    }
+  }
+}
+
+export interface ProjectUpdateResponse {
+  project: ProjectUpdateResponse.Project;
+}
+
+export namespace ProjectUpdateResponse {
+  export interface Project {
+    /**
+     * The project ID (example: "project_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    createdAt: string;
+
+    /**
+     * The keys of the project (get from the ProjectRoles table)
+     */
+    keys: Array<Project.Key>;
+
+    /**
+     * The project name (example: "Default Project")
+     */
+    name: string;
+
+    /**
+     * Whether the project is privacyMode In a privacyMode project, users can only see
+     * their own generated assets (except admins)
+     */
+    privacyMode: boolean;
+
+    /**
+     * The team ID (example: "team_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    teamId: string;
+
+    updatedAt: string;
+
+    /**
+     * The users of the project (get from the ProjectRoles table)
+     */
+    users: Array<Project.User>;
+
+    /**
+     * The project's avatar
+     */
+    avatar?: Project.Avatar;
+
+    /**
+     * Consumption (CU) used by this project over the current billing period.
+     */
+    consumption?: number;
+
+    /**
+     * High-level markdown description of the project Only returned on single project
+     * GET, not on list
+     */
+    description?: string;
+
+    /**
+     * ISO string date when the description was last updated Only returned on single
+     * project GET, not on list
+     */
+    descriptionDate?: string;
+
+    /**
+     * When true, IP detection is switched off for this project even if the team has an
+     * active posture. Absent means the team posture applies. The posture itself
+     * (disabled / active-fail-open / active-fail-closed) is a team-level setting, see
+     * the team's ipDetectionEnforcement.
+     */
+    disableIpDetection?: boolean;
+
+    /**
+     * The project's consumption (CU) cap for the period. Absent when uncapped.
+     */
+    maxConsumption?: number;
+
+    /**
+     * Whether Quality Gate auto-detection runs on generation for this project.
+     */
+    qualityGateAutoDetect?: boolean;
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    settings?: Project.Settings;
+  }
+
+  export namespace Project {
+    export interface Key {
+      /**
+       * The key's member id (its API user id, `apiu_...`), taken by the member and usage
+       * routes (example: "apiu_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The API key id (`api_...`), taken by the api-keys routes (example:
+       * "api_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      apiKeyId: string;
+
+      /**
+       * The status of the API key
+       */
+      apiKeyStatus: 'active' | 'inactive';
+
+      /**
+       * The API key creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The API key name (example: "eurv-scenario")
+       */
+      name: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The scope of the API key: 'project' for project-scoped keys, 'team' for
+       * team-scoped keys
+       */
+      scope: 'project' | 'team';
+
+      /**
+       * The API key last update date as an ISO string (example:
+       * "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The member who created the key: a human, or the member id (`apiu_...`) of the
+       * team API key that created it.
+       */
+      authorId?: string;
+
+      /**
+       * Consumption (CU) used by this key over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The date the API key was last used to authenticate a request, as an ISO string
+       * (example: "2023-02-03T11:19:41.579Z"). Absent if the key has never been used.
+       */
+      lastUsedAt?: string;
+
+      /**
+       * The key's effective consumption (CU) cap for the period (per-key override, else
+       * the team-wide default). Absent when the key is uncapped.
+       */
+      maxConsumption?: number;
+
+      /**
+       * For a PROJECT key: the project it was created on (the team id on some legacy
+       * keys). Absent for team keys.
+       */
+      ownerId?: string;
+
+      /**
+       * For a PROJECT key: the projects it has access to and its role on each. Empty
+       * when the key is currently not a member of any (live) project. Absent for team
+       * keys.
+       */
+      projects?: Array<Key.Project>;
+    }
+
+    export namespace Key {
+      /**
+       * A project a `project`-scoped API key has access to, with its role on that
+       * project. A key can be granted roles on several projects, potentially with
+       * different roles — one entry per project.
+       */
+      export interface Project {
+        /**
+         * The project the key has a role on
+         */
+        projectId: string;
+
+        /**
+         * The key's role on this project: a built-in role (`admin`/`editor`/`reader`) or a
+         * custom `;`-separated scope list (example: `"asset.read;model.read"`).
+         */
+        role: string;
+      }
+    }
+
+    export interface User {
+      /**
+       * The user ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The user email (example: "herve@scenario.com")
+       */
+      email: string;
+
+      /**
+       * A project role value. Accepted values are:
+       *
+       * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+       * - a custom inline role: a `;`-separated scope list, e.g.
+       *   `"assets.write;workflows.run"`.
+       *
+       * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+       */
+      role: string;
+
+      /**
+       * The user last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      updatedAt: string;
+
+      /**
+       * The user's avatar
+       */
+      avatar?: User.Avatar;
+
+      /**
+       * Consumption (CU) used by this member over the current billing period.
+       */
+      consumption?: number;
+
+      /**
+       * The member's effective consumption (CU) cap for the period (per-user override,
+       * else the team-wide default). Absent when the member is uncapped.
+       */
+      maxConsumption?: number;
+    }
+
+    export namespace User {
+      /**
+       * The user's avatar
+       */
+      export interface Avatar {
+        /**
+         * ID of the asset used as thumbnail if provided, otherwise undefined
+         */
+        assetId?: string;
+
+        /**
+         * Signed URL of the assetId or free url if assetId is undefined
+         */
+        url?: string;
+      }
+    }
+
+    /**
+     * The project's avatar
+     */
+    export interface Avatar {
+      /**
+       * ID of the asset used as thumbnail if provided, otherwise undefined
+       */
+      assetId?: string;
+
+      /**
+       * Signed URL of the assetId or free url if assetId is undefined
+       */
+      url?: string;
+    }
+
+    /**
+     * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+     * the projects list.
+     */
+    export interface Settings {
+      /**
+       * Published homepage layout.
+       */
+      homepage?: { [key: string]: unknown };
+    }
+  }
+}
+
+export interface ProjectListResponse {
+  /**
+   * The project ID (example: "project_eyVcnFJcR92BxBkz7N6g5w")
+   */
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * The keys of the project (get from the ProjectRoles table)
+   */
+  keys: Array<ProjectListResponse.Key>;
+
+  /**
+   * The project name (example: "Default Project")
+   */
+  name: string;
+
+  /**
+   * Whether the project is privacyMode In a privacyMode project, users can only see
+   * their own generated assets (except admins)
+   */
+  privacyMode: boolean;
+
+  /**
+   * The team ID (example: "team_eyVcnFJcR92BxBkz7N6g5w")
+   */
+  teamId: string;
+
+  updatedAt: string;
+
+  /**
+   * The users of the project (get from the ProjectRoles table)
+   */
+  users: Array<ProjectListResponse.User>;
+
+  /**
+   * The project's avatar
+   */
+  avatar?: ProjectListResponse.Avatar;
+
+  /**
+   * Consumption (CU) used by this project over the current billing period.
+   */
+  consumption?: number;
+
+  /**
+   * High-level markdown description of the project Only returned on single project
+   * GET, not on list
+   */
+  description?: string;
+
+  /**
+   * ISO string date when the description was last updated Only returned on single
+   * project GET, not on list
+   */
+  descriptionDate?: string;
+
+  /**
+   * When true, IP detection is switched off for this project even if the team has an
+   * active posture. Absent means the team posture applies. The posture itself
+   * (disabled / active-fail-open / active-fail-closed) is a team-level setting, see
+   * the team's ipDetectionEnforcement.
+   */
+  disableIpDetection?: boolean;
+
+  /**
+   * The project's consumption (CU) cap for the period. Absent when uncapped.
+   */
+  maxConsumption?: number;
+
+  /**
+   * Whether Quality Gate auto-detection runs on generation for this project.
+   */
+  qualityGateAutoDetect?: boolean;
+
+  /**
+   * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+   * the projects list.
+   */
+  settings?: ProjectListResponse.Settings;
+}
+
+export namespace ProjectListResponse {
+  export interface Key {
+    /**
+     * The key's member id (its API user id, `apiu_...`), taken by the member and usage
+     * routes (example: "apiu_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The API key id (`api_...`), taken by the api-keys routes (example:
+     * "api_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    apiKeyId: string;
+
+    /**
+     * The status of the API key
+     */
+    apiKeyStatus: 'active' | 'inactive';
+
+    /**
+     * The API key creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The API key name (example: "eurv-scenario")
+     */
+    name: string;
+
+    /**
+     * A project role value. Accepted values are:
+     *
+     * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+     * - a custom inline role: a `;`-separated scope list, e.g.
+     *   `"assets.write;workflows.run"`.
+     *
+     * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+     */
+    role: string;
+
+    /**
+     * The scope of the API key: 'project' for project-scoped keys, 'team' for
+     * team-scoped keys
+     */
+    scope: 'project' | 'team';
+
+    /**
+     * The API key last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The member who created the key: a human, or the member id (`apiu_...`) of the
+     * team API key that created it.
+     */
+    authorId?: string;
+
+    /**
+     * Consumption (CU) used by this key over the current billing period.
+     */
+    consumption?: number;
+
+    /**
+     * The date the API key was last used to authenticate a request, as an ISO string
+     * (example: "2023-02-03T11:19:41.579Z"). Absent if the key has never been used.
+     */
+    lastUsedAt?: string;
+
+    /**
+     * The key's effective consumption (CU) cap for the period (per-key override, else
+     * the team-wide default). Absent when the key is uncapped.
+     */
+    maxConsumption?: number;
+
+    /**
+     * For a PROJECT key: the project it was created on (the team id on some legacy
+     * keys). Absent for team keys.
+     */
+    ownerId?: string;
+
+    /**
+     * For a PROJECT key: the projects it has access to and its role on each. Empty
+     * when the key is currently not a member of any (live) project. Absent for team
+     * keys.
+     */
+    projects?: Array<Key.Project>;
+  }
+
+  export namespace Key {
+    /**
+     * A project a `project`-scoped API key has access to, with its role on that
+     * project. A key can be granted roles on several projects, potentially with
+     * different roles — one entry per project.
+     */
+    export interface Project {
+      /**
+       * The project the key has a role on
+       */
+      projectId: string;
+
+      /**
+       * The key's role on this project: a built-in role (`admin`/`editor`/`reader`) or a
+       * custom `;`-separated scope list (example: `"asset.read;model.read"`).
+       */
+      role: string;
+    }
+  }
+
+  export interface User {
+    /**
+     * The user ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The user email (example: "herve@scenario.com")
+     */
+    email: string;
+
+    /**
+     * A project role value. Accepted values are:
+     *
+     * - a built-in role: `"admin"`, `"editor"` or `"reader"` (see `ProjectRoles`);
+     * - a custom inline role: a `;`-separated scope list, e.g.
+     *   `"assets.write;workflows.run"`.
+     *
+     * Resolved to capabilities by `ProjectRole.scopesFromRole()`.
+     */
+    role: string;
+
+    /**
+     * The user last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The user's avatar
+     */
+    avatar?: User.Avatar;
+
+    /**
+     * Consumption (CU) used by this member over the current billing period.
+     */
+    consumption?: number;
+
+    /**
+     * The member's effective consumption (CU) cap for the period (per-user override,
+     * else the team-wide default). Absent when the member is uncapped.
+     */
+    maxConsumption?: number;
+  }
+
+  export namespace User {
+    /**
+     * The user's avatar
+     */
+    export interface Avatar {
+      /**
+       * ID of the asset used as thumbnail if provided, otherwise undefined
+       */
+      assetId?: string;
+
+      /**
+       * Signed URL of the assetId or free url if assetId is undefined
+       */
+      url?: string;
+    }
+  }
+
+  /**
+   * The project's avatar
+   */
+  export interface Avatar {
+    /**
+     * ID of the asset used as thumbnail if provided, otherwise undefined
+     */
+    assetId?: string;
+
+    /**
+     * Signed URL of the assetId or free url if assetId is undefined
+     */
+    url?: string;
+  }
+
+  /**
+   * Project settings. Returned on `GET` and `PUT /projects/{projectId}`, absent from
+   * the projects list.
+   */
+  export interface Settings {
+    /**
+     * Published homepage layout.
+     */
+    homepage?: { [key: string]: unknown };
+  }
+}
+
+export type ProjectDeleteResponse = unknown;
+
+export interface ProjectCreateParams {
+  /**
+   * Body param: The name of the project.
+   */
+  name: string;
+
+  /**
+   * Query param: The teamId used for ownership resource management. Either to assert
+   * ownership or to set the owner of the resource(s)
+   */
+  teamId?: string;
+
+  /**
+   * Body param: Whether to automatically join the project as admin.
+   */
+  autoJoin?: boolean;
+
+  /**
+   * Body param: Whether to create the project in privacyMode. Default is false.
+   */
+  privacyMode?: boolean;
+}
+
+export interface ProjectUpdateParams {
+  /**
+   * The project's avatar asset ID (must be kind image)
+   */
+  avatarAssetId?: string;
+
+  /**
+   * High-level markdown description of the project Set to null to clear the
+   * description
+   */
+  description?: string;
+
+  /**
+   * Switch IP detection off for this project only. The team's posture (see PUT
+   * /teams/{teamId}) applies to every project by default; set this to true to opt
+   * this project out of it, false to opt it back in. A project cannot choose a
+   * posture of its own. Team-admin only.
+   */
+  disableIpDetection?: boolean;
+
+  /**
+   * Max consumption (CU) for this project over the billing period. Set to null to
+   * remove the cap. Team admins only, or a team API key holding
+   * `team.members.manage`, which may then send this field alone.
+   */
+  maxConsumption?: number;
+
+  /**
+   * The project name (example: "Default Project")
+   */
+  name?: string;
+
+  /**
+   * Toggle the privacyMode mode When enabled, users can only see their own generated
+   * assets (except admins)
+   */
+  privacyMode?: boolean;
+
+  /**
+   * Quality Gate auto-detection override for this project (wins over the team
+   * default). Set to null to clear the override.
+   */
+  qualityGateAutoDetect?: boolean;
+
+  /**
+   * Project settings. Set `homepage` to a layout object to publish it, or to `null`
+   * to unpublish it. Team admins and project admins only.
+   */
+  settings?: ProjectUpdateParams.Settings;
+}
+
+export namespace ProjectUpdateParams {
+  /**
+   * Project settings. Set `homepage` to a layout object to publish it, or to `null`
+   * to unpublish it. Team admins and project admins only.
+   */
+  export interface Settings {
+    /**
+     * Homepage layout. An object publishes it; `null` unpublishes it.
+     */
+    homepage?: unknown;
+  }
+}
+
+export interface ProjectListParams extends ProjectsCursorParams {
+  /**
+   * The number of items to return in the response. The default value is 10, maximum
+   * value is 100, minimum value is 1
+   */
+  pageSize?: number;
+
+  /**
+   * The teamId used for ownership resource management. Either to assert ownership or
+   * to set the owner of the resource(s)
+   */
+  teamId?: string;
+}
+
+Projects.APIKeys = APIKeys;
+Projects.Brief = Brief;
+Projects.Instructions = Instructions;
+Projects.Members = Members;
+Projects.Memory = Memory;
+Projects.Watermark = Watermark;
+Projects.WebhookEndpoints = WebhookEndpoints;
+
+export declare namespace Projects {
+  export {
+    type ProjectCreateResponse as ProjectCreateResponse,
+    type ProjectRetrieveResponse as ProjectRetrieveResponse,
+    type ProjectUpdateResponse as ProjectUpdateResponse,
+    type ProjectListResponse as ProjectListResponse,
+    type ProjectDeleteResponse as ProjectDeleteResponse,
+    type ProjectListResponsesProjectsCursor as ProjectListResponsesProjectsCursor,
+    type ProjectCreateParams as ProjectCreateParams,
+    type ProjectUpdateParams as ProjectUpdateParams,
+    type ProjectListParams as ProjectListParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyDeleteParams as APIKeyDeleteParams,
+  };
+
+  export {
+    Brief as Brief,
+    type BriefRetrieveResponse as BriefRetrieveResponse,
+    type BriefUpdateResponse as BriefUpdateResponse,
+    type BriefDeleteResponse as BriefDeleteResponse,
+    type BriefUpdateParams as BriefUpdateParams,
+  };
+
+  export {
+    Instructions as Instructions,
+    type InstructionRetrieveResponse as InstructionRetrieveResponse,
+    type InstructionUpdateResponse as InstructionUpdateResponse,
+    type InstructionUpdateParams as InstructionUpdateParams,
+  };
+
+  export {
+    Members as Members,
+    type MemberCreateResponse as MemberCreateResponse,
+    type MemberUpdateResponse as MemberUpdateResponse,
+    type MemberDeleteResponse as MemberDeleteResponse,
+    type MemberCreateParams as MemberCreateParams,
+    type MemberUpdateParams as MemberUpdateParams,
+    type MemberDeleteParams as MemberDeleteParams,
+  };
+
+  export {
+    Memory as Memory,
+    type MemoryRetrieveResponse as MemoryRetrieveResponse,
+    type MemoryUpdateResponse as MemoryUpdateResponse,
+    type MemoryUpdateParams as MemoryUpdateParams,
+  };
+
+  export {
+    Watermark as Watermark,
+    type WatermarkRetrieveResponse as WatermarkRetrieveResponse,
+    type WatermarkUpdateResponse as WatermarkUpdateResponse,
+    type WatermarkDeleteResponse as WatermarkDeleteResponse,
+    type WatermarkDeleteLogoResponse as WatermarkDeleteLogoResponse,
+    type WatermarkPreviewResponse as WatermarkPreviewResponse,
+    type WatermarkUpdateLogoResponse as WatermarkUpdateLogoResponse,
+    type WatermarkUpdateParams as WatermarkUpdateParams,
+    type WatermarkPreviewParams as WatermarkPreviewParams,
+    type WatermarkUpdateLogoParams as WatermarkUpdateLogoParams,
+  };
+
+  export {
+    WebhookEndpoints as WebhookEndpoints,
+    type WebhookEndpointCreateResponse as WebhookEndpointCreateResponse,
+    type WebhookEndpointUpdateResponse as WebhookEndpointUpdateResponse,
+    type WebhookEndpointListResponse as WebhookEndpointListResponse,
+    type WebhookEndpointDeleteResponse as WebhookEndpointDeleteResponse,
+    type WebhookEndpointCreateParams as WebhookEndpointCreateParams,
+    type WebhookEndpointUpdateParams as WebhookEndpointUpdateParams,
+    type WebhookEndpointDeleteParams as WebhookEndpointDeleteParams,
+  };
+}