feat(api): api update (#37)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-6e9b1263cf6d720224f647537949aef5bbf794efd14e08055bed7d31b523b0a8.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-f8b7e23cec932020dc713b51d2b154f2365d151e4c0be0a785195f5cd3c78134.yml

README.md

@@ -138,6 +138,7 @@ You can use the `maxRetries` option to configure or disable this:
 // Configure the default for all requests:
 const client = new Grid({
   maxRetries: 0, // default is 2
+  apiKey: 'My API Key',
 });
 
 // Or, configure per-request:
@@ -155,6 +156,7 @@ Requests time out after one minute by default. You can configure this with a `ti
 // Configure the default for all requests:
 const client = new Grid({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
+  apiKey: 'My API Key',
 });
 
 // Override per-request:

src/client.ts

@@ -186,10 +186,6 @@ export class Grid {
     return;
   }
 
-  protected authHeaders(opts: FinalRequestOptions): Headers | undefined {
-    return new Headers({ Authorization: `Bearer ${this.apiKey}` });
-  }
-
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
@@ -640,7 +636,6 @@ export class Grid {
         ...getPlatformHeaders(),
         'X-Client-Name': 'api-sdk',
       },
-      this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,

src/resources/workbooks.ts

@@ -168,8 +168,14 @@ export namespace WorkbookQueryResponse {
    * state and any changes made are cleared after each request.
    */
   export interface Apply {
+    /**
+     * A1-style reference for the cell that was updated
+     */
     target: string;
 
+    /**
+     * New value of the cell
+     */
     value: number | string | boolean | null;
 
     /**
@@ -185,6 +191,9 @@ export namespace WorkbookQueryResponse {
   export interface DataTable {
     data: Array<Array<DataTable.ValueCell | DataTable.ErrorCell | DataTable.EmptyCell>>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'dataTable';
@@ -197,20 +206,28 @@ export namespace WorkbookQueryResponse {
      */
     export interface ValueCell {
       /**
-       * Specifies the type of a workbook cell. Possible values include `b` (boolean),
-       * `n` (number), `d` (date), and `s` (string).
+       * Data type of the cell value (e.g. boolean, number, text)
        */
       t: 'b' | 'n' | 'd' | 's';
 
+      /**
+       * Underlying cell value
+       */
       v: number | string | boolean | null;
 
       /**
        * Relative A1-based cell reference
        */
       r?: string | null;
 
+      /**
+       * Formatted cell value
+       */
       w?: string | null;
 
+      /**
+       * Number format associated with the cell
+       */
       z?: string | null;
     }
 
@@ -220,8 +237,14 @@ export namespace WorkbookQueryResponse {
      * provides details for identifying and understanding errors in workbook data.
      */
     export interface ErrorCell {
+      /**
+       * Data type of the cell value (always 'e' for 'error')
+       */
       t: 'e';
 
+      /**
+       * Underlying cell value
+       */
       v: string;
 
       /**
@@ -239,6 +262,9 @@ export namespace WorkbookQueryResponse {
      * Cells that have no content but hold metadata like comments.
      */
     export interface EmptyCell {
+      /**
+       * Data type of the cell value (always 'z' for 'empty cell')
+       */
       t: 'z';
     }
   }
@@ -250,6 +276,9 @@ export namespace WorkbookQueryResponse {
   export interface DataList {
     data: Array<DataList.ValueCell | DataList.ErrorCell | DataList.EmptyCell>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'dataList';
@@ -262,20 +291,28 @@ export namespace WorkbookQueryResponse {
      */
     export interface ValueCell {
       /**
-       * Specifies the type of a workbook cell. Possible values include `b` (boolean),
-       * `n` (number), `d` (date), and `s` (string).
+       * Data type of the cell value (e.g. boolean, number, text)
        */
       t: 'b' | 'n' | 'd' | 's';
 
+      /**
+       * Underlying cell value
+       */
       v: number | string | boolean | null;
 
       /**
        * Relative A1-based cell reference
        */
       r?: string | null;
 
+      /**
+       * Formatted cell value
+       */
       w?: string | null;
 
+      /**
+       * Number format associated with the cell
+       */
       z?: string | null;
     }
 
@@ -285,8 +322,14 @@ export namespace WorkbookQueryResponse {
      * provides details for identifying and understanding errors in workbook data.
      */
     export interface ErrorCell {
+      /**
+       * Data type of the cell value (always 'e' for 'error')
+       */
       t: 'e';
 
+      /**
+       * Underlying cell value
+       */
       v: string;
 
       /**
@@ -304,6 +347,9 @@ export namespace WorkbookQueryResponse {
      * Cells that have no content but hold metadata like comments.
      */
     export interface EmptyCell {
+      /**
+       * Data type of the cell value (always 'z' for 'empty cell')
+       */
       t: 'z';
     }
   }
@@ -319,6 +365,9 @@ export namespace WorkbookQueryResponse {
      */
     data: DataCell.ValueCell | DataCell.ErrorCell | DataCell.EmptyCell;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'cell';
@@ -331,20 +380,28 @@ export namespace WorkbookQueryResponse {
      */
     export interface ValueCell {
       /**
-       * Specifies the type of a workbook cell. Possible values include `b` (boolean),
-       * `n` (number), `d` (date), and `s` (string).
+       * Data type of the cell value (e.g. boolean, number, text)
        */
       t: 'b' | 'n' | 'd' | 's';
 
+      /**
+       * Underlying cell value
+       */
       v: number | string | boolean | null;
 
       /**
        * Relative A1-based cell reference
        */
       r?: string | null;
 
+      /**
+       * Formatted cell value
+       */
       w?: string | null;
 
+      /**
+       * Number format associated with the cell
+       */
       z?: string | null;
     }
 
@@ -354,8 +411,14 @@ export namespace WorkbookQueryResponse {
      * provides details for identifying and understanding errors in workbook data.
      */
     export interface ErrorCell {
+      /**
+       * Data type of the cell value (always 'e' for 'error')
+       */
       t: 'e';
 
+      /**
+       * Underlying cell value
+       */
       v: string;
 
       /**
@@ -373,6 +436,9 @@ export namespace WorkbookQueryResponse {
      * Cells that have no content but hold metadata like comments.
      */
     export interface EmptyCell {
+      /**
+       * Data type of the cell value (always 'z' for 'empty cell')
+       */
       t: 'z';
     }
   }
@@ -384,6 +450,9 @@ export namespace WorkbookQueryResponse {
   export interface ValueTable {
     data: Array<Array<number | string | boolean | null>>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'valueTable';
@@ -396,6 +465,9 @@ export namespace WorkbookQueryResponse {
   export interface ValueList {
     data: Array<number | string | boolean | null>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'valueList';
@@ -408,6 +480,9 @@ export namespace WorkbookQueryResponse {
   export interface Value {
     data: number | string | boolean | null;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'value';
@@ -420,6 +495,9 @@ export namespace WorkbookQueryResponse {
   export interface FormattedValueTable {
     data: Array<Array<string>>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'formattedValueTable';
@@ -432,6 +510,9 @@ export namespace WorkbookQueryResponse {
   export interface FormattedValueList {
     data: Array<string>;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'formattedValueList';
@@ -444,6 +525,9 @@ export namespace WorkbookQueryResponse {
   export interface FormattedValue {
     data: string;
 
+    /**
+     * A1-style reference for the cell or cells that were updated
+     */
     source: string;
 
     type: 'formattedValue';
@@ -471,7 +555,7 @@ export namespace WorkbookQueryResponse {
     /**
      * The result of the formula
      */
-    solution?: number | string | boolean | null;
+    solution?: number;
   }
 }
 
@@ -682,6 +766,11 @@ export namespace WorkbookRenderChartParams {
      * Type of chart to render
      */
     type?: 'line' | 'column';
+
+    /**
+     * How to label individual data values on the chart
+     */
+    values?: 'none' | 'selective' | 'all';
   }
 
   /**
@@ -703,6 +792,9 @@ export namespace WorkbookRenderChartParams {
 }
 
 export interface WorkbookUploadParams {
+  /**
+   * Excel (.xlsx) file
+   */
   file: Uploadable;
 }
 

tests/api-resources/workbooks.test.ts

@@ -53,7 +53,14 @@ describe('resource workbooks', () => {
   // skipped: tests are disabled for the time being
   test.skip('renderChart: required and optional params', async () => {
     const response = await client.workbooks.renderChart('id', {
-      chart: { data: '=C2:C142', format: 'png', labels: '=B2:B142', title: '=A1', type: 'line' },
+      chart: {
+        data: '=C2:C142',
+        format: 'png',
+        labels: '=B2:B142',
+        title: '=A1',
+        type: 'line',
+        values: 'none',
+      },
       apply: [{ target: 'A2', value: 1234 }],
     });
   });