feat(api): update via SDK Studio

Author: stainless-app[bot]

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 GRID
+   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

@@ -2,7 +2,7 @@
 
 [![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 GRID 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 [alpha.grid.is](https://alpha.grid.is/). The full API of this library can be found in [api.md](api.md).
 
@@ -23,9 +23,9 @@ The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 
-const client = new GRID();
+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 GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 
-const client = new GRID();
+const client = new Grid();
 
 async function main() {
-  const params: GRID.WorkbookQueryParams = { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] };
-  const response: GRID.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 GRID.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 GRID({
+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 GRID({
+const client = new Grid({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
@@ -143,9 +143,9 @@ 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';
+import Grid from '@grid-is/api';
 
-const client = new GRID();
+const client = new Grid();
 
 const response = await client.workbooks.query(
   'REPLACE_ME',
@@ -164,7 +164,7 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const client = new GRID();
+const client = new Grid();
 
 const response = await client.workbooks
   .query('REPLACE_ME', { read: ['A1', 'Sheet2!B3', '=SUM(A1:A4)'] })
@@ -240,7 +240,7 @@ Or pass it to the client:
 ```ts
 import fetch from 'my-fetch';
 
-const client = new GRID({ fetch });
+const client = new Grid({ fetch });
 ```
 
 ### Logging and middleware
@@ -250,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 GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 
-const client = new GRID({
+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);
@@ -270,9 +270,9 @@ This is intended for debugging purposes only and may change in the future withou
 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 GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 
-const client = new GRID({
+const client = new Grid({
   fetchOptions: {
     // `RequestInit` options
   },
@@ -287,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 GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
-const client = new GRID({
+const client = new Grid({
   fetchOptions: {
     dispatcher: proxyAgent,
   },
@@ -301,9 +301,9 @@ const client = new GRID({
 <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 GRID from '@grid-is/api';
+import Grid from '@grid-is/api';
 
-const client = new GRID({
+const client = new Grid({
   fetchOptions: {
     proxy: 'http://localhost:8888',
   },
@@ -313,10 +313,10 @@ const client = new GRID({
 <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 GRID from 'npm:@grid-is/api';
+import Grid from 'npm:@grid-is/api';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
-const client = new GRID({
+const client = new Grid({
   fetchOptions: {
     client: httpClient,
   },

SECURITY.md

@@ -16,9 +16,9 @@ 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 GRID please follow the respective company's security reporting guidelines.
+or products provided by Grid please follow the respective company's security reporting guidelines.
 
-### GRID Terms and Policies
+### Grid Terms and Policies
 
 Please contact info@grid.is for any questions or concerns regarding security of our services.
 

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@grid-is/api",
   "version": "0.0.1-alpha.0",
-  "description": "The official TypeScript library for the GRID API",
-  "author": "GRID <info@grid.is>",
+  "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",

scripts/build

@@ -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 = GRID 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

src/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type GRID } 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: GRID;
+  #client: Grid;
 
   constructor(
-    client: GRID,
+    client: Grid,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: GRID,
+      client: Grid,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

src/client.ts

@@ -132,9 +132,9 @@ export interface ClientOptions {
 type FinalizedRequestInit = RequestInit & { headers: Headers };
 
 /**
- * API Client for interfacing with the GRID API.
+ * API Client for interfacing with the Grid API.
  */
-export class GRID {
+export class Grid {
   bearerToken: string;
 
   baseURL: string;
@@ -150,7 +150,7 @@ export class GRID {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the GRID API.
+   * API Client for interfacing with the Grid API.
    *
    * @param {string | undefined} [opts.bearerToken=process.env['GRID_API_TOKEN'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['GRID_BASE_URL'] ?? https://api-alpha.grid.is] - Override the default base URL for the API.
@@ -167,8 +167,8 @@ export class GRID {
     ...opts
   }: ClientOptions = {}) {
     if (bearerToken === undefined) {
-      throw new Errors.GRIDError(
-        "The GRID_API_TOKEN environment variable is missing or empty; either provide it, or instantiate the GRID client with an bearerToken option, like new GRID({ bearerToken: 'My Bearer Token' }).",
+      throw new Errors.GridError(
+        "The GRID_API_TOKEN environment variable is missing or empty; either provide it, or instantiate the Grid client with an bearerToken option, like new Grid({ bearerToken: 'My Bearer Token' }).",
       );
     }
 
@@ -179,7 +179,7 @@ export class GRID {
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? GRID.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? Grid.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     if (options.logLevel != null) {
       this.logLevel = options.logLevel;
@@ -224,7 +224,7 @@ export class GRID {
         if (value === null) {
           return `${encodeURIComponent(key)}=`;
         }
-        throw new Errors.GRIDError(
+        throw new Errors.GridError(
           `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
         );
       })
@@ -604,10 +604,10 @@ export class GRID {
     }
   }
 
-  static GRID = this;
+  static Grid = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static GRIDError = Errors.GRIDError;
+  static GridError = Errors.GridError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -625,8 +625,8 @@ export class GRID {
 
   workbooks: API.Workbooks = new API.Workbooks(this);
 }
-GRID.Workbooks = Workbooks;
-export declare namespace GRID {
+Grid.Workbooks = Workbooks;
+export declare namespace Grid {
   export type RequestOptions = Opts.RequestOptions;
 
   export {

src/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from './internal/errors';
 
-export class GRIDError extends Error {}
+export class GridError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends GRIDError {
+> extends GridError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { GRID as default } from './client';
+export { Grid as default } from './client';
 
 export { type Uploadable, toFile } from './uploads';
 export { APIPromise } from './api-promise';
-export { GRID, type ClientOptions } from './client';
+export { Grid, type ClientOptions } from './client';
 export {
-  GRIDError,
+  GridError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type GRID } from '../client';
+import { type Grid } from '../client';
 import { logger } from './utils/log';
 
 export type APIResponseProps = {
@@ -10,7 +10,7 @@ export type APIResponseProps = {
   controller: AbortController;
 };
 
-export async function defaultParseResponse<T>(client: GRID, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: Grid, props: APIResponseProps): Promise<T> {
   const { response } = props;
 
   // fetch refuses to read the body when the status code is 204.