@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/teams/teams.ts

@@ -0,0 +1,1255 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BriefAPI from './brief';
+import {
+  Brief,
+  BriefDeleteResponse,
+  BriefRetrieveResponse,
+  BriefUpdateParams,
+  BriefUpdateResponse,
+} from './brief';
+import * as IPFiltersAPI from './ip-filters';
+import {
+  IPFilterCreateParams,
+  IPFilterCreateResponse,
+  IPFilterDeleteParams,
+  IPFilterDeleteResponse,
+  IPFilterDraftInstructionParams,
+  IPFilterDraftInstructionResponse,
+  IPFilterListResponse,
+  IPFilterUpdateParams,
+  IPFilterUpdateResponse,
+  IPFilters,
+} from './ip-filters';
+import * as MembersAPI from './members';
+import {
+  MemberCreateParams,
+  MemberCreateResponse,
+  MemberDeleteParams,
+  MemberDeleteResponse,
+  MemberUpdateParams,
+  MemberUpdateResponse,
+  Members,
+} from './members';
+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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
+
+export class Teams extends APIResource {
+  brief: BriefAPI.Brief = new BriefAPI.Brief(this._client);
+  ipFilters: IPFiltersAPI.IPFilters = new IPFiltersAPI.IPFilters(this._client);
+  members: MembersAPI.Members = new MembersAPI.Members(this._client);
+  watermark: WatermarkAPI.Watermark = new WatermarkAPI.Watermark(this._client);
+  webhookEndpoints: WebhookEndpointsAPI.WebhookEndpoints = new WebhookEndpointsAPI.WebhookEndpoints(
+    this._client,
+  );
+
+  /**
+   * Get the details of a team
+   */
+  retrieve(teamID: string, options?: RequestOptions): APIPromise<TeamRetrieveResponse> {
+    return this._client.get(path`/teams/${teamID}`, options);
+  }
+
+  /**
+   * Update a particular team
+   */
+  update(teamID: string, body: TeamUpdateParams, options?: RequestOptions): APIPromise<TeamUpdateResponse> {
+    return this._client.put(path`/teams/${teamID}`, { body, ...options });
+  }
+
+  /**
+   * List the teams the user belongs to
+   */
+  list(options?: RequestOptions): APIPromise<TeamListResponse> {
+    return this._client.get('/teams', options);
+  }
+
+  /**
+   * Withdraw a user invitation on the team
+   */
+  deleteInvitations(
+    teamID: string,
+    params: TeamDeleteInvitationsParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { email } = params;
+    return this._client.delete(path`/teams/${teamID}/invitations`, {
+      ...options,
+      query: { email, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Retrieve current limits for a team
+   */
+  retrieveLimits(teamID: string, options?: RequestOptions): APIPromise<TeamRetrieveLimitsResponse> {
+    return this._client.get(path`/teams/${teamID}/limits`, options);
+  }
+}
+
+export interface TeamRetrieveResponse {
+  team: TeamRetrieveResponse.Team;
+}
+
+export namespace TeamRetrieveResponse {
+  export interface Team {
+    /**
+     * The team ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The team creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The list of pending invitations
+     */
+    invitations: Array<Team.Invitation>;
+
+    /**
+     * The list of API keys
+     */
+    keys: Array<Team.Key>;
+
+    /**
+     * The team name (example: "Scenario")
+     */
+    name: string;
+
+    /**
+     * The paymentStatus for the team
+     */
+    paymentStatus: 'failed' | 'succeeded';
+
+    /**
+     * 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 search host for the team
+     */
+    searchHost: string;
+
+    /**
+     * The search indexes for the team
+     */
+    searchIndexes: Team.SearchIndexes;
+
+    /**
+     * The team type
+     */
+    type: 'personal' | 'shared';
+
+    /**
+     * The team update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The list of teams members and their role
+     */
+    users: Array<Team.User>;
+
+    /**
+     * 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;
+
+    /**
+     * Team settings. Returned on `GET` and `PUT /teams/{teamId}`, absent from the
+     * teams list.
+     */
+    settings?: Team.Settings;
+
+    /**
+     * The subscriptionStatus for the team
+     */
+    subscriptionStatus?: 'active' | 'inactive' | 'paused';
+  }
+
+  export namespace Team {
+    export interface Invitation {
+      /**
+       * The user creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+       */
+      createdAt: string;
+
+      /**
+       * The invited user email (example: "herve@scenario.com")
+       */
+      email: string;
+
+      /**
+       * The role of the invited user inside the team
+       */
+      role: 'admin' | 'key' | 'member';
+
+      /**
+       * The status of the invitation
+       */
+      status: 'accepted' | 'expired' | 'pending' | 'withdrawn';
+
+      /**
+       * The link the invited user opens to accept the invitation, as sent by email
+       */
+      url: string;
+
+      /**
+       * The list of project IDs for which the user is invited
+       */
+      projectIds?: Array<string>;
+    }
+
+    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;
+
+      /**
+       * 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>;
+
+      /**
+       * The key's role. For a TEAM key: its effective team-plane scopes as a
+       * `;`-separated list (e.g. `"team.read;team.usage.read"`). Project keys carry
+       * their project-plane role(s) per project in `projects` instead.
+       */
+      role?: string;
+    }
+
+    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 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 search indexes for the team
+     */
+    export interface SearchIndexes {
+      assets: SearchIndexes.Assets;
+
+      models: SearchIndexes.Models;
+
+      workflows: SearchIndexes.Workflows;
+    }
+
+    export namespace SearchIndexes {
+      export interface Assets {
+        /**
+         * The private search index for the team
+         */
+        private: string;
+
+        /**
+         * The public search index for the team
+         */
+        public: string;
+      }
+
+      export interface Models {
+        /**
+         * The private search index for the team
+         */
+        private: string;
+
+        /**
+         * The public search index for the team
+         */
+        public: string;
+      }
+
+      export interface Workflows {
+        /**
+         * The private search index for the team
+         */
+        private: string;
+
+        /**
+         * The public search index for the team
+         */
+        public: 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;
+
+      /**
+       * The role of the user inside the team
+       */
+      role: 'admin' | 'key' | 'member';
+
+      /**
+       * 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 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;
+    }
+
+    /**
+     * Team settings. Returned on `GET` and `PUT /teams/{teamId}`, absent from the
+     * teams list.
+     */
+    export interface Settings {
+      /**
+       * Published homepage layout.
+       */
+      homepage?: { [key: string]: unknown };
+    }
+  }
+}
+
+export interface TeamUpdateResponse {
+  /**
+   * The updated team.
+   */
+  team: TeamUpdateResponse.Team;
+}
+
+export namespace TeamUpdateResponse {
+  /**
+   * The updated team.
+   */
+  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;
+
+    /**
+     * Team settings.
+     */
+    settings?: Team.Settings;
+  }
+
+  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;
+    }
+
+    /**
+     * Team settings.
+     */
+    export interface Settings {
+      /**
+       * Published homepage layout.
+       */
+      homepage?: { [key: string]: unknown };
+    }
+  }
+}
+
+export interface TeamListResponse {
+  /**
+   * A list of the teams the user belongs to
+   */
+  teams: Array<TeamListResponse.Team>;
+}
+
+export namespace TeamListResponse {
+  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 TeamDeleteInvitationsResponse = unknown;
+
+export interface TeamRetrieveLimitsResponse {
+  /**
+   * The actual billing limits values related to the plan
+   */
+  limits: TeamRetrieveLimitsResponse.Limits;
+
+  /**
+   * The list of one-shot Compute Units
+   *
+   * Can be empty if the team has no one-shot Compute Units
+   */
+  oneShotCreativeUnits: Array<TeamRetrieveLimitsResponse.OneShotCreativeUnit>;
+
+  /**
+   * The actual billing period start and end dates ISO strings
+   */
+  period: TeamRetrieveLimitsResponse.Period;
+
+  /**
+   * The actual plan of the team
+   */
+  plan:
+    | 'cu-basic'
+    | 'cu-creator'
+    | 'cu-max'
+    | 'cu-pro'
+    | 'cu-pro-q3-25'
+    | 'cu-team'
+    | 'cu-team-v2'
+    | 'enterprise'
+    | 'essential'
+    | 'free'
+    | 'premium'
+    | 'pro';
+
+  /**
+   * The current value for each relevant limit in the billing period
+   */
+  values: TeamRetrieveLimitsResponse.Values;
+}
+
+export namespace TeamRetrieveLimitsResponse {
+  /**
+   * The actual billing limits values related to the plan
+   */
+  export interface Limits {
+    apiKeys: number;
+
+    canvasAssetLayers: number;
+
+    canvasAssets: number;
+
+    collections: number;
+
+    /**
+     * The amount of Compute Units available for the plan
+     */
+    creativeUnits: number;
+
+    defaultSeats: number;
+
+    downloadAssets: number;
+
+    downloadModel: number;
+
+    inferenceBatchSize: number;
+
+    /**
+     * The maximum cooldown applied in case of over head
+     */
+    maxCooldown: number;
+
+    maxTrainingDatasets: number;
+
+    /**
+     * The minimum cooldown applied in case of over head
+     */
+    minCooldown: number;
+
+    /**
+     * The maximum models a project can have (train/upload/copy/transfer/...)
+     */
+    models: number;
+
+    OTPSessions: number;
+
+    parallelCustomJobs: number;
+
+    parallelInferences: number;
+
+    parallelTraining: number;
+
+    parallelWorkflowRuns: number;
+
+    premiumGenerationSamples: number;
+
+    /**
+     * The maximum projects a team can have
+     */
+    projects: number;
+
+    scalingFactor: number;
+
+    seats: number;
+
+    snapshotsRetention: number;
+
+    upload: number;
+  }
+
+  export interface OneShotCreativeUnit {
+    /**
+     * The Compute Units amount bought
+     */
+    amount: number;
+
+    /**
+     * The creation date of the Compute Units (buy date) ISO string
+     */
+    createdAt: string;
+
+    /**
+     * The expiration date of the Compute Units ISO string
+     */
+    expiration: string;
+
+    /**
+     * The remaining Compute Units available
+     */
+    remaining: number;
+
+    /**
+     * The last update date of the Compute Units (use date) ISO string
+     */
+    updatedAt: string;
+  }
+
+  /**
+   * The actual billing period start and end dates ISO strings
+   */
+  export interface Period {
+    end: string;
+
+    start: string;
+  }
+
+  /**
+   * The current value for each relevant limit in the billing period
+   */
+  export interface Values {
+    apiKeys: number;
+
+    canvasAssets: number;
+
+    collections: number;
+
+    creativeUnits: number;
+
+    projects: number;
+
+    seats: number;
+  }
+}
+
+export interface TeamUpdateParams {
+  /**
+   * The team's avatar asset ID (must be kind image)
+   */
+  avatarAssetId?: string;
+
+  /**
+   * Team-wide default max consumption (CU) applied to every member over the billing
+   * period, overridable per member. Set to null to remove the default.
+   */
+  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';
+
+  /**
+   * The team name (example: "Scenario")
+   */
+  name?: string;
+
+  /**
+   * Enable Quality Gate auto-detection on generation for this team (projects can
+   * override). Set to null to clear the default.
+   */
+  qualityGateAutoDetect?: boolean;
+
+  /**
+   * Team settings. Set `homepage` to a layout object to publish it, or to `null` to
+   * unpublish it. Team-admin only.
+   */
+  settings?: TeamUpdateParams.Settings;
+}
+
+export namespace TeamUpdateParams {
+  /**
+   * Team settings. Set `homepage` to a layout object to publish it, or to `null` to
+   * unpublish it. Team-admin only.
+   */
+  export interface Settings {
+    /**
+     * Homepage layout. An object publishes it; `null` unpublishes it.
+     */
+    homepage?: unknown;
+  }
+}
+
+export interface TeamDeleteInvitationsParams {
+  /**
+   * The invitation email to withdraw from the team
+   */
+  email: string;
+}
+
+Teams.Brief = Brief;
+Teams.IPFilters = IPFilters;
+Teams.Members = Members;
+Teams.Watermark = Watermark;
+Teams.WebhookEndpoints = WebhookEndpoints;
+
+export declare namespace Teams {
+  export {
+    type TeamRetrieveResponse as TeamRetrieveResponse,
+    type TeamUpdateResponse as TeamUpdateResponse,
+    type TeamListResponse as TeamListResponse,
+    type TeamDeleteInvitationsResponse as TeamDeleteInvitationsResponse,
+    type TeamRetrieveLimitsResponse as TeamRetrieveLimitsResponse,
+    type TeamUpdateParams as TeamUpdateParams,
+    type TeamDeleteInvitationsParams as TeamDeleteInvitationsParams,
+  };
+
+  export {
+    Brief as Brief,
+    type BriefRetrieveResponse as BriefRetrieveResponse,
+    type BriefUpdateResponse as BriefUpdateResponse,
+    type BriefDeleteResponse as BriefDeleteResponse,
+    type BriefUpdateParams as BriefUpdateParams,
+  };
+
+  export {
+    IPFilters as IPFilters,
+    type IPFilterCreateResponse as IPFilterCreateResponse,
+    type IPFilterUpdateResponse as IPFilterUpdateResponse,
+    type IPFilterListResponse as IPFilterListResponse,
+    type IPFilterDeleteResponse as IPFilterDeleteResponse,
+    type IPFilterDraftInstructionResponse as IPFilterDraftInstructionResponse,
+    type IPFilterCreateParams as IPFilterCreateParams,
+    type IPFilterUpdateParams as IPFilterUpdateParams,
+    type IPFilterDeleteParams as IPFilterDeleteParams,
+    type IPFilterDraftInstructionParams as IPFilterDraftInstructionParams,
+  };
+
+  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 {
+    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,
+  };
+}