@getivy/node-sdk 2.20.0 → 2.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.20.1](https://github.com/augustus/node-sdk/compare/v2.20.0...v2.20.1) (2026-11-06)
4
+
5
+
6
+ ### Documentation
7
+
8
+ * **jup-2026:** document request signing in the readme ([9dbd0e6](https://github.com/augustus/node-sdk/commit/9dbd0e6a12ecd9bb1c96de85a6a2110afba9ca79))
9
+ * **jup-2026:** document request signing in the readme ([3aa9b4a](https://github.com/augustus/node-sdk/commit/3aa9b4a2a2f870c665e8192b6fb3c0c6fb8827d2))
10
+
3
11
  ## [2.20.0](https://github.com/augustus/node-sdk/compare/v2.19.0...v2.20.0) (2026-11-06)
4
12
 
5
13
 
package/README.md CHANGED
@@ -51,6 +51,37 @@ const customer: Ivy.CustomerCreateResponse = await client.customers.create(param
51
51
 
52
52
  Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
53
53
 
54
+ ## Request signing
55
+
56
+ If your API key has a signing public key, every request must be signed with the matching private key. Pass the private key as `signingPrivateKey`, or set `IVY_SIGNING_PRIVATE_KEY`, and the client signs each request for you. The private key never leaves your system.
57
+
58
+ Generate an Ed25519 key pair, then upload the public key when you create the API key in the dashboard:
59
+
60
+ ```sh
61
+ openssl genpkey -algorithm ed25519 -out signing-private-key.pem
62
+ openssl pkey -in signing-private-key.pem -pubout -out signing-public-key.pem
63
+ ```
64
+
65
+ <!-- prettier-ignore -->
66
+ ```ts
67
+ import { readFile } from 'node:fs/promises';
68
+ import Ivy from '@getivy/node-sdk';
69
+
70
+ const client = new Ivy({
71
+ apiKey: process.env['IVY_API_KEY'],
72
+ signingPrivateKey: await readFile('signing-private-key.pem', 'utf8'),
73
+ environment: 'sandbox',
74
+ });
75
+
76
+ const balance = await client.balance.retrieve({ currency: 'EUR' });
77
+ ```
78
+
79
+ The key must be an unencrypted PKCS#8 PEM for Ed25519 or P-256. Keep its line breaks. A PEM stored on one line with `\n` escapes is rejected.
80
+
81
+ The client signs each retry again with a new nonce, and it does not follow redirects. To turn signing off on a client created with `withOptions()`, pass `signingPrivateKey: null`.
82
+
83
+ See [Request signing](https://docs.augustus.com/reference/request-signing) for how signatures are built and verified.
84
+
54
85
  ## Handling errors
55
86
 
56
87
  When the library is unable to connect to the API,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getivy/node-sdk",
3
- "version": "2.20.0",
3
+ "version": "2.20.1",
4
4
  "description": "The official TypeScript library for the Ivy API",
5
5
  "author": "Ivy <developer@augustus.com>",
6
6
  "types": "./index.d.ts",
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '2.20.0'; // x-release-please-version
1
+ export const VERSION = '2.20.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.20.0";
1
+ export declare const VERSION = "2.20.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.20.0";
1
+ export declare const VERSION = "2.20.1";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '2.20.0'; // x-release-please-version
4
+ exports.VERSION = '2.20.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '2.20.0'; // x-release-please-version
1
+ export const VERSION = '2.20.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map