docs: update examples

Author: stainless-app[bot]

README.md

@@ -26,9 +26,7 @@ const client = new Grid({
   apiKey: process.env['GRID_API_TOKEN'], // This is the default and can be omitted
 });
 
-const response = await client.workbooks.query('YOUR_WORKBOOK_ID', {
-  read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'],
-});
+const response = await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] });
 
 console.log(response.read);
 ```
@@ -45,7 +43,7 @@ const client = new Grid({
   apiKey: process.env['GRID_API_TOKEN'], // This is the default and can be omitted
 });
 
-const params: Grid.WorkbookQueryParams = { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] };
+const params: Grid.WorkbookQueryParams = { read: ['A1:A4'] };
 const response: Grid.WorkbookQueryResponse = await client.workbooks.query(
   'YOUR_WORKBOOK_ID',
   params,
@@ -92,7 +90,7 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 const response = await client.workbooks
-  .query('YOUR_WORKBOOK_ID', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
+  .query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] })
   .catch(async (err) => {
     if (err instanceof Grid.APIError) {
       console.log(err.status); // 400
@@ -133,7 +131,7 @@ const client = new Grid({
 });
 
 // Or, configure per-request:
-await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] }, {
+await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] }, {
   maxRetries: 5,
 });
 ```
@@ -150,7 +148,7 @@ const client = new Grid({
 });
 
 // Override per-request:
-await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] }, {
+await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] }, {
   timeout: 5 * 1000,
 });
 ```
@@ -203,7 +201,7 @@ const client = new Grid();
 
 const response = await client.workbooks.query(
   'YOUR_WORKBOOK_ID',
-  { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] },
+  { read: ['A1:A4'] },
   { headers: { 'X-Client-Name': 'My-Custom-Value' } },
 );
 ```
@@ -222,14 +220,12 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new Grid();
 
-const response = await client.workbooks
-  .query('YOUR_WORKBOOK_ID', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
-  .asResponse();
+const response = await client.workbooks.query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
 const { data: response, response: raw } = await client.workbooks
-  .query('YOUR_WORKBOOK_ID', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
+  .query('YOUR_WORKBOOK_ID', { read: ['A1:A4'] })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(response.read);

src/resources/beta.ts

@@ -11,20 +11,39 @@ import { path } from '../internal/utils/path';
 export class Beta extends APIResource {
   /**
    * Retrieve labels automatically detected for cells and ranges in the workbook.
+   *
+   * @example
+   * ```ts
+   * const response = await client.beta.getWorkbookLabels('id');
+   * ```
    */
   getWorkbookLabels(id: string, options?: RequestOptions): APIPromise<BetaGetWorkbookLabelsResponse> {
     return this._client.get(path`/v1/workbooks/${id}/labels`, options);
   }
 
   /**
    * Retrieve labels automatically detected for cells and ranges in the workbook.
+   *
+   * @example
+   * ```ts
+   * const response = await client.beta.getWorkbookParameters(
+   *   'id',
+   * );
+   * ```
    */
   getWorkbookParameters(id: string, options?: RequestOptions): APIPromise<BetaGetWorkbookParametersResponse> {
     return this._client.get(path`/v1/workbooks/${id}/parameters`, options);
   }
 
   /**
    * Search data labels across all spreadsheets uploaded to an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.beta.searchLabels({
+   *   query: 'profit',
+   * });
+   * ```
    */
   searchLabels(body: BetaSearchLabelsParams, options?: RequestOptions): APIPromise<BetaSearchLabelsResponse> {
     return this._client.post('/v1/workbooks/search/labels', { body, ...options });

src/resources/workbooks.ts

@@ -83,7 +83,7 @@ export class Workbooks extends APIResource {
    * @example
    * ```ts
    * const response = await client.workbooks.query('id', {
-   *   read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'],
+   *   read: ['A1:A4'],
    * });
    * ```
    */

tests/api-resources/workbooks.test.ts

@@ -55,7 +55,7 @@ describe('resource workbooks', () => {
 
   // Mock server tests are disabled
   test.skip('query: only required params', async () => {
-    const responsePromise = client.workbooks.query('id', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] });
+    const responsePromise = client.workbooks.query('id', { read: ['A1:A4'] });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -68,7 +68,7 @@ describe('resource workbooks', () => {
   // Mock server tests are disabled
   test.skip('query: required and optional params', async () => {
     const response = await client.workbooks.query('id', {
-      read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'],
+      read: ['A1:A4'],
       apply: [{ target: 'A2', value: 1234 }],
       goalSeek: {
         controlCell: 'Sheet1!A1:B2',