@scenario-labs/sdk 2.7.0 → 3.0.0

package/src/resources/models/models.ts

@@ -52,8 +52,8 @@ export class Models extends APIResource {
    * Create a new model
    */
   create(params: ModelCreateParams, options?: RequestOptions): APIPromise<ModelCreateResponse> {
-    const { originalAssets, ...body } = params;
-    return this._client.post('/models', { query: { originalAssets }, body, ...options });
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.post('/models', { query: { originalAssets, projectId }, body, ...options });
   }
 
   /**
@@ -78,8 +78,12 @@ export class Models extends APIResource {
     params: ModelUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ModelUpdateResponse> {
-    const { originalAssets, ...body } = params;
-    return this._client.put(path`/models/${modelID}`, { query: { originalAssets }, body, ...options });
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.put(path`/models/${modelID}`, {
+      query: { originalAssets, projectId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -96,8 +100,13 @@ export class Models extends APIResource {
   /**
    * Delete a model
    */
-  delete(modelID: string, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.delete(path`/models/${modelID}`, options);
+  delete(
+    modelID: string,
+    params: ModelDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { projectId } = params ?? {};
+    return this._client.delete(path`/models/${modelID}`, { query: { projectId }, ...options });
   }
 
   /**
@@ -105,8 +114,12 @@ export class Models extends APIResource {
    * training images and pairs if any
    */
   copy(modelID: string, params: ModelCopyParams, options?: RequestOptions): APIPromise<ModelCopyResponse> {
-    const { originalAssets, ...body } = params;
-    return this._client.post(path`/models/${modelID}/copy`, { query: { originalAssets }, body, ...options });
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/copy`, {
+      query: { originalAssets, projectId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -117,8 +130,8 @@ export class Models extends APIResource {
     params: ModelDeleteImagesParams,
     options?: RequestOptions,
   ): APIPromise<unknown> {
-    const { ids } = params;
-    return this._client.delete(path`/models/${modelID}/images`, { query: { ids }, ...options });
+    const { ids, projectId } = params;
+    return this._client.delete(path`/models/${modelID}/images`, { query: { ids, projectId }, ...options });
   }
 
   /**
@@ -126,18 +139,19 @@ export class Models extends APIResource {
    */
   download(
     modelID: string,
-    body: ModelDownloadParams,
+    params: ModelDownloadParams,
     options?: RequestOptions,
   ): APIPromise<ModelDownloadResponse> {
-    return this._client.post(path`/models/${modelID}/download`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/download`, { query: { projectId }, body, ...options });
   }
 
   /**
    * Get multiple models by their `modelIds`
    */
   getBulk(params: ModelGetBulkParams, options?: RequestOptions): APIPromise<ModelGetBulkResponse> {
-    const { originalAssets, ...body } = params;
-    return this._client.post('/models/get-bulk', { query: { originalAssets }, body, ...options });
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.post('/models/get-bulk', { query: { originalAssets, projectId }, body, ...options });
   }
 
   /**
@@ -146,10 +160,11 @@ export class Models extends APIResource {
    */
   transfer(
     modelID: string,
-    body: ModelTransferParams,
+    params: ModelTransferParams,
     options?: RequestOptions,
   ): APIPromise<ModelTransferResponse> {
-    return this._client.post(path`/models/${modelID}/transfer`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/transfer`, { query: { projectId }, body, ...options });
   }
 
   /**
@@ -157,10 +172,11 @@ export class Models extends APIResource {
    */
   updateTags(
     modelID: string,
-    body: ModelUpdateTagsParams,
+    params: ModelUpdateTagsParams,
     options?: RequestOptions,
   ): APIPromise<ModelUpdateTagsResponse> {
-    return this._client.put(path`/models/${modelID}/tags`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.put(path`/models/${modelID}/tags`, { query: { projectId }, body, ...options });
   }
 }
 
@@ -9394,6 +9410,12 @@ export interface ModelCreateParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: The ID of the base model to use as a starting point for the training
    * (example: "flux.1-dev")
@@ -9504,6 +9526,12 @@ export interface ModelRetrieveParams {
    * If set to true, returns the original asset without transformation
    */
   originalAssets?: boolean;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface ModelUpdateParams {
@@ -9512,6 +9540,12 @@ export interface ModelUpdateParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: The slug of the class you want to use (ex:
    * "characters-npcs-mobs-characters"). Set to null to unset the class
@@ -9960,6 +9994,12 @@ export interface ModelListParams extends ModelsCursorParams {
    */
   privacy?: 'private' | 'public';
 
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Sort results by createdAt, updatedAt, or score. When privacy=public, defaults to
    * score if not specified. When privacy=private/unlisted, supports createdAt and
@@ -10096,12 +10136,26 @@ export interface ModelListParams extends ModelsCursorParams {
   updatedBefore?: string;
 }
 
+export interface ModelDeleteParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
 export interface ModelCopyParams {
   /**
    * Query param: If set to true, returns the original asset without transformation
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: If set to true, the training data will be copied
    */
@@ -10118,13 +10172,26 @@ export interface ModelDeleteImagesParams {
    * The asset ids of the images to delete
    */
   ids: Array<string>;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface ModelDownloadParams {
   /**
-   * The epoch hash of the model to download Only available for Flux Lora Trained
-   * models with epochs Will only apply to the main model in the download request If
-   * not set, the default (latest or setup at model level) epoch will be used
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: The epoch hash of the model to download Only available for Flux Lora
+   * Trained models with epochs Will only apply to the main model in the download
+   * request If not set, the default (latest or setup at model level) epoch will be
+   * used
    */
   modelEpoch?: string;
 }
@@ -10135,6 +10202,12 @@ export interface ModelGetBulkParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: If true will return all training images; otherwise returns only the
    * first 3 training images.
@@ -10179,29 +10252,41 @@ export interface ModelGetBulkParams {
 
 export interface ModelTransferParams {
   /**
-   * The id of the project to copy and transfer the model to
+   * Body param: The id of the project to copy and transfer the model to
    */
   destinationProjectId: string;
 
   /**
-   * The id of the team to copy and transfer the model to
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: The id of the team to copy and transfer the model to
    */
   destinationTeamId?: string;
 }
 
 export interface ModelUpdateTagsParams {
   /**
-   * The list of tags to add
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: The list of tags to add
    */
   add?: Array<string>;
 
   /**
-   * The list of tags to delete
+   * Body param: The list of tags to delete
    */
   delete?: Array<string>;
 
   /**
-   * If true, the function will throw an error if:
+   * Body param: If true, the function will throw an error if:
    *
    * - one of the tags to add already exists
    * - one of the tags to delete is not found If false, the endpoint will behave as
@@ -10233,6 +10318,7 @@ export declare namespace Models {
     type ModelRetrieveParams as ModelRetrieveParams,
     type ModelUpdateParams as ModelUpdateParams,
     type ModelListParams as ModelListParams,
+    type ModelDeleteParams as ModelDeleteParams,
     type ModelCopyParams as ModelCopyParams,
     type ModelDeleteImagesParams as ModelDeleteImagesParams,
     type ModelDownloadParams as ModelDownloadParams,

package/src/resources/models/train.ts

@@ -14,9 +14,9 @@ export class Train extends APIResource {
     params: TrainActionParams,
     options?: RequestOptions,
   ): APIPromise<TrainActionResponse> {
-    const { originalAssets, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/train/action`, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       ...options,
     });
@@ -30,9 +30,9 @@ export class Train extends APIResource {
     params: TrainTriggerParams,
     options?: RequestOptions,
   ): APIPromise<TrainTriggerResponse> {
-    const { dryRun, originalAssets, trainingImagesCount, ...body } = params;
+    const { dryRun, originalAssets, projectId, trainingImagesCount, ...body } = params;
     return this._client.put(path`/models/${modelID}/train`, {
-      query: { dryRun, originalAssets, trainingImagesCount },
+      query: { dryRun, originalAssets, projectId, trainingImagesCount },
       body,
       ...options,
     });
@@ -1359,6 +1359,14 @@ export interface TrainTriggerResponse {
 
   model: TrainTriggerResponse.Model;
 
+  /**
+   * Compute Units cost per billing action for this request, after discount. Values
+   * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
+   * charge appear. Lets clients split the total (e.g. generation vs
+   * `slop-detection`) — including on dryRun estimates.
+   */
+  costDetails?: TrainTriggerResponse.CostDetails;
+
   /**
    * The Compute Units cost for the request billed
    */
@@ -2323,6 +2331,27 @@ export namespace TrainTriggerResponse {
 
       cuDiscount: number;
 
+      /**
+       * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+       * top of the generation itself, such as `slop-detection`.
+       *
+       * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+       * values here.
+       *
+       * Two caveats when displaying it:
+       *
+       * - These are a remaining refundable balance, not a receipt: a job that failed or
+       *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+       *   still shows the main action's original charge.
+       * - `ip-detection` is part of the shape but is never populated today: that fee is
+       *   charged outside the job and reported once, as
+       *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+       *   it.
+       *
+       * Absent when the job paid for no add-on.
+       */
+      cuCostDetails?: Billing.CuCostDetails;
+
       /**
        * When true, the credits charged for this job are not automatically refunded if
        * the generation fails, because the model used does not support refund-on-failure.
@@ -2330,6 +2359,33 @@ export namespace TrainTriggerResponse {
        */
       disableRefund?: boolean;
     }
+
+    export namespace Billing {
+      /**
+       * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+       * top of the generation itself, such as `slop-detection`.
+       *
+       * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+       * values here.
+       *
+       * Two caveats when displaying it:
+       *
+       * - These are a remaining refundable balance, not a receipt: a job that failed or
+       *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+       *   still shows the main action's original charge.
+       * - `ip-detection` is part of the shape but is never populated today: that fee is
+       *   charged outside the job and reported once, as
+       *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+       *   it.
+       *
+       * Absent when the job paid for no add-on.
+       */
+      export interface CuCostDetails {
+        'ip-detection'?: number;
+
+        'slop-detection'?: number;
+      }
+    }
   }
 
   export interface Model {
@@ -3641,6 +3697,60 @@ export namespace TrainTriggerResponse {
     }
   }
 
+  /**
+   * Compute Units cost per billing action for this request, after discount. Values
+   * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
+   * charge appear. Lets clients split the total (e.g. generation vs
+   * `slop-detection`) — including on dryRun estimates.
+   */
+  export interface CostDetails {
+    'assistant-message'?: number;
+
+    caption?: number;
+
+    'custom-generation'?: number;
+
+    'describe-style'?: number;
+
+    detection?: number;
+
+    embed?: number;
+
+    'image-prompt-editing'?: number;
+
+    'inference-images'?: number;
+
+    'ip-detection'?: number;
+
+    pixelate?: number;
+
+    prompt?: number;
+
+    'remove-background'?: number;
+
+    repaint?: number;
+
+    restyle?: number;
+
+    segmentation?: number;
+
+    'skybox-base-360'?: number;
+
+    'skybox-upscale-360'?: number;
+
+    'slop-detection'?: number;
+
+    texture?: number;
+
+    'train-model'?: number;
+
+    translate?: number;
+
+    upscale?: number;
+
+    vectorization?: number;
+  }
+
   /**
    * IP detection findings, when detection ran for this request.
    */
@@ -3730,6 +3840,12 @@ export interface TrainActionParams {
    * Query param: If set to true, returns the original asset without transformation
    */
   originalAssets?: boolean;
+
+  /**
+   * 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 TrainTriggerParams {
@@ -3743,6 +3859,12 @@ export interface TrainTriggerParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Query param: Simulate the number of training images, used for dryRun purpose
    */

package/src/resources/models/training-images.ts

@@ -14,8 +14,11 @@ export class TrainingImages extends APIResource {
     params: TrainingImageDeleteParams,
     options?: RequestOptions,
   ): APIPromise<unknown> {
-    const { modelId } = params;
-    return this._client.delete(path`/models/${modelId}/training-images/${trainingImageID}`, options);
+    const { modelId, projectId } = params;
+    return this._client.delete(path`/models/${modelId}/training-images/${trainingImageID}`, {
+      query: { projectId },
+      ...options,
+    });
   }
 
   /**
@@ -26,9 +29,9 @@ export class TrainingImages extends APIResource {
     params: TrainingImageAddParams,
     options?: RequestOptions,
   ): APIPromise<TrainingImageAddResponse> {
-    const { originalAssets, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/training-images`, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       ...options,
     });
@@ -42,9 +45,9 @@ export class TrainingImages extends APIResource {
     params: TrainingImageReplaceParams,
     options?: RequestOptions,
   ): APIPromise<TrainingImageReplaceResponse> {
-    const { modelId, originalAssets, ...body } = params;
+    const { modelId, originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelId}/training-images/${trainingImageID}`, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       ...options,
     });
@@ -58,8 +61,12 @@ export class TrainingImages extends APIResource {
     params: TrainingImageReplacePairsParams,
     options?: RequestOptions,
   ): APIPromise<TrainingImageReplacePairsResponse> {
-    const { body } = params;
-    return this._client.put(path`/models/${modelID}/training-images/pairs`, { body: body, ...options });
+    const { body, projectId } = params;
+    return this._client.put(path`/models/${modelID}/training-images/pairs`, {
+      query: { projectId },
+      body: body,
+      ...options,
+    });
   }
 }
 
@@ -176,9 +183,15 @@ export namespace TrainingImageReplacePairsResponse {
 
 export interface TrainingImageDeleteParams {
   /**
-   * The training image's `modelId`
+   * Path param: The training image's `modelId`
    */
   modelId: 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 TrainingImageAddParams {
@@ -187,6 +200,12 @@ export interface TrainingImageAddParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: The asset ID to use as a training image (example:
    * "asset_GTrL3mq4SXWyMxkOHRxlpw"). If provided, "data" and "name" parameters will
@@ -231,6 +250,12 @@ export interface TrainingImageReplaceParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: The asset ID to use as a training image (example:
    * "asset_GTrL3mq4SXWyMxkOHRxlpw"). If provided, "data" and "name" parameters will
@@ -266,9 +291,15 @@ export interface TrainingImageReplaceParams {
 
 export interface TrainingImageReplacePairsParams {
   /**
-   * Array of training image pairs
+   * Body param: Array of training image pairs
    */
   body: Array<TrainingImageReplacePairsParams.Body>;
+
+  /**
+   * 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 namespace TrainingImageReplacePairsParams {

package/src/resources/search.ts

@@ -15,9 +15,9 @@ export class Search extends APIResource {
     params: SearchAssetSearchParams,
     options?: RequestOptions,
   ): PagePromise<SearchAssetSearchResponsesSearchHitsOffset, SearchAssetSearchResponse> {
-    const { originalAssets, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/assets', SearchHitsOffset<SearchAssetSearchResponse>, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       method: 'post',
       ...options,
@@ -34,9 +34,9 @@ export class Search extends APIResource {
     params: SearchModelSearchParams,
     options?: RequestOptions,
   ): PagePromise<SearchModelSearchResponsesSearchHitsOffset, SearchModelSearchResponse> {
-    const { originalAssets, originalModels, ...body } = params;
+    const { originalAssets, originalModels, projectId, ...body } = params;
     return this._client.getAPIList('/search/models', SearchHitsOffset<SearchModelSearchResponse>, {
-      query: { originalAssets, originalModels },
+      query: { originalAssets, originalModels, projectId },
       body,
       method: 'post',
       ...options,
@@ -419,6 +419,12 @@ export interface SearchAssetSearchParams extends SearchHitsOffsetParams {
    */
   originalAssets?: boolean;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: Filter queries by an attribute's value
    */
@@ -521,6 +527,12 @@ export interface SearchModelSearchParams extends SearchHitsOffsetParams {
    */
   originalModels?: unknown;
 
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
   /**
    * Body param: Filter queries by an attribute's value
    */

package/src/resources/tags.ts

@@ -51,6 +51,12 @@ export interface TagListParams extends TagsCursorParams {
    * value is 100, minimum value is 1
    */
   pageSize?: number;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export declare namespace Tags {