@scenario-labs/sdk 2.6.0 → 3.0.0

package/src/resources/index.ts

@@ -35,8 +35,10 @@ export {
   type CollectionListResponse,
   type CollectionDeleteResponse,
   type CollectionCreateParams,
+  type CollectionRetrieveParams,
   type CollectionUpdateParams,
   type CollectionListParams,
+  type CollectionDeleteParams,
   type CollectionListResponsesCollectionsCursor,
 } from './collections/collections';
 export {
@@ -63,6 +65,7 @@ export {
   type JobRetrieveResponse,
   type JobListResponse,
   type JobTriggerActionResponse,
+  type JobRetrieveParams,
   type JobListParams,
   type JobTriggerActionParams,
   type JobListResponsesJobsCursor,
@@ -84,6 +87,7 @@ export {
   type ModelRetrieveParams,
   type ModelUpdateParams,
   type ModelListParams,
+  type ModelDeleteParams,
   type ModelCopyParams,
   type ModelDeleteImagesParams,
   type ModelDownloadParams,
@@ -110,6 +114,7 @@ export {
   type UploadRetrieveResponse,
   type UploadTriggerActionResponse,
   type UploadCreateParams,
+  type UploadRetrieveParams,
   type UploadTriggerActionParams,
 } from './uploads';
 export { Usages, type UsageListResponse, type UsageListParams } from './usages';
@@ -124,8 +129,10 @@ export {
   type WorkflowRunResponse,
   type WorkflowUserApprovalResponse,
   type WorkflowCreateParams,
+  type WorkflowRetrieveParams,
   type WorkflowUpdateParams,
   type WorkflowListParams,
+  type WorkflowDeleteParams,
   type WorkflowGetTagsParams,
   type WorkflowRunParams,
   type WorkflowUserApprovalParams,

package/src/resources/jobs.ts

@@ -10,8 +10,12 @@ export class Jobs extends APIResource {
   /**
    * Get job data by job ID
    */
-  retrieve(jobID: string, options?: RequestOptions): APIPromise<JobRetrieveResponse> {
-    return this._client.get(path`/jobs/${jobID}`, options);
+  retrieve(
+    jobID: string,
+    query: JobRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobRetrieveResponse> {
+    return this._client.get(path`/jobs/${jobID}`, { query, ...options });
   }
 
   /**
@@ -35,8 +39,12 @@ export class Jobs extends APIResource {
     params: JobTriggerActionParams,
     options?: RequestOptions,
   ): APIPromise<JobTriggerActionResponse> {
-    const { originalAssets, ...body } = params;
-    return this._client.post(path`/jobs/${jobID}/action`, { query: { originalAssets }, body, ...options });
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.post(path`/jobs/${jobID}/action`, {
+      query: { originalAssets, projectId },
+      body,
+      ...options,
+    });
   }
 }
 
@@ -994,6 +1002,27 @@ export namespace JobRetrieveResponse {
 
       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.
@@ -1001,6 +1030,33 @@ export namespace JobRetrieveResponse {
        */
       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;
+      }
+    }
   }
 }
 
@@ -1951,6 +2007,27 @@ export namespace JobListResponse {
 
     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.
@@ -1958,6 +2035,33 @@ export namespace JobListResponse {
      */
     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 JobTriggerActionResponse {
@@ -2912,6 +3016,27 @@ export namespace JobTriggerActionResponse {
 
       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.
@@ -2919,9 +3044,40 @@ export namespace JobTriggerActionResponse {
        */
       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 JobRetrieveParams {
+  projectId?: unknown;
+}
+
 export interface JobListParams extends JobsCursorParams {
   /**
    * The authorId of the jobs to return. Optional.
@@ -2939,6 +3095,8 @@ export interface JobListParams extends JobsCursorParams {
    */
   pageSize?: number;
 
+  projectId?: unknown;
+
   /**
    * The status of the jobs to return. Optional.
    */
@@ -3053,6 +3211,12 @@ export interface JobTriggerActionParams {
    */
   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 action to execute on the job, such as canceling it. Today only
    * cancel on inference jobs is supported.
@@ -3066,6 +3230,7 @@ export declare namespace Jobs {
     type JobListResponse as JobListResponse,
     type JobTriggerActionResponse as JobTriggerActionResponse,
     type JobListResponsesJobsCursor as JobListResponsesJobsCursor,
+    type JobRetrieveParams as JobRetrieveParams,
     type JobListParams as JobListParams,
     type JobTriggerActionParams as JobTriggerActionParams,
   };

package/src/resources/models/description.ts

@@ -25,9 +25,9 @@ export class Description extends APIResource {
     params: DescriptionUpdateParams,
     options?: RequestOptions,
   ): APIPromise<DescriptionUpdateResponse> {
-    const { originalAssets, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelID}/description`, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       ...options,
     });
@@ -945,6 +945,12 @@ export interface DescriptionRetrieveParams {
    * 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 DescriptionUpdateParams {
@@ -958,6 +964,12 @@ export interface DescriptionUpdateParams {
    * 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 declare namespace Description {