@budgetary/sdk
Advanced tools
+1
-1
| { | ||
| "name": "@budgetary/sdk", | ||
| "version": "0.7.0", | ||
| "version": "0.7.1", | ||
| "description": "TypeScript SDK for the Budgetary API.", | ||
@@ -5,0 +5,0 @@ "license": "Apache-2.0", |
+3
-1
@@ -130,4 +130,6 @@ # @budgetary/sdk | ||
| `estimate()` accepts an optional `clientRequestId` that is forwarded to the server as `client_request_id`. The API treats identical replays within 24 hours as the same call, returning the original response without rebilling. The SDK auto-generates a fresh UUID v4 on every call by default so retries are safe out of the box. | ||
| `estimate()` accepts an optional `clientRequestId` that is forwarded to the server as `client_request_id`. It is a **correlation id only**: the server accepts it but **currently ignores it — it does not provide idempotent replay.** A retry with the same `client_request_id` produces a **new** `estimate_id`, recomputes, and is **billed as a separate estimate**. Do **not** rely on it for dedup. | ||
| `POST /v1/actuals` *is* idempotent on `estimate_id`, and is safe to retry on network failure. See §8 of the [API contract](../../docs/api-contract.md). | ||
| ```ts | ||
@@ -134,0 +136,0 @@ // default — SDK generates a UUID |
207934
0.11%157
1.29%