agentmail 0.2.17 → 0.2.18

package/README.md

@@ -1,681 +0,0 @@
-# Agentmail TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fagentmail-to%2Fagentmail-node)
-[![npm shield](https://img.shields.io/npm/v/agentmail)](https://www.npmjs.com/package/agentmail)
-
-The Agentmail TypeScript library provides convenient access to the Agentmail APIs from TypeScript.
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Reference](#reference)
-- [Usage](#usage)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
-- [Pagination](#pagination)
-- [Advanced](#advanced)
-  - [Additional Headers](#additional-headers)
-  - [Additional Query String Parameters](#additional-query-string-parameters)
-  - [Retries](#retries)
-  - [Timeouts](#timeouts)
-  - [Aborting Requests](#aborting-requests)
-  - [Access Raw Response Data](#access-raw-response-data)
-  - [Logging](#logging)
-  - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
-- [Binary Response](#binary-response)
-
-## Installation
-
-```sh
-npm i -s agentmail
-```
-
-## Reference
-
-A full reference for this library is available [here](https://github.com/agentmail-to/agentmail-node/blob/HEAD/./reference.md).
-
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { AgentMailClient } from "agentmail";
-
-const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });
-await client.inboxes.create(undefined);
-```
-
-## Request and Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { AgentMail } from "agentmail";
-
-const request: AgentMail.ListInboxesRequest = {
-    ...
-};
-```
-
-## Exception Handling
-
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
-
-```typescript
-import { AgentMailError } from "agentmail";
-
-try {
-    await client.inboxes.create(...);
-} catch (err) {
-    if (err instanceof AgentMailError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-        console.log(err.rawResponse);
-    }
-}
-```
-
-## Pagination
-
-List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
-
-```typescript
-import { AgentMailClient } from "agentmail";
-
-const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });
-const pageableResponse = await client.inboxes.list();
-for await (const item of pageableResponse) {
-    console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.inboxes.list();
-while (page.hasNextPage()) {
-    page = page.getNextPage();
-}
-
-// You can also access the underlying response
-const response = page.response;
-```
-
-## Advanced
-
-### Additional Headers
-
-If you would like to send additional headers as part of the request, use the `headers` request option.
-
-```typescript
-import { AgentMailClient } from "agentmail";
-
-const client = new AgentMailClient({
-    ...
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-
-const response = await client.inboxes.create(..., {
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-```
-
-### Additional Query String Parameters
-
-If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
-
-```typescript
-const response = await client.inboxes.create(..., {
-    queryParams: {
-        'customQueryParamKey': 'custom query param value'
-    }
-});
-```
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
-
-A request is deemed retryable when any of the following HTTP status codes is returned:
-
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.inboxes.create(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-### Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await client.inboxes.create(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
-### Aborting Requests
-
-The SDK allows users to abort requests at any point by passing in an abort signal.
-
-```typescript
-const controller = new AbortController();
-const response = await client.inboxes.create(..., {
-    abortSignal: controller.signal
-});
-controller.abort(); // aborts the request
-```
-
-### Access Raw Response Data
-
-The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
-The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
-
-```typescript
-const { data, rawResponse } = await client.inboxes.create(...).withRawResponse();
-
-console.log(data);
-console.log(rawResponse.headers['X-My-Header']);
-```
-
-### Logging
-
-The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
-
-```typescript
-import { AgentMailClient, logging } from "agentmail";
-
-const client = new AgentMailClient({
-    ...
-    logging: {
-        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
-        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
-        silent: false, // defaults to true, set to false to enable logging
-    }
-});
-```
-The `logging` object can have the following properties:
-- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
-- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
-- `silent`: Whether to silence the logger. Defaults to `true`.
-
-The `level` property can be one of the following values:
-- `logging.LogLevel.Debug`
-- `logging.LogLevel.Info`
-- `logging.LogLevel.Warn`
-- `logging.LogLevel.Error`
-
-To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
-
-<details>
-<summary>Custom logger examples</summary>
-
-Here's an example using the popular `winston` logging library.
-```ts
-import winston from 'winston';
-
-const winstonLogger = winston.createLogger({...});
-
-const logger: logging.ILogger = {
-    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
-    info: (msg, ...args) => winstonLogger.info(msg, ...args),
-    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
-    error: (msg, ...args) => winstonLogger.error(msg, ...args),
-};
-```
-
-Here's an example using the popular `pino` logging library.
-
-```ts
-import pino from 'pino';
-
-const pinoLogger = pino({...});
-
-const logger: logging.ILogger = {
-  debug: (msg, ...args) => pinoLogger.debug(args, msg),
-  info: (msg, ...args) => pinoLogger.info(args, msg),
-  warn: (msg, ...args) => pinoLogger.warn(args, msg),
-  error: (msg, ...args) => pinoLogger.error(args, msg),
-};
-```
-</details>
-
-
-### Runtime Compatibility
-
-
-The SDK works in the following runtimes:
-
-
-
-- Node.js 18+
-- Vercel
-- Cloudflare Workers
-- Deno v1.25+
-- Bun 1.0+
-- React Native
-
-### Customizing Fetch Client
-
-The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
-unsupported environment, this provides a way for you to break glass and ensure the SDK works.
-
-```typescript
-import { AgentMailClient } from "agentmail";
-
-const client = new AgentMailClient({
-    ...
-    fetcher: // provide your implementation here
-});
-```
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically.
-Additions made directly to this library would have to be moved over to our generation code,
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
-a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
-## Binary Response
-
-You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
-
-```typescript
-const response = await client.domains.getZoneFile(...);
-const stream: ReadableStream<Uint8Array> = response.stream();
-// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
-// const blob: Blob = response.blob();
-// const bytes: Uint8Array = response.bytes();
-// You can only use the response body once, so you must choose one of the above methods.
-// If you want to check if the response body has been used, you can use the following property.
-const bodyUsed = response.bodyUsed;
-```
-<details>
-<summary>Save binary response to a file</summary>
-
-<blockquote>
-<details>
-<summary>Node.js</summary>
-
-<blockquote>
-<details>
-<summary>ReadableStream (most-efficient)</summary>
-
-```ts
-import { createWriteStream } from 'fs';
-import { Readable } from 'stream';
-import { pipeline } from 'stream/promises';
-
-const response = await client.domains.getZoneFile(...);
-
-const stream = response.stream();
-const nodeStream = Readable.fromWeb(stream);
-const writeStream = createWriteStream('path/to/file');
-
-await pipeline(nodeStream, writeStream);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-import { writeFile } from 'fs/promises';
-
-const response = await client.domains.getZoneFile(...);
-
-const arrayBuffer = await response.arrayBuffer();
-await writeFile('path/to/file', Buffer.from(arrayBuffer));
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-import { writeFile } from 'fs/promises';
-
-const response = await client.domains.getZoneFile(...);
-
-const blob = await response.blob();
-const arrayBuffer = await blob.arrayBuffer();
-await writeFile('output.bin', Buffer.from(arrayBuffer));
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-import { writeFile } from 'fs/promises';
-
-const response = await client.domains.getZoneFile(...);
-
-const bytes = await response.bytes();
-await writeFile('path/to/file', bytes);
-```
-
-</details>
-</blockquote>
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bun</summary>
-
-<blockquote>
-<details>
-<summary>ReadableStream (most-efficient)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const stream = response.stream();
-await Bun.write('path/to/file', stream);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const arrayBuffer = await response.arrayBuffer();
-await Bun.write('path/to/file', arrayBuffer);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const blob = await response.blob();
-await Bun.write('path/to/file', blob);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const bytes = await response.bytes();
-await Bun.write('path/to/file', bytes);
-```
-
-</details>
-</blockquote>
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Deno</summary>
-
-<blockquote>
-<details>
-<summary>ReadableStream (most-efficient)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const stream = response.stream();
-const file = await Deno.open('path/to/file', { write: true, create: true });
-await stream.pipeTo(file.writable);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const arrayBuffer = await response.arrayBuffer();
-await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const blob = await response.blob();
-const arrayBuffer = await blob.arrayBuffer();
-await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const bytes = await response.bytes();
-await Deno.writeFile('path/to/file', bytes);
-```
-
-</details>
-</blockquote>
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Browser</summary>
-
-<blockquote>
-<details>
-<summary>Blob (most-efficient)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const blob = await response.blob();
-const url = URL.createObjectURL(blob);
-
-// trigger download
-const a = document.createElement('a');
-a.href = url;
-a.download = 'filename';
-a.click();
-URL.revokeObjectURL(url);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ReadableStream</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const stream = response.stream();
-const reader = stream.getReader();
-const chunks = [];
-
-while (true) {
-  const { done, value } = await reader.read();
-  if (done) break;
-  chunks.push(value);
-}
-
-const blob = new Blob(chunks);
-const url = URL.createObjectURL(blob);
-
-// trigger download
-const a = document.createElement('a');
-a.href = url;
-a.download = 'filename';
-a.click();
-URL.revokeObjectURL(url);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const arrayBuffer = await response.arrayBuffer();
-const blob = new Blob([arrayBuffer]);
-const url = URL.createObjectURL(blob);
-
-// trigger download
-const a = document.createElement('a');
-a.href = url;
-a.download = 'filename';
-a.click();
-URL.revokeObjectURL(url);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const bytes = await response.bytes();
-const blob = new Blob([bytes]);
-const url = URL.createObjectURL(blob);
-
-// trigger download
-const a = document.createElement('a');
-a.href = url;
-a.download = 'filename';
-a.click();
-URL.revokeObjectURL(url);
-```
-
-</details>
-</blockquote>
-
-</details>
-</blockquote>
-
-</details>
-</blockquote>
-
-<details>
-<summary>Convert binary response to text</summary>
-
-<blockquote>
-<details>
-<summary>ReadableStream</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const stream = response.stream();
-const text = await new Response(stream).text();
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const arrayBuffer = await response.arrayBuffer();
-const text = new TextDecoder().decode(arrayBuffer);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const blob = await response.blob();
-const text = await blob.text();
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-const response = await client.domains.getZoneFile(...);
-
-const bytes = await response.bytes();
-const text = new TextDecoder().decode(bytes);
-```
-
-</details>
-</blockquote>
-
-</details>

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "agentmail",
-        "X-Fern-SDK-Version": "0.2.17",
-        "User-Agent": "agentmail/0.2.17",
+        "X-Fern-SDK-Version": "0.2.18",
+        "User-Agent": "agentmail/0.2.18",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/core/fetcher/Fetcher.js

@@ -156,7 +156,13 @@ function getHeaders(args) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
         const newHeaders = new Headers_js_1.Headers();
-        newHeaders.set("Accept", args.responseType === "json" ? "application/json" : args.responseType === "text" ? "text/plain" : "*/*");
+        newHeaders.set("Accept", args.responseType === "json"
+            ? "application/json"
+            : args.responseType === "text"
+                ? "text/plain"
+                : args.responseType === "sse"
+                    ? "text/event-stream"
+                    : "*/*");
         if (args.body !== undefined && args.contentType != null) {
             newHeaders.set("Content-Type", args.contentType);
         }