@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/assets/assets.ts

@@ -21,6 +21,7 @@ import {
 } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Assets extends APIResource {
   download: DownloadAPI.Download = new DownloadAPI.Download(this._client);
@@ -35,7 +36,10 @@ export class Assets extends APIResource {
     query: AssetRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<AssetRetrieveResponse> {
-    return this._client.get(path`/assets/${assetID}`, { query, ...options });
+    return this._client.get(path`/assets/${assetID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -48,9 +52,9 @@ export class Assets extends APIResource {
   ): APIPromise<AssetUpdateResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/assets/${assetID}`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -63,7 +67,10 @@ export class Assets extends APIResource {
     query: AssetListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<AssetListResponsesAssetsCursor, AssetListResponse> {
-    return this._client.getAPIList('/assets', AssetsCursor<AssetListResponse>, { query, ...options });
+    return this._client.getAPIList('/assets', AssetsCursor<AssetListResponse>, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -71,7 +78,11 @@ export class Assets extends APIResource {
    */
   deleteMultiple(params: AssetDeleteMultipleParams, options?: RequestOptions): APIPromise<unknown> {
     const { projectId, ...body } = params;
-    return this._client.delete('/assets', { query: { projectId }, body, ...options });
+    return this._client.delete('/assets', {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -84,9 +95,9 @@ export class Assets extends APIResource {
   ): APIPromise<AssetDuplicateResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.post(path`/assets/${assetID}/copy`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -95,7 +106,11 @@ export class Assets extends APIResource {
    */
   getBulk(params: AssetGetBulkParams, options?: RequestOptions): APIPromise<AssetGetBulkResponse> {
     const { originalAssets, projectId, ...body } = params;
-    return this._client.post('/assets/get-bulk', { query: { originalAssets, projectId }, body, ...options });
+    return this._client.post('/assets/get-bulk', {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -109,7 +124,7 @@ export class Assets extends APIResource {
     return this._client.getAPIList(
       path`/assets/${assetID}/snapshots`,
       SnapshotsCursor<AssetListSnapshotsResponse>,
-      { query, ...options },
+      { ...options, query: { ...query, ...omitUndefined(options?.query) } },
     );
   }
 
@@ -119,9 +134,9 @@ export class Assets extends APIResource {
   lock(assetID: string, params: AssetLockParams, options?: RequestOptions): APIPromise<AssetLockResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/assets/${assetID}/lock`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -135,9 +150,9 @@ export class Assets extends APIResource {
   ): APIPromise<AssetUnlockResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/assets/${assetID}/unlock`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -150,7 +165,11 @@ export class Assets extends APIResource {
     options?: RequestOptions,
   ): APIPromise<AssetUpdateTagsResponse> {
     const { projectId, ...body } = params;
-    return this._client.put(path`/assets/${assetID}/tags`, { query: { projectId }, body, ...options });
+    return this._client.put(path`/assets/${assetID}/tags`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -158,7 +177,11 @@ export class Assets extends APIResource {
    */
   upload(params: AssetUploadParams, options?: RequestOptions): APIPromise<AssetUploadResponse> {
     const { originalAssets, projectId, ...body } = params;
-    return this._client.post('/assets', { query: { originalAssets, projectId }, body, ...options });
+    return this._client.post('/assets', {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -419,6 +442,7 @@ export namespace AssetRetrieveResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -449,6 +473,7 @@ export namespace AssetRetrieveResponse {
       | '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'
@@ -686,6 +711,12 @@ export namespace AssetRetrieveResponse {
        */
       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;
 
       /**
@@ -775,6 +806,11 @@ export namespace AssetRetrieveResponse {
        */
       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
        */
@@ -1796,6 +1832,7 @@ export namespace AssetUpdateResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -1826,6 +1863,7 @@ export namespace AssetUpdateResponse {
       | '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'
@@ -2063,6 +2101,12 @@ export namespace AssetUpdateResponse {
        */
       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;
 
       /**
@@ -2152,6 +2196,11 @@ export namespace AssetUpdateResponse {
        */
       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
        */
@@ -3168,6 +3217,7 @@ export interface AssetListResponse {
     | 'application/x-zip-compressed'
     | 'application/x.autodesk.fbx'
     | 'application/zip'
+    | 'audio/flac'
     | 'audio/m4a'
     | 'audio/mpeg'
     | 'audio/ogg'
@@ -3198,6 +3248,7 @@ export interface AssetListResponse {
     | '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'
@@ -3435,6 +3486,12 @@ export namespace AssetListResponse {
      */
     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;
 
     /**
@@ -3524,6 +3581,11 @@ export namespace AssetListResponse {
      */
     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
      */
@@ -4546,6 +4608,7 @@ export namespace AssetDuplicateResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -4576,6 +4639,7 @@ export namespace AssetDuplicateResponse {
       | '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'
@@ -4813,6 +4877,12 @@ export namespace AssetDuplicateResponse {
        */
       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;
 
       /**
@@ -4902,6 +4972,11 @@ export namespace AssetDuplicateResponse {
        */
       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
        */
@@ -5923,6 +5998,7 @@ export namespace AssetGetBulkResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -5953,6 +6029,7 @@ export namespace AssetGetBulkResponse {
       | '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'
@@ -6190,6 +6267,12 @@ export namespace AssetGetBulkResponse {
        */
       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;
 
       /**
@@ -6279,6 +6362,11 @@ export namespace AssetGetBulkResponse {
        */
       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
        */
@@ -7315,6 +7403,7 @@ export namespace AssetLockResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -7345,6 +7434,7 @@ export namespace AssetLockResponse {
       | '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'
@@ -7582,6 +7672,12 @@ export namespace AssetLockResponse {
        */
       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;
 
       /**
@@ -7671,6 +7767,11 @@ export namespace AssetLockResponse {
        */
       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
        */
@@ -8692,6 +8793,7 @@ export namespace AssetUnlockResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -8722,6 +8824,7 @@ export namespace AssetUnlockResponse {
       | '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'
@@ -8959,6 +9062,12 @@ export namespace AssetUnlockResponse {
        */
       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;
 
       /**
@@ -9048,6 +9157,11 @@ export namespace AssetUnlockResponse {
        */
       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
        */
@@ -10083,6 +10197,7 @@ export namespace AssetUploadResponse {
       | 'application/x-zip-compressed'
       | 'application/x.autodesk.fbx'
       | 'application/zip'
+      | 'audio/flac'
       | 'audio/m4a'
       | 'audio/mpeg'
       | 'audio/ogg'
@@ -10113,6 +10228,7 @@ export namespace AssetUploadResponse {
       | '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'
@@ -10350,6 +10466,12 @@ export namespace AssetUploadResponse {
        */
       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;
 
       /**
@@ -10439,6 +10561,11 @@ export namespace AssetUploadResponse {
        */
       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
        */
@@ -11390,6 +11517,7 @@ export namespace AssetUploadResponse {
           | 'remove-background'
           | 'transform'
           | 'user-approval'
+          | 'user-selection'
           | 'workflow';
 
         /**
@@ -11420,14 +11548,15 @@ export namespace AssetUploadResponse {
         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>;
 
@@ -11707,8 +11836,7 @@ export namespace AssetUploadResponse {
            * - \`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.
            */
@@ -11938,8 +12066,7 @@ export namespace AssetUploadResponse {
              * - \`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.
              */
@@ -11996,8 +12123,7 @@ export namespace AssetUploadResponse {
              * - \`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.
              */
@@ -12008,12 +12134,9 @@ export namespace AssetUploadResponse {
               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:
@@ -12031,6 +12154,26 @@ export namespace AssetUploadResponse {
                */
               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';
+              }
+            }
           }
 
           /**
@@ -12071,8 +12214,7 @@ export namespace AssetUploadResponse {
            * - \`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.
            */
@@ -12083,12 +12225,9 @@ export namespace AssetUploadResponse {
             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:
@@ -12106,6 +12245,26 @@ export namespace AssetUploadResponse {
              */
             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';
+            }
+          }
         }
 
         /**