@scenario-labs/sdk 2.2.1 → 2.4.0-alpha.1

package/src/resources/jobs.ts

@@ -215,7 +215,7 @@ export namespace JobRetrieveResponse {
         /**
          * The status of the node. Only available for WorkflowJob nodes.
          */
-        status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+        status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
         /**
          * The type of the job for the node.
@@ -1176,7 +1176,7 @@ export namespace JobListResponse {
       /**
        * The status of the node. Only available for WorkflowJob nodes.
        */
-      status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+      status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
       /**
        * The type of the job for the node.
@@ -2141,7 +2141,7 @@ export namespace JobTriggerActionResponse {
         /**
          * The status of the node. Only available for WorkflowJob nodes.
          */
-        status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+        status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
         /**
          * The type of the job for the node.

package/src/resources/models/examples.ts

@@ -1745,7 +1745,7 @@ export namespace ExampleUpdateResponse {
           /**
            * The status of the node. Only available for WorkflowJob nodes.
            */
-          status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+          status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
           /**
            * The type of the job for the node.
@@ -4250,7 +4250,7 @@ export namespace ExampleListResponse {
           /**
            * The status of the node. Only available for WorkflowJob nodes.
            */
-          status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+          status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
           /**
            * The type of the job for the node.

package/src/resources/models/models.ts

@@ -1286,13 +1286,25 @@ export namespace ModelCreateResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -1309,6 +1321,20 @@ export namespace ModelCreateResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -2592,13 +2618,25 @@ export namespace ModelRetrieveResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -2615,6 +2653,20 @@ export namespace ModelRetrieveResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -3898,13 +3950,25 @@ export namespace ModelUpdateResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -3921,6 +3985,20 @@ export namespace ModelUpdateResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -5199,13 +5277,25 @@ export namespace ModelListResponse {
     /**
      * The stage of the request
      */
-    stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+    stage:
+      | 'pending'
+      | 'pending-captcha'
+      | 'queued-for-train'
+      | 'ready-for-captcha'
+      | 'running-train'
+      | 'starting-train';
 
     /**
      * Timestamp in milliseconds of the last time the training progress was updated
      */
     updatedAt: number;
 
+    /**
+     * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+     * present when stage === 'pending-captcha'. Overwritten on each retry.
+     */
+    captchaImageUrl?: string;
+
     /**
      * Position of the job in the queue (ie. the number of job in the queue before this
      * one)
@@ -5222,6 +5312,20 @@ export namespace ModelListResponse {
      */
     remainingTimeMs?: number;
 
+    /**
+     * Last recoverable failure message during PVC. Present when the model has bounced
+     * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+     * captcha rejected, time limit exceeded). Surface above the retry button so the
+     * user understands why they're back here.
+     */
+    retryableError?: string;
+
+    /**
+     * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+     * model is marked Failed when this reaches the platform's max retries.
+     */
+    retryCount?: number;
+
     /**
      * The timestamp in millisecond marking the start of the process
      */
@@ -6506,13 +6610,25 @@ export namespace ModelCopyResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -6529,6 +6645,20 @@ export namespace ModelCopyResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -7821,13 +7951,25 @@ export namespace ModelGetBulkResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -7844,6 +7986,20 @@ export namespace ModelGetBulkResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -9127,13 +9283,25 @@ export namespace ModelTransferResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -9150,6 +9318,20 @@ export namespace ModelTransferResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */

package/src/resources/models/train.ts

@@ -1159,13 +1159,25 @@ export namespace TrainActionResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -1182,6 +1194,20 @@ export namespace TrainActionResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -1359,6 +1385,11 @@ export interface TrainTriggerResponse {
    * The Creative Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
+
+  /**
+   * IP detection findings, when detection ran for this request.
+   */
+  ipDetection?: TrainTriggerResponse.IPDetection;
 }
 
 export namespace TrainTriggerResponse {
@@ -1530,7 +1561,7 @@ export namespace TrainTriggerResponse {
         /**
          * The status of the node. Only available for WorkflowJob nodes.
          */
-        status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+        status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
         /**
          * The type of the job for the node.
@@ -3437,13 +3468,25 @@ export namespace TrainTriggerResponse {
       /**
        * The stage of the request
        */
-      stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+      stage:
+        | 'pending'
+        | 'pending-captcha'
+        | 'queued-for-train'
+        | 'ready-for-captcha'
+        | 'running-train'
+        | 'starting-train';
 
       /**
        * Timestamp in milliseconds of the last time the training progress was updated
        */
       updatedAt: number;
 
+      /**
+       * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+       * present when stage === 'pending-captcha'. Overwritten on each retry.
+       */
+      captchaImageUrl?: string;
+
       /**
        * Position of the job in the queue (ie. the number of job in the queue before this
        * one)
@@ -3460,6 +3503,20 @@ export namespace TrainTriggerResponse {
        */
       remainingTimeMs?: number;
 
+      /**
+       * Last recoverable failure message during PVC. Present when the model has bounced
+       * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+       * captcha rejected, time limit exceeded). Surface above the retry button so the
+       * user understands why they're back here.
+       */
+      retryableError?: string;
+
+      /**
+       * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+       * model is marked Failed when this reaches the platform's max retries.
+       */
+      retryCount?: number;
+
       /**
        * The timestamp in millisecond marking the start of the process
        */
@@ -3621,6 +3678,84 @@ export namespace TrainTriggerResponse {
       }
     }
   }
+
+  /**
+   * IP detection findings, when detection ran for this request.
+   */
+  export interface IPDetection {
+    /**
+     * Whether and how detection affected the request.
+     */
+    action: 'allowed' | 'blocked' | 'flagged';
+
+    /**
+     * IP-detection CU fee, separate from creativeUnitsCost: a fixed base fee plus a
+     * per-image fee for each analyzed input image.
+     */
+    creativeUnitsCharged: number;
+
+    /**
+     * Number of enabled filters evaluated for this request.
+     */
+    evaluatedFilters: number;
+
+    /**
+     * Per-filter verdicts gathered for this request.
+     */
+    findings: Array<IPDetection.Finding>;
+
+    /**
+     * Convenience flag; always true when action is not 'allowed'.
+     */
+    flagged: boolean;
+
+    /**
+     * True if one or more detectors errored while evaluating this request.
+     */
+    hasDetectorError?: boolean;
+  }
+
+  export namespace IPDetection {
+    /**
+     * A single filter's verdict.
+     */
+    export interface Finding {
+      /**
+       * Category of the filter that produced this verdict.
+       */
+      category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+
+      /**
+       * Confidence score from 0 (low) to 1 (high).
+       */
+      confidence: number;
+
+      /**
+       * Identifier of the filter that produced this verdict.
+       */
+      filterId: string;
+
+      /**
+       * Display name of the filter that produced this verdict.
+       */
+      filterName: string;
+
+      /**
+       * Whether this filter considered the request an IP risk.
+       */
+      flagged: boolean;
+
+      /**
+       * Short, user-facing explanation of the verdict.
+       */
+      reason: string;
+
+      /**
+       * Named entities the filter recognized (e.g. characters, brands, people).
+       */
+      entities?: Array<string>;
+    }
+  }
 }
 
 export interface TrainActionParams {

package/src/resources/usages.ts

@@ -112,6 +112,7 @@ export namespace UsageListResponse {
       | 'project'
       | 'project-member'
       | 'reframe'
+      | 'refunds'
       | 'repaint'
       | 'restyle'
       | 'segmentation'
@@ -780,7 +781,7 @@ export namespace UsageListResponse {
           /**
            * The status of the node. Only available for WorkflowJob nodes.
            */
-          status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+          status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
 
           /**
            * The type of the job for the node.
@@ -1748,6 +1749,7 @@ export namespace UsageListResponse {
       | 'models-training'
       | 'patch'
       | 'pixelate'
+      | 'refunds'
       | 'repaint'
       | 'restyle'
       | 'segmentation'
@@ -1774,6 +1776,30 @@ export namespace UsageListResponse {
        * Value of the point
        */
       value: string;
+
+      /**
+       * Cost in Creative Units for the point restricted to API-key calls (mirrors the
+       * `apiKey` value field but on the cost axis).
+       */
+      apiKeyCost?: number;
+
+      /**
+       * Discount in Creative Units for the point restricted to API-key calls.
+       */
+      apiKeyDiscount?: number;
+
+      /**
+       * Cost in Creative Units (sum of `creativeUnitsCost`) for the point. Only
+       * populated for usage actions that carry a CU cost (generations, trainings, etc.).
+       * Free actions like `delete-asset` or `tag-asset` will report `0`.
+       */
+      cost?: number;
+
+      /**
+       * Discount applied in Creative Units (sum of `creativeUnitsDiscount`) for the
+       * point. Only populated for usage actions that carry a CU discount.
+       */
+      discount?: number;
     }
   }
 }