feat(api): manual updates (#63)

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 Stainless 2
+   Copyright 2025 Stainless
 
    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,8 +1,8 @@
-# Stainless 2 TypeScript API Library
+# Stainless TypeScript API Library
 
 [![NPM version](https://img.shields.io/npm/v/stainless.svg)](https://npmjs.org/package/stainless) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/stainless)
 
-This library provides convenient access to the Stainless 2 REST API from server-side TypeScript or JavaScript.
+This library provides convenient access to the Stainless REST API from server-side TypeScript or JavaScript.
 
 The REST API documentation can be found on [app.stainlessapi.com](https://app.stainlessapi.com/docs). 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 Stainless2 from 'stainless';
+import Stainless from 'stainless';
 
-const client = new Stainless2({
+const client = new Stainless({
   apiKey: process.env['API_KEY'], // This is the default and can be omitted
 });
 
@@ -44,15 +44,15 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Stainless2 from 'stainless';
+import Stainless from 'stainless';
 
-const client = new Stainless2({
+const client = new Stainless({
   apiKey: process.env['API_KEY'], // This is the default and can be omitted
 });
 
 async function main() {
-  const params: Stainless2.Builds.OutputRetrieveParams = { target: 'node' };
-  const output: Stainless2.Builds.OutputRetrieveResponse = await client.builds.outputs.retrieve(
+  const params: Stainless.Builds.OutputRetrieveParams = { target: 'node' };
+  const output: Stainless.Builds.OutputRetrieveResponse = await client.builds.outputs.retrieve(
     'bui_123',
     params,
   );
@@ -73,7 +73,7 @@ a subclass of `APIError` will be thrown:
 ```ts
 async function main() {
   const output = await client.builds.outputs.retrieve('bui_123', { target: 'node' }).catch(async (err) => {
-    if (err instanceof Stainless2.APIError) {
+    if (err instanceof Stainless.APIError) {
       console.log(err.status); // 400
       console.log(err.name); // BadRequestError
       console.log(err.headers); // {server: 'nginx', ...}
@@ -110,7 +110,7 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const client = new Stainless2({
+const client = new Stainless({
   maxRetries: 0, // default is 2
 });
 
@@ -127,7 +127,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 Stainless2({
+const client = new Stainless({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
@@ -151,7 +151,7 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const client = new Stainless2();
+const client = new Stainless();
 
 const response = await client.builds.outputs.retrieve('bui_123', { target: 'node' }).asResponse();
 console.log(response.headers.get('X-My-Header'));
@@ -225,7 +225,7 @@ Or pass it to the client:
 ```ts
 import fetch from 'my-fetch';
 
-const client = new Stainless2({ fetch });
+const client = new Stainless({ fetch });
 ```
 
 ### Logging and middleware
@@ -235,9 +235,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 Stainless2 from 'stainless';
+import Stainless from 'stainless';
 
-const client = new Stainless2({
+const client = new Stainless({
   fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
     console.log('About to make a request', url, init);
     const response = await fetch(url, init);
@@ -247,17 +247,17 @@ const client = new Stainless2({
 });
 ```
 
-Note that if given a `STAINLESS_2_LOG=debug` environment variable, this library will log all requests and responses automatically.
+Note that if given a `STAINLESS_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 Stainless2 from 'stainless';
+import Stainless from 'stainless';
 
-const client = new Stainless2({
+const client = new Stainless({
   fetchOptions: {
     // `RequestInit` options
   },
@@ -272,11 +272,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 Stainless2 from 'stainless';
+import Stainless from 'stainless';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
-const client = new Stainless2({
+const client = new Stainless({
   fetchOptions: {
     dispatcher: proxyAgent,
   },
@@ -286,9 +286,9 @@ const client = new Stainless2({
 <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 Stainless2 from 'stainless';
+import Stainless from 'stainless';
 
-const client = new Stainless2({
+const client = new Stainless({
   fetchOptions: {
     proxy: 'http://localhost:8888',
   },
@@ -298,10 +298,10 @@ const client = new Stainless2({
 <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 Stainless2 from 'npm:stainless';
+import Stainless from 'npm:stainless';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
-const client = new Stainless2({
+const client = new Stainless({
   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 Stainless 2 please follow the respective company's security reporting guidelines.
+or products provided by Stainless please follow the respective company's security reporting guidelines.
 
-### Stainless 2 Terms and Policies
+### Stainless Terms and Policies
 
 Please contact [email protected] for any questions or concerns regarding security of our services.
 

package.json

@@ -1,8 +1,8 @@
 {
   "name": "stainless",
   "version": "0.1.0-alpha.16",
-  "description": "The official TypeScript library for the Stainless 2 API",
-  "author": "Stainless 2 <[email protected]>",
+  "description": "The official TypeScript library for the Stainless API",
+  "author": "Stainless <[email protected]>",
   "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 = Stainless2 to index.js;
+# we need to add exports = module.exports = Stainless 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 Stainless2 } from './client';
+import { type Stainless } 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: Stainless2;
+  #client: Stainless;
 
   constructor(
-    client: Stainless2,
+    client: Stainless,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: Stainless2,
+      client: Stainless,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

src/client.ts

@@ -65,7 +65,7 @@ export interface ClientOptions {
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['STAINLESS_2_BASE_URL'].
+   * Defaults to process.env['STAINLESS_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -117,7 +117,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['STAINLESS_2_LOG'].
+   * Defaults to process.env['STAINLESS_LOG'].
    */
   logLevel?: LogLevel | undefined | null;
 
@@ -132,9 +132,9 @@ export interface ClientOptions {
 type FinalizedRequestInit = RequestInit & { headers: Headers };
 
 /**
- * API Client for interfacing with the Stainless 2 API.
+ * API Client for interfacing with the Stainless API.
  */
-export class Stainless2 {
+export class Stainless {
   apiKey: string;
 
   baseURL: string;
@@ -150,10 +150,10 @@ export class Stainless2 {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Stainless 2 API.
+   * API Client for interfacing with the Stainless API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['API_KEY'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['STAINLESS_2_BASE_URL'] ?? https://api.stainlessapi.com] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['STAINLESS_BASE_URL'] ?? https://api.stainlessapi.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -162,13 +162,13 @@ export class Stainless2 {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('STAINLESS_2_BASE_URL'),
+    baseURL = readEnv('STAINLESS_BASE_URL'),
     apiKey = readEnv('API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Errors.Stainless2Error(
-        "The API_KEY environment variable is missing or empty; either provide it, or instantiate the Stainless2 client with an apiKey option, like new Stainless2({ apiKey: 'My API Key' }).",
+      throw new Errors.StainlessError(
+        "The API_KEY environment variable is missing or empty; either provide it, or instantiate the Stainless client with an apiKey option, like new Stainless({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -179,12 +179,12 @@ export class Stainless2 {
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? Stainless2.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? Stainless.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     if (options.logLevel != null) {
       this.logLevel = options.logLevel;
     } else {
-      const envLevel = readEnv('STAINLESS_2_LOG');
+      const envLevel = readEnv('STAINLESS_LOG');
       if (isLogLevel(envLevel)) {
         this.logLevel = envLevel;
       }
@@ -224,7 +224,7 @@ export class Stainless2 {
         if (value === null) {
           return `${encodeURIComponent(key)}=`;
         }
-        throw new Errors.Stainless2Error(
+        throw new Errors.StainlessError(
           `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.`,
         );
       })
@@ -612,10 +612,10 @@ export class Stainless2 {
     }
   }
 
-  static Stainless2 = this;
+  static Stainless = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static Stainless2Error = Errors.Stainless2Error;
+  static StainlessError = Errors.StainlessError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -633,8 +633,8 @@ export class Stainless2 {
 
   builds: API.Builds = new API.Builds(this);
 }
-Stainless2.Builds = Builds;
-export declare namespace Stainless2 {
+Stainless.Builds = Builds;
+export declare namespace Stainless {
   export type RequestOptions = Opts.RequestOptions;
 
   export {

src/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from './internal/errors';
 
-export class Stainless2Error extends Error {}
+export class StainlessError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends Stainless2Error {
+> extends StainlessError {
   /** 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 { Stainless2 as default } from './client';
+export { Stainless as default } from './client';
 
 export { type Uploadable, toFile } from './uploads';
 export { APIPromise } from './api-promise';
-export { Stainless2, type ClientOptions } from './client';
+export { Stainless, type ClientOptions } from './client';
 export {
-  Stainless2Error,
+  StainlessError,
   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 Stainless2 } from '../client';
+import { type Stainless } 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: Stainless2, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: Stainless, props: APIResponseProps): Promise<T> {
   const { response } = props;
 
   // fetch refuses to read the body when the status code is 204.