feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 18
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lemma%2Flemma-34406ba4cbe013a332aa89d2e6de85dd0f10426405476c8f37da3c3a4b57e0ce.yml
-openapi_spec_hash: 509d1233071637148a2b3298d7fc3de2
+configured_endpoints: 17
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lemma%2Flemma-7d37defa0f907862d7d3c807dd33259df967ddaa70601f91d4d771c9c02e4dec.yml
+openapi_spec_hash: 357f9bb257a1f73b57bd4bd5f3018000
 config_hash: 3911423d0a218a9e0813f5fe6370ae95

README.md

@@ -24,7 +24,9 @@ import Lemma from '@uselemma/api';
 
 const client = new Lemma();
 
-const datasets = await client.datasets.list();
+const dataset = await client.datasets.create({ name: 'name' });
+
+console.log(dataset.id);
 ```
 
 ### Request & Response types
@@ -37,7 +39,8 @@ import Lemma from '@uselemma/api';
 
 const client = new Lemma();
 
-const datasets: Lemma.DatasetListResponse = await client.datasets.list();
+const params: Lemma.DatasetCreateParams = { name: 'name' };
+const dataset: Lemma.Dataset = await client.datasets.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -79,7 +82,7 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const datasets = await client.datasets.list().catch(async (err) => {
+const dataset = await client.datasets.create({ name: 'name' }).catch(async (err) => {
   if (err instanceof Lemma.APIError) {
     console.log(err.status); // 400
     console.log(err.name); // BadRequestError
@@ -119,7 +122,7 @@ const client = new Lemma({
 });
 
 // Or, configure per-request:
-await client.datasets.list({
+await client.datasets.create({ name: 'name' }, {
   maxRetries: 5,
 });
 ```
@@ -136,7 +139,7 @@ const client = new Lemma({
 });
 
 // Override per-request:
-await client.datasets.list({
+await client.datasets.create({ name: 'name' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -159,13 +162,13 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new Lemma();
 
-const response = await client.datasets.list().asResponse();
+const response = await client.datasets.create({ name: 'name' }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: datasets, response: raw } = await client.datasets.list().withResponse();
+const { data: dataset, response: raw } = await client.datasets.create({ name: 'name' }).withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(datasets);
+console.log(dataset.id);
 ```
 
 ### Logging
@@ -245,7 +248,7 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.datasets.list({
+client.datasets.create({
   // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',

api.md

@@ -3,7 +3,6 @@
 Types:
 
 - <code><a href="./src/resources/datasets.ts">Dataset</a></code>
-- <code><a href="./src/resources/datasets.ts">DatasetListResponse</a></code>
 - <code><a href="./src/resources/datasets.ts">DatasetDeleteResponse</a></code>
 - <code><a href="./src/resources/datasets.ts">DatasetCreateDownloadURLResponse</a></code>
 - <code><a href="./src/resources/datasets.ts">DatasetGenerateDatasetResponse</a></code>
@@ -14,7 +13,6 @@ Methods:
 
 - <code title="post /datasets">client.datasets.<a href="./src/resources/datasets.ts">create</a>({ ...params }) -> Dataset</code>
 - <code title="get /datasets/{dataset_id}">client.datasets.<a href="./src/resources/datasets.ts">retrieve</a>(datasetID) -> Dataset</code>
-- <code title="get /datasets">client.datasets.<a href="./src/resources/datasets.ts">list</a>() -> DatasetListResponse</code>
 - <code title="delete /datasets/{dataset_id}">client.datasets.<a href="./src/resources/datasets.ts">delete</a>(datasetID) -> DatasetDeleteResponse</code>
 - <code title="get /datasets/{dataset_id}/create-download-url">client.datasets.<a href="./src/resources/datasets.ts">createDownloadURL</a>(datasetID) -> string</code>
 - <code title="post /datasets/generate-dataset">client.datasets.<a href="./src/resources/datasets.ts">generateDataset</a>({ ...params }) -> DatasetGenerateDatasetResponse</code>

src/client.ts

@@ -27,7 +27,6 @@ import {
   DatasetGenerateSchemaResponse,
   DatasetGenerateValidatorsParams,
   DatasetGenerateValidatorsResponse,
-  DatasetListResponse,
   Datasets,
 } from './resources/datasets';
 import {
@@ -770,7 +769,6 @@ export declare namespace Lemma {
   export {
     Datasets as Datasets,
     type Dataset as Dataset,
-    type DatasetListResponse as DatasetListResponse,
     type DatasetDeleteResponse as DatasetDeleteResponse,
     type DatasetCreateDownloadURLResponse as DatasetCreateDownloadURLResponse,
     type DatasetGenerateDatasetResponse as DatasetGenerateDatasetResponse,

src/resources/datasets.ts

@@ -27,16 +27,6 @@ export class Datasets extends APIResource {
     return this._client.get(path`/datasets/${datasetID}`, options);
   }
 
-  /**
-   * List all datasets for the current tenant.
-   *
-   * Retrieves all datasets that belong to the current user's tenant. This includes
-   * datasets created by any user within the same tenant.
-   */
-  list(options?: RequestOptions): APIPromise<DatasetListResponse> {
-    return this._client.get('/datasets', options);
-  }
-
   /**
    * Delete a dataset by ID.
    *
@@ -135,8 +125,6 @@ export interface Dataset {
   updatedAt?: string | null;
 }
 
-export type DatasetListResponse = Array<Dataset>;
-
 export type DatasetDeleteResponse = boolean;
 
 export type DatasetCreateDownloadURLResponse = string;
@@ -223,7 +211,6 @@ export interface DatasetGenerateValidatorsParams {
 export declare namespace Datasets {
   export {
     type Dataset as Dataset,
-    type DatasetListResponse as DatasetListResponse,
     type DatasetDeleteResponse as DatasetDeleteResponse,
     type DatasetCreateDownloadURLResponse as DatasetCreateDownloadURLResponse,
     type DatasetGenerateDatasetResponse as DatasetGenerateDatasetResponse,

src/resources/index.ts

@@ -3,7 +3,6 @@
 export {
   Datasets,
   type Dataset,
-  type DatasetListResponse,
   type DatasetDeleteResponse,
   type DatasetCreateDownloadURLResponse,
   type DatasetGenerateDatasetResponse,

tests/api-resources/datasets.test.ts

@@ -37,18 +37,6 @@ describe('resource datasets', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // Prism tests are disabled
-  test.skip('list', async () => {
-    const responsePromise = client.datasets.list();
-    const rawResponse = await responsePromise.asResponse();
-    expect(rawResponse).toBeInstanceOf(Response);
-    const response = await responsePromise;
-    expect(response).not.toBeInstanceOf(Response);
-    const dataAndResponse = await responsePromise.withResponse();
-    expect(dataAndResponse.data).toBe(response);
-    expect(dataAndResponse.response).toBe(rawResponse);
-  });
-
   // Prism tests are disabled
   test.skip('delete', async () => {
     const responsePromise = client.datasets.delete('dataset_id');