@scenario-labs/sdk 3.3.1 → 3.4.0

package/src/resources/assets/assets.ts

@@ -140,6 +140,22 @@ export class Assets extends APIResource {
     });
   }
 
+  /**
+   * Restore assets deleted in the last 30 days. Tags and collections are not
+   * restored. Max plan and above only.
+   */
+  restoreMultiple(
+    params: AssetRestoreMultipleParams,
+    options?: RequestOptions,
+  ): APIPromise<AssetRestoreMultipleResponse> {
+    const { projectId, ...body } = params;
+    return this._client.post('/assets/restore', {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
+  }
+
   /**
    * Unlock a canvas
    */
@@ -345,6 +361,7 @@ export namespace AssetRetrieveResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -374,6 +391,12 @@ export namespace AssetRetrieveResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -472,11 +495,13 @@ export namespace AssetRetrieveResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -603,6 +628,7 @@ export namespace AssetRetrieveResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -1735,6 +1761,7 @@ export namespace AssetUpdateResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -1764,6 +1791,12 @@ export namespace AssetUpdateResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -1862,11 +1895,13 @@ export namespace AssetUpdateResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -1993,6 +2028,7 @@ export namespace AssetUpdateResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -3120,6 +3156,7 @@ export interface AssetListResponse {
     | 'video23d'
     | 'video2audio'
     | 'video2img'
+    | 'video2txt'
     | 'video2video'
     | 'voice-clone';
 
@@ -3149,6 +3186,12 @@ export interface AssetListResponse {
    */
   automaticCaptioning?: string;
 
+  /**
+   * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+   * Only set on deleted assets, listed with `deleted=true`.
+   */
+  deletedAt?: string;
+
   /**
    * The description, it will contain in priority:
    *
@@ -3247,11 +3290,13 @@ export interface AssetListResponse {
     | 'model/stl'
     | 'model/vnd.collada+xml'
     | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+    | 'model/vnd.usdz+zip'
     | 'model/x-3d-vox'
     | 'model/x-blender'
     | 'model/x-fbx'
     | 'model/x-maya-ascii'
     | 'model/x-maya-binary'
+    | 'model/x-vsplat'
     | 'model/x3d+xml'
     | 'text/plain'
     | 'video/mp4'
@@ -3378,6 +3423,7 @@ export namespace AssetListResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -4511,6 +4557,7 @@ export namespace AssetDuplicateResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -4540,6 +4587,12 @@ export namespace AssetDuplicateResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -4638,11 +4691,13 @@ export namespace AssetDuplicateResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -4769,6 +4824,7 @@ export namespace AssetDuplicateResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -5901,6 +5957,7 @@ export namespace AssetGetBulkResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -5930,6 +5987,12 @@ export namespace AssetGetBulkResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -6028,11 +6091,13 @@ export namespace AssetGetBulkResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -6159,6 +6224,7 @@ export namespace AssetGetBulkResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -7306,6 +7372,7 @@ export namespace AssetLockResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -7335,6 +7402,12 @@ export namespace AssetLockResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -7433,11 +7506,13 @@ export namespace AssetLockResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -7564,6 +7639,7 @@ export namespace AssetLockResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -8540,6 +8616,31 @@ export namespace AssetLockResponse {
   }
 }
 
+export interface AssetRestoreMultipleResponse {
+  /**
+   * The ids of the restored assets
+   */
+  restoredAssetIds: Array<string>;
+
+  /**
+   * The assets that were not restored, and why
+   */
+  skippedAssets: Array<AssetRestoreMultipleResponse.SkippedAsset>;
+}
+
+export namespace AssetRestoreMultipleResponse {
+  export interface SkippedAsset {
+    assetId: string;
+
+    /**
+     * "not-found": no asset with this id. "not-deleted": the asset is not deleted.
+     * "expired": deleted more than 30 days ago, or past the Free plan retention
+     * period.
+     */
+    reason: 'not-found' | 'not-deleted' | 'expired';
+  }
+}
+
 export interface AssetUnlockResponse {
   asset: AssetUnlockResponse.Asset;
 }
@@ -8696,6 +8797,7 @@ export namespace AssetUnlockResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -8725,6 +8827,12 @@ export namespace AssetUnlockResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -8823,11 +8931,13 @@ export namespace AssetUnlockResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -8954,6 +9064,7 @@ export namespace AssetUnlockResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -10100,6 +10211,7 @@ export namespace AssetUploadResponse {
       | 'video23d'
       | 'video2audio'
       | 'video2img'
+      | 'video2txt'
       | 'video2video'
       | 'voice-clone';
 
@@ -10129,6 +10241,12 @@ export namespace AssetUploadResponse {
      */
     automaticCaptioning?: string;
 
+    /**
+     * The asset deletion date as an ISO string (example: "2023-02-03T11:19:41.579Z").
+     * Only set on deleted assets, listed with `deleted=true`.
+     */
+    deletedAt?: string;
+
     /**
      * The description, it will contain in priority:
      *
@@ -10227,11 +10345,13 @@ export namespace AssetUploadResponse {
       | 'model/stl'
       | 'model/vnd.collada+xml'
       | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+      | 'model/vnd.usdz+zip'
       | 'model/x-3d-vox'
       | 'model/x-blender'
       | 'model/x-fbx'
       | 'model/x-maya-ascii'
       | 'model/x-maya-binary'
+      | 'model/x-vsplat'
       | 'model/x3d+xml'
       | 'text/plain'
       | 'video/mp4'
@@ -10358,6 +10478,7 @@ export namespace AssetUploadResponse {
         | 'video23d'
         | 'video2audio'
         | 'video2img'
+        | 'video2txt'
         | 'video2video'
         | 'voice-clone';
 
@@ -11753,6 +11874,13 @@ export namespace AssetUploadResponse {
            */
           min?: number;
 
+          /**
+           * The minimum allowed media duration in seconds. Only applies to \`file\` and
+           * \`file_array\` input types for video and audio assets. Validated against
+           * \`asset.properties.duration\` at job creation time.
+           */
+          minDuration?: number;
+
           /**
            * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
            * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
@@ -11983,6 +12111,13 @@ export namespace AssetUploadResponse {
              */
             min?: number;
 
+            /**
+             * The minimum allowed media duration in seconds. Only applies to \`file\` and
+             * \`file_array\` input types for video and audio assets. Validated against
+             * \`asset.properties.duration\` at job creation time.
+             */
+            minDuration?: number;
+
             /**
              * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
              * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
@@ -12475,6 +12610,14 @@ export interface AssetListParams extends AssetsCursorParams {
    */
   createdBefore?: string;
 
+  /**
+   * When true, list the assets deleted in the last 30 days, most recently deleted
+   * first, each with its `deletedAt` date. Max plan and above only. Can only be
+   * combined with "projectId", "teamId", "pageSize", "paginationToken" and
+   * "originalAssets"
+   */
+  deleted?: boolean;
+
   /**
    * List assets generated from a specific inference
    */
@@ -12554,8 +12697,8 @@ export interface AssetListParams extends AssetsCursorParams {
    * img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
    * video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
    * uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video, uploaded-text,
-   * audio2txt, txt2txt, img2txt, assets with a type starting with "inference-" will
-   * be returned
+   * audio2txt, txt2txt, img2txt, video2txt, assets with a type starting with
+   * "inference-" will be returned
    */
   type?:
     | 'inference-txt2img'
@@ -12637,7 +12780,8 @@ export interface AssetListParams extends AssetsCursorParams {
     | 'uploaded-text'
     | 'audio2txt'
     | 'txt2txt'
-    | 'img2txt';
+    | 'img2txt'
+    | 'video2txt';
 
   /**
    * List of the asset types to request. The parameter "type" and "types" cannot be
@@ -12659,7 +12803,7 @@ export interface AssetListParams extends AssetsCursorParams {
    * img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
    * video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
    * uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video, uploaded-text,
-   * audio2txt, txt2txt, img2txt
+   * audio2txt, txt2txt, img2txt, video2txt
    */
   types?: Array<
     | 'inference-txt2img'
@@ -12742,6 +12886,7 @@ export interface AssetListParams extends AssetsCursorParams {
     | 'audio2txt'
     | 'txt2txt'
     | 'img2txt'
+    | 'video2txt'
   >;
 
   /**
@@ -12840,6 +12985,19 @@ export interface AssetLockParams {
   projectId?: string;
 }
 
+export interface AssetRestoreMultipleParams {
+  /**
+   * Body param: The ids of the deleted assets to restore. (Max 100 at once)
+   */
+  assetIds: Array<string>;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
 export interface AssetUnlockParams {
   /**
    * Query param: If set to true, returns the original asset without transformation
@@ -12953,6 +13111,7 @@ export declare namespace Assets {
     type AssetGetBulkResponse as AssetGetBulkResponse,
     type AssetListSnapshotsResponse as AssetListSnapshotsResponse,
     type AssetLockResponse as AssetLockResponse,
+    type AssetRestoreMultipleResponse as AssetRestoreMultipleResponse,
     type AssetUnlockResponse as AssetUnlockResponse,
     type AssetUpdateTagsResponse as AssetUpdateTagsResponse,
     type AssetUploadResponse as AssetUploadResponse,
@@ -12966,6 +13125,7 @@ export declare namespace Assets {
     type AssetGetBulkParams as AssetGetBulkParams,
     type AssetListSnapshotsParams as AssetListSnapshotsParams,
     type AssetLockParams as AssetLockParams,
+    type AssetRestoreMultipleParams as AssetRestoreMultipleParams,
     type AssetUnlockParams as AssetUnlockParams,
     type AssetUpdateTagsParams as AssetUpdateTagsParams,
     type AssetUploadParams as AssetUploadParams,

package/src/resources/assets/index.ts

@@ -10,6 +10,7 @@ export {
   type AssetGetBulkResponse,
   type AssetListSnapshotsResponse,
   type AssetLockResponse,
+  type AssetRestoreMultipleResponse,
   type AssetUnlockResponse,
   type AssetUpdateTagsResponse,
   type AssetUploadResponse,
@@ -21,6 +22,7 @@ export {
   type AssetGetBulkParams,
   type AssetListSnapshotsParams,
   type AssetLockParams,
+  type AssetRestoreMultipleParams,
   type AssetUnlockParams,
   type AssetUpdateTagsParams,
   type AssetUploadParams,