@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/teams/members.ts

@@ -0,0 +1,282 @@
+// 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 team
+   */
+  create(
+    teamID: string,
+    body: MemberCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<MemberCreateResponse> {
+    return this._client.post(path`/teams/${teamID}/members`, { body, ...options });
+  }
+
+  /**
+   * Update a team member's role and/or consumption limit
+   */
+  update(memberID: string, params: MemberUpdateParams, options?: RequestOptions): APIPromise<unknown> {
+    const { teamId, ...body } = params;
+    return this._client.put(path`/teams/${teamId}/members/${memberID}`, { body, ...options });
+  }
+
+  /**
+   * Remove a member from the team
+   */
+  delete(memberID: string, params: MemberDeleteParams, options?: RequestOptions): APIPromise<unknown> {
+    const { teamId } = params;
+    return this._client.delete(path`/teams/${teamId}/members/${memberID}`, options);
+  }
+}
+
+export interface MemberCreateResponse {
+  team: MemberCreateResponse.Team;
+}
+
+export namespace MemberCreateResponse {
+  export interface Team {
+    /**
+     * The team ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The context of the team for the current authenticated user
+     */
+    context: Team.Context;
+
+    /**
+     * The team creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The team name (example: "Scenario")
+     */
+    name: string;
+
+    /**
+     * The team plan
+     */
+    plan:
+      | 'cu-basic'
+      | 'cu-creator'
+      | 'cu-max'
+      | 'cu-pro'
+      | 'cu-pro-q3-25'
+      | 'cu-team'
+      | 'cu-team-v2'
+      | 'enterprise'
+      | 'essential'
+      | 'free'
+      | 'premium'
+      | 'pro';
+
+    /**
+     * Projects of the team
+     */
+    projects: Array<Team.Project>;
+
+    /**
+     * The team type
+     */
+    type: 'personal' | 'shared';
+
+    /**
+     * The team update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The team's avatar
+     */
+    avatar?: Team.Avatar;
+
+    /**
+     * BYOK pricing override. Admin-only — omitted for non-admin callers.
+     */
+    byok?: Team.Byok;
+
+    /**
+     * Team-wide default max consumption (CU) applied to every member over the billing
+     * period, unless overridden per member. Absent when no team-wide default is set.
+     */
+    defaultUserMaxConsumption?: number;
+
+    /**
+     * The IP detection enforcement posture for the team. 'disabled': IP detection is
+     * not performed. 'active-fail-open': IP detection runs; on detector error the
+     * request is allowed through. 'active-fail-closed': IP detection runs; on detector
+     * error the request is blocked.
+     */
+    ipDetectionEnforcement?: 'active-fail-closed' | 'active-fail-open' | 'disabled';
+
+    /**
+     * Quality Gate auto-detection default for the team.
+     */
+    qualityGateAutoDetect?: boolean;
+  }
+
+  export namespace Team {
+    /**
+     * The context of the team for the current authenticated user
+     */
+    export interface Context {
+      /**
+       * The number of invitations on this team
+       */
+      invitationsCount: number;
+
+      /**
+       * The number of API keys on this team
+       */
+      keysCount: number;
+
+      /**
+       * The authenticated user's role for this team
+       */
+      userRole: 'admin' | 'key' | 'member';
+
+      /**
+       * The number of users on this team
+       */
+      usersCount: number;
+    }
+
+    export interface Project {
+      id: string;
+
+      createdAt: string;
+
+      name: string;
+
+      updatedAt: string;
+
+      avatar?: Project.Avatar;
+
+      /**
+       * When true, IP detection is switched off for this project.
+       */
+      disableIpDetection?: boolean;
+
+      /**
+       * Whether Quality Gate auto-detection runs on generation for this project.
+       */
+      qualityGateAutoDetect?: boolean;
+    }
+
+    export namespace Project {
+      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 team'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;
+    }
+
+    /**
+     * BYOK pricing override. Admin-only — omitted for non-admin callers.
+     */
+    export interface Byok {
+      markupMultiplier: number;
+
+      /**
+       * ISO timestamp of the last update. Optional — legacy rows may lack it.
+       */
+      updatedAt?: string;
+
+      /**
+       * Human-readable handle of who last updated the markup (display name).
+       */
+      updatedBy?: string;
+    }
+  }
+}
+
+export type MemberUpdateResponse = unknown;
+
+export type MemberDeleteResponse = unknown;
+
+export interface MemberCreateParams {
+  /**
+   * The email of the user you want to add to your team
+   */
+  email: string;
+
+  /**
+   * The project IDs for which the user is invited
+   */
+  projectIds?: Array<string>;
+
+  /**
+   * The role you want to give the user
+   */
+  role?: 'admin' | 'member';
+}
+
+export interface MemberUpdateParams {
+  /**
+   * Path param: The team Id the member belongs to
+   */
+  teamId: string;
+
+  /**
+   * Body param: Max consumption (CU) for this member over the billing period,
+   * overriding the team-wide default. Use a value `>= 0` to cap, `-1` for unlimited
+   * (uncapped), or `null` to remove the override and fall back to the team-wide
+   * default.
+   */
+  maxConsumption?: number;
+
+  /**
+   * Body param: For a human member: a built-in team role (`admin` | `member`). For
+   * an API-key member: a team-plane role — a `;`-separated list of `team.*` scopes
+   * (e.g. `"team.members.manage;team.usage.read"`). Only a human team admin can
+   * grant a write scope; `team.members.manage` also lets a team key manage the
+   * members, API keys and consumption cap of every project of the team.
+   */
+  role?: string;
+}
+
+export interface MemberDeleteParams {
+  /**
+   * The team Id concerned by the member removal
+   */
+  teamId: 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,
+  };
+}