release: 1.0.1 (#52)

* fix(stainless): configure calc and values endpoints

The two new endpoints were missing from the Stainless config, and so hadn't made their way into the public realm.

* release: 1.0.1

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.0.0"
+  ".": "1.0.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 5
+configured_endpoints: 7
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-8f089189d87fe061afe62a54cdce6752e1b9597de7fdaa4154412ce2115c7ed4.yml
 openapi_spec_hash: 2bff1feefeadafaa3c714059c1ebf682
-config_hash: 3e61a9566953ce5dbd4bcea7ceb568a3
+config_hash: 8d14e76153d6c3003008e70a59928aa8

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.0.1 (2025-05-15)
+
+Full Changelog: [v1.0.0...v1.0.1](https://github.com/GRID-is/api-sdk-ts/compare/v1.0.0...v1.0.1)
+
+### Bug Fixes
+
+* **stainless:** configure calc and values endpoints ([b1e8f44](https://github.com/GRID-is/api-sdk-ts/commit/b1e8f44ccf9d4eb6dcd97fd7726085737adc77eb))
+
 ## 1.0.0 (2025-05-13)
 
 Full Changelog: [v1.0.0-rc.9...v1.0.0](https://github.com/GRID-is/api-sdk-ts/compare/v1.0.0-rc.9...v1.0.0)

api.md

@@ -3,13 +3,17 @@
 Types:
 
 - <code><a href="./src/resources/workbooks.ts">WorkbookListResponse</a></code>
+- <code><a href="./src/resources/workbooks.ts">WorkbookCalcResponse</a></code>
 - <code><a href="./src/resources/workbooks.ts">WorkbookQueryResponse</a></code>
 - <code><a href="./src/resources/workbooks.ts">WorkbookUploadResponse</a></code>
+- <code><a href="./src/resources/workbooks.ts">WorkbookValuesResponse</a></code>
 
 Methods:
 
 - <code title="get /v1/workbooks">client.workbooks.<a href="./src/resources/workbooks.ts">list</a>({ ...params }) -> WorkbookListResponsesCursorPagination</code>
+- <code title="post /v1/workbooks/{id}/calc">client.workbooks.<a href="./src/resources/workbooks.ts">calc</a>(id, { ...params }) -> WorkbookCalcResponse</code>
 - <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 }) -> Response</code>
 - <code title="post /v1/workbooks">client.workbooks.<a href="./src/resources/workbooks.ts">upload</a>({ ...params }) -> WorkbookUploadResponse</code>
+- <code title="post /v1/workbooks/{id}/values">client.workbooks.<a href="./src/resources/workbooks.ts">values</a>(id, { ...params }) -> WorkbookValuesResponse</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grid-is/api",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The official TypeScript library for the Grid API",
   "author": "Grid <info@grid.is>",
   "types": "dist/index.d.ts",

src/client.ts

@@ -23,6 +23,8 @@ import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
 import {
+  WorkbookCalcParams,
+  WorkbookCalcResponse,
   WorkbookExportParams,
   WorkbookListParams,
   WorkbookListResponse,
@@ -32,6 +34,8 @@ import {
   WorkbookRenderChartParams,
   WorkbookUploadParams,
   WorkbookUploadResponse,
+  WorkbookValuesParams,
+  WorkbookValuesResponse,
   Workbooks,
 } from './resources/workbooks';
 import { readEnv } from './internal/utils/env';
@@ -739,13 +743,17 @@ export declare namespace Grid {
   export {
     Workbooks as Workbooks,
     type WorkbookListResponse as WorkbookListResponse,
+    type WorkbookCalcResponse as WorkbookCalcResponse,
     type WorkbookQueryResponse as WorkbookQueryResponse,
     type WorkbookUploadResponse as WorkbookUploadResponse,
+    type WorkbookValuesResponse as WorkbookValuesResponse,
     type WorkbookListResponsesCursorPagination as WorkbookListResponsesCursorPagination,
     type WorkbookListParams as WorkbookListParams,
+    type WorkbookCalcParams as WorkbookCalcParams,
     type WorkbookExportParams as WorkbookExportParams,
     type WorkbookQueryParams as WorkbookQueryParams,
     type WorkbookRenderChartParams as WorkbookRenderChartParams,
     type WorkbookUploadParams as WorkbookUploadParams,
+    type WorkbookValuesParams as WorkbookValuesParams,
   };
 }

src/resources/index.ts

@@ -3,12 +3,16 @@
 export {
   Workbooks,
   type WorkbookListResponse,
+  type WorkbookCalcResponse,
   type WorkbookQueryResponse,
   type WorkbookUploadResponse,
+  type WorkbookValuesResponse,
   type WorkbookListParams,
+  type WorkbookCalcParams,
   type WorkbookExportParams,
   type WorkbookQueryParams,
   type WorkbookRenderChartParams,
   type WorkbookUploadParams,
+  type WorkbookValuesParams,
   type WorkbookListResponsesCursorPagination,
 } from './workbooks';

src/resources/workbooks.ts

@@ -33,6 +33,20 @@ export class Workbooks extends APIResource {
     });
   }
 
+  /**
+   * Run calculations in a workbook and retrieve cell objects.
+   *
+   * @example
+   * ```ts
+   * const response = await client.workbooks.calc('id', {
+   *   read: ['A1'],
+   * });
+   * ```
+   */
+  calc(id: string, body: WorkbookCalcParams, options?: RequestOptions): APIPromise<WorkbookCalcResponse> {
+    return this._client.post(path`/v1/workbooks/${id}/calc`, { body, ...options });
+  }
+
   /**
    * Export a workbook as an .xlsx file. Cells can be updated before the workbook is
    * exported.
@@ -115,6 +129,24 @@ export class Workbooks extends APIResource {
       multipartFormRequestOptions({ body, ...options }, this._client),
     );
   }
+
+  /**
+   * Run calculations in a workbook and retrieve cell values.
+   *
+   * @example
+   * ```ts
+   * const response = await client.workbooks.values('id', {
+   *   read: ['A1'],
+   * });
+   * ```
+   */
+  values(
+    id: string,
+    body: WorkbookValuesParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkbookValuesResponse> {
+    return this._client.post(path`/v1/workbooks/${id}/values`, { body, ...options });
+  }
 }
 
 export type WorkbookListResponsesCursorPagination = CursorPagination<WorkbookListResponse>;
@@ -168,6 +200,66 @@ export interface WorkbookListResponse {
   latest_ready_version?: number | null;
 }
 
+/**
+ * Response type returned by the for /calc query endpoint.
+ */
+export type WorkbookCalcResponse = Record<
+  string,
+  WorkbookCalcResponse.ReadValue | Array<WorkbookCalcResponse.UnionMember1>
+>;
+
+export namespace WorkbookCalcResponse {
+  export interface ReadValue {
+    /**
+     * Formatted cell value
+     */
+    formatted: string;
+
+    /**
+     * Cell position in the spreadsheet, using 0-indexed x/y coordinates. Origin [0, 0]
+     * is at the top-left
+     */
+    offset: Array<unknown>;
+
+    /**
+     * Type of the cell value
+     */
+    type: 'blank' | 'boolean' | 'number' | 'string' | 'date' | 'error';
+
+    /**
+     * Cell value
+     */
+    value: number | string | boolean | null;
+
+    error?: string | null;
+  }
+
+  export interface UnionMember1 {
+    /**
+     * Formatted cell value
+     */
+    formatted: string;
+
+    /**
+     * Cell position in the spreadsheet, using 0-indexed x/y coordinates. Origin [0, 0]
+     * is at the top-left
+     */
+    offset: Array<unknown>;
+
+    /**
+     * Type of the cell value
+     */
+    type: 'blank' | 'boolean' | 'number' | 'string' | 'date' | 'error';
+
+    /**
+     * Cell value
+     */
+    value: number | string | boolean | null;
+
+    error?: string | null;
+  }
+}
+
 /**
  * Contains the results of a workbook query, including `read` (queried cell data)
  * and `apply` (details of temporary changes applied). Note that the API has no
@@ -339,8 +431,22 @@ export interface WorkbookUploadResponse {
   id: string;
 }
 
+/**
+ * Response type returned by the for /values query endpoint.
+ */
+export type WorkbookValuesResponse = Record<
+  string,
+  number | string | boolean | Array<number | string | boolean | null> | null
+>;
+
 export interface WorkbookListParams extends CursorPaginationParams {}
 
+export interface WorkbookCalcParams {
+  read: Array<string>;
+
+  apply?: Record<string, number | string | boolean | null> | null;
+}
+
 export interface WorkbookExportParams {
   /**
    * Cells to update before exporting
@@ -833,16 +939,26 @@ export interface WorkbookUploadParams {
   file: Uploadable;
 }
 
+export interface WorkbookValuesParams {
+  read: Array<string>;
+
+  apply?: Record<string, number | string | boolean | null> | null;
+}
+
 export declare namespace Workbooks {
   export {
     type WorkbookListResponse as WorkbookListResponse,
+    type WorkbookCalcResponse as WorkbookCalcResponse,
     type WorkbookQueryResponse as WorkbookQueryResponse,
     type WorkbookUploadResponse as WorkbookUploadResponse,
+    type WorkbookValuesResponse as WorkbookValuesResponse,
     type WorkbookListResponsesCursorPagination as WorkbookListResponsesCursorPagination,
     type WorkbookListParams as WorkbookListParams,
+    type WorkbookCalcParams as WorkbookCalcParams,
     type WorkbookExportParams as WorkbookExportParams,
     type WorkbookQueryParams as WorkbookQueryParams,
     type WorkbookRenderChartParams as WorkbookRenderChartParams,
     type WorkbookUploadParams as WorkbookUploadParams,
+    type WorkbookValuesParams as WorkbookValuesParams,
   };
 }

src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.0.0'; // x-release-please-version
+export const VERSION = '1.0.1'; // x-release-please-version

tests/api-resources/workbooks.test.ts

@@ -28,6 +28,23 @@ describe('resource workbooks', () => {
     ).rejects.toThrow(Grid.NotFoundError);
   });
 
+  // skipped: tests are disabled for the time being
+  test.skip('calc: only required params', async () => {
+    const responsePromise = client.workbooks.calc('id', { read: ['A1'] });
+    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('calc: required and optional params', async () => {
+    const response = await client.workbooks.calc('id', { read: ['A1'], apply: { foo: 0 } });
+  });
+
   // skipped: tests are disabled for the time being
   test.skip('query: only required params', async () => {
     const responsePromise = client.workbooks.query('id', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] });
@@ -110,4 +127,21 @@ describe('resource workbooks', () => {
       file: await toFile(Buffer.from('# my file contents'), 'README.md'),
     });
   });
+
+  // skipped: tests are disabled for the time being
+  test.skip('values: only required params', async () => {
+    const responsePromise = client.workbooks.values('id', { read: ['A1'] });
+    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('values: required and optional params', async () => {
+    const response = await client.workbooks.values('id', { read: ['A1'], apply: { foo: 0 } });
+  });
 });