feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-f9fd5fb43d56001ea7d7f49e92bd55134347b198b2664fd76321cc02a75817c9.yml
-openapi_spec_hash: 5130b5ebb7cbfe7a906716c5cf21764b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-81154a75608f9e6eee6e73e9565f7c062e2277a812021713cf1fe70b0516189c.yml
+openapi_spec_hash: a84243958fdcbc1d229f8c8b73815908
 config_hash: 3e61a9566953ce5dbd4bcea7ceb568a3

src/resources/workbooks.ts

@@ -590,16 +590,33 @@ export namespace WorkbookExportParams {
    */
   export interface Apply {
     /**
-     * A1-style reference for the cell to write to
+     * Reference for the cell to write to
      */
-    target: string;
+    target: string | Apply.ReferenceObject;
 
     /**
      * Value to write to the target cell
      */
     value: number | string | boolean | null;
   }
 
+  export namespace Apply {
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+  }
+
   /**
    * Goal seek. Use this to calculate the required input value for a formula to
    * achieve a specified target result. This is particularly useful when the desired
@@ -609,25 +626,57 @@ export namespace WorkbookExportParams {
     /**
      * Reference for the cell that will contain the solution
      */
-    controlCell: string;
+    controlCell: string | GoalSeek.ReferenceObject;
 
     /**
      * Reference for the cell that contains the formula you want to resolve
      */
-    targetCell: string;
+    targetCell: string | GoalSeek.ReferenceObject;
 
     /**
      * The value you want the formula to return
      */
     targetValue: number;
   }
+
+  export namespace GoalSeek {
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+  }
 }
 
 export interface WorkbookQueryParams {
   /**
    * Cell references to read from the workbook and return to the client
    */
-  read: Array<string>;
+  read: Array<string | WorkbookQueryParams.ReferenceObject>;
 
   /**
    * Cells to update before reading. Note that the API has no state and any changes
@@ -649,23 +698,55 @@ export interface WorkbookQueryParams {
 }
 
 export namespace WorkbookQueryParams {
+  /**
+   * A reference to a range of spreadsheet cells.
+   */
+  export interface ReferenceObject {
+    /**
+     * Unprefixed A1-style range, id, or name
+     */
+    cells: string;
+
+    /**
+     * Name of the sheet to reference
+     */
+    sheet: string | null;
+  }
+
   /**
    * Specifies a temporary change to a workbook cell, including the `target` cell
    * reference and the `value` to apply. The API has no state, and so any changes
    * made are cleared after each request.
    */
   export interface Apply {
     /**
-     * A1-style reference for the cell to write to
+     * Reference for the cell to write to
      */
-    target: string;
+    target: string | Apply.ReferenceObject;
 
     /**
      * Value to write to the target cell
      */
     value: number | string | boolean | null;
   }
 
+  export namespace Apply {
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+  }
+
   /**
    * Goal seek. Use this to calculate the required input value for a formula to
    * achieve a specified target result. This is particularly useful when the desired
@@ -675,19 +756,51 @@ export namespace WorkbookQueryParams {
     /**
      * Reference for the cell that will contain the solution
      */
-    controlCell: string;
+    controlCell: string | GoalSeek.ReferenceObject;
 
     /**
      * Reference for the cell that contains the formula you want to resolve
      */
-    targetCell: string;
+    targetCell: string | GoalSeek.ReferenceObject;
 
     /**
      * The value you want the formula to return
      */
     targetValue: number;
   }
 
+  export namespace GoalSeek {
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+  }
+
   /**
    * Defines settings for formatting and structuring query results.
    */
@@ -780,15 +893,32 @@ export namespace WorkbookRenderChartParams {
    */
   export interface Apply {
     /**
-     * A1-style reference for the cell to write to
+     * Reference for the cell to write to
      */
-    target: string;
+    target: string | Apply.ReferenceObject;
 
     /**
      * Value to write to the target cell
      */
     value: number | string | boolean | null;
   }
+
+  export namespace Apply {
+    /**
+     * A reference to a range of spreadsheet cells.
+     */
+    export interface ReferenceObject {
+      /**
+       * Unprefixed A1-style range, id, or name
+       */
+      cells: string;
+
+      /**
+       * Name of the sheet to reference
+       */
+      sheet: string | null;
+    }
+  }
 }
 
 export interface WorkbookUploadParams {

tests/api-resources/workbooks.test.ts

@@ -45,7 +45,7 @@ describe('resource workbooks', () => {
     const response = await client.workbooks.query('id', {
       read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'],
       apply: [{ target: 'A2', value: 1234 }],
-      goalSeek: { controlCell: 'controlCell', targetCell: 'targetCell', targetValue: 0 },
+      goalSeek: { controlCell: 'Sheet1!A1:B2', targetCell: 'Sheet1!A1:B2', targetValue: 0 },
       options: { axis: 'rows', originals: 'off', refs: 'off', structure: 'single', values: 'full' },
     });
   });