@scenario-labs/sdk 2.2.1 → 2.3.0

package/src/resources/generate.ts

@@ -288,7 +288,7 @@ export namespace GenerateCaptionResponse {
         /**
          * 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.
@@ -1274,7 +1274,7 @@ export namespace GenerateDescribeStyleResponse {
         /**
          * 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.
@@ -2252,7 +2252,7 @@ export namespace GenerateDetectResponse {
         /**
          * 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.
@@ -4376,7 +4376,7 @@ export namespace GenerateEmbedResponse {
         /**
          * 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.
@@ -5354,7 +5354,7 @@ export namespace GeneratePatchResponse {
         /**
          * 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.
@@ -7481,7 +7481,7 @@ export namespace GeneratePromptResponse {
         /**
          * 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.
@@ -8457,7 +8457,7 @@ export namespace GenerateRunModelResponse {
         /**
          * 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.
@@ -9443,7 +9443,7 @@ export namespace GenerateTranslateResponse {
         /**
          * 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/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
        */
@@ -1530,7 +1556,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 +3463,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 +3498,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
        */

package/src/resources/usages.ts

@@ -780,7 +780,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.

package/src/resources/workflows.ts

@@ -85,7 +85,10 @@ export class Workflows extends APIResource {
   }
 
   /**
-   * Approve a user approval node in a workflow
+   * Respond to a user-approval node in a workflow. Pass action="approve" (default)
+   * to advance the workflow, or action="reject" to mark the node Rejected. A
+   * rejected stand-alone node cancels the workflow; a rejected ForEach iteration
+   * cascades to the surrounding loop.
    */
   userApproval(
     workflowID: string,
@@ -5580,7 +5583,7 @@ export namespace WorkflowRunResponse {
         /**
          * 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.
@@ -7866,7 +7869,7 @@ export namespace WorkflowUserApprovalResponse {
         /**
          * 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.
@@ -9788,7 +9791,7 @@ export interface WorkflowListParams extends WorkflowsCursorParams {
 
 export interface WorkflowApproveUserParams {
   /**
-   * The ID of the user approval node to approve in the workflow
+   * The ID of the user approval node to act on in the workflow
    */
   nodeId: string;
 
@@ -9796,6 +9799,14 @@ export interface WorkflowApproveUserParams {
    * The ID of the workflow job that contains the user approval node
    */
   workflowJobId: string;
+
+  /**
+   * Decision taken on the approval node. "approve" marks it Success and advances the
+   * workflow; "reject" marks it Rejected and either cancels the workflow or — if the
+   * node is inside a ForEach iteration — cascades to the loop. Defaults to "approve"
+   * for backward compatibility.
+   */
+  action?: 'approve' | 'reject';
 }
 
 export interface WorkflowGetTagsParams {
@@ -9817,7 +9828,7 @@ export interface WorkflowRunParams {
 
 export interface WorkflowUserApprovalParams {
   /**
-   * The ID of the user approval node to approve in the workflow
+   * The ID of the user approval node to act on in the workflow
    */
   nodeId: string;
 
@@ -9825,6 +9836,14 @@ export interface WorkflowUserApprovalParams {
    * The ID of the workflow job that contains the user approval node
    */
   workflowJobId: string;
+
+  /**
+   * Decision taken on the approval node. "approve" marks it Success and advances the
+   * workflow; "reject" marks it Rejected and either cancels the workflow or — if the
+   * node is inside a ForEach iteration — cascades to the loop. Defaults to "approve"
+   * for backward compatibility.
+   */
+  action?: 'approve' | 'reject';
 }
 
 export declare namespace Workflows {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.2.1'; // x-release-please-version
+export const VERSION = '2.3.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.1";
+export declare const VERSION = "2.3.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.1";
+export declare const VERSION = "2.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.2.1'; // x-release-please-version
+exports.VERSION = '2.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.2.1'; // x-release-please-version
+export const VERSION = '2.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map