@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/uploads.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 Uploads extends APIResource {
   /**
@@ -11,8 +12,12 @@ export class Uploads extends APIResource {
    * list of URLs for each part of the file.
    */
   create(params: UploadCreateParams, options?: RequestOptions): APIPromise<UploadCreateResponse> {
-    const { projectId, ...body } = params;
-    return this._client.post('/uploads', { query: { projectId }, body, ...options });
+    const { dryRun, projectId, ...body } = params;
+    return this._client.post('/uploads', {
+      body,
+      ...options,
+      query: { dryRun, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -23,7 +28,10 @@ export class Uploads extends APIResource {
     query: UploadRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<UploadRetrieveResponse> {
-    return this._client.get(path`/uploads/${uploadID}`, { query, ...options });
+    return this._client.get(path`/uploads/${uploadID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -35,7 +43,11 @@ export class Uploads extends APIResource {
     options?: RequestOptions,
   ): APIPromise<UploadTriggerActionResponse> {
     const { projectId, ...body } = params;
-    return this._client.post(path`/uploads/${uploadID}/action`, { query: { projectId }, body, ...options });
+    return this._client.post(path`/uploads/${uploadID}/action`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -280,6 +292,12 @@ export namespace UploadTriggerActionResponse {
 }
 
 export interface UploadCreateParams {
+  /**
+   * Query param: Estimate the operation instead of running it: the call returns a
+   * 269 response carrying the creative units cost. `api` estimates at the API tier.
+   */
+  dryRun?: 'true' | 'api';
+
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -365,7 +383,11 @@ export namespace UploadCreateParams {
 }
 
 export interface UploadRetrieveParams {
-  projectId?: unknown;
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface UploadTriggerActionParams {
@@ -376,9 +398,10 @@ export interface UploadTriggerActionParams {
   action: 'complete';
 
   /**
-   * Query param
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
    */
-  projectId?: unknown;
+  projectId?: string;
 }
 
 export declare namespace Uploads {

package/src/resources/usages.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
+import { omitUndefined } from '../internal/utils/values';
 
 export class Usages extends APIResource {
   /**
@@ -14,7 +15,7 @@ export class Usages extends APIResource {
     query: UsageListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<UsageListResponse> {
-    return this._client.get('/usages', { query, ...options });
+    return this._client.get('/usages', { ...options, query: { ...query, ...omitUndefined(options?.query) } });
   }
 }
 
@@ -31,7 +32,7 @@ export interface UsageListResponse {
 
   nsfwUsages?: Array<UsageListResponse.NsfwUsage>;
 
-  slopUsages?: Array<UsageListResponse.SlopUsage>;
+  qualityGateUsages?: Array<UsageListResponse.QualityGateUsage>;
 
   usages?: Array<UsageListResponse.Usage>;
 }
@@ -81,6 +82,7 @@ export namespace UsageListResponse {
       | 'delete-model'
       | 'delete-model-preset'
       | 'delete-oscu-auto-refill'
+      | 'delete-project-api-key'
       | 'delete-project-member'
       | 'delete-subscription'
       | 'delete-team-api-key'
@@ -113,6 +115,7 @@ export namespace UsageListResponse {
       | 'patch'
       | 'pixelate'
       | 'project'
+      | 'project-api-key'
       | 'project-member'
       | 'reframe'
       | 'refunds'
@@ -282,7 +285,7 @@ export namespace UsageListResponse {
 
     /**
      * Compute Units consumed per billing action, when a breakdown is available
-     * (example: `{ "slop-detection": 12 }`). Values are included in `value`.
+     * (example: `{ "quality-gate": 12 }`). Values are included in `value`.
      */
     costDetails?: unknown;
   }
@@ -842,6 +845,7 @@ export namespace UsageListResponse {
             | 'remove-background'
             | 'transform'
             | 'user-approval'
+            | 'user-selection'
             | 'workflow';
 
           /**
@@ -872,14 +876,15 @@ export namespace UsageListResponse {
           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>;
 
@@ -1028,7 +1033,9 @@ export namespace UsageListResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1056,8 +1063,9 @@ export namespace UsageListResponse {
             maxDuration?: number;
 
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
 
@@ -1074,8 +1082,9 @@ export namespace UsageListResponse {
             min?: number;
 
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
 
@@ -1155,8 +1164,7 @@ export namespace UsageListResponse {
              * - \`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.
              */
@@ -1255,7 +1263,9 @@ export namespace UsageListResponse {
                * The asset kind of the input. Only taken into account for \`file\` and
                * \`file_array\` input types. If model provides multiple kinds, the input will be
                * not able to create the asset on the flight on API side with dataurl without
-               * data:kind, prefix
+               * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+               * a model does not declare one, \`image\` is returned, which is the kind used at
+               * generation time.
                */
               kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1283,8 +1293,9 @@ export namespace UsageListResponse {
               maxDuration?: number;
 
               /**
-               * The maximum allowed length for \`string\` inputs. Also applies to each item in
-               * \`string_array\`.
+               * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+               * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+               * ITEMS instead — the length of each item is not constrained.
                */
               maxLength?: number;
 
@@ -1301,8 +1312,9 @@ export namespace UsageListResponse {
               min?: number;
 
               /**
-               * The minimum allowed length for string inputs. Also applies to each item in
-               * \`string_array\`.
+               * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+               * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+               * ITEMS instead — the length of each item is not constrained.
                */
               minLength?: number;
 
@@ -1382,8 +1394,7 @@ export namespace UsageListResponse {
                * - \`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.
                */
@@ -1440,8 +1451,7 @@ export namespace UsageListResponse {
                * - \`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.
                */
@@ -1452,12 +1462,9 @@ export namespace UsageListResponse {
                 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:
@@ -1475,6 +1482,26 @@ export namespace UsageListResponse {
                  */
                 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';
+                }
+              }
             }
 
             /**
@@ -1515,8 +1542,7 @@ export namespace UsageListResponse {
              * - \`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.
              */
@@ -1527,12 +1553,9 @@ export namespace UsageListResponse {
               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:
@@ -1550,6 +1573,26 @@ export namespace UsageListResponse {
                */
               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';
+              }
+            }
           }
 
           /**
@@ -1756,13 +1799,13 @@ export namespace UsageListResponse {
   }
 
   /**
-   * A SlopGuard verdict series: one per bucket (total | pass | warn | fail).
+   * A Quality Gate verdict series: one per bucket (total | pass | warn | fail).
    */
-  export interface SlopUsage {
+  export interface QualityGateUsage {
     /**
      * The data points
      */
-    points: Array<SlopUsage.Point>;
+    points: Array<QualityGateUsage.Point>;
 
     /**
      * The verdict bucket: "total", "pass", "warn", or "fail"
@@ -1770,9 +1813,9 @@ export namespace UsageListResponse {
     verdict: string;
   }
 
-  export namespace SlopUsage {
+  export namespace QualityGateUsage {
     /**
-     * One time-bucket point in a SlopGuard verdict series.
+     * One time-bucket point in a Quality Gate verdict series.
      */
     export interface Point {
       /**
@@ -1885,11 +1928,11 @@ export interface UsageListParams {
 
   /**
    * When set, points whose numeric fields are all zero are removed from `usages`,
-   * `modelUsages`, `assetUsages`, `nsfwUsages` and `slopUsages`. The parent entry
-   * (model, kind, label, usageName) is preserved with `points: []` so callers still
-   * see every row. Useful on wide windows × fine granularities × many models, where
-   * the zero-fill can push the response past the 6 MB API Gateway sync limit. The
-   * bare `?dropZeroPoints` form, plus any value (`true`, `1`, `yes`, `on`, …)
+   * `modelUsages`, `assetUsages`, `nsfwUsages` and `qualityGateUsages`. The parent
+   * entry (model, kind, label, usageName) is preserved with `points: []` so callers
+   * still see every row. Useful on wide windows × fine granularities × many models,
+   * where the zero-fill can push the response past the 6 MB API Gateway sync limit.
+   * The bare `?dropZeroPoints` form, plus any value (`true`, `1`, `yes`, `on`, …)
    * enables it; absent or explicit falsy literals (`false`, `0`, `no`, `off`)
    * disable it. Default disabled for backwards compatibility.
    */
@@ -1914,8 +1957,7 @@ export interface UsageListParams {
   startDate?: string;
 
   /**
-   * The teamId used for ownership resource management. Either to assert ownership or
-   * to set the owner of the resource(s)
+   * The team identifier for usage data. If omitted, the default team will be used.
    */
   teamId?: string;
 
@@ -1928,11 +1970,17 @@ export interface UsageListParams {
   /**
    * The type of the usage data. Can be one or more comma separated values. Can be
    * any of the following values: usages, activity, consumption, model-usages,
-   * asset-usages, nsfw-usages, slop-usages. Default is all types. If bad type or
-   * empty, all types will be returned.
+   * asset-usages, nsfw-usages, quality-gate-usages. Default is all types. If bad
+   * type or empty, all types will be returned.
    */
   type?: Array<
-    'usages' | 'activity' | 'consumption' | 'model-usages' | 'asset-usages' | 'nsfw-usages' | 'slop-usages'
+    | 'usages'
+    | 'activity'
+    | 'consumption'
+    | 'model-usages'
+    | 'asset-usages'
+    | 'nsfw-usages'
+    | 'quality-gate-usages'
   >;
 
   /**