@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/models/train.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 Train extends APIResource {
   /**
@@ -16,9 +17,9 @@ export class Train extends APIResource {
   ): APIPromise<TrainActionResponse> {
     const { projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/train/action`, {
-      query: { projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -32,9 +33,9 @@ export class Train extends APIResource {
   ): APIPromise<TrainTriggerResponse> {
     const { dryRun, originalAssets, projectId, trainingImagesCount, ...body } = params;
     return this._client.put(path`/models/${modelID}/train`, {
-      query: { dryRun, originalAssets, projectId, trainingImagesCount },
       body,
       ...options,
+      query: { dryRun, originalAssets, projectId, trainingImagesCount, ...omitUndefined(options?.query) },
     });
   }
 }
@@ -179,8 +180,8 @@ export namespace TrainActionResponse {
     updatedAt: string;
 
     /**
-     * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-     * 75: Team plan 100: Enterprise plan
+     * The access restrictions of the model 0: Free plan 25: Starter plan 50: Pro plan
+     * 75: Max plan 100: Enterprise plan
      */
     accessRestrictions?: 0 | 100 | 25 | 50 | 75;
 
@@ -229,6 +230,12 @@ export namespace TrainActionResponse {
      */
     inputs?: Array<Model.Input>;
 
+    /**
+     * The ID of the job that trained the model, returned to the model owner only
+     * (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId?: string;
+
     /**
      * The model keyword, this is a legacy parameter, please use conceptPrompt in
      * parameters
@@ -618,8 +625,7 @@ export namespace TrainActionResponse {
        * - \`ifNotDefined\`: Input is required when another specified input is not
        *   defined
        * - \`ifDefined\`: Input is required when another specified input is defined
-       * - \`conditionalValues\`: Input is required when another input has a specific
-       *   value
+       * - \`conditional\`: Input is required when other inputs have specific values
        *
        * By default, the input is not required.
        */
@@ -639,8 +645,7 @@ export namespace TrainActionResponse {
        * - \`ifNotDefined\`: Input is required when another specified input is not
        *   defined
        * - \`ifDefined\`: Input is required when another specified input is defined
-       * - \`conditionalValues\`: Input is required when another input has a specific
-       *   value
+       * - \`conditional\`: Input is required when other inputs have specific values
        *
        * By default, the input is not required.
        */
@@ -651,12 +656,9 @@ export namespace TrainActionResponse {
         always?: boolean;
 
         /**
-         * Makes this input required when another input has a specific value:
-         *
-         * - Key: name of the input to check
-         * - Value: operation and allowed values that trigger the requirement
+         * Makes this input required when other inputs have one of the listed values
          */
-        conditionalValues?: unknown;
+        conditional?: Required.Conditional;
 
         /**
          * Makes this input required when another input is defined:
@@ -674,6 +676,26 @@ export namespace TrainActionResponse {
          */
         ifNotDefined?: unknown;
       }
+
+      export namespace Required {
+        /**
+         * Makes this input required when other inputs have one of the listed values
+         */
+        export interface Conditional {
+          /**
+           * The conditions to check:
+           *
+           * - Key: name of the input to check
+           * - Value: values of that input that satisfy the condition
+           */
+          values: unknown;
+
+          /**
+           * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
+           */
+          operator?: 'and' | 'or';
+        }
+      }
     }
 
     /**
@@ -1581,6 +1603,7 @@ export namespace TrainTriggerResponse {
           | 'remove-background'
           | 'transform'
           | 'user-approval'
+          | 'user-selection'
           | 'workflow';
 
         /**
@@ -1611,14 +1634,15 @@ export namespace TrainTriggerResponse {
         includeOutputsInWorkflowJob?: true;
 
         /**
-         * The inputs of the node.
+         * The inputs of the node. For a user-selection node, the array input's `min`/`max`
+         * bound how many items the user may pick (defaults: 1 and 100); conditional
+         * connections may be present as additional inputs.
          */
         inputs?: Array<Flow.Input>;
 
         /**
-         * Statically-configured items for a List node. The node outputs this array as-is
-         * when executed. Only available for List nodes. The values can be strings,
-         * numbers, or asset IDs.
+         * Statically-configured items for a List node, or the frozen candidate list of a
+         * UserSelection node. The values can be strings, numbers, or asset IDs.
          */
         items?: Array<string>;
 
@@ -1898,8 +1922,7 @@ export namespace TrainTriggerResponse {
            * - \`ifNotDefined\`: Input is required when another specified input is not
            *   defined
            * - \`ifDefined\`: Input is required when another specified input is defined
-           * - \`conditionalValues\`: Input is required when another input has a specific
-           *   value
+           * - \`conditional\`: Input is required when other inputs have specific values
            *
            * By default, the input is not required.
            */
@@ -2129,8 +2152,7 @@ export namespace TrainTriggerResponse {
              * - \`ifNotDefined\`: Input is required when another specified input is not
              *   defined
              * - \`ifDefined\`: Input is required when another specified input is defined
-             * - \`conditionalValues\`: Input is required when another input has a specific
-             *   value
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -2187,8 +2209,7 @@ export namespace TrainTriggerResponse {
              * - \`ifNotDefined\`: Input is required when another specified input is not
              *   defined
              * - \`ifDefined\`: Input is required when another specified input is defined
-             * - \`conditionalValues\`: Input is required when another input has a specific
-             *   value
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -2199,12 +2220,9 @@ export namespace TrainTriggerResponse {
               always?: boolean;
 
               /**
-               * Makes this input required when another input has a specific value:
-               *
-               * - Key: name of the input to check
-               * - Value: operation and allowed values that trigger the requirement
+               * Makes this input required when other inputs have one of the listed values
                */
-              conditionalValues?: unknown;
+              conditional?: Required.Conditional;
 
               /**
                * Makes this input required when another input is defined:
@@ -2222,6 +2240,26 @@ export namespace TrainTriggerResponse {
                */
               ifNotDefined?: unknown;
             }
+
+            export namespace Required {
+              /**
+               * Makes this input required when other inputs have one of the listed values
+               */
+              export interface Conditional {
+                /**
+                 * The conditions to check:
+                 *
+                 * - Key: name of the input to check
+                 * - Value: values of that input that satisfy the condition
+                 */
+                values: unknown;
+
+                /**
+                 * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
+                 */
+                operator?: 'and' | 'or';
+              }
+            }
           }
 
           /**
@@ -2262,8 +2300,7 @@ export namespace TrainTriggerResponse {
            * - \`ifNotDefined\`: Input is required when another specified input is not
            *   defined
            * - \`ifDefined\`: Input is required when another specified input is defined
-           * - \`conditionalValues\`: Input is required when another input has a specific
-           *   value
+           * - \`conditional\`: Input is required when other inputs have specific values
            *
            * By default, the input is not required.
            */
@@ -2274,12 +2311,9 @@ export namespace TrainTriggerResponse {
             always?: boolean;
 
             /**
-             * Makes this input required when another input has a specific value:
-             *
-             * - Key: name of the input to check
-             * - Value: operation and allowed values that trigger the requirement
+             * Makes this input required when other inputs have one of the listed values
              */
-            conditionalValues?: unknown;
+            conditional?: Required.Conditional;
 
             /**
              * Makes this input required when another input is defined:
@@ -2297,6 +2331,26 @@ export namespace TrainTriggerResponse {
              */
             ifNotDefined?: unknown;
           }
+
+          export namespace Required {
+            /**
+             * Makes this input required when other inputs have one of the listed values
+             */
+            export interface Conditional {
+              /**
+               * The conditions to check:
+               *
+               * - Key: name of the input to check
+               * - Value: values of that input that satisfy the condition
+               */
+              values: unknown;
+
+              /**
+               * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
+               */
+              operator?: 'and' | 'or';
+            }
+          }
         }
 
         /**
@@ -2544,8 +2598,8 @@ export namespace TrainTriggerResponse {
     updatedAt: string;
 
     /**
-     * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-     * 75: Team plan 100: Enterprise plan
+     * The access restrictions of the model 0: Free plan 25: Starter plan 50: Pro plan
+     * 75: Max plan 100: Enterprise plan
      */
     accessRestrictions?: 0 | 100 | 25 | 50 | 75;
 
@@ -2594,6 +2648,12 @@ export namespace TrainTriggerResponse {
      */
     inputs?: Array<Model.Input>;
 
+    /**
+     * The ID of the job that trained the model, returned to the model owner only
+     * (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId?: string;
+
     /**
      * The model keyword, this is a legacy parameter, please use conceptPrompt in
      * parameters
@@ -2983,8 +3043,7 @@ export namespace TrainTriggerResponse {
        * - \`ifNotDefined\`: Input is required when another specified input is not
        *   defined
        * - \`ifDefined\`: Input is required when another specified input is defined
-       * - \`conditionalValues\`: Input is required when another input has a specific
-       *   value
+       * - \`conditional\`: Input is required when other inputs have specific values
        *
        * By default, the input is not required.
        */
@@ -3004,8 +3063,7 @@ export namespace TrainTriggerResponse {
        * - \`ifNotDefined\`: Input is required when another specified input is not
        *   defined
        * - \`ifDefined\`: Input is required when another specified input is defined
-       * - \`conditionalValues\`: Input is required when another input has a specific
-       *   value
+       * - \`conditional\`: Input is required when other inputs have specific values
        *
        * By default, the input is not required.
        */
@@ -3016,12 +3074,9 @@ export namespace TrainTriggerResponse {
         always?: boolean;
 
         /**
-         * Makes this input required when another input has a specific value:
-         *
-         * - Key: name of the input to check
-         * - Value: operation and allowed values that trigger the requirement
+         * Makes this input required when other inputs have one of the listed values
          */
-        conditionalValues?: unknown;
+        conditional?: Required.Conditional;
 
         /**
          * Makes this input required when another input is defined:
@@ -3039,6 +3094,26 @@ export namespace TrainTriggerResponse {
          */
         ifNotDefined?: unknown;
       }
+
+      export namespace Required {
+        /**
+         * Makes this input required when other inputs have one of the listed values
+         */
+        export interface Conditional {
+          /**
+           * The conditions to check:
+           *
+           * - Key: name of the input to check
+           * - Value: values of that input that satisfy the condition
+           */
+          values: unknown;
+
+          /**
+           * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
+           */
+          operator?: 'and' | 'or';
+        }
+      }
     }
 
     /**

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,
+  };
+}