@scenario-labs/sdk 0.1.2

package/src/resources/assets/download.ts

@@ -0,0 +1,138 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Download extends APIResource {
+  /**
+   * Retrieve the status and the url of a batch download assets request
+   */
+  getStatus(jobID: string, options?: RequestOptions): APIPromise<DownloadGetStatusResponse> {
+    return this._client.get(path`/assets/download/${jobID}`, options);
+  }
+
+  /**
+   * Request a link to download the given `assetId` in the given `targetFormat`
+   */
+  request(
+    assetID: string,
+    body: DownloadRequestParams,
+    options?: RequestOptions,
+  ): APIPromise<DownloadRequestResponse> {
+    return this._client.post(path`/assets/${assetID}/download`, { body, ...options });
+  }
+
+  /**
+   * Request a link to batch download assets (batch limited to 1000 assets)
+   */
+  requestBatch(
+    body: DownloadRequestBatchParams,
+    options?: RequestOptions,
+  ): APIPromise<DownloadRequestBatchResponse> {
+    return this._client.post('/assets/download', { body, ...options });
+  }
+}
+
+export interface DownloadGetStatusResponse {
+  /**
+   * The job id associated with the download request
+   */
+  jobId: string;
+
+  /**
+   * The current job status
+   */
+  jobStatus: string;
+
+  /**
+   * The download url
+   */
+  downloadUrl?: string;
+}
+
+export interface DownloadRequestResponse {
+  /**
+   * The signed URL to download the asset in the given format
+   */
+  url: string;
+}
+
+export interface DownloadRequestBatchResponse {
+  /**
+   * The job id associated with the download request
+   */
+  jobId: string;
+}
+
+export interface DownloadRequestParams {
+  /**
+   * The format to download the asset in
+   */
+  targetFormat?:
+    | 'gif'
+    | 'heif'
+    | 'jpeg'
+    | 'jpg'
+    | 'png'
+    | 'svg'
+    | 'webp'
+    | 'avif'
+    | 'tif'
+    | 'tiff'
+    | 'glb'
+    | 'fbx'
+    | 'obj';
+}
+
+export interface DownloadRequestBatchParams {
+  options: DownloadRequestBatchParams.Options;
+
+  query: DownloadRequestBatchParams.Query;
+}
+
+export namespace DownloadRequestBatchParams {
+  export interface Options {
+    /**
+     * 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>"
+     */
+    fileNameTemplate: string;
+
+    /**
+     * Flag to prevent grouping assets in directories and store them flat
+     */
+    flat?: boolean;
+  }
+
+  export interface Query {
+    /**
+     * Every individual assets specified will be included in the archive
+     */
+    assetIds: Array<string>;
+
+    /**
+     * All assets issued from the provided inference ids will be included in the
+     * archive
+     */
+    inferenceIds: Array<string>;
+
+    /**
+     * All assets issued from the provided model ids will be included in the archive
+     */
+    modelIds: Array<string>;
+  }
+}
+
+export declare namespace Download {
+  export {
+    type DownloadGetStatusResponse as DownloadGetStatusResponse,
+    type DownloadRequestResponse as DownloadRequestResponse,
+    type DownloadRequestBatchResponse as DownloadRequestBatchResponse,
+    type DownloadRequestParams as DownloadRequestParams,
+    type DownloadRequestBatchParams as DownloadRequestBatchParams,
+  };
+}

package/src/resources/assets/index.ts

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assets,
+  type AssetRetrieveResponse,
+  type AssetUpdateResponse,
+  type AssetListResponse,
+  type AssetDeleteMultipleResponse,
+  type AssetDuplicateResponse,
+  type AssetGetBulkResponse,
+  type AssetListSnapshotsResponse,
+  type AssetLockResponse,
+  type AssetUnlockResponse,
+  type AssetUpdateTagsResponse,
+  type AssetUploadResponse,
+  type AssetRetrieveParams,
+  type AssetUpdateParams,
+  type AssetListParams,
+  type AssetDeleteMultipleParams,
+  type AssetDuplicateParams,
+  type AssetGetBulkParams,
+  type AssetListSnapshotsParams,
+  type AssetLockParams,
+  type AssetUnlockParams,
+  type AssetUpdateTagsParams,
+  type AssetUploadParams,
+} from './assets';
+export {
+  Download,
+  type DownloadGetStatusResponse,
+  type DownloadRequestResponse,
+  type DownloadRequestBatchResponse,
+  type DownloadRequestParams,
+  type DownloadRequestBatchParams,
+} from './download';
+export {
+  Public,
+  type PublicRetrieveResponse,
+  type PublicListResponse,
+  type PublicListParams,
+} from './public';