feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 2
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-9c32b0e4ddfdf467e980af727cd6cb85e7c60d4df9924a4a06a5abc38dbaf671.yml
+configured_endpoints: 3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-4f7e4249cd44e912120dd6531cc506a8c0c0e3e3b5f0c91b18c37177b850b590.yml

api.md

@@ -3,9 +3,9 @@
 Types:
 
 - <code><a href="./src/resources/workbooks.ts">WorkbookQueryResponse</a></code>
-- <code><a href="./src/resources/workbooks.ts">WorkbookRenderChartResponse</a></code>
 
 Methods:
 
+- <code title="post /v1/workbooks/{id}/export">client.workbooks.<a href="./src/resources/workbooks.ts">export</a>(id, { ...params }) -> Response</code>
 - <code title="post /v1/workbooks/{id}/query">client.workbooks.<a href="./src/resources/workbooks.ts">query</a>(id, { ...params }) -> WorkbookQueryResponse</code>
-- <code title="post /v1/workbooks/{id}/chart">client.workbooks.<a href="./src/resources/workbooks.ts">renderChart</a>(id, { ...params }) -> unknown</code>
+- <code title="post /v1/workbooks/{id}/chart">client.workbooks.<a href="./src/resources/workbooks.ts">renderChart</a>(id, { ...params }) -> Response</code>

src/client.ts

@@ -19,10 +19,10 @@ import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
 import {
+  WorkbookExportParams,
   WorkbookQueryParams,
   WorkbookQueryResponse,
   WorkbookRenderChartParams,
-  WorkbookRenderChartResponse,
   Workbooks,
 } from './resources/workbooks';
 import { readEnv } from './internal/utils/env';
@@ -632,7 +632,7 @@ export declare namespace GRID {
   export {
     Workbooks as Workbooks,
     type WorkbookQueryResponse as WorkbookQueryResponse,
-    type WorkbookRenderChartResponse as WorkbookRenderChartResponse,
+    type WorkbookExportParams as WorkbookExportParams,
     type WorkbookQueryParams as WorkbookQueryParams,
     type WorkbookRenderChartParams as WorkbookRenderChartParams,
   };

src/resources/index.ts

@@ -3,7 +3,7 @@
 export {
   Workbooks,
   type WorkbookQueryResponse,
-  type WorkbookRenderChartResponse,
+  type WorkbookExportParams,
   type WorkbookQueryParams,
   type WorkbookRenderChartParams,
 } from './workbooks';

src/resources/workbooks.ts

@@ -2,10 +2,27 @@
 
 import { APIResource } from '../resource';
 import { APIPromise } from '../api-promise';
+import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Workbooks extends APIResource {
+  /**
+   * Export a workbook as an .xlsx file. Cells can be updated before the workbook is
+   * exported.
+   */
+  export(id: string, body: WorkbookExportParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post(path`/v1/workbooks/${id}/export`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' },
+        options?.headers,
+      ]),
+      __binaryResponse: true,
+    });
+  }
+
   /**
    * Read cell data or apply temporary changes.
    *
@@ -19,8 +36,13 @@ export class Workbooks extends APIResource {
   /**
    * Render a chart using workbook data
    */
-  renderChart(id: string, body: WorkbookRenderChartParams, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.post(path`/v1/workbooks/${id}/chart`, { body, ...options });
+  renderChart(id: string, body: WorkbookRenderChartParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post(path`/v1/workbooks/${id}/chart`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: 'image/png' }, options?.headers]),
+      __binaryResponse: true,
+    });
   }
 }
 
@@ -371,7 +393,60 @@ export namespace WorkbookQueryResponse {
   }
 }
 
-export type WorkbookRenderChartResponse = unknown;
+export interface WorkbookExportParams {
+  /**
+   * Cells to update before exporting
+   */
+  apply?: Array<WorkbookExportParams.Apply> | 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
+   * outcome is known, but the corresponding input is not.
+   */
+  goalSeek?: WorkbookExportParams.GoalSeek | null;
+}
+
+export namespace WorkbookExportParams {
+  /**
+   * 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
+     */
+    target: string;
+
+    /**
+     * Value to write to the target cell
+     */
+    value: number | string | boolean | 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
+   * outcome is known, but the corresponding input is not.
+   */
+  export interface GoalSeek {
+    /**
+     * Reference for the cell that will contain the solution
+     */
+    controlCell: string;
+
+    /**
+     * Reference for the cell that contains the formula you want to resolve
+     */
+    targetCell: string;
+
+    /**
+     * The value you want the formula to return
+     */
+    targetValue: number;
+  }
+}
 
 export interface WorkbookQueryParams {
   /**
@@ -539,7 +614,7 @@ export namespace WorkbookRenderChartParams {
 export declare namespace Workbooks {
   export {
     type WorkbookQueryResponse as WorkbookQueryResponse,
-    type WorkbookRenderChartResponse as WorkbookRenderChartResponse,
+    type WorkbookExportParams as WorkbookExportParams,
     type WorkbookQueryParams as WorkbookQueryParams,
     type WorkbookRenderChartParams as WorkbookRenderChartParams,
   };

tests/api-resources/workbooks.test.ts

@@ -30,18 +30,6 @@ describe('resource workbooks', () => {
     });
   });
 
-  // skipped: tests are disabled for the time being
-  test.skip('renderChart: only required params', async () => {
-    const responsePromise = client.workbooks.renderChart('id', { chart: { data: '=C2:C142' } });
-    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);
-  });
-
   // skipped: tests are disabled for the time being
   test.skip('renderChart: required and optional params', async () => {
     const response = await client.workbooks.renderChart('id', {