feat(api): update via SDK Studio

Author: stainless-app[bot]

.eslintrc.js

@@ -10,7 +10,7 @@ module.exports = {
       {
         patterns: [
           {
-            group: ['spreadsheet-api', 'spreadsheet-api/*'],
+            group: ['@grid-is/api', '@grid-is/api/*'],
             message: 'Use a relative import, not a package import.',
           },
         ],

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd spreadsheet-api-typescript
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link spreadsheet-api
+$ yarn link @grid-is/api
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global spreadsheet-api
+$ pnpm link -—global @grid-is/api
 ```
 
 ## Running tests

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Spreadsheet API
+   Copyright 2025 GRID
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,10 +1,10 @@
-# Spreadsheet API TypeScript API Library
+# GRID Spreadsheet API API Library
 
-[![NPM version](https://img.shields.io/npm/v/spreadsheet-api.svg)](https://npmjs.org/package/spreadsheet-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/spreadsheet-api)
+[![NPM version](https://img.shields.io/npm/v/@grid-is/api.svg)](https://npmjs.org/package/@grid-is/api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@grid-is/api)
 
-This library provides convenient access to the Spreadsheet API REST API from server-side TypeScript or JavaScript.
+This library provides convenient access to the GRID REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found on [docs.spreadsheet-api.com](https://docs.spreadsheet-api.com). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [alpha.grid.is](https://alpha.grid.is/). The full API of this library can be found in [api.md](api.md).
 
 It is generated with [Stainless](https://www.stainlessapi.com/).
 
@@ -15,17 +15,17 @@ npm install git+ssh://git@github.com:stainless-sdks/spreadsheet-api-typescript.g
 ```
 
 > [!NOTE]
-> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install spreadsheet-api`
+> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install @grid-is/api`
 
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 
-const client = new SpreadsheetAPI();
+const client = new GRID();
 
 async function main() {
   const response = await client.workbooks.query('REPLACE_ME', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] });
@@ -42,13 +42,13 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 
-const client = new SpreadsheetAPI();
+const client = new GRID();
 
 async function main() {
-  const params: SpreadsheetAPI.WorkbookQueryParams = { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] };
-  const response: SpreadsheetAPI.WorkbookQueryResponse = await client.workbooks.query('REPLACE_ME', params);
+  const params: GRID.WorkbookQueryParams = { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] };
+  const response: GRID.WorkbookQueryResponse = await client.workbooks.query('REPLACE_ME', params);
 }
 
 main();
@@ -68,7 +68,7 @@ async function main() {
   const response = await client.workbooks
     .query('REPLACE_ME', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
     .catch(async (err) => {
-      if (err instanceof SpreadsheetAPI.APIError) {
+      if (err instanceof GRID.APIError) {
         console.log(err.status); // 400
         console.log(err.name); // BadRequestError
         console.log(err.headers); // {server: 'nginx', ...}
@@ -105,7 +105,7 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const client = new SpreadsheetAPI({
+const client = new GRID({
   maxRetries: 0, // default is 2
 });
 
@@ -122,7 +122,7 @@ Requests time out after 1 minute by default. You can configure this with a `time
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
-const client = new SpreadsheetAPI({
+const client = new GRID({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
@@ -136,6 +136,24 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
 
 Note that requests which time out will be [retried twice by default](#retries).
 
+## Default Headers
+
+We automatically send the `X-Client-Name` header set to `spreadsheet-api-node`.
+
+If you need to, you can override it by setting default headers on a per-request basis.
+
+```ts
+import GRID from '@grid-is/api';
+
+const client = new GRID();
+
+const response = await client.workbooks.query(
+  'REPLACE_ME',
+  { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] },
+  { headers: { 'X-Client-Name': 'My-Custom-Value' } },
+);
+```
+
 ## Advanced Usage
 
 ### Accessing raw Response data (e.g., headers)
@@ -146,7 +164,7 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const client = new SpreadsheetAPI();
+const client = new GRID();
 
 const response = await client.workbooks
   .query('REPLACE_ME', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
@@ -222,7 +240,7 @@ Or pass it to the client:
 ```ts
 import fetch from 'my-fetch';
 
-const client = new SpreadsheetAPI({ fetch });
+const client = new GRID({ fetch });
 ```
 
 ### Logging and middleware
@@ -232,9 +250,9 @@ which can be used to inspect or alter the `Request` or `Response` before/after e
 
 ```ts
 import { fetch } from 'undici'; // as one example
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 
-const client = new SpreadsheetAPI({
+const client = new GRID({
   fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     console.log('About to make a request', url, init);
     const response = await fetch(url, init);
@@ -244,17 +262,17 @@ const client = new SpreadsheetAPI({
 });
 ```
 
-Note that if given a `SPREADSHEET_API_LOG=debug` environment variable, this library will log all requests and responses automatically.
+Note that if given a `GRID_LOG=debug` environment variable, this library will log all requests and responses automatically.
 This is intended for debugging purposes only and may change in the future without notice.
 
 ### Fetch options
 
 If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 
-const client = new SpreadsheetAPI({
+const client = new GRID({
   fetchOptions: {
     // `RequestInit` options
   },
@@ -269,11 +287,11 @@ options to requests:
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
 ```ts
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
-const client = new SpreadsheetAPI({
+const client = new GRID({
   fetchOptions: {
     dispatcher: proxyAgent,
   },
@@ -283,9 +301,9 @@ const client = new SpreadsheetAPI({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
 ```ts
-import SpreadsheetAPI from 'spreadsheet-api';
+import GRID from '@grid-is/api';
 
-const client = new SpreadsheetAPI({
+const client = new GRID({
   fetchOptions: {
     proxy: 'http://localhost:8888',
   },
@@ -295,10 +313,10 @@ const client = new SpreadsheetAPI({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
 
 ```ts
-import SpreadsheetAPI from 'npm:spreadsheet-api';
+import GRID from 'npm:@grid-is/api';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
-const client = new SpreadsheetAPI({
+const client = new GRID({
   fetchOptions: {
     client: httpClient,
   },

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Spreadsheet API please follow the respective company's security reporting guidelines.
+or products provided by GRID please follow the respective company's security reporting guidelines.
 
-### Spreadsheet API Terms and Policies
+### GRID Terms and Policies
 
-Please contact dev-feedback@spreadsheet-api.com for any questions or concerns regarding security of our services.
+Please contact info@grid.is for any questions or concerns regarding security of our services.
 
 ---
 

jest.config.ts

@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^spreadsheet-api$': '<rootDir>/src/index.ts',
-    '^spreadsheet-api/(.*)$': '<rootDir>/src/$1',
+    '^@grid-is/api$': '<rootDir>/src/index.ts',
+    '^@grid-is/api/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "spreadsheet-api",
+  "name": "@grid-is/api",
   "version": "0.0.1-alpha.0",
-  "description": "The official TypeScript library for the Spreadsheet API API",
-  "author": "Spreadsheet API <dev-feedback@spreadsheet-api.com>",
+  "description": "The official TypeScript library for the GRID API",
+  "author": "GRID <info@grid.is>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",
@@ -46,8 +46,8 @@
     "typescript": "^4.8.2"
   },
   "imports": {
-    "spreadsheet-api": ".",
-    "spreadsheet-api/*": "./src/*"
+    "@grid-is/api": ".",
+    "@grid-is/api/*": "./src/*"
   },
   "exports": {
     ".": {

scripts/build

@@ -8,7 +8,7 @@ node scripts/utils/check-version.cjs
 
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
-# This way importing from `"spreadsheet-api/resources/foo"` works
+# This way importing from `"@grid-is/api/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
 rm -rf dist; mkdir dist
@@ -28,7 +28,7 @@ node scripts/utils/make-dist-package-json.cjs > dist/package.json
 
 # build to .js/.mjs/.d.ts files
 npm exec tsc-multi
-# we need to add exports = module.exports = SpreadsheetAPI to index.js;
+# we need to add exports = module.exports = GRID to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
 node scripts/utils/fix-index-exports.cjs
@@ -47,8 +47,8 @@ node scripts/utils/postprocess-files.cjs
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-(cd dist && node -e 'require("spreadsheet-api")')
-(cd dist && node -e 'import("spreadsheet-api")' --input-type=module)
+(cd dist && node -e 'require("@grid-is/api")')
+(cd dist && node -e 'import("@grid-is/api")' --input-type=module)
 
 if [ -e ./scripts/build-deno ]
 then

src/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type SpreadsheetAPI } from './client';
+import { type GRID } from './client';
 
 import { type PromiseOrValue } from './internal/types';
 import { APIResponseProps, defaultParseResponse } from './internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from './internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: SpreadsheetAPI;
+  #client: GRID;
 
   constructor(
-    client: SpreadsheetAPI,
+    client: GRID,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: SpreadsheetAPI,
+      client: GRID,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {