@scenario-labs/sdk 3.2.0 → 3.3.1

package/src/resources/index.ts

@@ -47,16 +47,20 @@ export {
   type GenerateDescribeStyleResponse,
   type GenerateDetectResponse,
   type GenerateEmbedResponse,
+  type GenerateIPDetectionResponse,
   type GeneratePatchResponse,
   type GeneratePromptResponse,
+  type GenerateQualityGateResponse,
   type GenerateRunModelResponse,
   type GenerateTranslateResponse,
   type GenerateCaptionParams,
   type GenerateDescribeStyleParams,
   type GenerateDetectParams,
   type GenerateEmbedParams,
+  type GenerateIPDetectionParams,
   type GeneratePatchParams,
   type GeneratePromptParams,
+  type GenerateQualityGateParams,
   type GenerateRunModelParams,
   type GenerateTranslateParams,
 } from './generate';
@@ -98,6 +102,24 @@ export {
 } from './models/models';
 export { Oscu, type OscuRetrievePricesResponse } from './oscu';
 export { Pricing } from './pricing/pricing';
+export {
+  Projects,
+  type ProjectCreateResponse,
+  type ProjectRetrieveResponse,
+  type ProjectUpdateResponse,
+  type ProjectListResponse,
+  type ProjectDeleteResponse,
+  type ProjectCreateParams,
+  type ProjectUpdateParams,
+  type ProjectListParams,
+  type ProjectListResponsesProjectsCursor,
+} from './projects/projects';
+export {
+  Recommendations,
+  type RecommendationListModelsResponse,
+  type RecommendationListModelsParams,
+  type RecommendationListModelsResponsesRecommendationsCursor,
+} from './recommendations';
 export {
   Search,
   type SearchAssetSearchResponse,
@@ -111,6 +133,16 @@ export {
   type SearchWorkflowSearchResponsesSearchHitsOffset,
 } from './search';
 export { Tags, type TagListResponse, type TagListParams, type TagListResponsesTagsCursor } from './tags';
+export {
+  Teams,
+  type TeamRetrieveResponse,
+  type TeamUpdateResponse,
+  type TeamListResponse,
+  type TeamDeleteInvitationsResponse,
+  type TeamRetrieveLimitsResponse,
+  type TeamUpdateParams,
+  type TeamDeleteInvitationsParams,
+} from './teams/teams';
 export {
   Uploads,
   type UploadCreateResponse,
@@ -131,6 +163,7 @@ export {
   type WorkflowGetTagsResponse,
   type WorkflowRunResponse,
   type WorkflowUserApprovalResponse,
+  type WorkflowUserSelectionResponse,
   type WorkflowCreateParams,
   type WorkflowRetrieveParams,
   type WorkflowUpdateParams,
@@ -139,6 +172,7 @@ export {
   type WorkflowGetTagsParams,
   type WorkflowRunParams,
   type WorkflowUserApprovalParams,
+  type WorkflowUserSelectionParams,
   type WorkflowApproveUserParams,
   type WorkflowListResponsesWorkflowsCursor,
 } from './workflows';

package/src/resources/jobs.ts

@@ -5,6 +5,7 @@ import { APIPromise } from '../core/api-promise';
 import { JobsCursor, type JobsCursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
+import { omitUndefined } from '../internal/utils/values';
 
 export class Jobs extends APIResource {
   /**
@@ -15,20 +16,27 @@ export class Jobs extends APIResource {
     query: JobRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<JobRetrieveResponse> {
-    return this._client.get(path`/jobs/${jobID}`, { query, ...options });
+    return this._client.get(path`/jobs/${jobID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
    * List all jobs matching the given filters. A job is a synchronous operation or an
    * asynchronous task such as a training, a generation, etc. It offers a unified
    * view of all operations running on the platform along with their status and
-   * results.
+   * results. A page can hold fewer jobs than "pageSize", or none, while
+   * "nextPaginationToken" is set: keep paginating until it is absent.
    */
   list(
     query: JobListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobListResponsesJobsCursor, JobListResponse> {
-    return this._client.getAPIList('/jobs', JobsCursor<JobListResponse>, { query, ...options });
+    return this._client.getAPIList('/jobs', JobsCursor<JobListResponse>, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -40,7 +48,11 @@ export class Jobs extends APIResource {
     options?: RequestOptions,
   ): APIPromise<JobTriggerActionResponse> {
     const { projectId, ...body } = params;
-    return this._client.post(path`/jobs/${jobID}/action`, { query: { projectId }, body, ...options });
+    return this._client.post(path`/jobs/${jobID}/action`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -235,6 +247,7 @@ export namespace JobRetrieveResponse {
           | 'remove-background'
           | 'transform'
           | 'user-approval'
+          | 'user-selection'
           | 'workflow';
 
         /**
@@ -265,14 +278,15 @@ export namespace JobRetrieveResponse {
         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>;
 
@@ -552,8 +566,7 @@ export namespace JobRetrieveResponse {
            * - \`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.
            */
@@ -783,8 +796,7 @@ export namespace JobRetrieveResponse {
              * - \`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.
              */
@@ -841,8 +853,7 @@ export namespace JobRetrieveResponse {
              * - \`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.
              */
@@ -853,12 +864,9 @@ export namespace JobRetrieveResponse {
               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:
@@ -876,6 +884,26 @@ export namespace JobRetrieveResponse {
                */
               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';
+              }
+            }
           }
 
           /**
@@ -916,8 +944,7 @@ export namespace JobRetrieveResponse {
            * - \`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.
            */
@@ -928,12 +955,9 @@ export namespace JobRetrieveResponse {
             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:
@@ -951,6 +975,26 @@ export namespace JobRetrieveResponse {
              */
             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';
+            }
+          }
         }
 
         /**
@@ -1248,6 +1292,7 @@ export namespace JobListResponse {
         | 'remove-background'
         | 'transform'
         | 'user-approval'
+        | 'user-selection'
         | 'workflow';
 
       /**
@@ -1278,14 +1323,15 @@ export namespace JobListResponse {
       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>;
 
@@ -1565,8 +1611,7 @@ export namespace JobListResponse {
          * - \`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.
          */
@@ -1796,8 +1841,7 @@ export namespace JobListResponse {
            * - \`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.
            */
@@ -1854,8 +1898,7 @@ export namespace JobListResponse {
            * - \`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.
            */
@@ -1866,12 +1909,9 @@ export namespace JobListResponse {
             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:
@@ -1889,6 +1929,26 @@ export namespace JobListResponse {
              */
             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';
+            }
+          }
         }
 
         /**
@@ -1929,8 +1989,7 @@ export namespace JobListResponse {
          * - \`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.
          */
@@ -1941,12 +2000,9 @@ export namespace JobListResponse {
           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:
@@ -1964,6 +2020,26 @@ export namespace JobListResponse {
            */
           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';
+          }
+        }
       }
 
       /**
@@ -2265,6 +2341,7 @@ export namespace JobTriggerActionResponse {
           | 'remove-background'
           | 'transform'
           | 'user-approval'
+          | 'user-selection'
           | 'workflow';
 
         /**
@@ -2295,14 +2372,15 @@ export namespace JobTriggerActionResponse {
         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>;
 
@@ -2582,8 +2660,7 @@ export namespace JobTriggerActionResponse {
            * - \`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.
            */
@@ -2813,8 +2890,7 @@ export namespace JobTriggerActionResponse {
              * - \`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.
              */
@@ -2871,8 +2947,7 @@ export namespace JobTriggerActionResponse {
              * - \`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.
              */
@@ -2883,12 +2958,9 @@ export namespace JobTriggerActionResponse {
               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:
@@ -2906,6 +2978,26 @@ export namespace JobTriggerActionResponse {
                */
               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';
+              }
+            }
           }
 
           /**
@@ -2946,8 +3038,7 @@ export namespace JobTriggerActionResponse {
            * - \`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.
            */
@@ -2958,12 +3049,9 @@ export namespace JobTriggerActionResponse {
             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:
@@ -2981,6 +3069,26 @@ export namespace JobTriggerActionResponse {
              */
             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';
+            }
+          }
         }
 
         /**
@@ -3104,18 +3212,32 @@ export interface JobRetrieveParams {
 
 export interface JobListParams extends JobsCursorParams {
   /**
-   * The authorId of the jobs to return. Optional.
+   * The authorId of the jobs to return. When set, only jobs from the last 30 days
+   * are returned (by creation date, or by update date when "status", "type", "types"
+   * or "workflowId" is set) unless "createdAfter" or "updatedAfter" is set.
+   * Optional.
    */
   authorId?: string;
 
   /**
-   * If false, jobs containing the hideResults param will be not returned. Optional.
+   * Only return the jobs created after this date (ISO 8601). Only allowed without
+   * "status", "type", "types" and "workflowId", which sort jobs by update date: use
+   * "updatedAfter" with them. Overrides the 30-day window applied with "authorId" or
+   * "hideResults=false". Optional.
+   */
+  createdAfter?: string;
+
+  /**
+   * If false, jobs submitted with "hideResults": true are not returned. When false,
+   * only jobs from the last 30 days are returned (by creation date, or by update
+   * date when "status", "type", "types" or "workflowId" is set) unless
+   * "createdAfter" or "updatedAfter" is set. Optional.
    */
   hideResults?: boolean;
 
   /**
-   * The number of items to return in the response. The default value is 10, maximum
-   * value is 200, minimum value is 1
+   * The number of items to return in the response. The default value is 50, maximum
+   * value is 100, minimum value is 1
    */
   pageSize?: number;
 
@@ -3230,6 +3352,14 @@ export interface JobListParams extends JobsCursorParams {
     | 'workflow'
   >;
 
+  /**
+   * Only return the jobs updated after this date (ISO 8601). Only allowed with
+   * "status", "type", "types" or "workflowId": without them jobs are sorted by
+   * creation date, use "createdAfter". Overrides the 30-day window applied with
+   * "authorId" or "hideResults=false". Optional.
+   */
+  updatedAfter?: string;
+
   /**
    * Only return the jobs produced by the given workflow. Optional.
    */