@scenario-labs/sdk 0.1.3 → 0.3.0

package/src/resources/usages.ts

@@ -21,12 +21,16 @@ export class Usages extends APIResource {
 export interface UsageListResponse {
   activity?: Array<UsageListResponse.Activity>;
 
+  assetUsages?: Array<UsageListResponse.AssetUsage>;
+
   consumption?: Array<UsageListResponse.Consumption>;
 
   entities?: UsageListResponse.Entities;
 
   modelUsages?: Array<UsageListResponse.ModelUsage>;
 
+  nsfwUsages?: Array<UsageListResponse.NsfwUsage>;
+
   usages?: Array<UsageListResponse.Usage>;
 }
 
@@ -46,7 +50,12 @@ export namespace UsageListResponse {
     action:
       | 'asset'
       | 'asset-privacy'
+      | 'assistant-message'
       | 'background-removal'
+      | 'byok-remove-project-provider'
+      | 'byok-remove-provider'
+      | 'byok-set-project-provider'
+      | 'byok-set-provider'
       | 'captioning'
       | 'collection'
       | 'collection-assets'
@@ -61,6 +70,7 @@ export namespace UsageListResponse {
       | 'creative-unit-cost'
       | 'creative-unit-discount'
       | 'custom'
+      | 'custom-asset-created'
       | 'delete-asset'
       | 'delete-collection'
       | 'delete-collection-assets'
@@ -77,9 +87,13 @@ export namespace UsageListResponse {
       | 'delete-training-images'
       | 'describe-style'
       | 'detection'
+      | 'disable-project-model'
+      | 'disable-team-model'
       | 'download-assets'
       | 'download-model'
       | 'embed'
+      | 'enable-project-model'
+      | 'enable-team-model'
       | 'generative-fill'
       | 'image-prompt-editing'
       | 'images-generation'
@@ -165,6 +179,12 @@ export namespace UsageListResponse {
        */
       assetId?: string;
 
+      /**
+       * The BYOK provider information for this action Only set if the action is a BYOK
+       * action (byok-set-provider or byok-remove-provider)
+       */
+      byokProvider?: Data.ByokProvider;
+
       /**
        * The collection for this action
        */
@@ -185,6 +205,46 @@ export namespace UsageListResponse {
        */
       modelId?: string;
     }
+
+    export namespace Data {
+      /**
+       * The BYOK provider information for this action Only set if the action is a BYOK
+       * action (byok-set-provider or byok-remove-provider)
+       */
+      export interface ByokProvider {
+        id: string;
+
+        displayName: string;
+      }
+    }
+  }
+
+  export interface AssetUsage {
+    kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+    /**
+     * The data points
+     */
+    points: Array<AssetUsage.Point>;
+  }
+
+  export namespace AssetUsage {
+    export interface Point {
+      /**
+       * Number of assets created
+       */
+      count: number;
+
+      /**
+       * Number of assets created via an API key
+       */
+      countApiKey: number;
+
+      /**
+       * The UTC ISO date of the point
+       */
+      time: string;
+    }
   }
 
   /**
@@ -193,6 +253,16 @@ export namespace UsageListResponse {
    * There is no limit on the number of entries
    */
   export interface Consumption {
+    /**
+     * The Creative Units discount for the user
+     */
+    discount: number;
+
+    /**
+     * The total consumption for the user (value + discount)
+     */
+    total: number;
+
     /**
      * The unique identifier of the user
      */
@@ -311,8 +381,10 @@ export namespace UsageListResponse {
         | 'upscale-texture'
         | 'upscale-video'
         | 'vectorization'
+        | 'video23d'
         | 'video2img'
-        | 'video2video';
+        | 'video2video'
+        | 'voice-clone';
     }
 
     export namespace Asset {
@@ -393,8 +465,10 @@ export namespace UsageListResponse {
           | 'upscale-texture'
           | 'upscale-video'
           | 'vectorization'
+          | 'video23d'
           | 'video2img'
-          | 'video2video';
+          | 'video2video'
+          | 'voice-clone';
       }
 
       /**
@@ -441,7 +515,7 @@ export namespace UsageListResponse {
         /**
          * Bounding box dimensions [width, height, depth]
          */
-        dimensions?: Array<unknown>;
+        dimensions?: Array<number>;
 
         /**
          * Duration of the media in seconds
@@ -558,6 +632,7 @@ export namespace UsageListResponse {
         | 'model-download'
         | 'model-import'
         | 'model-training'
+        | 'musubi-model-training'
         | 'openai-image-generation'
         | 'patch-image'
         | 'pixelate'
@@ -608,20 +683,37 @@ export namespace UsageListResponse {
          */
         assetIds?: Array<string>;
 
+        /**
+         * Eventual error for the job
+         */
+        error?: string | null;
+
         /**
          * The flow of the job. Only available for workflow jobs.
          */
         flow?: Array<Metadata.Flow>;
 
+        /**
+         * Actionable hint for the user explaining what went wrong and how to resolve it.
+         */
+        hint?: string;
+
         /**
          * The inputs for the job
          */
-        input?: unknown;
+        input?: { [key: string]: unknown };
+
+        /**
+         * May contain the output of the job for specific custom models jobs. Only
+         * available for custom models which generate non-assets outputs. Example: LLM text
+         * results.
+         */
+        output?: { [key: string]: unknown };
 
         /**
-         * The output of the job
+         * For voice-clone jobs: the ID of the model being trained.
          */
-        output?: unknown;
+        outputModelId?: string;
 
         /**
          * The workflow ID of the job if job is part of a workflow.
@@ -651,8 +743,11 @@ export namespace UsageListResponse {
            */
           type:
             | 'custom-model'
+            | 'for-each'
             | 'generate-prompt'
+            | 'list'
             | 'logic'
+            | 'model'
             | 'remove-background'
             | 'transform'
             | 'user-approval'
@@ -663,17 +758,46 @@ export namespace UsageListResponse {
            */
           assets?: Array<Flow.Asset>;
 
+          /**
+           * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
+           * `count` times regardless of array input. When not set, the loop iterates over
+           * the resolved array input. Only available for ForEach nodes.
+           */
+          count?: number;
+
           /**
            * The nodes that this node depends on. Only available for nodes that have
            * dependencies. Mainly used for user approval nodes.
            */
           dependsOn?: Array<string>;
 
+          /**
+           * If true, the outputs of this node will be included in the workflow job's final
+           * output. Only applicable to producing nodes (custom-model, inference, etc.). By
+           * default, only last nodes (nodes not referenced by other nodes) contribute to
+           * outputs. Set this to true to also include intermediate nodes in the final
+           * output. Note: This should only be set to `true` or left undefined.
+           */
+          includeOutputsInWorkflowJob?: true;
+
           /**
            * The inputs of the node.
            */
           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.
+           */
+          items?: Array<string>;
+
+          /**
+           * Zero-based index of the iteration this node copy belongs to. Set on
+           * dynamically-created copies of loop body nodes.
+           */
+          iterationIndex?: number;
+
           /**
            * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
            * only available for nodes started. A node "Pending" for a running workflow job is
@@ -691,11 +815,29 @@ export namespace UsageListResponse {
            */
           logicType?: 'if-else';
 
+          /**
+           * IDs of the body template nodes that belong to this ForEach loop. At runtime
+           * these templates are cloned once per iteration and marked Skipped. Only available
+           * for ForEach nodes.
+           */
+          loopBodyNodeIds?: Array<string>;
+
+          /**
+           * ID of the ForEach node that spawned this iteration copy. Set on
+           * dynamically-created copies of loop body nodes.
+           */
+          loopNodeId?: string;
+
           /**
            * The model id for the node. Mainly used for custom model tasks.
            */
           modelId?: string;
 
+          /**
+           * The output of the node. Only available for logic nodes.
+           */
+          output?: unknown;
+
           /**
            * The workflow id for the node. Mainly used for workflow tasks.
            */
@@ -756,6 +898,11 @@ export namespace UsageListResponse {
              */
             costImpact?: boolean;
 
+            /**
+             * The default value for the input
+             */
+            default?: unknown;
+
             /**
              * Help text displayed in the UI to provide additional information about the input
              */
@@ -777,11 +924,20 @@ export namespace UsageListResponse {
              * the same as the current object. This is only available for type inputs_array
              * inputs.
              */
-            inputs?: Array<unknown>;
+            inputs?: Array<{ [key: string]: unknown }>;
+
+            /**
+             * The configured items for inputs_array type inputs. Each item is an array of
+             * SubNodeInput that need ref/value resolution. Only available for inputs_array
+             * type.
+             */
+            items?: Array<Array<Input.Item>>;
 
             /**
              * The asset kind of the input. Only taken into account for \`file\` and
-             * \`file_array\` input types.
+             * \`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
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
 
@@ -807,6 +963,13 @@ export namespace UsageListResponse {
              */
             maxLength?: number;
 
+            /**
+             * The maximum allowed file size in bytes. Only applies to \`file\` and
+             * \`file_array\` input types. Validated against \`asset.properties.size\` at job
+             * creation time.
+             */
+            maxSize?: number;
+
             /**
              * The minimum allowed value. Only available for \`number\` and array input types.
              */
@@ -824,6 +987,7 @@ export namespace UsageListResponse {
              */
             modelTypes?: Array<
               | 'custom'
+              | 'elevenlabs-voice'
               | 'flux.1'
               | 'flux.1-composition'
               | 'flux.1-kontext-dev'
@@ -833,14 +997,32 @@ export namespace UsageListResponse {
               | 'flux.1-lora'
               | 'flux.1-pro'
               | 'flux.1.1-pro-ultra'
+              | 'flux.2-dev-edit-lora'
+              | 'flux.2-dev-lora'
+              | 'flux.2-klein-4b-edit-lora'
+              | 'flux.2-klein-4b-lora'
+              | 'flux.2-klein-9b-edit-lora'
+              | 'flux.2-klein-9b-lora'
+              | 'flux.2-klein-base-4b-edit-lora'
+              | 'flux.2-klein-base-4b-lora'
+              | 'flux.2-klein-base-9b-edit-lora'
+              | 'flux.2-klein-base-9b-lora'
               | 'flux1.1-pro'
               | 'gpt-image-1'
+              | 'qwen-image-2512-lora'
+              | 'qwen-image-edit-2509-lora'
+              | 'qwen-image-edit-2511-lora'
+              | 'qwen-image-edit-lora'
+              | 'qwen-image-lora'
               | 'sd-1_5'
               | 'sd-1_5-composition'
               | 'sd-1_5-lora'
               | 'sd-xl'
               | 'sd-xl-composition'
               | 'sd-xl-lora'
+              | 'zimage-de-turbo-lora'
+              | 'zimage-lora'
+              | 'zimage-turbo-lora'
             >;
 
             /**
@@ -892,9 +1074,316 @@ export namespace UsageListResponse {
              * The step increment for numeric inputs. Only available for \`number\` input type.
              */
             step?: number;
+
+            /**
+             * The value of the input. This is the value of the input that will be used to run
+             * the node. Only available for flows managed by a WorkflowJob.
+             */
+            value?: unknown;
           }
 
           export namespace Input {
+            /**
+             * A sub-input within an inputs_array item. Same as NodeInput but without the
+             * recursive items field.
+             */
+            export interface Item {
+              /**
+               * The name that must be user to call the model through the API
+               */
+              name: string;
+
+              /**
+               * The data type of the input
+               */
+              type:
+                | 'boolean'
+                | 'file'
+                | 'file_array'
+                | 'inputs_array'
+                | 'model'
+                | 'model_array'
+                | 'number'
+                | 'number_array'
+                | 'string'
+                | 'string_array';
+
+              /**
+               * The allowed values for the input. For \`string\` or \`number\` types, creates a
+               * single-select dropdown. For \`string_array\` type, creates a multi-select
+               * dropdown.
+               */
+              allowedValues?: Array<unknown>;
+
+              /**
+               * Specifies the background behavior for the input. Only available for \`file\` and
+               * \`file_array\` input types with kind \`image\`.
+               */
+              backgroundBehavior?: 'opaque' | 'transparent';
+
+              /**
+               * Whether the input is a color or not. Only available for \`string\` input type.
+               */
+              color?: boolean;
+
+              /**
+               * Whether this input affects the model's cost calculation
+               */
+              costImpact?: boolean;
+
+              /**
+               * The default value for the input
+               */
+              default?: unknown;
+
+              /**
+               * Help text displayed in the UI to provide additional information about the input
+               */
+              description?: string;
+
+              /**
+               * Used to visually group inputs together in the UI. Inputs with the same group
+               * value appear consecutively in the UI.
+               */
+              group?: string;
+
+              /**
+               * Hint text displayed in the UI as a tooltip to guide the user
+               */
+              hint?: string;
+
+              /**
+               * The list of inputs which form an object within a container array. All inputs are
+               * the same as the current object. This is only available for type inputs_array
+               * inputs.
+               */
+              inputs?: Array<{ [key: string]: unknown }>;
+
+              /**
+               * 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
+               */
+              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+              /**
+               * The label displayed in the UI for this input
+               */
+              label?: string;
+
+              /**
+               * The name of the file input field to use as the mask source
+               */
+              maskFrom?: string;
+
+              /**
+               * The maximum allowed value. Only available for \`number\` and \`array\` input
+               * types.
+               */
+              max?: number;
+
+              /**
+               * The maximum allowed length for \`string\` inputs. Also applies to each item in
+               * \`string_array\`.
+               */
+              maxLength?: number;
+
+              /**
+               * The maximum allowed file size in bytes. Only applies to \`file\` and
+               * \`file_array\` input types. Validated against \`asset.properties.size\` at job
+               * creation time.
+               */
+              maxSize?: number;
+
+              /**
+               * The minimum allowed value. Only available for \`number\` and array input types.
+               */
+              min?: number;
+
+              /**
+               * The minimum allowed length for string inputs. Also applies to each item in
+               * \`string_array\`.
+               */
+              minLength?: number;
+
+              /**
+               * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+               * available for \`model_array\` input type.
+               */
+              modelTypes?: Array<
+                | 'custom'
+                | 'elevenlabs-voice'
+                | 'flux.1'
+                | 'flux.1-composition'
+                | 'flux.1-kontext-dev'
+                | 'flux.1-kontext-lora'
+                | 'flux.1-krea-dev'
+                | 'flux.1-krea-lora'
+                | 'flux.1-lora'
+                | 'flux.1-pro'
+                | 'flux.1.1-pro-ultra'
+                | 'flux.2-dev-edit-lora'
+                | 'flux.2-dev-lora'
+                | 'flux.2-klein-4b-edit-lora'
+                | 'flux.2-klein-4b-lora'
+                | 'flux.2-klein-9b-edit-lora'
+                | 'flux.2-klein-9b-lora'
+                | 'flux.2-klein-base-4b-edit-lora'
+                | 'flux.2-klein-base-4b-lora'
+                | 'flux.2-klein-base-9b-edit-lora'
+                | 'flux.2-klein-base-9b-lora'
+                | 'flux1.1-pro'
+                | 'gpt-image-1'
+                | 'qwen-image-2512-lora'
+                | 'qwen-image-edit-2509-lora'
+                | 'qwen-image-edit-2511-lora'
+                | 'qwen-image-edit-lora'
+                | 'qwen-image-lora'
+                | 'sd-1_5'
+                | 'sd-1_5-composition'
+                | 'sd-1_5-lora'
+                | 'sd-xl'
+                | 'sd-xl-composition'
+                | 'sd-xl-lora'
+                | 'zimage-de-turbo-lora'
+                | 'zimage-lora'
+                | 'zimage-turbo-lora'
+              >;
+
+              /**
+               * Whether this input represents a parent asset to assign to the produced assets.
+               * Only available for \`file\` and \`file_array\` input types.
+               *
+               * For \`file_array\`, the parent asset is the first item in the array.
+               */
+              parent?: boolean;
+
+              /**
+               * Placeholder text for the input. Only available for 'string' input type.
+               */
+              placeholder?: string;
+
+              /**
+               * Whether the input is a prompt. When true, displays as a text area with prompt
+               * spark feature. Only available for \`string\` input type.
+               */
+              prompt?: boolean;
+
+              /**
+               * Whether the input is used with prompt spark. Only available for \`string\` input
+               * type.
+               */
+              promptSpark?: boolean;
+
+              /**
+               * The reference to another input or output of the same workflow. Must have at
+               * least one of node or conditional.
+               */
+              ref?: Item.Ref;
+
+              /**
+               * Set of rules that describes when this input is required:
+               *
+               * - \`always\`: Input is always required
+               * - \`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
+               *
+               * By default, the input is not required.
+               */
+              required?: Item.Required;
+
+              /**
+               * The step increment for numeric inputs. Only available for \`number\` input type.
+               */
+              step?: number;
+
+              /**
+               * The value of the input. This is the value of the input that will be used to run
+               * the node. Only available for flows managed by a WorkflowJob.
+               */
+              value?: unknown;
+            }
+
+            export namespace Item {
+              /**
+               * The reference to another input or output of the same workflow. Must have at
+               * least one of node or conditional.
+               */
+              export interface Ref {
+                /**
+                 * The conditional nodes to reference. If the conditional nodes are successful, the
+                 * node will be successful. If the conditional nodes are skipped, the node will be
+                 * skipped. Contains an array of node ids used to check the status of the nodes.
+                 */
+                conditional?: Array<string>;
+
+                /**
+                 * This is the desired node output value if ref is an if/else node.
+                 */
+                equal?: string;
+
+                /**
+                 * The name of the input or output to reference. If the type is 'workflow', the
+                 * name is the name of the input of the workflow is required If the type is 'node',
+                 * the name is not mandatory, except if you want all outputs of the node. To get
+                 * all outputs of a node, you can use the name 'all'.
+                 */
+                name?: string;
+
+                /**
+                 * The node id or 'workflow' if the source is a workflow input.
+                 */
+                node?: string;
+              }
+
+              /**
+               * Set of rules that describes when this input is required:
+               *
+               * - \`always\`: Input is always required
+               * - \`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
+               *
+               * By default, the input is not required.
+               */
+              export interface Required {
+                /**
+                 * Whether the input is always required
+                 */
+                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
+                 */
+                conditionalValues?: unknown;
+
+                /**
+                 * Makes this input required when another input is defined:
+                 *
+                 * - Key: name of the input that must be defined
+                 * - Value: message to display when this input is required
+                 */
+                ifDefined?: unknown;
+
+                /**
+                 * Makes this input required when another input is not defined:
+                 *
+                 * - Key: name of the input that must be undefined
+                 * - Value: message to display when this input is required
+                 */
+                ifNotDefined?: unknown;
+              }
+            }
+
             /**
              * The reference to another input or output of the same workflow. Must have at
              * least one of node or conditional.
@@ -1113,6 +1602,16 @@ export namespace UsageListResponse {
 
   export namespace ModelUsage {
     export interface Point {
+      /**
+       * Cost for model usage for API key only
+       */
+      apiKeyCost: number;
+
+      /**
+       * The discount for model usage for API key only
+       */
+      apiKeyDiscount: number;
+
       /**
        * Cost for model usage
        */
@@ -1135,6 +1634,34 @@ export namespace UsageListResponse {
     }
   }
 
+  export interface NsfwUsage {
+    label: string;
+
+    /**
+     * The data points
+     */
+    points: Array<NsfwUsage.Point>;
+  }
+
+  export namespace NsfwUsage {
+    export interface Point {
+      /**
+       * Number of NSFW assets created
+       */
+      count: number;
+
+      /**
+       * Number of NSFW assets created via an API key
+       */
+      countApiKey: number;
+
+      /**
+       * The UTC ISO date of the point
+       */
+      time: string;
+    }
+  }
+
   export interface Usage {
     /**
      * Granularity for points (example: "1d", "1h", "1m", "15m")
@@ -1156,6 +1683,7 @@ export namespace UsageListResponse {
       | 'creative-unit-cost'
       | 'creative-unit-discount'
       | 'custom'
+      | 'custom-asset-created'
       | 'detection'
       | 'image-prompt-editing'
       | 'images-generation'
@@ -1174,6 +1702,11 @@ export namespace UsageListResponse {
 
   export namespace Usage {
     export interface Point {
+      /**
+       * Value of the point for API key only
+       */
+      apiKey: string;
+
       /**
        * The UTC ISO date of the point
        */
@@ -1192,7 +1725,7 @@ export interface UsageListParams {
    * The offset for the activity data. Default is 0. If bad offset or empty, 0 will
    * be returned. Must be a positive integer.
    */
-  activityOffset?: string;
+  activityOffset?: number;
 
   /**
    * The end date of the usage in ISO 8601 format. If not provided, use default
@@ -1216,13 +1749,13 @@ export interface UsageListParams {
    * The time range of the usage. If not provided, use default timeRange. If
    * startDate and endDate provided, timeRange is ignored.
    */
-  timeRange?: string;
+  timeRange?: 'last-hour' | 'last-day' | 'last-three-days' | 'last-seven-days' | 'last-thirty-one-days';
 
   /**
    * The type of the usage data. Can be one or more comma separated values. Default
    * is all types. If bad type or empty, all types will be returned.
    */
-  type?: string;
+  type?: 'usages' | 'activity' | 'consumption' | 'model-usages' | 'asset-usages' | 'nsfw-usages';
 
   /**
    * The unique identifier of the user for the usage. If not provided, returns all