@scenario-labs/sdk 3.1.0 → 3.3.0

package/resources/teams/ip-filters.d.ts

@@ -0,0 +1,115 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class IPFilters extends APIResource {
+    /**
+     * Create a custom IP-detection filter for a team (built-in filters are toggled via
+     * PUT /teams/{teamId}/ip-filters/{filterId})
+     */
+    create(teamID: string, body: IPFilterCreateParams, options?: RequestOptions): APIPromise<IPFilterCreateResponse>;
+    /**
+     * Enable, disable, or override a built-in or custom IP-detection filter for a team
+     */
+    update(filterID: string, params: IPFilterUpdateParams, options?: RequestOptions): APIPromise<IPFilterUpdateResponse>;
+    /**
+     * List the built-in and custom IP-detection filters available to a team, with
+     * their enabled state
+     */
+    list(teamID: string, options?: RequestOptions): APIPromise<IPFilterListResponse>;
+    /**
+     * Delete a custom IP-detection filter for a team
+     */
+    delete(filterID: string, params: IPFilterDeleteParams, options?: RequestOptions): APIPromise<IPFilterDeleteResponse>;
+    /**
+     * Draft a custom IP-detection filter instruction from reference assets (the caller
+     * must have read access to every asset)
+     */
+    draftInstruction(teamID: string, body: IPFilterDraftInstructionParams, options?: RequestOptions): APIPromise<IPFilterDraftInstructionResponse>;
+}
+export interface IPFilterCreateResponse {
+    /**
+     * The created custom filter, including its enabled state
+     */
+    filter: unknown;
+}
+export interface IPFilterUpdateResponse {
+    /**
+     * The updated filter, including its enabled state
+     */
+    filter: unknown;
+}
+export interface IPFilterListResponse {
+    /**
+     * Built-in and custom IP-detection filters for the team, each with its enabled
+     * state
+     */
+    filters: Array<unknown>;
+}
+export interface IPFilterDeleteResponse {
+    /**
+     * True when the filter was deleted
+     */
+    deleted: boolean;
+}
+export interface IPFilterDraftInstructionResponse {
+    /**
+     * Drafted natural-language detection instruction derived from the reference assets
+     */
+    instruction: string;
+}
+export interface IPFilterCreateParams {
+    /**
+     * Filter category; use "custom" for customer-authored filters
+     */
+    category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+    /**
+     * Display name for the filter
+     */
+    name: string;
+    /**
+     * Whether the filter is active
+     */
+    enabled?: boolean;
+    /**
+     * Natural-language detection instruction (required for custom filters)
+     */
+    instruction?: string;
+    /**
+     * Optional reference assets used only to generate the instruction
+     */
+    sourceAssetIds?: Array<string>;
+}
+export interface IPFilterUpdateParams {
+    /**
+     * Path param: The team the filter belongs to
+     */
+    teamId: string;
+    /**
+     * Body param: Whether the filter is active
+     */
+    enabled?: boolean;
+    /**
+     * Body param: Natural-language detection instruction
+     */
+    instruction?: string;
+    /**
+     * Body param: Display name for the filter
+     */
+    name?: string;
+}
+export interface IPFilterDeleteParams {
+    /**
+     * The team the filter belongs to
+     */
+    teamId: string;
+}
+export interface IPFilterDraftInstructionParams {
+    /**
+     * Reference assets whose imagery seeds the drafted detection instruction
+     */
+    assetIds: Array<string>;
+}
+export declare namespace IPFilters {
+    export { 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, };
+}
+//# sourceMappingURL=ip-filters.d.ts.map

package/resources/teams/ip-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-filters.d.ts","sourceRoot":"","sources":["../../src/resources/teams/ip-filters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAKrC;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhF;;OAEG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAKrC;;;OAGG;IACH,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAGhD;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,cAAc,GAAG,iBAAiB,GAAG,oBAAoB,GAAG,QAAQ,GAAG,qBAAqB,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/teams/ip-filters.js

@@ -0,0 +1,45 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPFilters = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class IPFilters extends resource_1.APIResource {
+    /**
+     * Create a custom IP-detection filter for a team (built-in filters are toggled via
+     * PUT /teams/{teamId}/ip-filters/{filterId})
+     */
+    create(teamID, body, options) {
+        return this._client.post((0, path_1.path) `/teams/${teamID}/ip-filters`, { body, ...options });
+    }
+    /**
+     * Enable, disable, or override a built-in or custom IP-detection filter for a team
+     */
+    update(filterID, params, options) {
+        const { teamId, ...body } = params;
+        return this._client.put((0, path_1.path) `/teams/${teamId}/ip-filters/${filterID}`, { body, ...options });
+    }
+    /**
+     * List the built-in and custom IP-detection filters available to a team, with
+     * their enabled state
+     */
+    list(teamID, options) {
+        return this._client.get((0, path_1.path) `/teams/${teamID}/ip-filters`, options);
+    }
+    /**
+     * Delete a custom IP-detection filter for a team
+     */
+    delete(filterID, params, options) {
+        const { teamId } = params;
+        return this._client.delete((0, path_1.path) `/teams/${teamId}/ip-filters/${filterID}`, options);
+    }
+    /**
+     * Draft a custom IP-detection filter instruction from reference assets (the caller
+     * must have read access to every asset)
+     */
+    draftInstruction(teamID, body, options) {
+        return this._client.post((0, path_1.path) `/teams/${teamID}/ip-filters/draft-instruction`, { body, ...options });
+    }
+}
+exports.IPFilters = IPFilters;
+//# sourceMappingURL=ip-filters.js.map

package/resources/teams/ip-filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-filters.js","sourceRoot":"","sources":["../../src/resources/teams/ip-filters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;OAGG;IACH,MAAM,CACJ,MAAc,EACd,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,eAAe,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,aAAa,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAc,EACd,IAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;CACF;AAxDD,8BAwDC"}

package/resources/teams/ip-filters.mjs

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class IPFilters extends APIResource {
+    /**
+     * Create a custom IP-detection filter for a team (built-in filters are toggled via
+     * PUT /teams/{teamId}/ip-filters/{filterId})
+     */
+    create(teamID, body, options) {
+        return this._client.post(path `/teams/${teamID}/ip-filters`, { body, ...options });
+    }
+    /**
+     * Enable, disable, or override a built-in or custom IP-detection filter for a team
+     */
+    update(filterID, params, options) {
+        const { teamId, ...body } = params;
+        return this._client.put(path `/teams/${teamId}/ip-filters/${filterID}`, { body, ...options });
+    }
+    /**
+     * List the built-in and custom IP-detection filters available to a team, with
+     * their enabled state
+     */
+    list(teamID, options) {
+        return this._client.get(path `/teams/${teamID}/ip-filters`, options);
+    }
+    /**
+     * Delete a custom IP-detection filter for a team
+     */
+    delete(filterID, params, options) {
+        const { teamId } = params;
+        return this._client.delete(path `/teams/${teamId}/ip-filters/${filterID}`, options);
+    }
+    /**
+     * Draft a custom IP-detection filter instruction from reference assets (the caller
+     * must have read access to every asset)
+     */
+    draftInstruction(teamID, body, options) {
+        return this._client.post(path `/teams/${teamID}/ip-filters/draft-instruction`, { body, ...options });
+    }
+}
+//# sourceMappingURL=ip-filters.mjs.map

package/resources/teams/ip-filters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-filters.mjs","sourceRoot":"","sources":["../../src/resources/teams/ip-filters.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,MAAM,CACJ,MAAc,EACd,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,eAAe,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,aAAa,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,MAAM,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAc,EACd,IAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;CACF"}

package/resources/teams/members.d.mts

@@ -0,0 +1,204 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Members extends APIResource {
+    /**
+     * Add a member to the team
+     */
+    create(teamID: string, body: MemberCreateParams, options?: RequestOptions): APIPromise<MemberCreateResponse>;
+    /**
+     * Update a team member's role and/or consumption limit
+     */
+    update(memberID: string, params: MemberUpdateParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * Remove a member from the team
+     */
+    delete(memberID: string, params: MemberDeleteParams, options?: RequestOptions): APIPromise<unknown>;
+}
+export interface MemberCreateResponse {
+    team: MemberCreateResponse.Team;
+}
+export declare namespace MemberCreateResponse {
+    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;
+    }
+    namespace Team {
+        /**
+         * The context of the team for the current authenticated user
+         */
+        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;
+        }
+        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;
+        }
+        namespace Project {
+            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
+         */
+        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.
+         */
+        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, };
+}
+//# sourceMappingURL=members.d.mts.map

package/resources/teams/members.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"members.d.mts","sourceRoot":"","sources":["../../src/resources/teams/members.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKnG;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAIpG;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EACA,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,cAAc,GACd,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,CAAC;QAEV;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;QAE5B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;QAEjB;;;WAGG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;;;;WAKG;QACH,sBAAsB,CAAC,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,UAAU,CAAC;QAEhF;;WAEG;QACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;YAErC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,SAAS,EAAE,MAAM,CAAC;YAElB,IAAI,EAAE,MAAM,CAAC;YAEb,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;YAExB;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;SACjC;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;SACF;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/teams/members.d.ts

@@ -0,0 +1,204 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Members extends APIResource {
+    /**
+     * Add a member to the team
+     */
+    create(teamID: string, body: MemberCreateParams, options?: RequestOptions): APIPromise<MemberCreateResponse>;
+    /**
+     * Update a team member's role and/or consumption limit
+     */
+    update(memberID: string, params: MemberUpdateParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * Remove a member from the team
+     */
+    delete(memberID: string, params: MemberDeleteParams, options?: RequestOptions): APIPromise<unknown>;
+}
+export interface MemberCreateResponse {
+    team: MemberCreateResponse.Team;
+}
+export declare namespace MemberCreateResponse {
+    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;
+    }
+    namespace Team {
+        /**
+         * The context of the team for the current authenticated user
+         */
+        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;
+        }
+        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;
+        }
+        namespace Project {
+            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
+         */
+        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.
+         */
+        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, };
+}
+//# sourceMappingURL=members.d.ts.map

package/resources/teams/members.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"members.d.ts","sourceRoot":"","sources":["../../src/resources/teams/members.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKnG;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAIpG;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EACA,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,cAAc,GACd,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,CAAC;QAEV;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;QAE5B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;QAEjB;;;WAGG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;;;;WAKG;QACH,sBAAsB,CAAC,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,UAAU,CAAC;QAEhF;;WAEG;QACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;YAErC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,SAAS,EAAE,MAAM,CAAC;YAElB,IAAI,EAAE,MAAM,CAAC;YAEb,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;YAExB;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;SACjC;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;SACF;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/teams/members.js

@@ -0,0 +1,30 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Members = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Members extends resource_1.APIResource {
+    /**
+     * Add a member to the team
+     */
+    create(teamID, body, options) {
+        return this._client.post((0, path_1.path) `/teams/${teamID}/members`, { body, ...options });
+    }
+    /**
+     * Update a team member's role and/or consumption limit
+     */
+    update(memberID, params, options) {
+        const { teamId, ...body } = params;
+        return this._client.put((0, path_1.path) `/teams/${teamId}/members/${memberID}`, { body, ...options });
+    }
+    /**
+     * Remove a member from the team
+     */
+    delete(memberID, params, options) {
+        const { teamId } = params;
+        return this._client.delete((0, path_1.path) `/teams/${teamId}/members/${memberID}`, options);
+    }
+}
+exports.Members = Members;
+//# sourceMappingURL=members.js.map