@scenario-labs/sdk 2.7.0 → 3.1.0

package/src/client.ts

@@ -60,6 +60,7 @@ import {
   JobListParams,
   JobListResponse,
   JobListResponsesJobsCursor,
+  JobRetrieveParams,
   JobRetrieveResponse,
   JobTriggerActionParams,
   JobTriggerActionResponse,
@@ -79,6 +80,7 @@ import { TagListParams, TagListResponse, TagListResponsesTagsCursor, Tags } from
 import {
   UploadCreateParams,
   UploadCreateResponse,
+  UploadRetrieveParams,
   UploadRetrieveResponse,
   UploadTriggerActionParams,
   UploadTriggerActionResponse,
@@ -89,12 +91,14 @@ import {
   WorkflowApproveUserParams,
   WorkflowCreateParams,
   WorkflowCreateResponse,
+  WorkflowDeleteParams,
   WorkflowDeleteResponse,
   WorkflowGetTagsParams,
   WorkflowGetTagsResponse,
   WorkflowListParams,
   WorkflowListResponse,
   WorkflowListResponsesWorkflowsCursor,
+  WorkflowRetrieveParams,
   WorkflowRetrieveResponse,
   WorkflowRunParams,
   WorkflowRunResponse,
@@ -134,10 +138,12 @@ import {
 import {
   CollectionCreateParams,
   CollectionCreateResponse,
+  CollectionDeleteParams,
   CollectionDeleteResponse,
   CollectionListParams,
   CollectionListResponse,
   CollectionListResponsesCollectionsCursor,
+  CollectionRetrieveParams,
   CollectionRetrieveResponse,
   CollectionUpdateParams,
   CollectionUpdateResponse,
@@ -150,6 +156,7 @@ import {
   ModelCreateResponse,
   ModelDeleteImagesParams,
   ModelDeleteImagesResponse,
+  ModelDeleteParams,
   ModelDeleteResponse,
   ModelDownloadParams,
   ModelDownloadResponse,
@@ -969,8 +976,8 @@ export class Scenario {
   generate: API.Generate = new API.Generate(this);
   jobs: API.Jobs = new API.Jobs(this);
   models: API.Models = new API.Models(this);
-  pricing: API.Pricing = new API.Pricing(this);
   oscu: API.Oscu = new API.Oscu(this);
+  pricing: API.Pricing = new API.Pricing(this);
   search: API.Search = new API.Search(this);
   tags: API.Tags = new API.Tags(this);
   uploads: API.Uploads = new API.Uploads(this);
@@ -983,8 +990,8 @@ Scenario.Collections = Collections;
 Scenario.Generate = Generate;
 Scenario.Jobs = Jobs;
 Scenario.Models = Models;
-Scenario.Pricing = Pricing;
 Scenario.Oscu = Oscu;
+Scenario.Pricing = Pricing;
 Scenario.Search = Search;
 Scenario.Tags = Tags;
 Scenario.Uploads = UploadsAPIUploads;
@@ -1067,8 +1074,10 @@ export declare namespace Scenario {
     type CollectionDeleteResponse as CollectionDeleteResponse,
     type CollectionListResponsesCollectionsCursor as CollectionListResponsesCollectionsCursor,
     type CollectionCreateParams as CollectionCreateParams,
+    type CollectionRetrieveParams as CollectionRetrieveParams,
     type CollectionUpdateParams as CollectionUpdateParams,
     type CollectionListParams as CollectionListParams,
+    type CollectionDeleteParams as CollectionDeleteParams,
   };
 
   export {
@@ -1097,6 +1106,7 @@ export declare namespace Scenario {
     type JobListResponse as JobListResponse,
     type JobTriggerActionResponse as JobTriggerActionResponse,
     type JobListResponsesJobsCursor as JobListResponsesJobsCursor,
+    type JobRetrieveParams as JobRetrieveParams,
     type JobListParams as JobListParams,
     type JobTriggerActionParams as JobTriggerActionParams,
   };
@@ -1119,6 +1129,7 @@ export declare namespace Scenario {
     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,
@@ -1127,10 +1138,10 @@ export declare namespace Scenario {
     type ModelUpdateTagsParams as ModelUpdateTagsParams,
   };
 
-  export { Pricing as Pricing };
-
   export { Oscu as Oscu, type OscuRetrievePricesResponse as OscuRetrievePricesResponse };
 
+  export { Pricing as Pricing };
+
   export {
     Search as Search,
     type SearchAssetSearchResponse as SearchAssetSearchResponse,
@@ -1154,6 +1165,7 @@ export declare namespace Scenario {
     type UploadRetrieveResponse as UploadRetrieveResponse,
     type UploadTriggerActionResponse as UploadTriggerActionResponse,
     type UploadCreateParams as UploadCreateParams,
+    type UploadRetrieveParams as UploadRetrieveParams,
     type UploadTriggerActionParams as UploadTriggerActionParams,
   };
 
@@ -1175,8 +1187,10 @@ export declare namespace Scenario {
     type WorkflowUserApprovalResponse as WorkflowUserApprovalResponse,
     type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor,
     type WorkflowCreateParams as WorkflowCreateParams,
+    type WorkflowRetrieveParams as WorkflowRetrieveParams,
     type WorkflowUpdateParams as WorkflowUpdateParams,
     type WorkflowListParams as WorkflowListParams,
+    type WorkflowDeleteParams as WorkflowDeleteParams,
     type WorkflowGetTagsParams as WorkflowGetTagsParams,
     type WorkflowRunParams as WorkflowRunParams,
     type WorkflowUserApprovalParams as WorkflowUserApprovalParams,

package/src/core/pagination.ts

@@ -155,9 +155,9 @@ export class AssetsCursor<Item> extends AbstractPage<Item> implements AssetsCurs
 }
 
 export interface SnapshotsCursorResponse<Item> {
-  snapshots: Array<Item>;
-
   nextPaginationToken: string;
+
+  snapshots: Array<Item>;
 }
 
 export interface SnapshotsCursorParams {
@@ -165,10 +165,10 @@ export interface SnapshotsCursorParams {
 }
 
 export class SnapshotsCursor<Item> extends AbstractPage<Item> implements SnapshotsCursorResponse<Item> {
-  snapshots: Array<Item>;
-
   nextPaginationToken: string;
 
+  snapshots: Array<Item>;
+
   constructor(
     client: Scenario,
     response: Response,
@@ -177,8 +177,8 @@ export class SnapshotsCursor<Item> extends AbstractPage<Item> implements Snapsho
   ) {
     super(client, response, body, options);
 
-    this.snapshots = body.snapshots || [];
     this.nextPaginationToken = body.nextPaginationToken || '';
+    this.snapshots = body.snapshots || [];
   }
 
   getPaginatedItems(): Item[] {
@@ -343,9 +343,9 @@ export class ModelsCursor<Item> extends AbstractPage<Item> implements ModelsCurs
 }
 
 export interface TagsCursorResponse<Item> {
-  tags: Array<Item>;
-
   nextPaginationToken: string;
+
+  tags: Array<Item>;
 }
 
 export interface TagsCursorParams {
@@ -353,10 +353,10 @@ export interface TagsCursorParams {
 }
 
 export class TagsCursor<Item> extends AbstractPage<Item> implements TagsCursorResponse<Item> {
-  tags: Array<Item>;
-
   nextPaginationToken: string;
 
+  tags: Array<Item>;
+
   constructor(
     client: Scenario,
     response: Response,
@@ -365,8 +365,8 @@ export class TagsCursor<Item> extends AbstractPage<Item> implements TagsCursorRe
   ) {
     super(client, response, body, options);
 
-    this.tags = body.tags || [];
     this.nextPaginationToken = body.nextPaginationToken || '';
+    this.tags = body.tags || [];
   }
 
   getPaginatedItems(): Item[] {
@@ -390,9 +390,9 @@ export class TagsCursor<Item> extends AbstractPage<Item> implements TagsCursorRe
 }
 
 export interface WorkflowsCursorResponse<Item> {
-  workflows: Array<Item>;
-
   nextPaginationToken: string;
+
+  workflows: Array<Item>;
 }
 
 export interface WorkflowsCursorParams {
@@ -400,10 +400,10 @@ export interface WorkflowsCursorParams {
 }
 
 export class WorkflowsCursor<Item> extends AbstractPage<Item> implements WorkflowsCursorResponse<Item> {
-  workflows: Array<Item>;
-
   nextPaginationToken: string;
 
+  workflows: Array<Item>;
+
   constructor(
     client: Scenario,
     response: Response,
@@ -412,8 +412,8 @@ export class WorkflowsCursor<Item> extends AbstractPage<Item> implements Workflo
   ) {
     super(client, response, body, options);
 
-    this.workflows = body.workflows || [];
     this.nextPaginationToken = body.nextPaginationToken || '';
+    this.workflows = body.workflows || [];
   }
 
   getPaginatedItems(): Item[] {
@@ -437,10 +437,10 @@ export class WorkflowsCursor<Item> extends AbstractPage<Item> implements Workflo
 }
 
 export interface SearchHitsOffsetResponse<Item> {
-  hits: Array<Item>;
-
   estimatedTotalHits: number;
 
+  hits: Array<Item>;
+
   offset: number;
 }
 
@@ -449,10 +449,10 @@ export interface SearchHitsOffsetParams {
 }
 
 export class SearchHitsOffset<Item> extends AbstractPage<Item> implements SearchHitsOffsetResponse<Item> {
-  hits: Array<Item>;
-
   estimatedTotalHits: number;
 
+  hits: Array<Item>;
+
   offset: number;
 
   constructor(
@@ -463,8 +463,8 @@ export class SearchHitsOffset<Item> extends AbstractPage<Item> implements Search
   ) {
     super(client, response, body, options);
 
-    this.hits = body.hits || [];
     this.estimatedTotalHits = body.estimatedTotalHits || 0;
+    this.hits = body.hits || [];
     this.offset = body.offset || 0;
   }
 

package/src/lib/job.ts

@@ -3,6 +3,7 @@ import type { APIPromise } from '../core/api-promise';
 import type { RequestOptions } from '../internal/request-options';
 import {
   Jobs,
+  type JobRetrieveParams,
   type JobRetrieveResponse,
   type JobTriggerActionParams,
   type JobTriggerActionResponse,
@@ -49,7 +50,7 @@ export class JobMethods {
     let elapsed = 0;
 
     while (elapsed < timeoutMs) {
-      const response = await this._client.jobs.retrieve(this.jobId, withScope(scope));
+      const response = await this._client.jobs.retrieve(this.jobId, undefined, withScope(scope));
 
       if (TERMINAL_STATUSES.has(response.job.status)) {
         return Job.from(this._client, response.job, scope);
@@ -107,8 +108,12 @@ export function enhanceJob<T extends { job: { jobId: string; status: string } }>
  * typically fetch individual jobs via `retrieve` before acting on them.
  */
 export class EnhancedJobs extends Jobs {
-  override retrieve(jobID: string, options?: RequestOptions): APIPromise<WithJob<JobRetrieveResponse>> {
-    return enhanceJob(this._client, super.retrieve(jobID, options), options);
+  override retrieve(
+    jobID: string,
+    query: JobRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WithJob<JobRetrieveResponse>> {
+    return enhanceJob(this._client, super.retrieve(jobID, query, options), options);
   }
 
   override triggerAction(

package/src/lib/upload.ts

@@ -5,6 +5,7 @@ import {
   Uploads,
   type UploadCreateParams,
   type UploadCreateResponse,
+  type UploadRetrieveParams,
   type UploadRetrieveResponse,
   type UploadTriggerActionParams,
   type UploadTriggerActionResponse,
@@ -113,7 +114,7 @@ export class UploadMethods {
   async wait(this: Upload, options?: UploadWaitOptions): Promise<Upload> {
     const scope = waitOverrideScope(options) ?? this._scope;
     const final = await pollUntilImported(
-      () => this._client.uploads.retrieve(this.id, withScope(scope)),
+      () => this._client.uploads.retrieve(this.id, undefined, withScope(scope)),
       options?.intervalMs ?? 2_000,
       options?.timeoutMs ?? 300_000,
     );
@@ -174,9 +175,10 @@ export class EnhancedUploads extends Uploads {
 
   override retrieve(
     uploadID: string,
+    query: UploadRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<WithUpload<UploadRetrieveResponse>> {
-    return enhanceUpload(this._client, super.retrieve(uploadID, options), options);
+    return enhanceUpload(this._client, super.retrieve(uploadID, query, options), options);
   }
 
   override triggerAction(
@@ -269,7 +271,7 @@ export class EnhancedUploads extends Uploads {
 
     // Step 4 — poll until the upload has been processed into an entity.
     const final = await pollUntilImported(
-      () => this.retrieve(uploadId, options),
+      () => this.retrieve(uploadId, undefined, options),
       params.pollIntervalMs ?? 2_000,
       params.pollTimeoutMs ?? 300_000,
     );

package/src/lib/workflow.ts

@@ -4,6 +4,7 @@ import {
   Workflows,
   WorkflowUserApprovalResponse,
   type WorkflowApproveUserParams,
+  type WorkflowRetrieveParams,
   type WorkflowRetrieveResponse,
   type WorkflowRunParams,
   type WorkflowRunResponse,
@@ -104,11 +105,12 @@ export class EnhancedWorkflows extends Workflows {
    */
   override retrieve(
     workflowID: string,
+    query: WorkflowRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<EnhancedWorkflowRetrieveResponse> {
     const client = this._client as Scenario;
     const scope = effectiveScope(options, client.projectId);
-    return super.retrieve(workflowID, options)._thenUnwrap((data) => ({
+    return super.retrieve(workflowID, query, options)._thenUnwrap((data) => ({
       ...data,
       workflow: WorkflowEntity.from(client, data.workflow, scope),
     }));