@scenario-labs/sdk 0.3.0 → 1.1.0

package/src/client.ts

@@ -14,6 +14,26 @@ import * as Opts from './internal/request-options';
 import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
+import * as Pagination from './core/pagination';
+import {
+  AbstractPage,
+  type AssetsCursorParams,
+  AssetsCursorResponse,
+  type CollectionsCursorParams,
+  CollectionsCursorResponse,
+  type JobsCursorParams,
+  JobsCursorResponse,
+  type ModelsCursorParams,
+  ModelsCursorResponse,
+  type SearchHitsOffsetParams,
+  SearchHitsOffsetResponse,
+  type SnapshotsCursorParams,
+  SnapshotsCursorResponse,
+  type TagsCursorParams,
+  TagsCursorResponse,
+  type WorkflowsCursorParams,
+  WorkflowsCursorResponse,
+} from './core/pagination';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
@@ -29,6 +49,8 @@ import {
   GenerateEmbedResponse,
   GeneratePatchParams,
   GeneratePatchResponse,
+  GeneratePromptParams,
+  GeneratePromptResponse,
   GenerateRunModelParams,
   GenerateRunModelResponse,
   GenerateTranslateParams,
@@ -37,6 +59,7 @@ import {
 import {
   JobListParams,
   JobListResponse,
+  JobListResponsesJobsCursor,
   JobRetrieveResponse,
   JobTriggerActionParams,
   JobTriggerActionResponse,
@@ -47,10 +70,12 @@ import {
   Search,
   SearchAssetSearchParams,
   SearchAssetSearchResponse,
+  SearchAssetSearchResponsesSearchHitsOffset,
   SearchModelSearchParams,
   SearchModelSearchResponse,
+  SearchModelSearchResponsesSearchHitsOffset,
 } from './resources/search';
-import { TagListParams, TagListResponse, Tags } from './resources/tags';
+import { TagListParams, TagListResponse, TagListResponsesTagsCursor, Tags } from './resources/tags';
 import {
   UploadCreateParams,
   UploadCreateResponse,
@@ -70,6 +95,7 @@ import {
   WorkflowGetTagsResponse,
   WorkflowListParams,
   WorkflowListResponse,
+  WorkflowListResponsesWorkflowsCursor,
   WorkflowRetrieveResponse,
   WorkflowRunParams,
   WorkflowRunResponse,
@@ -86,8 +112,10 @@ import {
   AssetGetBulkResponse,
   AssetListParams,
   AssetListResponse,
+  AssetListResponsesAssetsCursor,
   AssetListSnapshotsParams,
   AssetListSnapshotsResponse,
+  AssetListSnapshotsResponsesSnapshotsCursor,
   AssetLockParams,
   AssetLockResponse,
   AssetRetrieveParams,
@@ -108,6 +136,7 @@ import {
   CollectionDeleteResponse,
   CollectionListParams,
   CollectionListResponse,
+  CollectionListResponsesCollectionsCursor,
   CollectionRetrieveResponse,
   CollectionUpdateParams,
   CollectionUpdateResponse,
@@ -127,6 +156,7 @@ import {
   ModelGetBulkResponse,
   ModelListParams,
   ModelListResponse,
+  ModelListResponsesModelsCursor,
   ModelRetrieveParams,
   ModelRetrieveResponse,
   ModelTransferParams,
@@ -647,6 +677,30 @@ export class Scenario {
     return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
   }
 
+  getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
+    path: string,
+    Page: new (...args: any[]) => PageClass,
+    opts?: PromiseOrValue<RequestOptions>,
+  ): Pagination.PagePromise<PageClass, Item> {
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
+  }
+
+  requestAPIList<
+    Item = unknown,
+    PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
+  >(
+    Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
+    options: PromiseOrValue<FinalRequestOptions>,
+  ): Pagination.PagePromise<PageClass, Item> {
+    const request = this.makeRequest(options, null, undefined);
+    return new Pagination.PagePromise<PageClass, Item>(this as any as Scenario, request, Page);
+  }
+
   async fetchWithTimeout(
     url: RequestInfo,
     init: RequestInit | undefined,
@@ -922,6 +976,42 @@ Scenario.Workflows = Workflows;
 export declare namespace Scenario {
   export type RequestOptions = Opts.RequestOptions;
 
+  export import AssetsCursor = Pagination.AssetsCursor;
+  export { type AssetsCursorParams as AssetsCursorParams, type AssetsCursorResponse as AssetsCursorResponse };
+
+  export import SnapshotsCursor = Pagination.SnapshotsCursor;
+  export {
+    type SnapshotsCursorParams as SnapshotsCursorParams,
+    type SnapshotsCursorResponse as SnapshotsCursorResponse,
+  };
+
+  export import CollectionsCursor = Pagination.CollectionsCursor;
+  export {
+    type CollectionsCursorParams as CollectionsCursorParams,
+    type CollectionsCursorResponse as CollectionsCursorResponse,
+  };
+
+  export import JobsCursor = Pagination.JobsCursor;
+  export { type JobsCursorParams as JobsCursorParams, type JobsCursorResponse as JobsCursorResponse };
+
+  export import ModelsCursor = Pagination.ModelsCursor;
+  export { type ModelsCursorParams as ModelsCursorParams, type ModelsCursorResponse as ModelsCursorResponse };
+
+  export import TagsCursor = Pagination.TagsCursor;
+  export { type TagsCursorParams as TagsCursorParams, type TagsCursorResponse as TagsCursorResponse };
+
+  export import WorkflowsCursor = Pagination.WorkflowsCursor;
+  export {
+    type WorkflowsCursorParams as WorkflowsCursorParams,
+    type WorkflowsCursorResponse as WorkflowsCursorResponse,
+  };
+
+  export import SearchHitsOffset = Pagination.SearchHitsOffset;
+  export {
+    type SearchHitsOffsetParams as SearchHitsOffsetParams,
+    type SearchHitsOffsetResponse as SearchHitsOffsetResponse,
+  };
+
   export {
     Assets as Assets,
     type AssetRetrieveResponse as AssetRetrieveResponse,
@@ -935,6 +1025,8 @@ export declare namespace Scenario {
     type AssetUnlockResponse as AssetUnlockResponse,
     type AssetUpdateTagsResponse as AssetUpdateTagsResponse,
     type AssetUploadResponse as AssetUploadResponse,
+    type AssetListResponsesAssetsCursor as AssetListResponsesAssetsCursor,
+    type AssetListSnapshotsResponsesSnapshotsCursor as AssetListSnapshotsResponsesSnapshotsCursor,
     type AssetRetrieveParams as AssetRetrieveParams,
     type AssetUpdateParams as AssetUpdateParams,
     type AssetListParams as AssetListParams,
@@ -955,6 +1047,7 @@ export declare namespace Scenario {
     type CollectionUpdateResponse as CollectionUpdateResponse,
     type CollectionListResponse as CollectionListResponse,
     type CollectionDeleteResponse as CollectionDeleteResponse,
+    type CollectionListResponsesCollectionsCursor as CollectionListResponsesCollectionsCursor,
     type CollectionCreateParams as CollectionCreateParams,
     type CollectionUpdateParams as CollectionUpdateParams,
     type CollectionListParams as CollectionListParams,
@@ -967,6 +1060,7 @@ export declare namespace Scenario {
     type GenerateDetectResponse as GenerateDetectResponse,
     type GenerateEmbedResponse as GenerateEmbedResponse,
     type GeneratePatchResponse as GeneratePatchResponse,
+    type GeneratePromptResponse as GeneratePromptResponse,
     type GenerateRunModelResponse as GenerateRunModelResponse,
     type GenerateTranslateResponse as GenerateTranslateResponse,
     type GenerateCaptionParams as GenerateCaptionParams,
@@ -974,6 +1068,7 @@ export declare namespace Scenario {
     type GenerateDetectParams as GenerateDetectParams,
     type GenerateEmbedParams as GenerateEmbedParams,
     type GeneratePatchParams as GeneratePatchParams,
+    type GeneratePromptParams as GeneratePromptParams,
     type GenerateRunModelParams as GenerateRunModelParams,
     type GenerateTranslateParams as GenerateTranslateParams,
   };
@@ -983,6 +1078,7 @@ export declare namespace Scenario {
     type JobRetrieveResponse as JobRetrieveResponse,
     type JobListResponse as JobListResponse,
     type JobTriggerActionResponse as JobTriggerActionResponse,
+    type JobListResponsesJobsCursor as JobListResponsesJobsCursor,
     type JobListParams as JobListParams,
     type JobTriggerActionParams as JobTriggerActionParams,
   };
@@ -1000,6 +1096,7 @@ export declare namespace Scenario {
     type ModelGetBulkResponse as ModelGetBulkResponse,
     type ModelTransferResponse as ModelTransferResponse,
     type ModelUpdateTagsResponse as ModelUpdateTagsResponse,
+    type ModelListResponsesModelsCursor as ModelListResponsesModelsCursor,
     type ModelCreateParams as ModelCreateParams,
     type ModelRetrieveParams as ModelRetrieveParams,
     type ModelUpdateParams as ModelUpdateParams,
@@ -1018,11 +1115,18 @@ export declare namespace Scenario {
     Search as Search,
     type SearchAssetSearchResponse as SearchAssetSearchResponse,
     type SearchModelSearchResponse as SearchModelSearchResponse,
+    type SearchAssetSearchResponsesSearchHitsOffset as SearchAssetSearchResponsesSearchHitsOffset,
+    type SearchModelSearchResponsesSearchHitsOffset as SearchModelSearchResponsesSearchHitsOffset,
     type SearchAssetSearchParams as SearchAssetSearchParams,
     type SearchModelSearchParams as SearchModelSearchParams,
   };
 
-  export { Tags as Tags, type TagListResponse as TagListResponse, type TagListParams as TagListParams };
+  export {
+    Tags as Tags,
+    type TagListResponse as TagListResponse,
+    type TagListResponsesTagsCursor as TagListResponsesTagsCursor,
+    type TagListParams as TagListParams,
+  };
 
   export {
     UploadsAPIUploads as Uploads,
@@ -1049,6 +1153,7 @@ export declare namespace Scenario {
     type WorkflowApproveUserResponse as WorkflowApproveUserResponse,
     type WorkflowGetTagsResponse as WorkflowGetTagsResponse,
     type WorkflowRunResponse as WorkflowRunResponse,
+    type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor,
     type WorkflowCreateParams as WorkflowCreateParams,
     type WorkflowUpdateParams as WorkflowUpdateParams,
     type WorkflowListParams as WorkflowListParams,