@scenario-labs/sdk 0.2.0 → 1.0.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';
@@ -37,6 +57,7 @@ import {
 import {
   JobListParams,
   JobListResponse,
+  JobListResponsesJobsCursor,
   JobRetrieveResponse,
   JobTriggerActionParams,
   JobTriggerActionResponse,
@@ -47,10 +68,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 +93,7 @@ import {
   WorkflowGetTagsResponse,
   WorkflowListParams,
   WorkflowListResponse,
+  WorkflowListResponsesWorkflowsCursor,
   WorkflowRetrieveResponse,
   WorkflowRunParams,
   WorkflowRunResponse,
@@ -78,6 +102,7 @@ import {
   Workflows,
 } from './resources/workflows';
 import {
+  AssetDeleteMultipleParams,
   AssetDeleteMultipleResponse,
   AssetDuplicateParams,
   AssetDuplicateResponse,
@@ -85,8 +110,10 @@ import {
   AssetGetBulkResponse,
   AssetListParams,
   AssetListResponse,
+  AssetListResponsesAssetsCursor,
   AssetListSnapshotsParams,
   AssetListSnapshotsResponse,
+  AssetListSnapshotsResponsesSnapshotsCursor,
   AssetLockParams,
   AssetLockResponse,
   AssetRetrieveParams,
@@ -107,6 +134,7 @@ import {
   CollectionDeleteResponse,
   CollectionListParams,
   CollectionListResponse,
+  CollectionListResponsesCollectionsCursor,
   CollectionRetrieveResponse,
   CollectionUpdateParams,
   CollectionUpdateResponse,
@@ -126,6 +154,7 @@ import {
   ModelGetBulkResponse,
   ModelListParams,
   ModelListResponse,
+  ModelListResponsesModelsCursor,
   ModelRetrieveParams,
   ModelRetrieveResponse,
   ModelTransferParams,
@@ -339,14 +368,14 @@ export class Scenario {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.bearerAuth && values.get('authorization')) {
+    if (this.apiKey && this.apiSecret && values.get('authorization')) {
       return;
     }
     if (nulls.has('authorization')) {
       return;
     }
 
-    if (this.apiKey && this.apiSecret && values.get('authorization')) {
+    if (this.bearerAuth && values.get('authorization')) {
       return;
     }
     if (nulls.has('authorization')) {
@@ -354,27 +383,20 @@ export class Scenario {
     }
 
     throw new Error(
-      'Could not resolve authentication method. Expected either bearerAuth, apiKey or apiSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted',
+      'Could not resolve authentication method. Expected either apiKey, apiSecret or bearerAuth to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted',
     );
   }
 
   protected async authHeaders(
     opts: FinalRequestOptions,
-    schemes: { scBearerAuth?: boolean; scBasicAuth?: boolean },
+    schemes: { scBasicAuth?: boolean; scBearerAuth?: boolean },
   ): Promise<NullableHeaders | undefined> {
     return buildHeaders([
-      schemes.scBearerAuth ? await this.scBearerAuth(opts) : null,
       schemes.scBasicAuth ? await this.scBasicAuth(opts) : null,
+      schemes.scBearerAuth ? await this.scBearerAuth(opts) : null,
     ]);
   }
 
-  protected async scBearerAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (this.bearerAuth == null) {
-      return undefined;
-    }
-    return buildHeaders([{ Authorization: `Bearer ${this.bearerAuth}` }]);
-  }
-
   protected async scBasicAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     if (!this.apiKey) {
       return undefined;
@@ -389,6 +411,13 @@ export class Scenario {
     return buildHeaders([{ Authorization }]);
   }
 
+  protected async scBearerAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    if (this.bearerAuth == null) {
+      return undefined;
+    }
+    return buildHeaders([{ Authorization: `Bearer ${this.bearerAuth}` }]);
+  }
+
   protected stringifyQuery(query: object | Record<string, unknown>): string {
     return stringifyQuery(query);
   }
@@ -646,6 +675,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,
@@ -812,7 +865,7 @@ export class Scenario {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      await this.authHeaders(options, options.__security ?? { scBearerAuth: true, scBasicAuth: true }),
+      await this.authHeaders(options, options.__security ?? { scBasicAuth: true, scBearerAuth: true }),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,
@@ -921,6 +974,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,
@@ -934,9 +1023,12 @@ 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,
+    type AssetDeleteMultipleParams as AssetDeleteMultipleParams,
     type AssetDuplicateParams as AssetDuplicateParams,
     type AssetGetBulkParams as AssetGetBulkParams,
     type AssetListSnapshotsParams as AssetListSnapshotsParams,
@@ -953,6 +1045,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,
@@ -981,6 +1074,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,
   };
@@ -998,6 +1092,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,
@@ -1016,11 +1111,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,
@@ -1047,6 +1149,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,