@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/models/training-images.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 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 TrainingImages extends APIResource {
   /**
@@ -16,8 +17,8 @@ export class TrainingImages extends APIResource {
   ): APIPromise<unknown> {
     const { modelId, projectId } = params;
     return this._client.delete(path`/models/${modelId}/training-images/${trainingImageID}`, {
-      query: { projectId },
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -31,9 +32,9 @@ export class TrainingImages extends APIResource {
   ): APIPromise<TrainingImageAddResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/training-images`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -47,9 +48,9 @@ export class TrainingImages extends APIResource {
   ): APIPromise<TrainingImageReplaceResponse> {
     const { modelId, originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelId}/training-images/${trainingImageID}`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -63,9 +64,9 @@ export class TrainingImages extends APIResource {
   ): APIPromise<TrainingImageReplacePairsResponse> {
     const { body, projectId } = params;
     return this._client.put(path`/models/${modelID}/training-images/pairs`, {
-      query: { projectId },
       body: body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 }

package/src/resources/projects/api-keys.ts

@@ -0,0 +1,86 @@
+// 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 APIKeys extends APIResource {
+  /**
+   * Create an API key for a particular project
+   */
+  create(
+    projectID: string,
+    body: APIKeyCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<APIKeyCreateResponse> {
+    return this._client.post(path`/projects/${projectID}/api-keys`, { body, ...options });
+  }
+
+  /**
+   * Delete a particular api key
+   */
+  delete(keyID: string, params: APIKeyDeleteParams, options?: RequestOptions): APIPromise<unknown> {
+    const { projectId } = params;
+    return this._client.delete(path`/projects/${projectId}/api-keys/${keyID}`, options);
+  }
+}
+
+export interface APIKeyCreateResponse {
+  id: string;
+
+  authorId: string;
+
+  createdAt: string;
+
+  ownerType: 'project' | 'team';
+
+  secret: string;
+
+  /**
+   * The key's member id (`apiu_...`), taken by the member routes; the api-keys
+   * routes take `id`.
+   */
+  userId: string;
+
+  ownerId?: string;
+
+  teamId?: string;
+}
+
+export type APIKeyDeleteResponse = unknown;
+
+export interface APIKeyCreateParams {
+  /**
+   * Optional spending cap (CU) for this key over the billing period: a value >= 0 to
+   * cap, or -1 for unlimited. Omit to inherit the default.
+   */
+  maxConsumption?: number;
+
+  /**
+   * The API Key name
+   */
+  name?: string;
+
+  /**
+   * Project role: a built-in role (admin | editor | reader) or a custom inline
+   * ";"-separated scope list (e.g. "assets.read;workflows.run"). Defaults to editor.
+   */
+  role?: string;
+}
+
+export interface APIKeyDeleteParams {
+  /**
+   * The project Id on which the api key exists
+   */
+  projectId: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyDeleteParams as APIKeyDeleteParams,
+  };
+}

package/src/resources/projects/brief.ts

@@ -0,0 +1,197 @@
+// 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 Brief extends APIResource {
+  /**
+   * Get the project's Quality Gate brief
+   */
+  retrieve(projectID: string, options?: RequestOptions): APIPromise<BriefRetrieveResponse> {
+    return this._client.get(path`/projects/${projectID}/brief`, options);
+  }
+
+  /**
+   * Create or update the project's Quality Gate brief
+   */
+  update(
+    projectID: string,
+    body: BriefUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<BriefUpdateResponse> {
+    return this._client.put(path`/projects/${projectID}/brief`, { body, ...options });
+  }
+
+  /**
+   * Delete the project's Quality Gate brief
+   */
+  delete(projectID: string, options?: RequestOptions): APIPromise<BriefDeleteResponse> {
+    return this._client.delete(path`/projects/${projectID}/brief`, options);
+  }
+}
+
+export interface BriefRetrieveResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  brief: BriefRetrieveResponse.Brief;
+}
+
+export namespace BriefRetrieveResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  export interface Brief {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * Free-text brief: brand style, rules, campaign context
+     */
+    body: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the brief
+     */
+    createdBy: string;
+
+    /**
+     * Whether the brief is applied during verification
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this brief applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Reference assets the verifier compares the image against
+     */
+    referenceAssetIds: Array<string>;
+
+    /**
+     * The id of the team or project that owns this brief
+     */
+    scopeId: string;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Threshold strictness applied when verifying against this scope
+     */
+    sensitivity?: 'high' | 'low' | 'medium';
+  }
+}
+
+export interface BriefUpdateResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  brief: BriefUpdateResponse.Brief;
+}
+
+export namespace BriefUpdateResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  export interface Brief {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * Free-text brief: brand style, rules, campaign context
+     */
+    body: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the brief
+     */
+    createdBy: string;
+
+    /**
+     * Whether the brief is applied during verification
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this brief applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Reference assets the verifier compares the image against
+     */
+    referenceAssetIds: Array<string>;
+
+    /**
+     * The id of the team or project that owns this brief
+     */
+    scopeId: string;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Threshold strictness applied when verifying against this scope
+     */
+    sensitivity?: 'high' | 'low' | 'medium';
+  }
+}
+
+export interface BriefDeleteResponse {
+  deleted: boolean;
+}
+
+export interface BriefUpdateParams {
+  /**
+   * Free-text brief content
+   */
+  body: string;
+
+  /**
+   * Whether the brief is applied during verification (default true)
+   */
+  enabled?: boolean;
+
+  /**
+   * Reference assets the verifier compares against (max 10). Send [] to clear.
+   */
+  referenceAssetIds?: Array<string>;
+
+  /**
+   * Threshold strictness stored for this scope: low, medium, or high. Applied to
+   * verifications unless the verify call passes its own sensitivity.
+   */
+  sensitivity?: 'high' | 'low' | 'medium';
+}
+
+export declare namespace Brief {
+  export {
+    type BriefRetrieveResponse as BriefRetrieveResponse,
+    type BriefUpdateResponse as BriefUpdateResponse,
+    type BriefDeleteResponse as BriefDeleteResponse,
+    type BriefUpdateParams as BriefUpdateParams,
+  };
+}

package/src/resources/projects/index.ts

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  APIKeys,
+  type APIKeyCreateResponse,
+  type APIKeyDeleteResponse,
+  type APIKeyCreateParams,
+  type APIKeyDeleteParams,
+} from './api-keys';
+export {
+  Brief,
+  type BriefRetrieveResponse,
+  type BriefUpdateResponse,
+  type BriefDeleteResponse,
+  type BriefUpdateParams,
+} from './brief';
+export {
+  Instructions,
+  type InstructionRetrieveResponse,
+  type InstructionUpdateResponse,
+  type InstructionUpdateParams,
+} from './instructions';
+export {
+  Members,
+  type MemberCreateResponse,
+  type MemberUpdateResponse,
+  type MemberDeleteResponse,
+  type MemberCreateParams,
+  type MemberUpdateParams,
+  type MemberDeleteParams,
+} from './members';
+export {
+  Memory,
+  type MemoryRetrieveResponse,
+  type MemoryUpdateResponse,
+  type MemoryUpdateParams,
+} from './memory';
+export {
+  Projects,
+  type ProjectCreateResponse,
+  type ProjectRetrieveResponse,
+  type ProjectUpdateResponse,
+  type ProjectListResponse,
+  type ProjectDeleteResponse,
+  type ProjectCreateParams,
+  type ProjectUpdateParams,
+  type ProjectListParams,
+  type ProjectListResponsesProjectsCursor,
+} from './projects';
+export {
+  Watermark,
+  type WatermarkRetrieveResponse,
+  type WatermarkUpdateResponse,
+  type WatermarkDeleteResponse,
+  type WatermarkDeleteLogoResponse,
+  type WatermarkPreviewResponse,
+  type WatermarkUpdateLogoResponse,
+  type WatermarkUpdateParams,
+  type WatermarkPreviewParams,
+  type WatermarkUpdateLogoParams,
+} from './watermark';
+export {
+  WebhookEndpoints,
+  type WebhookEndpointCreateResponse,
+  type WebhookEndpointUpdateResponse,
+  type WebhookEndpointListResponse,
+  type WebhookEndpointDeleteResponse,
+  type WebhookEndpointCreateParams,
+  type WebhookEndpointUpdateParams,
+  type WebhookEndpointDeleteParams,
+} from './webhook-endpoints/index';

package/src/resources/projects/instructions.ts

@@ -0,0 +1,134 @@
+// 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 Instructions extends APIResource {
+  /**
+   * Get the project's assistant instructions (markdown). Returns 404 if not set. Any
+   * project member can read.
+   */
+  retrieve(projectID: string, options?: RequestOptions): APIPromise<InstructionRetrieveResponse> {
+    return this._client.get(path`/projects/${projectID}/instructions`, options);
+  }
+
+  /**
+   * Set the project's assistant instructions (markdown, max 50KB). Set content to
+   * null to clear. Team or project admins only.
+   */
+  update(
+    projectID: string,
+    body: InstructionUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<InstructionUpdateResponse> {
+    return this._client.put(path`/projects/${projectID}/instructions`, { body, ...options });
+  }
+}
+
+export interface InstructionRetrieveResponse {
+  /**
+   * Public JSON shape returned by GET endpoints
+   */
+  memory: InstructionRetrieveResponse.Memory;
+}
+
+export namespace InstructionRetrieveResponse {
+  /**
+   * Public JSON shape returned by GET endpoints
+   */
+  export interface Memory {
+    /**
+     * The memory ID — deterministic from scope + parent IDs (example:
+     * "mem_team_team_abc")
+     */
+    id: string;
+
+    /**
+     * Markdown content of the memory
+     */
+    content: string;
+
+    /**
+     * ISO 8601 timestamp when the memory was first written
+     */
+    createdAt: string;
+
+    /**
+     * UTF-8 byte length of the content — used for quota enforcement
+     */
+    sizeBytes: number;
+
+    /**
+     * ISO 8601 timestamp when the memory was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * The userId of the last writer — useful for audit/UI
+     */
+    updatedBy: string;
+  }
+}
+
+export interface InstructionUpdateResponse {
+  /**
+   * Public JSON shape returned by GET endpoints
+   */
+  memory?: InstructionUpdateResponse.Memory;
+}
+
+export namespace InstructionUpdateResponse {
+  /**
+   * Public JSON shape returned by GET endpoints
+   */
+  export interface Memory {
+    /**
+     * The memory ID — deterministic from scope + parent IDs (example:
+     * "mem_team_team_abc")
+     */
+    id: string;
+
+    /**
+     * Markdown content of the memory
+     */
+    content: string;
+
+    /**
+     * ISO 8601 timestamp when the memory was first written
+     */
+    createdAt: string;
+
+    /**
+     * UTF-8 byte length of the content — used for quota enforcement
+     */
+    sizeBytes: number;
+
+    /**
+     * ISO 8601 timestamp when the memory was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * The userId of the last writer — useful for audit/UI
+     */
+    updatedBy: string;
+  }
+}
+
+export interface InstructionUpdateParams {
+  /**
+   * Markdown content of the memory. Set to null to clear. Max size depends on the
+   * scope (20-50 KB).
+   */
+  content?: string;
+}
+
+export declare namespace Instructions {
+  export {
+    type InstructionRetrieveResponse as InstructionRetrieveResponse,
+    type InstructionUpdateResponse as InstructionUpdateResponse,
+    type InstructionUpdateParams as InstructionUpdateParams,
+  };
+}