11# Warp API TypeScript API Library
22
3- [ ![ NPM version] ( < https://img.shields.io/npm/v/warp-sdk.svg?label=npm%20(stable) > )] ( https://npmjs.org/package/warp-sdk ) ![ npm bundle size] ( https://img.shields.io/bundlephobia/minzip/warp-sdk )
3+ [ ![ NPM version] ( < https://img.shields.io/npm/v/warp-agent- sdk.svg?label=npm%20(stable) > )] ( https://npmjs.org/package/warp-agent- sdk ) ![ npm bundle size] ( https://img.shields.io/bundlephobia/minzip/warp-agent -sdk )
44
55This library provides convenient access to the Warp API REST API from server-side TypeScript or JavaScript.
66
@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
1111## Installation
1212
1313``` sh
14- npm install warp-sdk
14+ npm install warp-agent- sdk
1515```
1616
1717## Usage
@@ -20,7 +20,7 @@ The full API of this library can be found in [api.md](api.md).
2020
2121<!-- prettier-ignore -->
2222``` js
23- import WarpAPI from ' warp-sdk' ;
23+ import WarpAPI from ' warp-agent- sdk' ;
2424
2525const client = new WarpAPI ({
2626 apiKey: process .env [' WARP_API_KEY' ], // This is the default and can be omitted
@@ -37,7 +37,7 @@ This library includes TypeScript definitions for all request params and response
3737
3838<!-- prettier-ignore -->
3939``` ts
40- import WarpAPI from ' warp-sdk' ;
40+ import WarpAPI from ' warp-agent- sdk' ;
4141
4242const client = new WarpAPI ({
4343 apiKey: process .env [' WARP_API_KEY' ], // This is the default and can be omitted
@@ -162,7 +162,7 @@ The log level can be configured in two ways:
1621622 . Using the ` logLevel ` client option (overrides the environment variable if set)
163163
164164``` ts
165- import WarpAPI from ' warp-sdk' ;
165+ import WarpAPI from ' warp-agent- sdk' ;
166166
167167const client = new WarpAPI ({
168168 logLevel: ' debug' , // Show all log messages
@@ -190,7 +190,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
190190below the configured level will not be sent to your logger.
191191
192192``` ts
193- import WarpAPI from ' warp-sdk' ;
193+ import WarpAPI from ' warp-agent- sdk' ;
194194import pino from ' pino' ;
195195
196196const logger = pino ();
@@ -259,7 +259,7 @@ globalThis.fetch = fetch;
259259Or pass it to the client:
260260
261261``` ts
262- import WarpAPI from ' warp-sdk' ;
262+ import WarpAPI from ' warp-agent- sdk' ;
263263import fetch from ' my-fetch' ;
264264
265265const client = new WarpAPI ({ fetch });
@@ -270,7 +270,7 @@ const client = new WarpAPI({ fetch });
270270If 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.)
271271
272272``` ts
273- import WarpAPI from ' warp-sdk' ;
273+ import WarpAPI from ' warp-agent- sdk' ;
274274
275275const client = new WarpAPI ({
276276 fetchOptions: {
@@ -287,7 +287,7 @@ options to requests:
287287<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 >
288288
289289``` ts
290- import WarpAPI from ' warp-sdk' ;
290+ import WarpAPI from ' warp-agent- sdk' ;
291291import * as undici from ' undici' ;
292292
293293const proxyAgent = new undici .ProxyAgent (' http://localhost:8888' );
@@ -301,7 +301,7 @@ const client = new WarpAPI({
301301<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 >
302302
303303``` ts
304- import WarpAPI from ' warp-sdk' ;
304+ import WarpAPI from ' warp-agent- sdk' ;
305305
306306const client = new WarpAPI ({
307307 fetchOptions: {
@@ -313,7 +313,7 @@ const client = new WarpAPI({
313313<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 >
314314
315315``` ts
316- import WarpAPI from ' npm:warp-sdk' ;
316+ import WarpAPI from ' npm:warp-agent- sdk' ;
317317
318318const httpClient = Deno .createHttpClient ({ proxy: { url: ' http://localhost:8888' } });
319319const client = new WarpAPI ({
0 commit comments