@scenario-labs/sdk 3.2.0 → 3.3.1

package/src/resources/projects/members.ts

@@ -0,0 +1,958 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+export class Members extends APIResource {
+  /**
+   * Add a member to the project
+   */
+  create(
+    projectID: string,
+    body: MemberCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<MemberCreateResponse> {
+    return this._client.post(path`/projects/${projectID}/members`, { body, ...options });
+  }
+
+  /**
+   * Change a member role
+   */
+  update(
+    memberID: string,
+    params: MemberUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<MemberUpdateResponse> {
+    const { projectId, ...body } = params;
+    return this._client.put(path`/projects/${projectId}/members/${memberID}`, { body, ...options });
+  }
+
+  /**
+   * Remove a member from the project
+   */
+  delete(
+    memberID: string,
+    params: MemberDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<MemberDeleteResponse> {
+    const { projectId } = params;
+    return this._client.delete(path`/projects/${projectId}/members/${memberID}`, options);
+  }
+}
+
+export interface MemberCreateResponse {
+  project: MemberCreateResponse.Project;
+}
+
+export namespace MemberCreateResponse {
+  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 MemberUpdateResponse {
+  project: MemberUpdateResponse.Project;
+}
+
+export namespace MemberUpdateResponse {
+  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 MemberDeleteResponse {
+  project: MemberDeleteResponse.Project;
+}
+
+export namespace MemberDeleteResponse {
+  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 MemberCreateParams {
+  /**
+   * The role you want to give the user
+   */
+  role: string;
+
+  /**
+   * The userId of the user you want to add to your project
+   */
+  userId: string;
+}
+
+export interface MemberUpdateParams {
+  /**
+   * Path param: The project Id concerned by the role change
+   */
+  projectId: string;
+
+  /**
+   * Body param: The role you want to give the member
+   */
+  role?: string;
+}
+
+export interface MemberDeleteParams {
+  /**
+   * The project Id concerned by the member removal
+   */
+  projectId: string;
+}
+
+export declare namespace Members {
+  export {
+    type MemberCreateResponse as MemberCreateResponse,
+    type MemberUpdateResponse as MemberUpdateResponse,
+    type MemberDeleteResponse as MemberDeleteResponse,
+    type MemberCreateParams as MemberCreateParams,
+    type MemberUpdateParams as MemberUpdateParams,
+    type MemberDeleteParams as MemberDeleteParams,
+  };
+}