@scenario-labs/sdk 3.1.0 → 3.2.0

package/src/resources/assets/download.ts

@@ -36,8 +36,8 @@ 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', { query: { dryRun, projectId }, body, ...options });
   }
 }
 
@@ -117,6 +117,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)
@@ -138,6 +144,17 @@ export namespace DownloadRequestBatchParams {
      * 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 {