@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/assets/download.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 Download extends APIResource {
   /**
@@ -14,7 +15,10 @@ export class Download extends APIResource {
     query: DownloadGetStatusParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<DownloadGetStatusResponse> {
-    return this._client.get(path`/assets/download/${jobID}`, { query, ...options });
+    return this._client.get(path`/assets/download/${jobID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -26,7 +30,11 @@ export class Download extends APIResource {
     options?: RequestOptions,
   ): APIPromise<DownloadRequestResponse> {
     const { projectId, ...body } = params;
-    return this._client.post(path`/assets/${assetID}/download`, { query: { projectId }, body, ...options });
+    return this._client.post(path`/assets/${assetID}/download`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -36,8 +44,12 @@ export class Download extends APIResource {
     params: DownloadRequestBatchParams,
     options?: RequestOptions,
   ): APIPromise<DownloadRequestBatchResponse> {
-    const { projectId, ...body } = params;
-    return this._client.post('/assets/download', { query: { projectId }, body, ...options });
+    const { dryRun, projectId, ...body } = params;
+    return this._client.post('/assets/download', {
+      body,
+      ...options,
+      query: { dryRun, projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -60,9 +72,15 @@ export interface DownloadGetStatusResponse {
 
 export interface DownloadRequestResponse {
   /**
-   * The signed URL to download the asset in the given format
+   * The signed URL to download the asset in the requested format, or its original
+   * file when `targetFormat` is omitted
    */
   url: string;
+
+  /**
+   * Mime type of the file served at `url`
+   */
+  mimeType?: string;
 }
 
 export interface DownloadRequestBatchResponse {
@@ -88,7 +106,8 @@ export interface DownloadRequestParams {
   projectId?: string;
 
   /**
-   * Body param: The format to download the asset in
+   * Body param: The format to download the asset in. If omitted, the original file
+   * is returned. Audio and video assets only accept their stored format.
    */
   targetFormat?:
     | 'gif'
@@ -103,7 +122,9 @@ export interface DownloadRequestParams {
     | 'tiff'
     | 'glb'
     | 'fbx'
-    | 'obj';
+    | 'obj'
+    | 'mp3'
+    | 'mp4';
 }
 
 export interface DownloadRequestBatchParams {
@@ -117,6 +138,12 @@ export interface DownloadRequestBatchParams {
    */
   query: DownloadRequestBatchParams.Query;
 
+  /**
+   * Query param: Estimate the operation instead of running it: the call returns a
+   * 269 response carrying the creative units cost. `api` estimates at the API tier.
+   */
+  dryRun?: 'true' | 'api';
+
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -129,15 +156,40 @@ export namespace DownloadRequestBatchParams {
     /**
      * A file naming convention as a string with the following available parameters:
      * <seed> (seed used to generate the asset) <num> (index of the asset in the
-     * inference) <prompt> (prompt of the inference) <generator> (prompt of the
-     * generator) Example: "<generator>-<prompt>-<num>-<seed>"
+     * inference) <prompt> (slug of the inference prompt: lower-cased, function words
+     * removed, max 8 words, joined with `_`) <generator> (name of the generator) <id>
+     * (asset id) <description> (slug of the asset description or caption: lower-cased,
+     * function words removed, max 8 words, joined with `_`. Does not fall back to the
+     * prompt.) A `/` in the template creates a subdirectory (e.g. `<prompt>/<id>` →
+     * `cat_dancing/asset_….png`). Later occurrences of the same dynamic token are
+     * dropped together with their preceding separator. The filename, including the
+     * extension, is capped at 128 characters; each template directory segment is
+     * capped at 64. Prompt and description are truncated first. Example:
+     * "<description>-<id>"
      */
     fileNameTemplate: string;
 
+    /**
+     * Name of the downloaded zip file, without the `.zip` extension. Defaults to
+     * `<YYYYMMDD>-export`.
+     */
+    archiveName?: string;
+
     /**
      * Flag to prevent grouping assets in directories and store them flat
      */
     flat?: boolean;
+
+    /**
+     * Flag to archive the file as it was originally uploaded, for assets whose upload
+     * was re-encoded on creation (e.g. a .mov stored as mp4). Each archived file is
+     * named with the extension of the format it contains.
+     *
+     * Assets that have no preserved original (every image, and anything uploaded in a
+     * format we serve as-is) are archived unchanged, so this is a preference and never
+     * fails a download.
+     */
+    preferOriginal?: boolean;
   }
 
   export interface Query {

package/src/resources/collections/assets.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 Assets extends APIResource {
   /**
@@ -12,9 +13,9 @@ export class Assets extends APIResource {
   add(collectionID: string, params: AssetAddParams, options?: RequestOptions): APIPromise<AssetAddResponse> {
     const { projectId, ...body } = params;
     return this._client.put(path`/collections/${collectionID}/assets`, {
-      query: { projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -28,9 +29,9 @@ export class Assets extends APIResource {
   ): APIPromise<AssetRemoveResponse> {
     const { projectId, ...body } = params;
     return this._client.delete(path`/collections/${collectionID}/assets`, {
-      query: { projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 }

package/src/resources/collections/collections.ts

@@ -9,6 +9,7 @@ import { APIPromise } from '../../core/api-promise';
 import { CollectionsCursor, type CollectionsCursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Collections extends APIResource {
   assets: AssetsAPI.Assets = new AssetsAPI.Assets(this._client);
@@ -19,7 +20,11 @@ export class Collections extends APIResource {
    */
   create(params: CollectionCreateParams, options?: RequestOptions): APIPromise<CollectionCreateResponse> {
     const { projectId, ...body } = params;
-    return this._client.post('/collections', { query: { projectId }, body, ...options });
+    return this._client.post('/collections', {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -30,7 +35,10 @@ export class Collections extends APIResource {
     query: CollectionRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CollectionRetrieveResponse> {
-    return this._client.get(path`/collections/${collectionID}`, { query, ...options });
+    return this._client.get(path`/collections/${collectionID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -42,7 +50,11 @@ export class Collections extends APIResource {
     options?: RequestOptions,
   ): APIPromise<CollectionUpdateResponse> {
     const { projectId, ...body } = params;
-    return this._client.put(path`/collections/${collectionID}`, { query: { projectId }, body, ...options });
+    return this._client.put(path`/collections/${collectionID}`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -53,8 +65,8 @@ export class Collections extends APIResource {
     options?: RequestOptions,
   ): PagePromise<CollectionListResponsesCollectionsCursor, CollectionListResponse> {
     return this._client.getAPIList('/collections', CollectionsCursor<CollectionListResponse>, {
-      query,
       ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
     });
   }
 
@@ -67,7 +79,10 @@ export class Collections extends APIResource {
     options?: RequestOptions,
   ): APIPromise<unknown> {
     const { projectId } = params ?? {};
-    return this._client.delete(path`/collections/${collectionID}`, { query: { projectId }, ...options });
+    return this._client.delete(path`/collections/${collectionID}`, {
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 

package/src/resources/collections/models.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 Models extends APIResource {
   /**
@@ -12,9 +13,9 @@ export class Models extends APIResource {
   add(collectionID: string, params: ModelAddParams, options?: RequestOptions): APIPromise<ModelAddResponse> {
     const { projectId, ...body } = params;
     return this._client.put(path`/collections/${collectionID}/models`, {
-      query: { projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -28,9 +29,9 @@ export class Models extends APIResource {
   ): APIPromise<ModelRemoveResponse> {
     const { projectId, ...body } = params;
     return this._client.delete(path`/collections/${collectionID}/models`, {
-      query: { projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 }