@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/models/description.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Description extends APIResource {
   /**
@@ -14,7 +15,10 @@ export class Description extends APIResource {
     query: DescriptionRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<DescriptionRetrieveResponse> {
-    return this._client.get(path`/models/${modelID}/description`, { query, ...options });
+    return this._client.get(path`/models/${modelID}/description`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -27,9 +31,9 @@ export class Description extends APIResource {
   ): APIPromise<DescriptionUpdateResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelID}/description`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 }
@@ -213,6 +217,7 @@ export namespace DescriptionRetrieveResponse {
         | 'application/x-zip-compressed'
         | 'application/x.autodesk.fbx'
         | 'application/zip'
+        | 'audio/flac'
         | 'audio/m4a'
         | 'audio/mpeg'
         | 'audio/ogg'
@@ -243,6 +248,7 @@ export namespace DescriptionRetrieveResponse {
         | 'model/vnd.collada+xml'
         | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
         | 'model/x-3d-vox'
+        | 'model/x-blender'
         | 'model/x-fbx'
         | 'model/x-maya-ascii'
         | 'model/x-maya-binary'
@@ -724,6 +730,7 @@ export namespace DescriptionUpdateResponse {
         | 'application/x-zip-compressed'
         | 'application/x.autodesk.fbx'
         | 'application/zip'
+        | 'audio/flac'
         | 'audio/m4a'
         | 'audio/mpeg'
         | 'audio/ogg'
@@ -754,6 +761,7 @@ export namespace DescriptionUpdateResponse {
         | 'model/vnd.collada+xml'
         | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
         | 'model/x-3d-vox'
+        | 'model/x-blender'
         | 'model/x-fbx'
         | 'model/x-maya-ascii'
         | 'model/x-maya-binary'

package/src/resources/models/examples.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Examples extends APIResource {
   /**
@@ -16,9 +17,9 @@ export class Examples extends APIResource {
   ): APIPromise<ExampleUpdateResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelID}/examples`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -30,7 +31,10 @@ export class Examples extends APIResource {
     query: ExampleListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ExampleListResponse> {
-    return this._client.get(path`/models/${modelID}/examples`, { query, ...options });
+    return this._client.get(path`/models/${modelID}/examples`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -318,6 +322,7 @@ export namespace ExampleUpdateResponse {
         | 'application/x-zip-compressed'
         | 'application/x.autodesk.fbx'
         | 'application/zip'
+        | 'audio/flac'
         | 'audio/m4a'
         | 'audio/mpeg'
         | 'audio/ogg'
@@ -348,6 +353,7 @@ export namespace ExampleUpdateResponse {
         | 'model/vnd.collada+xml'
         | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
         | 'model/x-3d-vox'
+        | 'model/x-blender'
         | 'model/x-fbx'
         | 'model/x-maya-ascii'
         | 'model/x-maya-binary'
@@ -585,6 +591,12 @@ export namespace ExampleUpdateResponse {
          */
         factor?: number;
 
+        /**
+         * The name its parent's files reference it by (an OBJ's MTL, an MTL's texture),
+         * kept as delivered.
+         */
+        fileName?: string;
+
         filterSpeckle?: number;
 
         /**
@@ -674,6 +686,11 @@ export namespace ExampleUpdateResponse {
          */
         invert?: boolean;
 
+        /**
+         * Its own references (an OBJ's `mtllib`, an MTL's maps) were kept as delivered.
+         */
+        keepsFileNames?: boolean;
+
         /**
          * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
          */
@@ -1971,6 +1988,7 @@ export namespace ExampleUpdateResponse {
             | 'remove-background'
             | 'transform'
             | 'user-approval'
+            | 'user-selection'
             | 'workflow';
 
           /**
@@ -2001,14 +2019,15 @@ export namespace ExampleUpdateResponse {
           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>;
 
@@ -2288,8 +2307,7 @@ export namespace ExampleUpdateResponse {
              * - \`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.
              */
@@ -2519,8 +2537,7 @@ export namespace ExampleUpdateResponse {
                * - \`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.
                */
@@ -2577,8 +2594,7 @@ export namespace ExampleUpdateResponse {
                * - \`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.
                */
@@ -2589,12 +2605,9 @@ export namespace ExampleUpdateResponse {
                 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:
@@ -2612,6 +2625,26 @@ export namespace ExampleUpdateResponse {
                  */
                 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';
+                }
+              }
             }
 
             /**
@@ -2652,8 +2685,7 @@ export namespace ExampleUpdateResponse {
              * - \`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.
              */
@@ -2664,12 +2696,9 @@ export namespace ExampleUpdateResponse {
               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:
@@ -2687,6 +2716,26 @@ export namespace ExampleUpdateResponse {
                */
               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';
+              }
+            }
           }
 
           /**
@@ -3085,6 +3134,7 @@ export namespace ExampleListResponse {
         | 'application/x-zip-compressed'
         | 'application/x.autodesk.fbx'
         | 'application/zip'
+        | 'audio/flac'
         | 'audio/m4a'
         | 'audio/mpeg'
         | 'audio/ogg'
@@ -3115,6 +3165,7 @@ export namespace ExampleListResponse {
         | 'model/vnd.collada+xml'
         | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
         | 'model/x-3d-vox'
+        | 'model/x-blender'
         | 'model/x-fbx'
         | 'model/x-maya-ascii'
         | 'model/x-maya-binary'
@@ -3352,6 +3403,12 @@ export namespace ExampleListResponse {
          */
         factor?: number;
 
+        /**
+         * The name its parent's files reference it by (an OBJ's MTL, an MTL's texture),
+         * kept as delivered.
+         */
+        fileName?: string;
+
         filterSpeckle?: number;
 
         /**
@@ -3441,6 +3498,11 @@ export namespace ExampleListResponse {
          */
         invert?: boolean;
 
+        /**
+         * Its own references (an OBJ's `mtllib`, an MTL's maps) were kept as delivered.
+         */
+        keepsFileNames?: boolean;
+
         /**
          * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
          */
@@ -4738,6 +4800,7 @@ export namespace ExampleListResponse {
             | 'remove-background'
             | 'transform'
             | 'user-approval'
+            | 'user-selection'
             | 'workflow';
 
           /**
@@ -4768,14 +4831,15 @@ export namespace ExampleListResponse {
           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>;
 
@@ -5055,8 +5119,7 @@ export namespace ExampleListResponse {
              * - \`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.
              */
@@ -5286,8 +5349,7 @@ export namespace ExampleListResponse {
                * - \`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.
                */
@@ -5344,8 +5406,7 @@ export namespace ExampleListResponse {
                * - \`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.
                */
@@ -5356,12 +5417,9 @@ export namespace ExampleListResponse {
                 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:
@@ -5379,6 +5437,26 @@ export namespace ExampleListResponse {
                  */
                 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';
+                }
+              }
             }
 
             /**
@@ -5419,8 +5497,7 @@ export namespace ExampleListResponse {
              * - \`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.
              */
@@ -5431,12 +5508,9 @@ export namespace ExampleListResponse {
               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:
@@ -5454,6 +5528,26 @@ export namespace ExampleListResponse {
                */
               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';
+              }
+            }
           }
 
           /**

package/src/resources/models/index.ts

@@ -40,6 +40,31 @@ export {
   type ModelUpdateTagsParams,
   type ModelListResponsesModelsCursor,
 } from './models';
+export {
+  Presets,
+  type PresetCreateResponse,
+  type PresetUpdateResponse,
+  type PresetListResponse,
+  type PresetDeleteResponse,
+  type PresetCreateParams,
+  type PresetUpdateParams,
+  type PresetListParams,
+  type PresetDeleteParams,
+} from './presets';
+export {
+  PromptGuide,
+  type PromptGuideRetrieveResponse,
+  type PromptGuideUpdateResponse,
+  type PromptGuideRetrieveParams,
+  type PromptGuideUpdateParams,
+} from './prompt-guide';
+export {
+  Scores,
+  type ScoreRetrievePromptResponse,
+  type ScoreRetrieveTrainingDatasetResponse,
+  type ScoreRetrievePromptParams,
+  type ScoreRetrieveTrainingDatasetParams,
+} from './scores';
 export {
   Train,
   type TrainActionResponse,