@naturalpay/sdk 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,119 @@
+# Changelog
+
+## 0.2.1 (2026-05-16)
+
+Full Changelog: [v0.0.1...v0.2.1](https://github.com/naturalpay/naturalpay-ts/compare/v0.0.1...v0.2.1)
+
+### ⚠ BREAKING CHANGES
+
+* **sdk:** align implemented endpoints with public OpenAPI ([#45](https://github.com/naturalpay/naturalpay-ts/issues/45))
+
+### Features
+
+* add context param and fill instanceId gaps across all methods ([#11](https://github.com/naturalpay/naturalpay-ts/issues/11)) ([8aee6b5](https://github.com/naturalpay/naturalpay-ts/commit/8aee6b5c8565719d245c1d02ac7e6c77de1ac797))
+* add instanceId for agent observability ([#10](https://github.com/naturalpay/naturalpay-ts/issues/10)) ([63c9a32](https://github.com/naturalpay/naturalpay-ts/commit/63c9a328f4ce7062a4c20e9d164812938a230ddc))
+* add ModelContext and ModelUsage for observability ([#25](https://github.com/naturalpay/naturalpay-ts/issues/25)) ([fc50eb0](https://github.com/naturalpay/naturalpay-ts/commit/fc50eb0eedc1c1afe9d49a51f8f1af49fc136dab))
+* add structured logging with Datadog support ([c34e43f](https://github.com/naturalpay/naturalpay-ts/commit/c34e43fbb7b43ea61d424497718e7326f1a40575))
+* add traceId parameter for distributed tracing ([#32](https://github.com/naturalpay/naturalpay-ts/issues/32)) ([2165263](https://github.com/naturalpay/naturalpay-ts/commit/21652635622d40b02bfc8c81857459c32f9c2cb3))
+* add type filter to transactions, remove wallet.transfers() ([c9c7559](https://github.com/naturalpay/naturalpay-ts/commit/c9c75599a1bdc7d5811aa063778e6a2ae9b277a2))
+* align SDK endpoints with public API ([#12](https://github.com/naturalpay/naturalpay-ts/issues/12)) ([c942396](https://github.com/naturalpay/naturalpay-ts/commit/c942396d1f7daf794ce8eb51205cd0c942218284))
+* **api:** api update ([c0b355c](https://github.com/naturalpay/naturalpay-ts/commit/c0b355cda288b6adaede8165f65c407c07fdee11))
+* **api:** api update ([40cf543](https://github.com/naturalpay/naturalpay-ts/commit/40cf543332c3cc7297f1815aa68ca13c56635c02))
+* **api:** api update ([e609cb8](https://github.com/naturalpay/naturalpay-ts/commit/e609cb831ad29e0abcc594a1e69d51afb010a25e))
+* **api:** api update ([07ca3a8](https://github.com/naturalpay/naturalpay-ts/commit/07ca3a891b7974c86a2369b02774c99af04be26d))
+* **api:** api update ([4103315](https://github.com/naturalpay/naturalpay-ts/commit/41033156995bd42332842f5077e6a53a7e289eb5))
+* **api:** api update ([9e01255](https://github.com/naturalpay/naturalpay-ts/commit/9e012559a0e89a7c9817536b8ba7889d567507bb))
+* **api:** api update ([5276f7c](https://github.com/naturalpay/naturalpay-ts/commit/5276f7c56bd6ea6d21fbb8b91c6d2115d788d776))
+* **api:** api update ([75d0d85](https://github.com/naturalpay/naturalpay-ts/commit/75d0d851c517fece28e0e61aa1370fd2d86ae0db))
+* **api:** api update ([e88ad5d](https://github.com/naturalpay/naturalpay-ts/commit/e88ad5d6e4be8ea95c6fcac3b510693d03912872))
+* **api:** api update ([f5565eb](https://github.com/naturalpay/naturalpay-ts/commit/f5565eb1488ee8048c25b989c3cc02afeb09bd79))
+* **api:** api update ([54140dd](https://github.com/naturalpay/naturalpay-ts/commit/54140dde4a811c84a1ecf5819770259472d06400))
+* **api:** api update ([ff8b849](https://github.com/naturalpay/naturalpay-ts/commit/ff8b8493c918551a4d754763aff74de964a10c90))
+* **api:** api update ([ee5f3c1](https://github.com/naturalpay/naturalpay-ts/commit/ee5f3c1f3619d7f544be8f8afe04ffb6d82417f2))
+* **api:** api update ([148ff21](https://github.com/naturalpay/naturalpay-ts/commit/148ff21f969415e8a0c4f51ae7b5e670e2b7df55))
+* **api:** api update ([06f3637](https://github.com/naturalpay/naturalpay-ts/commit/06f36375dc16aa98dea0f15ac0c1796a1305ed2e))
+* **api:** api update ([7610ef6](https://github.com/naturalpay/naturalpay-ts/commit/7610ef6677957dd3d05239d773962f113ca08a8a))
+* **api:** api update ([d8f7b3f](https://github.com/naturalpay/naturalpay-ts/commit/d8f7b3f183058347b28f03dba72144e58ebd0ba1))
+* **api:** api update ([45b409f](https://github.com/naturalpay/naturalpay-ts/commit/45b409f149c6b1a14ed0a1eab7373092f5e8607c))
+* **api:** api update ([195e031](https://github.com/naturalpay/naturalpay-ts/commit/195e0310f4b73a372adb6d1184f17d9e9844c510))
+* **api:** api update ([56ee513](https://github.com/naturalpay/naturalpay-ts/commit/56ee513159a8c6a26694d02445e90f95e5908e40))
+* **api:** api update ([0d1ca15](https://github.com/naturalpay/naturalpay-ts/commit/0d1ca1505b28f925e6c8170467cfef8cdd7fb8d4))
+* **api:** api update ([4581b56](https://github.com/naturalpay/naturalpay-ts/commit/4581b56f2b3e8139bde75fa2a3f56b5f66dad894))
+* **api:** api update ([65babd2](https://github.com/naturalpay/naturalpay-ts/commit/65babd2717e40697f12770422bc503070fade7e2))
+* **api:** Require Instance ID when Agent ID Present ([#27](https://github.com/naturalpay/naturalpay-ts/issues/27)) ([0e9524d](https://github.com/naturalpay/naturalpay-ts/commit/0e9524d69491f75132d30f23ec24e410b7dcdc3b))
+* improve create_payment MCP tool ([#4](https://github.com/naturalpay/naturalpay-ts/issues/4)) ([7cb463f](https://github.com/naturalpay/naturalpay-ts/commit/7cb463f3d6d6995c47a66d28182a8bc9029b7995))
+* make customerPartyId optional in payments SDK ([#34](https://github.com/naturalpay/naturalpay-ts/issues/34)) ([070d81d](https://github.com/naturalpay/naturalpay-ts/commit/070d81d2e0701759a701ef6e494046965a08b065))
+* **mcp:** Move to Proxy ([#26](https://github.com/naturalpay/naturalpay-ts/issues/26)) ([2584e15](https://github.com/naturalpay/naturalpay-ts/commit/2584e151771a2fa8b3d274e1779be6894579d644))
+* payments.create() returns Transaction, remove Payment interface ([#16](https://github.com/naturalpay/naturalpay-ts/issues/16)) ([1007b10](https://github.com/naturalpay/naturalpay-ts/commit/1007b1035f30de4c4f7f1c6a0ce114f47a0d2dcf))
+* per-agent invitation SDK (0.2.0) ([#43](https://github.com/naturalpay/naturalpay-ts/issues/43)) ([46625dc](https://github.com/naturalpay/naturalpay-ts/commit/46625dc03e0b1ee412abb696cfe5c172e4b1ccbc))
+* rename counterparties to customers in TypeScript SDK ([#15](https://github.com/naturalpay/naturalpay-ts/issues/15)) ([4fcd683](https://github.com/naturalpay/naturalpay-ts/commit/4fcd68368820582b7133cae2e7705adb4dd4a56a))
+* **sdk:** Achieve SDK Parity ([#30](https://github.com/naturalpay/naturalpay-ts/issues/30)) ([548beba](https://github.com/naturalpay/naturalpay-ts/commit/548beba167438b1eb4128b5e66c7b1090f972a56))
+* **sdk:** Allow Txn Queryable by Party ([#29](https://github.com/naturalpay/naturalpay-ts/issues/29)) ([edfa0a9](https://github.com/naturalpay/naturalpay-ts/commit/edfa0a9d50737ac4093a5a70790dd55c9af9077a))
+* **sdk:** enforce canonical Natural tool names via typed enum ([#36](https://github.com/naturalpay/naturalpay-ts/issues/36)) ([df2cff2](https://github.com/naturalpay/naturalpay-ts/commit/df2cff2299b243a0959c80822f5c8cab06032fed))
+* **sdk:** Retry and Webhook Signatures ([#33](https://github.com/naturalpay/naturalpay-ts/issues/33)) ([1e3056b](https://github.com/naturalpay/naturalpay-ts/commit/1e3056b77dc78db54ee7dcc6fce03466bb309281))
+* update SDK to match camelCase API shapes ([#24](https://github.com/naturalpay/naturalpay-ts/issues/24)) ([e5cfe83](https://github.com/naturalpay/naturalpay-ts/commit/e5cfe83d0a226f02434dacc39724080c9ec2f06f))
+
+
+### Bug Fixes
+
+* address codex review feedback ([5fa9b61](https://github.com/naturalpay/naturalpay-ts/commit/5fa9b618d3fcb3e07bce06a0b657b426f7c46f5a))
+* address review feedback ([12b335c](https://github.com/naturalpay/naturalpay-ts/commit/12b335c4b8cb805b4af4d215590d043c8d16fb02))
+* address review feedback for e2e testing ([4049706](https://github.com/naturalpay/naturalpay-ts/commit/4049706bef7ea65600cac463a5a62175aa0ae269))
+* **api:** Conform to new API Shape ([545b860](https://github.com/naturalpay/naturalpay-ts/commit/545b860995536e2d8637dff2f3e76a906048ae3d))
+* **api:** Unify Remaining Resources ([#8](https://github.com/naturalpay/naturalpay-ts/issues/8)) ([8b558e2](https://github.com/naturalpay/naturalpay-ts/commit/8b558e2526bdf7efbdc80ef63ee7ce2fc792ddef))
+* **CI:** Fix Release Workflow ([7ce6b24](https://github.com/naturalpay/naturalpay-ts/commit/7ce6b243e494e47543015dca1b683b8b0603e221))
+* **CI:** Remove Provenance ([749f1fb](https://github.com/naturalpay/naturalpay-ts/commit/749f1fbcdfad4c45cea419d7952c9ee420eb7af6))
+* **CI:** Update Node for Trusted Publisher ([8f327b7](https://github.com/naturalpay/naturalpay-ts/commit/8f327b7d532247fd779a480ad5cd7712e02f17db))
+* format transactions types ([71623c9](https://github.com/naturalpay/naturalpay-ts/commit/71623c9dfda7906fa1a0b275a0f1a5d66541b5e6))
+* only run release-drafter on push to main ([7a31510](https://github.com/naturalpay/naturalpay-ts/commit/7a31510a7df4e5d12d42368fd88cc82380a7f1c5))
+* prettier formatting and update Dockerfile to Node 22 ([eee3d29](https://github.com/naturalpay/naturalpay-ts/commit/eee3d29ff93c34dc3529488bbdbdda0f5cc85b36))
+* remove /v1 prefix from wallet API paths ([97aa86c](https://github.com/naturalpay/naturalpay-ts/commit/97aa86ccc1952206afa80cf6d677b09cb7824010))
+* restore agentId to payments.create(), pass as X-Agent-ID header ([#9](https://github.com/naturalpay/naturalpay-ts/issues/9)) ([b71b9c0](https://github.com/naturalpay/naturalpay-ts/commit/b71b9c0c6982c6bc9a6af180d664de350c8373ce))
+* **routes:** Unify SDK ([#18](https://github.com/naturalpay/naturalpay-ts/issues/18)) ([57245f2](https://github.com/naturalpay/naturalpay-ts/commit/57245f205d6c6005bad5110e8e0bf4724725cdad))
+* **sdk:** align implemented endpoints with public OpenAPI ([#45](https://github.com/naturalpay/naturalpay-ts/issues/45)) ([6e99127](https://github.com/naturalpay/naturalpay-ts/commit/6e991270a4e0bb8428fef87bfca3d1c255ebb5da))
+* update README - remove stale wallet methods, add type filter docs ([b064a7a](https://github.com/naturalpay/naturalpay-ts/commit/b064a7a944231b169dc4bba50f3098a908df50e3))
+* use /auth/api/token for JWT exchange ([#23](https://github.com/naturalpay/naturalpay-ts/issues/23)) ([30a0b33](https://github.com/naturalpay/naturalpay-ts/commit/30a0b33157bc36fe49e09e81087dc9af738b4bc8))
+* use correct customer party ID from seed_test_data.py ([878871d](https://github.com/naturalpay/naturalpay-ts/commit/878871dd9d3e14cc6d4fe856d2dc4bb25e079e38))
+* use getContext() in formatters for AsyncLocalStorage support ([228664d](https://github.com/naturalpay/naturalpay-ts/commit/228664d1a2d5cfe7ae5f1c845fe348e1ee336f44))
+* use integer minor units for amounts ([#22](https://github.com/naturalpay/naturalpay-ts/issues/22)) ([6750522](https://github.com/naturalpay/naturalpay-ts/commit/67505221c2d8551793799415651f693bc1e94141))
+
+
+### Chores
+
+* add package-lock.json to gitignore (repo uses pnpm) ([b2b4d31](https://github.com/naturalpay/naturalpay-ts/commit/b2b4d31dd90a255365fc5aeb23f1bd17c6ff28c0))
+* baseline main to Stainless next ([22f68df](https://github.com/naturalpay/naturalpay-ts/commit/22f68dfe9fbb4c5b8874dc6d6eb1d2717d522e93))
+* Bump Version ([58d890d](https://github.com/naturalpay/naturalpay-ts/commit/58d890d3630aa9171c03e90d81f6308ea0ee1aec))
+* **CI:** Fix Naming ([db60961](https://github.com/naturalpay/naturalpay-ts/commit/db6096110c95531190e3c76b2d911070154c9d35))
+* **CI:** Move Towards Trusted Publisher ([1564541](https://github.com/naturalpay/naturalpay-ts/commit/15645412fd98b848f565b20a34425d1c5629956b))
+* **deps:** update dependency @modelcontextprotocol/sdk to v1.26.0 [security] ([#49](https://github.com/naturalpay/naturalpay-ts/issues/49)) ([a8ec77d](https://github.com/naturalpay/naturalpay-ts/commit/a8ec77d6c3b7fe8afd246cf103bc9d923a467c8e))
+* **docs:** Fix README ([91893d7](https://github.com/naturalpay/naturalpay-ts/commit/91893d7fe25fac8df7ced3abe18f05fdf381af40))
+* **docs:** Update README ([319efe0](https://github.com/naturalpay/naturalpay-ts/commit/319efe02ef8d2216732c18e59157a1e03e5a9d7b))
+* rename BFF → server-ts in SDK docstrings ([#44](https://github.com/naturalpay/naturalpay-ts/issues/44)) ([a1fd526](https://github.com/naturalpay/naturalpay-ts/commit/a1fd526a0a37c6130ac7f1f88026e340875a6460))
+* **sdk:** Bump Patch Version ([ca3f58d](https://github.com/naturalpay/naturalpay-ts/commit/ca3f58dc6d6801da72f5f4047eb904dad17dff91))
+* **sdk:** Reset Version to 0.1.0 ([32c2117](https://github.com/naturalpay/naturalpay-ts/commit/32c2117a0bec17844502e0d4fda6d8f52b105e48))
+* sync repo ([b45d508](https://github.com/naturalpay/naturalpay-ts/commit/b45d508cef8057fd504c489be87be3ae0b52b39b))
+* **tests:** remove client-coupled envelope canary ([14aabfd](https://github.com/naturalpay/naturalpay-ts/commit/14aabfd42154ba3a2e2c7d78a39a7e4fbcaea55b))
+* update SDK settings ([8ad2341](https://github.com/naturalpay/naturalpay-ts/commit/8ad2341538beeaa2b50d304a8e6ccca620e362d3))
+* update SDK settings ([0cd65a9](https://github.com/naturalpay/naturalpay-ts/commit/0cd65a9f77acb5f15cf60978c33ad54a967d10be))
+* update SDK settings ([ebf5496](https://github.com/naturalpay/naturalpay-ts/commit/ebf5496369cf9b0c48b16a8e0d1b506f7c86eeee))
+* update SDK settings ([331a82b](https://github.com/naturalpay/naturalpay-ts/commit/331a82b186b351bc4704ae9c801bbec6e90f66f3))
+* update SDK settings ([9cc741a](https://github.com/naturalpay/naturalpay-ts/commit/9cc741a4b276016a2cae8543f9fc3556c8a7efba))
+* **version:** Bump Version ([2e126fc](https://github.com/naturalpay/naturalpay-ts/commit/2e126fc8f35e67b78a825b00262217ad7e37bbc6))
+
+
+### Documentation
+
+* **README:** Pare Down Readme ([#31](https://github.com/naturalpay/naturalpay-ts/issues/31)) ([0f34778](https://github.com/naturalpay/naturalpay-ts/commit/0f347784b96359ce9ab4d5be2c4b273c3b4ba932))
+
+
+### Styles
+
+* fix formatting with prettier ([d97479e](https://github.com/naturalpay/naturalpay-ts/commit/d97479e0d807eed7e77cf6484985e0b716194a4e))
+
+
+### Refactors
+
+* **models:** consolidate wallet balance to breakdown + available ([#17](https://github.com/naturalpay/naturalpay-ts/issues/17)) ([da08731](https://github.com/naturalpay/naturalpay-ts/commit/da08731fece1e004ad23fe2989fec272b8c0a1ba))
+* remove X-On-Behalf-Of header, use body/query params ([#14](https://github.com/naturalpay/naturalpay-ts/issues/14)) ([87853e2](https://github.com/naturalpay/naturalpay-ts/commit/87853e2aef03df11153b2440b53b9cbf3a724d2f))
+* **sdk:** drop developer_context — header-only v2 ([#38](https://github.com/naturalpay/naturalpay-ts/issues/38)) ([98d3fef](https://github.com/naturalpay/naturalpay-ts/commit/98d3fef32a28183bf0648ff823f3f64d05e50d90))
+* standardize ID prefixes to 3-letter format ([#13](https://github.com/naturalpay/naturalpay-ts/issues/13)) ([8a5a7c0](https://github.com/naturalpay/naturalpay-ts/commit/8a5a7c074813b379e2aa04615ae9727453027dae))

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 naturalpay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,12 +1,12 @@
-# Natural Payments SDK
+# Naturalpay TypeScript API Library
 
-[![NPM version](https://img.shields.io/npm/v/@naturalpay/sdk.svg)](https://npmjs.org/package/@naturalpay/sdk)
+[![NPM version](<https://img.shields.io/npm/v/@naturalpay/sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/@naturalpay/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@naturalpay/sdk)
 
-The Natural Payments SDK provides access to the [Natural API](https://docs.natural.co) from server-side TypeScript and JavaScript applications, for building AI agents that send, receive, and manage money.
+This library provides convenient access to the Naturalpay REST API from server-side TypeScript or JavaScript.
 
-## Documentation
+The REST API documentation can be found on [docs.natural.co](https://docs.natural.co). The full API of this library can be found in [api.md](api.md).
 
-Full documentation, guides, and API reference are available at **[docs.natural.co/guides/platform/sdks](https://docs.natural.co/guides/platform/sdks)**.
+It is generated with [Stainless](https://www.stainless.com/).
 
 ## Installation
 
@@ -14,40 +14,354 @@ Full documentation, guides, and API reference are available at **[docs.natural.c
 npm install @naturalpay/sdk
 ```
 
-## Getting started
+## Usage
 
-```typescript
-import { NaturalClient } from '@naturalpay/sdk';
+The full API of this library can be found in [api.md](api.md).
 
-const client = new NaturalClient({ apiKey: process.env['NATURAL_API_KEY'] });
+<!-- prettier-ignore -->
+```js
+import Natural from '@naturalpay/sdk';
 
-const payment = await client.payments.create({
-  recipient: 'alice@example.com',
-  amount: 5000,
-  memo: 'Payment for consulting',
-  agentId: 'agt_019cd1798d637a4da75dce386343931d',
-  instanceId: 'session-abc123',
-  customerPartyId: 'pty_019cd34e27c179bfbbe6870486b11b67',
-  idempotencyKey: 'pay_unique_key',
+const client = new Natural({
+  apiKey: process.env['NATURALPAY_API_KEY'], // This is the default and can be omitted
+  environment: 'dev', // defaults to 'production'
 });
 
-console.log(payment.transactionId);
+const agent = await client.agents.create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' });
+
+console.log(agent.data);
 ```
 
-## MCP server
+### Request & Response types
 
-The SDK ships with an MCP server for AI agent integration with Claude Desktop, Cursor, and other MCP clients:
+This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
 
-```sh
-npx @naturalpay/sdk mcp serve
+<!-- prettier-ignore -->
+```ts
+import Natural from '@naturalpay/sdk';
+
+const client = new Natural({
+  apiKey: process.env['NATURALPAY_API_KEY'], // This is the default and can be omitted
+  environment: 'dev', // defaults to 'production'
+});
+
+const params: Natural.AgentCreateParams = { name: 'x', 'Idempotency-Key': 'Idempotency-Key' };
+const agent: Natural.AgentCreateResponse = await client.agents.create(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 agent = await client.agents
+  .create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' })
+  .catch(async (err) => {
+    if (err instanceof Natural.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 Natural({
+  maxRetries: 0, // default is 2
+});
+
+// Or, configure per-request:
+await client.agents.create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' }, {
+  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 Natural({
+  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
+});
+
+// Override per-request:
+await client.agents.create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' }, {
+  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 Natural();
+
+const response = await client.agents
+  .create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' })
+  .asResponse();
+console.log(response.headers.get('X-My-Header'));
+console.log(response.statusText); // access the underlying Response object
+
+const { data: agent, response: raw } = await client.agents
+  .create({ name: 'x', 'Idempotency-Key': 'Idempotency-Key' })
+  .withResponse();
+console.log(raw.headers.get('X-My-Header'));
+console.log(agent.data);
 ```
 
-See [docs.natural.co/guides/platform/sdks#mcp-server](https://docs.natural.co/guides/platform/sdks#mcp-server) for client configuration.
+### 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 `NATURALPAY_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import Natural from '@naturalpay/sdk';
+
+const client = new Natural({
+  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 Natural from '@naturalpay/sdk';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new Natural({
+  logger: logger.child({ name: 'Natural' }),
+  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.agents.create({
+  // ...
+  // @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 Natural from '@naturalpay/sdk';
+import fetch from 'my-fetch';
+
+const client = new Natural({ 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 Natural from '@naturalpay/sdk';
+
+const client = new Natural({
+  fetchOptions: {
+    // `RequestInit` options
+  },
+});
+```
+
+#### Configuring proxies
+
+To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
+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 Natural from '@naturalpay/sdk';
+import * as undici from 'undici';
+
+const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
+const client = new Natural({
+  fetchOptions: {
+    dispatcher: proxyAgent,
+  },
+});
+```
+
+<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 Natural from '@naturalpay/sdk';
+
+const client = new Natural({
+  fetchOptions: {
+    proxy: 'http://localhost:8888',
+  },
+});
+```
+
+<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 Natural from 'npm:@naturalpay/sdk';
+
+const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
+const client = new Natural({
+  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/naturalpay/naturalpay-ts/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 
-Node.js 18+
+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.
 
-## License
+## Contributing
 
-MIT
+See [the contributing documentation](./CONTRIBUTING.md).

package/api-promise.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.d.mts.map

package/api-promise.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.js";
+//# sourceMappingURL=api-promise.d.ts.map

package/api-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/api-promise instead */
+tslib_1.__exportStar(require("./core/api-promise.js"), exports);
+//# sourceMappingURL=api-promise.js.map

package/api-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}

package/api-promise.mjs

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.mjs.map

package/api-promise.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}