@trycourier/courier 7.3.0 → 7.7.1

package/CHANGELOG.md

@@ -1,5 +1,120 @@
 # Changelog
 
+## 7.7.1 (2026-03-03)
+
+Full Changelog: [v7.7.0...v7.7.1](https://github.com/trycourier/courier-node/compare/v7.7.0...v7.7.1)
+
+### Bug Fixes
+
+* **api:** remove body_token parameter from tokens.addSingle method ([b8de6f7](https://github.com/trycourier/courier-node/commit/b8de6f7d6c936dce1b5e458b881635a4e0d920e4))
+* **api:** remove brand field from ElementalContent ([2a3d25d](https://github.com/trycourier/courier-node/commit/2a3d25dac9b544179e928800dba0f53623cd3734))
+* **docs/contributing:** correct pnpm link command ([d3b4a96](https://github.com/trycourier/courier-node/commit/d3b4a96b0d1112692832cff49bfd7897ec77df8c))
+
+
+### Chores
+
+* **internal/client:** fix form-urlencoded requests ([45deac0](https://github.com/trycourier/courier-node/commit/45deac06aa22be68b4ac57136d065dd85668901c))
+* **internal:** avoid type checking errors with ts-reset ([88b8c18](https://github.com/trycourier/courier-node/commit/88b8c18a47ac0d71e5a58274eeb705b41dfb42c3))
+* **internal:** codegen related update ([879dd2f](https://github.com/trycourier/courier-node/commit/879dd2f830081dd643bff1afafe1a4f3413f80c1))
+* **internal:** remove mock server code ([cbd7d67](https://github.com/trycourier/courier-node/commit/cbd7d675567742542d481cf9275fa765524f2dae))
+* update mock server docs ([f4a7c1f](https://github.com/trycourier/courier-node/commit/f4a7c1f3590b16463dd8edb1ef81a188ae276d06))
+
+
+### Documentation
+
+* add AUTO-GENERATED-OVERVIEW markers for README sync ([#228](https://github.com/trycourier/courier-node/issues/228)) ([63dc300](https://github.com/trycourier/courier-node/commit/63dc300ce3d67d339942446c86edeaa0f4aa69ee))
+* sync README from mintlify-docs (2026-02-20 18:11 UTC) ([#229](https://github.com/trycourier/courier-node/issues/229)) ([f35a2aa](https://github.com/trycourier/courier-node/commit/f35a2aa144409b12c125a564a003421a9b8a7a5b))
+
+## 7.7.0 (2026-02-06)
+
+Full Changelog: [v7.6.3...v7.7.0](https://github.com/trycourier/courier-node/compare/v7.6.3...v7.7.0)
+
+### Features
+
+* **api:** add publish/replace methods to tenants.templates, versions sub-resource ([a479e13](https://github.com/trycourier/courier-node/commit/a479e1356e4c924dd93959faccc2f0bc5b220706))
+* **api:** support array of recipients in send message to parameter ([e122396](https://github.com/trycourier/courier-node/commit/e1223964750961c6605fce9b5534b7f47c5912e4))
+
+
+### Bug Fixes
+
+* **client:** avoid memory leak with abort signals ([456f32b](https://github.com/trycourier/courier-node/commit/456f32b5857119e3bce1b98d684452089f0dac25))
+* **client:** avoid removing abort listener too early ([955a0ac](https://github.com/trycourier/courier-node/commit/955a0acd0c3562b8744f2d6ebcfc1a3afd3a81f0))
+
+
+### Chores
+
+* **client:** do not parse responses with empty content-length ([f6a0da2](https://github.com/trycourier/courier-node/commit/f6a0da2fc5de72f899350b471e635a26ae5fe22b))
+* **client:** restructure abort controller binding ([ebbf307](https://github.com/trycourier/courier-node/commit/ebbf30710e44dfe85ffd89a021c102381210f61c))
+
+## 7.6.3 (2026-01-27)
+
+Full Changelog: [v7.6.2...v7.6.3](https://github.com/trycourier/courier-node/compare/v7.6.2...v7.6.3)
+
+### Chores
+
+* **ci:** upgrade `actions/github-script` ([9be20f2](https://github.com/trycourier/courier-node/commit/9be20f262f8e308e07f27d7f577c029a24a5729c))
+* **internal:** update `actions/checkout` version ([ff49d84](https://github.com/trycourier/courier-node/commit/ff49d84985ceb2f0abd1a1672d060f171fb4773e))
+* **internal:** upgrade babel, qs, js-yaml ([69281b2](https://github.com/trycourier/courier-node/commit/69281b23561b6dc18cf5da460a3cfc4dc3563936))
+
+
+### Documentation
+
+* **types:** clarify version field description in AutomationTemplate ([3b61dec](https://github.com/trycourier/courier-node/commit/3b61dec839fd7e97f8cb8877d045d2a53dcca809))
+
+## 7.6.2 (2026-01-14)
+
+Full Changelog: [v7.6.1...v7.6.2](https://github.com/trycourier/courier-node/compare/v7.6.1...v7.6.2)
+
+### Chores
+
+* fix typo in descriptions ([3e9304a](https://github.com/trycourier/courier-node/commit/3e9304abd0cb3ee2905a1c8ef2ca6add6de40d76))
+* **internal:** regenerate SDK with no functional changes ([1eabb0d](https://github.com/trycourier/courier-node/commit/1eabb0d4747af6eb1077c56d0c701de3dfc4720d))
+* **internal:** regenerate SDK with no functional changes ([fdf454c](https://github.com/trycourier/courier-node/commit/fdf454c4f56a9562eb4821d067a0dda22e8af4df))
+* remove custom code ([68b45da](https://github.com/trycourier/courier-node/commit/68b45da055191f5b0a86995791dc5880dbed29e4))
+
+## 7.6.1 (2026-01-12)
+
+Full Changelog: [v7.6.0...v7.6.1](https://github.com/trycourier/courier-node/compare/v7.6.0...v7.6.1)
+
+### Bug Fixes
+
+* **types:** correct rules field type in NestedFilterConfig ([20636ec](https://github.com/trycourier/courier-node/commit/20636ecec7405c9c5370ac0842a8cf70a9cd16bc))
+
+
+### Chores
+
+* **internal:** regenerate SDK with no functional changes ([2230886](https://github.com/trycourier/courier-node/commit/22308868766859b3e40cf9854bec627a4a3680b1))
+
+## 7.6.0 (2026-01-08)
+
+Full Changelog: [v7.5.0...v7.6.0](https://github.com/trycourier/courier-node/compare/v7.5.0...v7.6.0)
+
+### Features
+
+* **api:** remove methods across audit-events/brands/bulk/automations/translations/tenants ([459d7de](https://github.com/trycourier/courier-node/commit/459d7deb6ec73b2f06de57c590b46f26b157f15b))
+
+
+### Chores
+
+* break long lines in snippets into multiline ([3c43d25](https://github.com/trycourier/courier-node/commit/3c43d2512f4bb4937fb40db54de74221d7d115ef))
+
+## 7.5.0 (2025-12-29)
+
+Full Changelog: [v7.4.0...v7.5.0](https://github.com/trycourier/courier-node/compare/v7.4.0...v7.5.0)
+
+### Features
+
+* **api:** add audience/slack/ms_teams/pagerduty/webhook recipient types to send.message ([236fa8b](https://github.com/trycourier/courier-node/commit/236fa8bfddfd5261c0058b78d7d44d0e060728e9))
+
+## 7.4.0 (2025-12-16)
+
+Full Changelog: [v7.3.0...v7.4.0](https://github.com/trycourier/courier-node/compare/v7.3.0...v7.4.0)
+
+### Features
+
+* Add timezone field to Delay schema ([30ff0dd](https://github.com/trycourier/courier-node/commit/30ff0dd269c78f2025c68c8ff161bb88027e381f))
+* Update bulk API spec: make event required, document profile.email req… ([ec59104](https://github.com/trycourier/courier-node/commit/ec5910407ff2f6b5f7f11699ac4a275d0b6c9375))
+
 ## 7.3.0 (2025-12-08)
 
 Full Changelog: [v7.2.0...v7.3.0](https://github.com/trycourier/courier-node/compare/v7.2.0...v7.3.0)

package/LICENSE

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

package/README.md

@@ -1,375 +1,64 @@
-# Courier TypeScript API Library
+<!-- AUTO-GENERATED-OVERVIEW:START — Do not edit this section. It is synced from mintlify-docs. -->
+# Courier Node.js SDK
 
-[![NPM version](<https://img.shields.io/npm/v/@trycourier/courier.svg?label=npm%20(stable)>)](https://npmjs.org/package/@trycourier/courier) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@trycourier/courier)
-
-This library provides convenient access to the Courier REST API from server-side TypeScript or JavaScript.
-
-The REST API documentation can be found on [www.courier.com](https://www.courier.com/docs). The full API of this library can be found in [api.md](api.md).
-
-It is generated with [Stainless](https://www.stainless.com/).
+The Courier Node.js SDK provides typed access to the Courier REST API from server-side TypeScript or JavaScript. Use it to send notifications, manage user profiles, check message status, issue JWT tokens for client-side SDKs, and more.
 
 ## Installation
 
-```sh
+```bash
 npm install @trycourier/courier
 ```
 
-## Usage
-
-The full API of this library can be found in [api.md](api.md).
-
-<!-- prettier-ignore -->
-```js
-import Courier from '@trycourier/courier';
-
-const client = new Courier({
-  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
-});
-
-const response = await client.send.message({
-  message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } },
-});
-
-console.log(response.requestId);
-```
+Also available via `yarn add @trycourier/courier` and `pnpm add @trycourier/courier`.
 
-### Request & Response types
+Requires Node.js 20+ (LTS). Also works in Deno 1.28+, Bun 1.0+, Cloudflare Workers, and Vercel Edge Runtime.
 
-This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
+## Quick Start
 
-<!-- prettier-ignore -->
 ```ts
 import Courier from '@trycourier/courier';
 
-const client = new Courier({
-  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
-});
-
-const params: Courier.SendMessageParams = {
-  message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } },
-};
-const response: Courier.SendMessageResponse = await client.send.message(params);
-```
-
-Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
-
-## Handling errors
-
-When the library is unable to connect to the API,
-or if the API returns a non-success status code (i.e., 4xx or 5xx response),
-a subclass of `APIError` will be thrown:
-
-<!-- prettier-ignore -->
-```ts
-const response = await client.send
-  .message({
-    message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } },
-  })
-  .catch(async (err) => {
-    if (err instanceof Courier.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
-```
-
-Error codes are as follows:
-
-| Status Code | Error Type                 |
-| ----------- | -------------------------- |
-| 400         | `BadRequestError`          |
-| 401         | `AuthenticationError`      |
-| 403         | `PermissionDeniedError`    |
-| 404         | `NotFoundError`            |
-| 422         | `UnprocessableEntityError` |
-| 429         | `RateLimitError`           |
-| >=500       | `InternalServerError`      |
-| N/A         | `APIConnectionError`       |
-
-### Retries
-
-Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
-429 Rate Limit, and >=500 Internal errors will all be retried by default.
-
-You can use the `maxRetries` option to configure or disable this:
-
-<!-- prettier-ignore -->
-```js
-// Configure the default for all requests:
-const client = new Courier({
-  maxRetries: 0, // default is 2
-});
-
-// Or, configure per-request:
-await client.send.message({ message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } } }, {
-  maxRetries: 5,
-});
-```
-
-### Timeouts
-
-Requests time out after 1 minute by default. You can configure this with a `timeout` option:
-
-<!-- prettier-ignore -->
-```ts
-// Configure the default for all requests:
-const client = new Courier({
-  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
-});
-
-// Override per-request:
-await client.send.message({ message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } } }, {
-  timeout: 5 * 1000,
-});
-```
-
-On timeout, an `APIConnectionTimeoutError` is thrown.
-
-Note that requests which time out will be [retried twice by default](#retries).
-
-## Advanced Usage
-
-### Accessing raw Response data (e.g., headers)
-
-The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
-This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
-
-You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
-Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
-
-<!-- prettier-ignore -->
-```ts
 const client = new Courier();
 
-const response = await client.send
-  .message({
-    message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } },
-  })
-  .asResponse();
-console.log(response.headers.get('X-My-Header'));
-console.log(response.statusText); // access the underlying Response object
-
-const { data: response, response: raw } = await client.send
-  .message({
-    message: { to: { user_id: 'your_user_id' }, template: 'your_template_id', data: { foo: 'bar' } },
-  })
-  .withResponse();
-console.log(raw.headers.get('X-My-Header'));
-console.log(response.requestId);
-```
-
-### Logging
-
-> [!IMPORTANT]
-> All log messages are intended for debugging only. The format and content of log messages
-> may change between releases.
-
-#### Log levels
-
-The log level can be configured in two ways:
-
-1. Via the `COURIER_LOG` environment variable
-2. Using the `logLevel` client option (overrides the environment variable if set)
-
-```ts
-import Courier from '@trycourier/courier';
-
-const client = new Courier({
-  logLevel: 'debug', // Show all log messages
-});
-```
-
-Available log levels, from most to least verbose:
-
-- `'debug'` - Show debug messages, info, warnings, and errors
-- `'info'` - Show info messages, warnings, and errors
-- `'warn'` - Show warnings and errors (default)
-- `'error'` - Show only errors
-- `'off'` - Disable all logging
-
-At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
-Some authentication-related headers are redacted, but sensitive data in request and response bodies
-may still be visible.
-
-#### Custom logger
-
-By default, this library logs to `globalThis.console`. You can also provide a custom logger.
-Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
-
-When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
-below the configured level will not be sent to your logger.
-
-```ts
-import Courier from '@trycourier/courier';
-import pino from 'pino';
-
-const logger = pino();
-
-const client = new Courier({
-  logger: logger.child({ name: 'Courier' }),
-  logLevel: 'debug', // Send all messages to pino, allowing it to filter
-});
-```
-
-### Making custom/undocumented requests
-
-This library is typed for convenient access to the documented API. If you need to access undocumented
-endpoints, params, or response properties, the library can still be used.
-
-#### Undocumented endpoints
-
-To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
-Options on the client, such as retries, will be respected when making these requests.
-
-```ts
-await client.post('/some/path', {
-  body: { some_prop: 'foo' },
-  query: { some_query_arg: 'bar' },
-});
-```
-
-#### Undocumented request params
-
-To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
-parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
-send will be sent as-is.
-
-```ts
-client.send.message({
-  // ...
-  // @ts-expect-error baz is not yet public
-  baz: 'undocumented option',
-});
-```
-
-For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
-extra param in the body.
-
-If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
-options.
-
-#### Undocumented response properties
-
-To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
-the response object, or cast the response object to the requisite type. Like the request params, we do not
-validate or strip extra properties from the response from the API.
-
-### Customizing the fetch client
-
-By default, this library expects a global `fetch` function is defined.
-
-If you want to use a different `fetch` function, you can either polyfill the global:
-
-```ts
-import fetch from 'my-fetch';
-
-globalThis.fetch = fetch;
-```
-
-Or pass it to the client:
-
-```ts
-import Courier from '@trycourier/courier';
-import fetch from 'my-fetch';
-
-const client = new Courier({ fetch });
-```
-
-### 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 Courier from '@trycourier/courier';
-
-const client = new Courier({
-  fetchOptions: {
-    // `RequestInit` options
+const response = await client.send.message({
+  message: {
+    to: { email: 'you@example.com' },
+    content: {
+      title: 'Hello from Courier!',
+      body: 'Your first notification, sent with the Node.js SDK.',
+    },
   },
 });
-```
 
-#### Configuring proxies
+console.log(response.requestId);
+```
 
-To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
-options to requests:
+The client reads `COURIER_API_KEY` from your environment automatically. You can also pass it explicitly: `new Courier({ apiKey: 'your-key' })`.
 
-<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>
+## Common Operations
 
 ```ts
-import Courier from '@trycourier/courier';
-import * as undici from 'undici';
+// Check message delivery status
+const message = await client.messages.retrieve('message-id');
+console.log(message.status);
 
-const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
-const client = new Courier({
-  fetchOptions: {
-    dispatcher: proxyAgent,
-  },
+// Create or update a user profile
+await client.profiles.create('user_123', {
+  profile: { email: 'jane@example.com', name: 'Jane Doe' },
 });
-```
 
-<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 Courier from '@trycourier/courier';
-
-const client = new Courier({
-  fetchOptions: {
-    proxy: 'http://localhost:8888',
-  },
+// Issue a JWT for client-side SDK auth
+const { token } = await client.auth.issueToken({
+  scope: 'user_id:user_123 inbox:read:messages inbox:write:events',
+  expires_in: '2 days',
 });
 ```
 
-<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 Courier from 'npm:@trycourier/courier';
-
-const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
-const client = new Courier({
-  fetchOptions: {
-    client: httpClient,
-  },
-});
-```
-
-## Frequently Asked Questions
-
-## Semantic versioning
-
-This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
-
-1. Changes that only affect static types, without breaking runtime behavior.
-2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
-3. Changes that we do not expect to impact the vast majority of users in practice.
-
-We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
-
-We are keen for your feedback; please open an [issue](https://www.github.com/trycourier/courier-node/issues) with questions, bugs, or suggestions.
-
-## Requirements
-
-TypeScript >= 4.9 is supported.
-
-The following runtimes are supported:
-
-- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
-- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
-- Deno v1.28.0 or higher.
-- Bun 1.0 or later.
-- Cloudflare Workers.
-- Vercel Edge Runtime.
-- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
-- Nitro v2.6 or greater.
-
-Note that React Native is not supported at this time.
-
-If you are interested in other runtime environments, please open or upvote an issue on GitHub.
+## Documentation
 
-## Contributing
+Full documentation: **[courier.com/docs/sdk-libraries/node](https://www.courier.com/docs/sdk-libraries/node/)**
 
-See [the contributing documentation](./CONTRIBUTING.md).
+- [Quickstart](https://www.courier.com/docs/getting-started/quickstart/)
+- [Send API](https://www.courier.com/docs/platform/sending/send-message/)
+- [API Reference](https://www.courier.com/docs/reference/get-started/)
+<!-- AUTO-GENERATED-OVERVIEW:END -->