increase 0.2.0 → 0.4.0

package/.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

package/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}

package/.stats.yml

@@ -1 +1 @@
-configured_endpoints: 115
+configured_endpoints: 133

package/CHANGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+## [0.4.0](https://github.com/Increase/increase-node/compare/v0.3.0...v0.4.0) (2023-06-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* drop official support for EOL Node versions (Node 12, 13, 14, 15) ([#18](https://github.com/Increase/increase-node/issues/18))
+* **api:** rename return reason enum member ([#12](https://github.com/Increase/increase-node/issues/12))
+* change nested query parameters to be objects ([#8](https://github.com/Increase/increase-node/issues/8))
+
+
+### Features
+* **client:** add support for specifying client-level default headers ([#5](https://github.com/Increase/increase-node/issues/5)) ([609c71a](https://github.com/Increase/increase-node/commit/609c71a7f657ec14fba3fa919d8b0dd4ff1ecb5d))
+* **api:** add new endpoints + properties + enums ([#9](https://github.com/Increase/increase-node/issues/9)) ([8fd90c4](https://github.com/Increase/increase-node/commit/8fd90c4b8a50ce9f5a23cc17ee71508df6e34eca))
+
+
+### Bug Fixes
+
+* **internal:** improve stream cancellation handling of abort controllers ([#17](https://github.com/Increase/increase-node/issues/17)) ([e8f15dd](https://github.com/Increase/increase-node/commit/e8f15dd5c2001dd6b3023266a2471c019ed96739))
+
+
+### Chores
+
+* **internal:** improve SSE decoding of lines ([#14](https://github.com/Increase/increase-node/issues/14)) ([74b9bdc](https://github.com/Increase/increase-node/commit/74b9bdcaa44639cd99865d8a2701a2232314f0fd))
+* **internal:** restructure core streaming implementation ([#7](https://github.com/Increase/increase-node/issues/7)) ([b97964b](https://github.com/Increase/increase-node/commit/b97964bd5e22ed7ce4ffdd8e4a8fe5005db40976))
+
+
+### Refactors
+
+* **api:** remove unused properties and enum members ([#16](https://github.com/Increase/increase-node/issues/16)) ([51c8ab5](https://github.com/Increase/increase-node/commit/51c8ab5e5415d722768af8c53c5c8453398545a6))
+* change nested query parameters to be objects ([#8](https://github.com/Increase/increase-node/issues/8)) ([fdcd3a4](https://github.com/Increase/increase-node/commit/fdcd3a47ff31cece47a646853086f9d9e024720c))
+* **api:** rename return reason enum member ([#12](https://github.com/Increase/increase-node/issues/12)) ([51ba5d4](https://github.com/Increase/increase-node/commit/51ba5d42e07dbde522cf7ff49863fc0935c350bb))
+* **docs:** cleanup api.md response types ([539848e](https://github.com/Increase/increase-node/commit/539848e9001e424f9492f60d82cfb861316cfcb2))
+* move error type definitions to error.ts ([#15](https://github.com/Increase/increase-node/issues/15)) ([e50a9a1](https://github.com/Increase/increase-node/commit/e50a9a1f43e107ae989306f73f210e6b88493d60))
+
+
+### Documentation
+
+* drop official support for EOL Node versions (Node 12, 13, 14, 15) ([#18](https://github.com/Increase/increase-node/issues/18)) ([f3be71b](https://github.com/Increase/increase-node/commit/f3be71b1191f72a6785f6be07dcf79b45b9640ac))
+* point to github repo instead of email contact ([#13](https://github.com/Increase/increase-node/issues/13)) ([72d7fef](https://github.com/Increase/increase-node/commit/72d7fef408e625906e2ec59c29b9a63ea5a9d64c))
+* slight improvement to file uploads example ([#10](https://github.com/Increase/increase-node/issues/10)) ([b134725](https://github.com/Increase/increase-node/commit/b1347253a900c1af41a66363bc225a2b09a9e4c3))
+
+
+### Build System
+
+* add `.github` folder to `.npmignore` ([#19](https://github.com/Increase/increase-node/issues/19)) ([a263289](https://github.com/Increase/increase-node/commit/a263289da32b5e0d708c5c21a92a6a58faf74abc))
+
+## [0.3.0](https://github.com/Increase/increase-node/compare/increase-v0.2.0...increase-v0.3.0) (2023-05-31)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** `notification_of_change` has been removed in favor of the new `notifications_of_change` list field
+
+### Features
+
+* add additional coercion functions ([5f106bf](https://github.com/Increase/increase-node/commit/5f106bf9d3e0ee1c5b5fc81d112677e2c7580b82))
+* add internal support for streaming responses ([a1c321e](https://github.com/Increase/increase-node/commit/a1c321edc8fd648c9f318e047db5dafb7e37eabe))
+* add internal support for streaming responses ([a1c321e](https://github.com/Increase/increase-node/commit/a1c321edc8fd648c9f318e047db5dafb7e37eabe))
+* add webhook HMAC verification helper methods ([7a00853](https://github.com/Increase/increase-node/commit/7a00853a03b5b606df2c5c9095c53db2a4957af8))
+* **api:** add `at_time` property for balance lookups ([0b6c0de](https://github.com/Increase/increase-node/commit/0b6c0de8d25b04fb95b16d902d90d116d617af76))
+* **api:** add `collection_receivable` to transaction source category enum ([e743cc9](https://github.com/Increase/increase-node/commit/e743cc9ad5855d7c16b2c1f3a1a41dc06581d01d))
+* **api:** add `expires_at` property ([c257707](https://github.com/Increase/increase-node/commit/c2577077bd280793bedf9ff8f802017784da7468))
+* **api:** add `simulations.checkTransfers.return()` method ([e7d330a](https://github.com/Increase/increase-node/commit/e7d330ab5d899ed2305530c0f23fe1fe36eee1a8))
+* **api:** add `simulations.checkTransfers.return()` method ([e7d330a](https://github.com/Increase/increase-node/commit/e7d330ab5d899ed2305530c0f23fe1fe36eee1a8))
+* **api:** add bookkeeping accounts, entries, and entry sets, and several other changes ([d63d4e7](https://github.com/Increase/increase-node/commit/d63d4e71e0d10e70f8d9257ff3ad903b41c64fbe))
+* **api:** add new endpoints ([7d4ebe6](https://github.com/Increase/increase-node/commit/7d4ebe6f0a38e7fade250ece8e50c8d9f6c6d653))
+* **api:** add new endpoints, several params, fields, enum members, and documentation updates ([8ffb013](https://github.com/Increase/increase-node/commit/8ffb0130a53a90c5b00c314850f33bc5af4cb070))
+* **api:** add new enum members ([0785f7a](https://github.com/Increase/increase-node/commit/0785f7a13f2c7194ed3f9f940a34b262c6b25027))
+* **api:** add new fields ([3d9c69b](https://github.com/Increase/increase-node/commit/3d9c69bddf970739f0b91eb4962a058e9ee756c8))
+* **api:** add new methods ([ca41987](https://github.com/Increase/increase-node/commit/ca41987401784ddb2266bd1a32b08f2f58864ceb))
+* **api:** add optional `pending_transaction_id` field to pending transaction ([fa011e7](https://github.com/Increase/increase-node/commit/fa011e7adb44fb954efa3024b01f88aab3d789ed))
+* **api:** add wire decline object ([2d2e77e](https://github.com/Increase/increase-node/commit/2d2e77eaf2c7244d7491153f32f70aae537a62c9))
+* **api:** enum updates ([f09e25a](https://github.com/Increase/increase-node/commit/f09e25a7e4683beb2779fd76a46c2c629414810b))
+* **api:** make routeType an enum & add ACHTransfer.effectiveDate ([77fd8ea](https://github.com/Increase/increase-node/commit/77fd8ea44236307fb6a8e7d464db55f8e3ba5fd9))
+* **api:** make routeType an enum & add ACHTransfer.effectiveDate ([77fd8ea](https://github.com/Increase/increase-node/commit/77fd8ea44236307fb6a8e7d464db55f8e3ba5fd9))
+* **api:** replace notification_of_change with a list, and add merchant_acceptor_id ([831e49e](https://github.com/Increase/increase-node/commit/831e49e0d1fbf8dd57ea204d89b1be2d69d1ee75))
+* **api:** updates ([ad907d5](https://github.com/Increase/increase-node/commit/ad907d5bf9f6fd2ffe7c8fb89c884d5ba0065593))
+* **api:** updates ([ca80997](https://github.com/Increase/increase-node/commit/ca80997fc7397066ac6149e8db65d6541bf012de))
+* **api:** updates ([ca80997](https://github.com/Increase/increase-node/commit/ca80997fc7397066ac6149e8db65d6541bf012de))
+* **api:** updates ([651bf76](https://github.com/Increase/increase-node/commit/651bf7670c167ffc41eb40c0e226fc76062a4305))
+* **api:** updates ([e58e324](https://github.com/Increase/increase-node/commit/e58e3241015e95afac62550f5b0f1d152dba999b))
+* **client:** handle trailing slash in base url properly ([a03d867](https://github.com/Increase/increase-node/commit/a03d86797fa71036cc45b241a1de1b5edb82e416))
+* **docs:** add more doc comments ([b8bc790](https://github.com/Increase/increase-node/commit/b8bc790a3e06fa3b8a9e6a5299c9e8e1db0b671d))
+* **docs:** updates ([6cea39c](https://github.com/Increase/increase-node/commit/6cea39cd892b2fdae5b7b2a171f9acbcab0e6f62))
+* improve docs and add new property ([418fe83](https://github.com/Increase/increase-node/commit/418fe831af1fcb216ea938930a956b6f1d3083d7))
+* improve error types ([db09c19](https://github.com/Increase/increase-node/commit/db09c19c6017817aba695bffd29c63cf5e31f5f3))
+* improve error types ([db09c19](https://github.com/Increase/increase-node/commit/db09c19c6017817aba695bffd29c63cf5e31f5f3))
+* **internal:** add support for positional params ([9cafda3](https://github.com/Increase/increase-node/commit/9cafda3db2f6d124839dabd66e4997826384d197))
+* **internal:** add support for positional params ([9cafda3](https://github.com/Increase/increase-node/commit/9cafda3db2f6d124839dabd66e4997826384d197))
+* **internal:** improve example generation ([e0fa5b3](https://github.com/Increase/increase-node/commit/e0fa5b3a5654d032d0ff98964ed055a27be4c5e7))
+* **internal:** improve example generation ([e0fa5b3](https://github.com/Increase/increase-node/commit/e0fa5b3a5654d032d0ff98964ed055a27be4c5e7))
+* **internal:** internal fixes ([4848450](https://github.com/Increase/increase-node/commit/4848450f8a0cbfa465097b154ccf866766146490))
+* **internal:** internal fixes ([4848450](https://github.com/Increase/increase-node/commit/4848450f8a0cbfa465097b154ccf866766146490))
+* **internal:** re-export `fileFromPath` helper util from the root ([09c0c79](https://github.com/Increase/increase-node/commit/09c0c795a42f8f15ae6008aa8e6baaaa22261dc2))
+* **internal:** re-export `fileFromPath` helper util from the root ([09c0c79](https://github.com/Increase/increase-node/commit/09c0c795a42f8f15ae6008aa8e6baaaa22261dc2))
+* send Idempotency-Key by default for POST requests ([4c15f76](https://github.com/Increase/increase-node/commit/4c15f76c2f04b92e0dd99045f4f801013c105afc))
+* send Idempotency-Key by default for POST requests ([4c15f76](https://github.com/Increase/increase-node/commit/4c15f76c2f04b92e0dd99045f4f801013c105afc))
+* **tsconfig:** set declarationMap: true ([50c755f](https://github.com/Increase/increase-node/commit/50c755f0f5df98074094175e71670d4f45366fb4))
+* **tsconfig:** set declarationMap: true ([50c755f](https://github.com/Increase/increase-node/commit/50c755f0f5df98074094175e71670d4f45366fb4))
+* update docs ([facb322](https://github.com/Increase/increase-node/commit/facb322b04c7951ea764b7db610902812cf5a7be))
+
+
+### Bug Fixes
+
+* allow importing in typescript without manually installing @types/web ([d802d9e](https://github.com/Increase/increase-node/commit/d802d9e0d145e1b183d476b47764a48f0de08497))
+* bump @types/node version ([7915638](https://github.com/Increase/increase-node/commit/7915638b2e4302a5ed0b9adc024916fccde742c4))
+* change unknown type generation to `interface{}` ([532c5ec](https://github.com/Increase/increase-node/commit/532c5ec12522300e92b4a05f731f8911a6afd3ec))
+* change unknown type generation to `interface{}` ([532c5ec](https://github.com/Increase/increase-node/commit/532c5ec12522300e92b4a05f731f8911a6afd3ec))
+* **client:** properly expose `maxRetries` option ([dfdce20](https://github.com/Increase/increase-node/commit/dfdce20b7a485d0f15182546f47ae340c6280ae7))
+* **internal:** fix TS error when setting global AbortController polyfill ([00c0df8](https://github.com/Increase/increase-node/commit/00c0df83c4ad058271e7207db244ed12c3fe856d))
+* **internal:** fix TS error when setting global AbortController polyfill ([00c0df8](https://github.com/Increase/increase-node/commit/00c0df83c4ad058271e7207db244ed12c3fe856d))
+* polyfill AbortController more safely ([71e0db3](https://github.com/Increase/increase-node/commit/71e0db32ccd0073e052edf6b33bd170e6c5bf7c8))
+* polyfill AbortController more safely ([71e0db3](https://github.com/Increase/increase-node/commit/71e0db32ccd0073e052edf6b33bd170e6c5bf7c8))
+* **sse:** handle server-sent events more robustly ([8dddf91](https://github.com/Increase/increase-node/commit/8dddf917c64db1623b7f4c756539abfe67ab4dd0))
+
+
+### Reverts
+
+* remove `crypto` module import ([b82e4b7](https://github.com/Increase/increase-node/commit/b82e4b7b2755d9ae1556a0d2bb9d5f30218e56fd))
+* remove `crypto` module import ([b82e4b7](https://github.com/Increase/increase-node/commit/b82e4b7b2755d9ae1556a0d2bb9d5f30218e56fd))
+
+
+### Refactors
+
+* **docs:** cleanup api.md response types ([539848e](https://github.com/Increase/increase-node/commit/539848e9001e424f9492f60d82cfb861316cfcb2))
+* remove ability to read the api key from the environment ([3051874](https://github.com/Increase/increase-node/commit/30518740b1c8226ee79d959febb32b517631d0bd))
+* reorganize pagination class definitions ([972a30e](https://github.com/Increase/increase-node/commit/972a30e58fb19c4e46d38dddd2b2acd1288f1e36))
+* reorganize pagination class definitions ([972a30e](https://github.com/Increase/increase-node/commit/972a30e58fb19c4e46d38dddd2b2acd1288f1e36))

package/README.md

@@ -70,7 +70,7 @@ import Increase, { fileFromPath } from 'increase';
 
 const increase = new Increase();
 
-const file = await fileFromPath('/my/file.txt');
+const file = await fileFromPath('my/file.txt');
 await increase.files.create({ file: file, purpose: 'other' });
 ```
 
@@ -155,7 +155,7 @@ Note that requests which time out will be [retried twice by default](#retries).
 ## Auto-pagination
 
 List methods in the Increase API are paginated.
-Use `for await … of` syntax to iterate through items across all pages.
+You can use `for await … of` syntax to iterate through items across all pages:
 
 ```ts
 async function fetchAllAccounts(params) {
@@ -168,6 +168,21 @@ async function fetchAllAccounts(params) {
 }
 ```
 
+Alternatively, you can make request a single page at a time:
+
+```ts
+let page = await increase.accounts.list();
+for (const account of page.data) {
+  console.log(account);
+}
+
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = page.getNextPage();
+  // ...
+}
+```
+
 ## Configuring an HTTP(S) Agent (e.g., for proxies)
 
 By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
@@ -197,14 +212,13 @@ This package is in beta. Its internals and interfaces are not stable
 and subject to change without a major semver bump;
 please reach out if you rely on any undocumented behavior.
 
-We are keen for your feedback; please email us at [dev-feedback@increase.com](mailto:dev-feedback@increase.com)
-or open an issue with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/increase/increase-node/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 
 The following runtimes are supported:
 
-- Node.js version 12 or higher.
+- Node.js 16 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
 - Deno v1.28.0 or higher (experimental).
   Use `import Increase from "npm:increase"`.
 

package/api.md

@@ -25,6 +25,37 @@ Methods:
 - <code title="patch /account_numbers/{account_number_id}">client.accountNumbers.<a href="./resources/account-numbers.ts">update</a>(accountNumberId, { ...params }) -> AccountNumber</code>
 - <code title="get /account_numbers">client.accountNumbers.<a href="./resources/account-numbers.ts">list</a>({ ...params }) -> AccountNumbersPage</code>
 
+# BookkeepingAccounts
+
+Models:
+
+- <code><a href="./resources/bookkeeping-accounts.ts">BookkeepingAccount</a></code>
+
+Methods:
+
+- <code title="post /bookkeeping_accounts">client.bookkeepingAccounts.<a href="./resources/bookkeeping-accounts.ts">create</a>({ ...params }) -> BookkeepingAccount</code>
+- <code title="get /bookkeeping_accounts">client.bookkeepingAccounts.<a href="./resources/bookkeeping-accounts.ts">list</a>({ ...params }) -> BookkeepingAccountsPage</code>
+
+# BookkeepingEntrySets
+
+Models:
+
+- <code><a href="./resources/bookkeeping-entry-sets.ts">BookkeepingEntrySet</a></code>
+
+Methods:
+
+- <code title="post /bookkeeping_entry_sets">client.bookkeepingEntrySets.<a href="./resources/bookkeeping-entry-sets.ts">create</a>({ ...params }) -> BookkeepingEntrySet</code>
+
+# BookkeepingEntries
+
+Models:
+
+- <code><a href="./resources/bookkeeping-entries.ts">BookkeepingEntry</a></code>
+
+Methods:
+
+- <code title="get /bookkeeping_entries">client.bookkeepingEntries.<a href="./resources/bookkeeping-entries.ts">list</a>({ ...params }) -> BookkeepingEntriesPage</code>
+
 # RealTimeDecisions
 
 Models:
@@ -36,6 +67,28 @@ Methods:
 - <code title="get /real_time_decisions/{real_time_decision_id}">client.realTimeDecisions.<a href="./resources/real-time-decisions.ts">retrieve</a>(realTimeDecisionId) -> RealTimeDecision</code>
 - <code title="post /real_time_decisions/{real_time_decision_id}/action">client.realTimeDecisions.<a href="./resources/real-time-decisions.ts">action</a>(realTimeDecisionId, { ...params }) -> RealTimeDecision</code>
 
+# RealTimePaymentsTransfers
+
+Models:
+
+- <code><a href="./resources/real-time-payments-transfers.ts">RealTimePaymentsTransfer</a></code>
+
+Methods:
+
+- <code title="post /real_time_payments_transfers">client.realTimePaymentsTransfers.<a href="./resources/real-time-payments-transfers.ts">create</a>({ ...params }) -> RealTimePaymentsTransfer</code>
+- <code title="get /real_time_payments_transfers/{real_time_payments_transfer_id}">client.realTimePaymentsTransfers.<a href="./resources/real-time-payments-transfers.ts">retrieve</a>(realTimePaymentsTransferId) -> RealTimePaymentsTransfer</code>
+- <code title="get /real_time_payments_transfers">client.realTimePaymentsTransfers.<a href="./resources/real-time-payments-transfers.ts">list</a>({ ...params }) -> RealTimePaymentsTransfersPage</code>
+
+# BalanceLookups
+
+Models:
+
+- <code><a href="./resources/balance-lookups.ts">BalanceLookupLookupResponse</a></code>
+
+Methods:
+
+- <code title="post /balance_lookups">client.balanceLookups.<a href="./resources/balance-lookups.ts">lookup</a>({ ...params }) -> BalanceLookupLookupResponse</code>
+
 # Cards
 
 Models:
@@ -88,6 +141,18 @@ Methods:
 - <code title="patch /external_accounts/{external_account_id}">client.externalAccounts.<a href="./resources/external-accounts.ts">update</a>(externalAccountId, { ...params }) -> ExternalAccount</code>
 - <code title="get /external_accounts">client.externalAccounts.<a href="./resources/external-accounts.ts">list</a>({ ...params }) -> ExternalAccountsPage</code>
 
+# Exports
+
+Models:
+
+- <code><a href="./resources/exports.ts">Export</a></code>
+
+Methods:
+
+- <code title="post /exports">client.exports.<a href="./resources/exports.ts">create</a>({ ...params }) -> Export</code>
+- <code title="get /exports/{export_id}">client.exports.<a href="./resources/exports.ts">retrieve</a>(exportId) -> Export</code>
+- <code title="get /exports">client.exports.<a href="./resources/exports.ts">list</a>({ ...params }) -> ExportsPage</code>
+
 # DigitalWalletTokens
 
 Models:
@@ -121,6 +186,17 @@ Methods:
 - <code title="get /pending_transactions/{pending_transaction_id}">client.pendingTransactions.<a href="./resources/pending-transactions.ts">retrieve</a>(pendingTransactionId) -> PendingTransaction</code>
 - <code title="get /pending_transactions">client.pendingTransactions.<a href="./resources/pending-transactions.ts">list</a>({ ...params }) -> PendingTransactionsPage</code>
 
+# Programs
+
+Models:
+
+- <code><a href="./resources/programs.ts">Program</a></code>
+
+Methods:
+
+- <code title="get /programs/{program_id}">client.programs.<a href="./resources/programs.ts">retrieve</a>(programId) -> Program</code>
+- <code title="get /programs">client.programs.<a href="./resources/programs.ts">list</a>({ ...params }) -> ProgramsPage</code>
+
 # DeclinedTransactions
 
 Models:
@@ -253,9 +329,14 @@ Methods:
 
 ## SupplementalDocuments
 
+Models:
+
+- <code><a href="./resources/entities/supplemental-documents.ts">SupplementalDocument</a></code>
+
 Methods:
 
 - <code title="post /entities/{entity_id}/supplemental_documents">client.entities.supplementalDocuments.<a href="./resources/entities/supplemental-documents.ts">create</a>(entityId, { ...params }) -> Entity</code>
+- <code title="get /entity_supplemental_documents">client.entities.supplementalDocuments.<a href="./resources/entities/supplemental-documents.ts">list</a>({ ...params }) -> SupplementalDocumentsPage</code>
 
 # InboundWireDrawdownRequests
 
@@ -414,6 +495,7 @@ Methods:
 
 - <code title="post /simulations/check_transfers/{check_transfer_id}/deposit">client.simulations.checkTransfers.<a href="./resources/simulations/check-transfers.ts">deposit</a>(checkTransferId) -> CheckTransfer</code>
 - <code title="post /simulations/check_transfers/{check_transfer_id}/mail">client.simulations.checkTransfers.<a href="./resources/simulations/check-transfers.ts">mail</a>(checkTransferId) -> CheckTransfer</code>
+- <code title="post /simulations/check_transfers/{check_transfer_id}/return">client.simulations.checkTransfers.<a href="./resources/simulations/check-transfers.ts">return</a>(checkTransferId, { ...params }) -> CheckTransfer</code>
 
 ## Documents
 
@@ -439,12 +521,28 @@ Methods:
 - <code title="post /simulations/check_deposits/{check_deposit_id}/return">client.simulations.checkDeposits.<a href="./resources/simulations/check-deposits.ts">return</a>(checkDepositId) -> CheckDeposit</code>
 - <code title="post /simulations/check_deposits/{check_deposit_id}/submit">client.simulations.checkDeposits.<a href="./resources/simulations/check-deposits.ts">submit</a>(checkDepositId) -> CheckDeposit</code>
 
+## Programs
+
+Methods:
+
+- <code title="post /simulations/programs">client.simulations.programs.<a href="./resources/simulations/programs.ts">create</a>({ ...params }) -> Program</code>
+
 ## InboundWireDrawdownRequests
 
 Methods:
 
 - <code title="post /simulations/inbound_wire_drawdown_requests">client.simulations.inboundWireDrawdownRequests.<a href="./resources/simulations/inbound-wire-drawdown-requests.ts">create</a>({ ...params }) -> InboundWireDrawdownRequest</code>
 
+## InterestPayments
+
+Models:
+
+- <code><a href="./resources/simulations/interest-payments.ts">InterestPaymentSimulationResult</a></code>
+
+Methods:
+
+- <code title="post /simulations/interest_payment">client.simulations.interestPayments.<a href="./resources/simulations/interest-payments.ts">create</a>({ ...params }) -> InterestPaymentSimulationResult</code>
+
 ## WireTransfers
 
 Models:
@@ -474,4 +572,5 @@ Models:
 
 Methods:
 
+- <code title="post /simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete">client.simulations.realTimePaymentsTransfers.<a href="./resources/simulations/real-time-payments-transfers.ts">complete</a>(realTimePaymentsTransferId, { ...params }) -> RealTimePaymentsTransfer</code>
 - <code title="post /simulations/inbound_real_time_payments_transfers">client.simulations.realTimePaymentsTransfers.<a href="./resources/simulations/real-time-payments-transfers.ts">createInbound</a>({ ...params }) -> InboundRealTimePaymentsTransferSimulationResult</code>

package/bin/check-release-environment

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${STAINLESS_API_KEY}" ]; then
+  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organisation secrets on GitHub.")
+fi
+
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The INCREASE_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organisation secrets")
+fi
+
+len=${#errors[@]}
+
+if [[ len -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"

package/bin/publish-npm

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -eux
+
+npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
+yarn publish --build --access public

package/check-version.ts

@@ -7,7 +7,10 @@ const main = () => {
   if (typeof version !== 'string') {
     throw `Unexpected type for the package.json version field; got ${typeof version}, expected string`;
   }
-  fs.writeFileSync('version.ts', `export const VERSION = '${version}';\n`);
+
+  const contents = fs.readFileSync('version.ts', 'utf8');
+  const output = contents.replace(/(export const VERSION = ')(.*)(')/g, `$1${version}$3`);
+  fs.writeFileSync('version.ts', output);
 };
 
 if (require.main === module) {

package/core.ts

@@ -7,8 +7,12 @@ import { FormDataEncoder } from 'form-data-encoder';
 import { Readable } from 'stream';
 
 import { VERSION } from './version';
+import { Stream } from './streaming';
+import { APIError, APIConnectionError, APIConnectionTimeoutError } from './error';
 import { Fetch, getDefaultAgent, getFetch } from './fetch-polyfill';
 
+const MAX_RETRIES = 2;
+
 export abstract class APIClient {
   baseURL: string;
   maxRetries: number;
@@ -20,17 +24,17 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
-    maxRetries = 2,
+    maxRetries,
     timeout = 60 * 1000, // 60s
     httpAgent,
   }: {
     baseURL: string;
-    maxRetries?: number;
+    maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
   }) {
     this.baseURL = baseURL;
-    this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
+    this.maxRetries = validatePositiveInteger('maxRetries', maxRetries ?? MAX_RETRIES);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
 
@@ -144,11 +148,29 @@ export abstract class APIClient {
     return { req, url, timeout };
   }
 
+  /**
+   * Used as a callback for mutating the given `RequestInit` object.
+   *
+   * This is useful for cases where you want to add certain headers based off of
+   * the request properties, e.g. `method` or `url`.
+   */
+  protected async prepareRequest(request: RequestInit, { url }: { url: string }): Promise<void> {}
+
+  protected makeStatusError(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    return APIError.generate(status, error, message, headers);
+  }
+
   async request<Req extends {}, Rsp>(
     options: FinalRequestOptions<Req>,
     retriesRemaining = options.maxRetries ?? this.maxRetries,
   ): Promise<APIResponse<Rsp>> {
     const { req, url, timeout } = this.buildRequest(options);
+    await this.prepareRequest(req, { url });
 
     this.debug('request', url, options, req.headers);
 
@@ -174,8 +196,7 @@ export abstract class APIClient {
 
       this.debug('response', response.status, url, responseHeaders, errMessage);
 
-      const err = APIError.generate(response.status, errJSON, errMessage, responseHeaders);
-
+      const err = this.makeStatusError(response.status, errJSON, errMessage, responseHeaders);
       throw err;
     }
 
@@ -218,7 +239,10 @@ export abstract class APIClient {
   }
 
   buildURL<Req>(path: string, query: Req | undefined): string {
-    const url = isAbsoluteURL(path) ? new URL(path) : new URL(this.baseURL + path);
+    const url =
+      isAbsoluteURL(path) ?
+        new URL(path)
+      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     if (query) {
       url.search = qs.stringify(query, this.qsOptions());
@@ -454,46 +478,6 @@ export class PagePromise<
   }
 }
 
-export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Item>> {
-  response: Response;
-  responseHeaders: Headers;
-  controller: AbortController;
-
-  constructor(response: Response, controller: AbortController) {
-    this.response = response;
-    this.controller = controller;
-    this.responseHeaders = createResponseHeaders(response.headers);
-  }
-
-  async *[Symbol.asyncIterator](): AsyncIterator<Item, any, undefined> {
-    if (!this.response.body) {
-      this.controller.abort();
-      throw new Error(`Attempted to iterate over a response with no body`);
-    }
-
-    for await (const chunk of this.response.body) {
-      let text;
-      if (chunk instanceof Buffer) {
-        text = chunk.toString();
-      } else {
-        text = chunk;
-      }
-
-      if (text.startsWith('data: ')) {
-        text = text.substring(6);
-      }
-
-      if (text.startsWith('[DONE]')) {
-        break;
-      }
-
-      yield JSON.parse(text);
-    }
-
-    this.controller.abort();
-  }
-}
-
 export const createResponseHeaders = (
   headers: Awaited<ReturnType<Fetch>>['headers'],
 ): Record<string, string> => {
@@ -560,84 +544,6 @@ export type APIResponse<T> = T & {
   responseHeaders: Headers;
 };
 
-export class APIError extends Error {
-  readonly status: number | undefined;
-  readonly headers: Headers | undefined;
-  readonly error: Object | undefined;
-
-  constructor(
-    status: number | undefined,
-    error: Object | undefined,
-    message: string | undefined,
-    headers: Headers | undefined,
-  ) {
-    super(message || (error as any)?.message);
-    this.status = status;
-    this.headers = headers;
-    this.error = error;
-  }
-
-  static generate(
-    status: number | undefined,
-    error: Object | undefined,
-    message: string | undefined,
-    headers: Headers | undefined,
-  ) {
-    if (!status) return new APIConnectionError({ cause: castToError(error) });
-
-    if (status === 400) return new BadRequestError(status, error, message, headers);
-    if (status === 401) return new AuthenticationError(status, error, message, headers);
-    if (status === 403) return new PermissionDeniedError(status, error, message, headers);
-    if (status === 404) return new NotFoundError(status, error, message, headers);
-    if (status === 409) return new ConflictError(status, error, message, headers);
-    if (status === 422) return new UnprocessableEntityError(status, error, message, headers);
-    if (status === 429) return new RateLimitError(status, error, message, headers);
-    if (status >= 500) return new InternalServerError(status, error, message, headers);
-
-    return new APIError(status, error, message, headers);
-  }
-}
-
-export class BadRequestError extends APIError {
-  override readonly status: 400 = 400;
-}
-export class AuthenticationError extends APIError {
-  override readonly status: 401 = 401;
-}
-export class PermissionDeniedError extends APIError {
-  override readonly status: 403 = 403;
-}
-export class NotFoundError extends APIError {
-  override readonly status: 404 = 404;
-}
-export class ConflictError extends APIError {
-  override readonly status: 409 = 409;
-}
-export class UnprocessableEntityError extends APIError {
-  override readonly status: 422 = 422;
-}
-export class RateLimitError extends APIError {
-  override readonly status: 429 = 429;
-}
-export class InternalServerError extends APIError {}
-
-export class APIConnectionError extends APIError {
-  override readonly status: undefined = undefined;
-
-  constructor({ message, cause }: { message?: string; cause?: Error | undefined }) {
-    super(undefined, undefined, message || 'Connection error.', undefined);
-    // eslint-disable-next-line
-    // @ts-ignore
-    if (cause) this.cause = cause;
-  }
-}
-
-export class APIConnectionTimeoutError extends APIConnectionError {
-  constructor() {
-    super({ message: 'Request timed out.' });
-  }
-}
-
 declare const Deno: any;
 type Arch = 'x32' | 'x64' | 'arm' | 'arm64' | `other:${string}` | 'unknown';
 type PlatformName =
@@ -732,7 +638,7 @@ const getPlatformHeaders = () => {
   return (_platformHeaders ??= getPlatformProperties());
 };
 
-const safeJSON = (text: string) => {
+export const safeJSON = (text: string) => {
   try {
     return JSON.parse(text);
   } catch (err) {
@@ -758,7 +664,7 @@ const validatePositiveInteger = (name: string, n: number) => {
   return n;
 };
 
-const castToError = (err: any): Error => {
+export const castToError = (err: any): Error => {
   if (err instanceof Error) return err;
   return new Error(err);
 };

package/dist/cjs/check-version.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=check-version.d.ts.map

package/dist/cjs/check-version.d.ts.map

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