integrateledger 0.0.0-stage → 0.1.0

package/FUNCTIONS.md

@@ -0,0 +1,39 @@
+# Standalone Functions
+
+Standalone functions use the same organization API key as the SDK class. Call them only from trusted server code or serverless functions that keep the key secret. Never bundle the key for a browser.
+
+Each SDK method is also available as a standalone function. Bundlers can remove unused operations from server deployments.
+
+## Example
+
+```typescript
+import { LedgerCore } from "integrateledger/core.js";
+import { createFeature } from "integrateledger/funcs/create-feature.js";
+
+const ledger = new LedgerCore({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+const result = await createFeature(ledger, {
+  id: "api_call",
+  name: "API call",
+  creditCost: 1,
+});
+if (!result.ok) throw result.error;
+console.log(result.value.item.id);
+```
+
+## Result types
+
+Standalone functions differ from SDK methods in that they return a
+`Result<Value, Error>` type to capture _known errors_ and document them using
+the type system. By avoiding throwing errors, application code maintains clear
+control flow and error-handling become part of the regular flow of application
+code.
+
+> We use the term "known errors" because standalone functions, and JavaScript
+> code in general, can still throw unexpected errors such as `TypeError`s,
+> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
+> something this SDK addresses in the future. Nevertheless, there is still a lot
+> of benefit from capturing most errors and turning them into values.
+
+Result values also make expected API errors explicit in server handlers, where each request can choose whether to retry, log, or return an error to the caller.
+
+The `result.ok` check in the example above narrows the return type, so `result.error` and `result.value` have explicit types.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ledger
+
+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,3 +1,398 @@
-# Temporary Holding Version
+# integrateledger
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Released under the [MIT license](LICENSE).
+
+Speakeasy-generated TypeScript SDK for Ledger's client API. For local setup and end-to-end exercises, see [TESTING.md](TESTING.md).
+
+The SDK calls the hosted Ledger API by default. Pass `serverURL` to use a local instance or a future custom domain.
+
+Ledger API keys grant organization-wide access. Use this SDK only in trusted server code; never ship its key to a browser or client bundle.
+
+[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=integrateledger&utm_campaign=typescript)
+
+
+<br /><br />
+Install the server-side SDK from npm. See the [Ledger docs](https://docs.integrateledger.com/sdk) for catalog, customer, usage, and Checkout examples.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [integrateledger](#integrateledger)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+`npm install integrateledger` or `bun add integrateledger`. The package provides both CommonJS and ES Modules. Keep your Ledger API key on the server.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+
+async function main() {
+  await client.createFeature({ id: "api_call", name: "API call", creditCost: 1 });
+  await client.createPlan({ id: "starter", name: "Starter", monthlyCredits: 100, monthlyPriceCents: 1900 });
+  await client.createAddOn({ id: "extra_credits", name: "Extra credits", type: "credit_pack", creditAmount: 50, priceCents: 500 });
+}
+
+main().catch((error) => { console.error(error); process.exitCode = 1; });
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+Set `LEDGER_API_KEY` in a trusted server environment. The key authorizes access to your organization, so do not include it in client code.
+
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+const feature = await client.createFeature({ id: "api_call", name: "API call", creditCost: 1 });
+console.log(feature.item.id);
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [Ledger SDK](docs/sdks/ledger/README.md)
+
+* [publishCatalog](docs/sdks/ledger/README.md#publishcatalog) - Publish an organization's catalog
+* [listFeatures](docs/sdks/ledger/README.md#listfeatures) - List active features
+* [createFeature](docs/sdks/ledger/README.md#createfeature) - Create a feature
+* [getFeature](docs/sdks/ledger/README.md#getfeature) - Get a feature
+* [updateFeature](docs/sdks/ledger/README.md#updatefeature) - Update a feature
+* [archiveFeature](docs/sdks/ledger/README.md#archivefeature) - Archive a feature
+* [listPlans](docs/sdks/ledger/README.md#listplans) - List active plans
+* [createPlan](docs/sdks/ledger/README.md#createplan) - Create a plan
+* [getPlan](docs/sdks/ledger/README.md#getplan) - Get a plan
+* [updatePlan](docs/sdks/ledger/README.md#updateplan) - Update a plan
+* [archivePlan](docs/sdks/ledger/README.md#archiveplan) - Archive a plan
+* [listAddOns](docs/sdks/ledger/README.md#listaddons) - List active add-ons
+* [createAddOn](docs/sdks/ledger/README.md#createaddon) - Create an add-on
+* [getAddOn](docs/sdks/ledger/README.md#getaddon) - Get an add-on
+* [updateAddOn](docs/sdks/ledger/README.md#updateaddon) - Update an add-on
+* [archiveAddOn](docs/sdks/ledger/README.md#archiveaddon) - Archive an add-on
+* [checkCredits](docs/sdks/ledger/README.md#checkcredits) - Check a customer's available credits
+* [listCustomerSubscriptions](docs/sdks/ledger/README.md#listcustomersubscriptions) - List a customer's subscriptions
+* [listCustomerPurchases](docs/sdks/ledger/README.md#listcustomerpurchases) - List a customer's credit-pack purchases
+* [setSubscriptionCancellation](docs/sdks/ledger/README.md#setsubscriptioncancellation) - Stop or resume a paid subscription's renewal
+* [getCustomer](docs/sdks/ledger/README.md#getcustomer) - Get a customer and current balance
+* [createOrGetCustomer](docs/sdks/ledger/README.md#createorgetcustomer) - Create or get a customer
+* [trackUsage](docs/sdks/ledger/README.md#trackusage) - Record feature usage
+* [attach](docs/sdks/ledger/README.md#attach) - Attach a plan or add-on to a customer
+* [upgradePaidPlan](docs/sdks/ledger/README.md#upgradepaidplan) - Upgrade a paid plan
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. They can reduce bundle size in trusted server or serverless deployments. They use the same secret organization API key as the SDK class.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`archiveAddOn`](docs/sdks/ledger/README.md#archiveaddon) - Archive an add-on
+- [`archiveFeature`](docs/sdks/ledger/README.md#archivefeature) - Archive a feature
+- [`archivePlan`](docs/sdks/ledger/README.md#archiveplan) - Archive a plan
+- [`attach`](docs/sdks/ledger/README.md#attach) - Attach a plan or add-on to a customer
+- [`checkCredits`](docs/sdks/ledger/README.md#checkcredits) - Check a customer's available credits
+- [`createAddOn`](docs/sdks/ledger/README.md#createaddon) - Create an add-on
+- [`createFeature`](docs/sdks/ledger/README.md#createfeature) - Create a feature
+- [`createOrGetCustomer`](docs/sdks/ledger/README.md#createorgetcustomer) - Create or get a customer
+- [`createPlan`](docs/sdks/ledger/README.md#createplan) - Create a plan
+- [`getAddOn`](docs/sdks/ledger/README.md#getaddon) - Get an add-on
+- [`getCustomer`](docs/sdks/ledger/README.md#getcustomer) - Get a customer and current balance
+- [`getFeature`](docs/sdks/ledger/README.md#getfeature) - Get a feature
+- [`getPlan`](docs/sdks/ledger/README.md#getplan) - Get a plan
+- [`listAddOns`](docs/sdks/ledger/README.md#listaddons) - List active add-ons
+- [`listCustomerPurchases`](docs/sdks/ledger/README.md#listcustomerpurchases) - List a customer's credit-pack purchases
+- [`listCustomerSubscriptions`](docs/sdks/ledger/README.md#listcustomersubscriptions) - List a customer's subscriptions
+- [`listFeatures`](docs/sdks/ledger/README.md#listfeatures) - List active features
+- [`listPlans`](docs/sdks/ledger/README.md#listplans) - List active plans
+- [`publishCatalog`](docs/sdks/ledger/README.md#publishcatalog) - Publish an organization's catalog
+- [`setSubscriptionCancellation`](docs/sdks/ledger/README.md#setsubscriptioncancellation) - Stop or resume a paid subscription's renewal
+- [`trackUsage`](docs/sdks/ledger/README.md#trackusage) - Record feature usage
+- [`updateAddOn`](docs/sdks/ledger/README.md#updateaddon) - Update an add-on
+- [`updateFeature`](docs/sdks/ledger/README.md#updatefeature) - Update a feature
+- [`updatePlan`](docs/sdks/ledger/README.md#updateplan) - Update a plan
+- [`upgradePaidPlan`](docs/sdks/ledger/README.md#upgradepaidplan) - Upgrade a paid plan
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+The SDK supports a default retry strategy and per-operation overrides. The example retries a read. For writes, reconcile the result or use an idempotency key where the endpoint supports one before retrying: a lost creation response can be followed by a conflict even when creation succeeded.
+
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+const features = await client.listFeatures(
+  { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100 }, retryConnectionErrors: false } },
+);
+console.log(features.items);
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`LedgerError`](./src/models/errors/ledger-error.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
+
+### Example
+
+```typescript
+import ledger from "integrateledger";
+import * as errors from "integrateledger/models/errors";
+
+const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+try {
+  await client.createFeature({ id: "api_call", name: "API call", creditCost: 1 });
+} catch (error) {
+  if (error instanceof errors.CreateFeatureConflictError) {
+    console.error(error.data$.error);
+  } else if (error instanceof errors.LedgerError) {
+    console.error(error.statusCode, error.message);
+  } else {
+    throw error;
+  }
+}
+```
+
+### Error Classes
+**Primary error:**
+* [`LedgerError`](./src/models/errors/ledger-error.ts): The base class for HTTP error responses.
+
+<details><summary>Less common errors (59)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`LedgerError`](./src/models/errors/ledger-error.ts)**:
+* [`CustomerError`](./src/models/errors/customer-error.ts): Applicable to 5 of 25 methods.*
+* [`CreateFeatureBadRequestError`](./src/models/errors/create-feature-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`GetFeatureBadRequestError`](./src/models/errors/get-feature-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`UpdateFeatureBadRequestError`](./src/models/errors/update-feature-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`ArchiveFeatureBadRequestError`](./src/models/errors/archive-feature-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`CreatePlanBadRequestError`](./src/models/errors/create-plan-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`GetPlanBadRequestError`](./src/models/errors/get-plan-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`UpdatePlanBadRequestError`](./src/models/errors/update-plan-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`ArchivePlanBadRequestError`](./src/models/errors/archive-plan-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`CreateAddOnBadRequestError`](./src/models/errors/create-add-on-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`GetAddOnBadRequestError`](./src/models/errors/get-add-on-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`UpdateAddOnBadRequestError`](./src/models/errors/update-add-on-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`ArchiveAddOnBadRequestError`](./src/models/errors/archive-add-on-bad-request-error.ts): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
+* [`UpgradeError`](./src/models/errors/upgrade-error.ts): Invalid or ineligible upgrade. Status code `400`. Applicable to 1 of 25 methods.*
+* [`CheckError`](./src/models/errors/check-error.ts): Invalid input. Applicable to 1 of 25 methods.*
+* [`TrackError`](./src/models/errors/track-error.ts): Invalid input. Applicable to 1 of 25 methods.*
+* [`AttachError`](./src/models/errors/attach-error.ts): Invalid request. Applicable to 1 of 25 methods.*
+* [`CatalogError`](./src/models/errors/catalog-error.ts): Invalid catalog. Applicable to 1 of 25 methods.*
+* [`ListFeaturesUnauthorizedError`](./src/models/errors/list-features-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`CreateFeatureUnauthorizedError`](./src/models/errors/create-feature-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`GetFeatureUnauthorizedError`](./src/models/errors/get-feature-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`UpdateFeatureUnauthorizedError`](./src/models/errors/update-feature-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`ArchiveFeatureUnauthorizedError`](./src/models/errors/archive-feature-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`ListPlansUnauthorizedError`](./src/models/errors/list-plans-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`CreatePlanUnauthorizedError`](./src/models/errors/create-plan-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`GetPlanUnauthorizedError`](./src/models/errors/get-plan-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`UpdatePlanUnauthorizedError`](./src/models/errors/update-plan-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`ArchivePlanUnauthorizedError`](./src/models/errors/archive-plan-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`ListAddOnsUnauthorizedError`](./src/models/errors/list-add-ons-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`CreateAddOnUnauthorizedError`](./src/models/errors/create-add-on-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`GetAddOnUnauthorizedError`](./src/models/errors/get-add-on-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`UpdateAddOnUnauthorizedError`](./src/models/errors/update-add-on-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`ArchiveAddOnUnauthorizedError`](./src/models/errors/archive-add-on-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`UpgradePaidPlanUnauthorizedError`](./src/models/errors/upgrade-paid-plan-unauthorized-error.ts): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
+* [`GetFeatureNotFoundError`](./src/models/errors/get-feature-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`UpdateFeatureNotFoundError`](./src/models/errors/update-feature-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`ArchiveFeatureNotFoundError`](./src/models/errors/archive-feature-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`GetPlanNotFoundError`](./src/models/errors/get-plan-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`UpdatePlanNotFoundError`](./src/models/errors/update-plan-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`ArchivePlanNotFoundError`](./src/models/errors/archive-plan-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`GetAddOnNotFoundError`](./src/models/errors/get-add-on-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`UpdateAddOnNotFoundError`](./src/models/errors/update-add-on-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`ArchiveAddOnNotFoundError`](./src/models/errors/archive-add-on-not-found-error.ts): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
+* [`UpgradePaidPlanNotFoundError`](./src/models/errors/upgrade-paid-plan-not-found-error.ts): Unknown customer or target plan. Status code `404`. Applicable to 1 of 25 methods.*
+* [`CreateFeatureConflictError`](./src/models/errors/create-feature-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`UpdateFeatureConflictError`](./src/models/errors/update-feature-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`CreatePlanConflictError`](./src/models/errors/create-plan-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`UpdatePlanConflictError`](./src/models/errors/update-plan-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`CreateAddOnConflictError`](./src/models/errors/create-add-on-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`UpdateAddOnConflictError`](./src/models/errors/update-add-on-conflict-error.ts): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
+* [`UpgradePaidPlanConflictError`](./src/models/errors/upgrade-paid-plan-conflict-error.ts): Idempotency key mismatch or pending upgrade. Status code `409`. Applicable to 1 of 25 methods.*
+* [`BadGatewayError`](./src/models/errors/bad-gateway-error.ts): Stripe request failed or signed webhook endpoint unhealthy. Status code `502`. Applicable to 1 of 25 methods.*
+* [`ServiceUnavailableError`](./src/models/errors/service-unavailable-error.ts): Upgrade requires Stripe reconciliation or payment action. Status code `503`. Applicable to 1 of 25 methods.*
+* [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+The SDK uses `https://api.integrateledger.com` by default. Pass `serverURL` for a local Ledger API or a custom domain.
+
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({
+  serverURL: "http://127.0.0.1:3001",
+  apiKey: process.env.LEDGER_API_KEY ?? "",
+});
+const features = await client.listFeatures();
+console.log(features.items);
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to:
+- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
+- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
+- use the `"requestError"` hook to log errors
+
+```typescript
+import ledger from "integrateledger";
+import { ProxyAgent } from "undici";
+import { HTTPClient } from "integrateledger/lib/http";
+
+const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
+
+const httpClient = new HTTPClient({
+  // 'fetcher' takes a function that has the same signature as native 'fetch'.
+  fetcher: (input, init) =>
+    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
+    fetch(input, { ...init, dispatcher } as RequestInit),
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new ledger({ httpClient: httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import ledger from "integrateledger";
+
+const sdk = new ledger({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `LEDGER_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=integrateledger&utm_campaign=typescript)

package/RUNTIMES.md

@@ -0,0 +1,49 @@
+# Supported JavaScript runtimes
+
+Ledger API keys authorize organization-wide access. Use this SDK only in trusted server runtimes; never include its key in a browser bundle.
+
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
+
+- [Web Fetch API][web-fetch]
+- [Web Streams API][web-streams] and in particular `ReadableStream`
+- [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Node.js [active and maintenance LTS releases][node-releases]
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+[node-releases]: https://nodejs.org/en/about/previous-releases
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of],
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"]
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.

package/TESTING.md

@@ -0,0 +1,55 @@
+# Test the Ledger TypeScript SDK
+
+This guide covers local source builds and packaged end-to-end verification. For public installation and API examples, see the [SDK guide](https://docs.integrateledger.com/sdk).
+
+The SDK in this directory is generated by Speakeasy from [`openapi.json`](openapi.json). It covers catalog items, customers, billing, and usage from Ledger's `GET /openapi.json` document. The Stripe webhook receiver is omitted because it requires a Stripe-signed payload.
+
+From the Ledger repository root:
+
+```bash
+bun run sdk:build
+bun run sdk:test
+bun run dev
+```
+
+Leave the API running in one terminal. In another terminal, set `LEDGER_API_KEY` to an organization's sandbox key, or use the existing `.env.test_data` file with `bun --env-file=.env.test_data run sdk:call ...` (the call script uses `TEST_ORG_1_LEDGER_API_KEY` if `LEDGER_API_KEY` is absent). Set `LEDGER_API_URL` to override the default `http://127.0.0.1:3001`.
+
+If you use `.env.test_data` with a fresh local database, seed its test organizations first:
+
+```bash
+bun --env-file=.env --env-file=.env.test_data run test-data:seed
+```
+
+The `sdk:call` command accepts an operation name and either a JSON request or `@path/to/file.json`:
+
+```bash
+bun run sdk:call createFeature '{"id":"generate_image","name":"Generate image","creditCost":1}'
+bun run sdk:call createPlan '{"id":"basic","name":"Basic","monthlyCredits":100,"monthlyPriceCents":1900}'
+bun run sdk:call createAddOn '{"id":"regular_pack","name":"Regular pack","type":"credit_pack","creditAmount":50,"priceCents":500}'
+bun run sdk:call listPlans '{}'
+bun run sdk:call createOrGetCustomer '{"customerId":"buyer"}'
+bun run sdk:call checkCredits '{"customerId":"buyer","featureId":"generate_image"}'
+bun run sdk:call trackUsage '{"customerId":"buyer","featureId":"generate_image","requestId":"req-001"}'
+bun run sdk:call attach '{"customerId":"buyer","planId":"basic"}'
+bun run sdk:call attach '{"customerId":"buyer","addOnId":"regular_pack"}'
+bun run sdk:call upgradePaidPlan '{"idempotencyKey":"upgrade-001","body":{"customerId":"buyer","planId":"pro"}}'
+```
+
+`attach` takes exactly one of `planId` or `addOnId`. Plan attachment returns `subscriptionId`; add-on attachment returns `addOnPurchaseId`. Both return a `checkoutUrl` to complete payment. `trackUsage` sends `requestId` as the API's `request_id` field. Reuse the same `idempotencyKey` when retrying an upgrade. Attach and upgrade require the organization's Stripe sandbox connection and appropriate customer subscription state; the SDK returns the API's errors when those prerequisites are missing.
+
+In TypeScript, import `Ledger` from the built local package and set `apiKey` and optionally `serverURL`:
+
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({
+  apiKey: process.env.LEDGER_API_KEY,
+  serverURL: process.env.LEDGER_API_URL ?? "http://127.0.0.1:3001",
+});
+
+const result = await client.checkCredits({ customerId: "buyer", featureId: "generate_image" });
+```
+
+To use a local build from another project, install it with `bun add /absolute/path/to/ledger/packages/sdk` after building. For the registry release, use `bun add integrateledger`.
+
+When API routes or schemas change, run `bun run sdk:generate`, then `bun run sdk:build` and `bun run sdk:test`. `sdk:generate` exports the current Hono OpenAPI document, normalizes its OpenAPI 3.1 schemas, and runs the checked-in Speakeasy workflow. It requires a signed-in Speakeasy CLI (`speakeasy auth login`).

package/USAGE.md

@@ -0,0 +1,15 @@
+<!-- Start SDK Example Usage [usage] -->
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
+
+async function main() {
+  await client.createFeature({ id: "api_call", name: "API call", creditCost: 1 });
+  await client.createPlan({ id: "starter", name: "Starter", monthlyCredits: 100, monthlyPriceCents: 1900 });
+  await client.createAddOn({ id: "extra_credits", name: "Extra credits", type: "credit_pack", creditAmount: 50, priceCents: 500 });
+}
+
+main().catch((error) => { console.error(error); process.exitCode = 1; });
+```
+<!-- End SDK Example Usage [usage] -->

package/dist/commonjs/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class LedgerCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/dist/commonjs/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,SAAS;CAAG"}

package/dist/commonjs/core.js

@@ -0,0 +1,17 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerCore = void 0;
+const sdks_js_1 = require("./lib/sdks.js");
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+class LedgerCore extends sdks_js_1.ClientSDK {
+}
+exports.LedgerCore = LedgerCore;
+//# sourceMappingURL=core.js.map

package/dist/commonjs/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,gBAAwB,SAAQ,mBAAS;CAAG"}

package/dist/commonjs/funcs/archive-add-on.d.ts

@@ -0,0 +1,16 @@
+import { LedgerCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { LedgerError } from "../models/errors/ledger-error.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Archive an add-on
+ */
+export declare function archiveAddOn(client: LedgerCore, request: operations.ArchiveAddOnRequest, options?: RequestOptions): APIPromise<Result<models.AddOnArchived, errors.ArchiveAddOnBadRequestError | errors.ArchiveAddOnUnauthorizedError | errors.ArchiveAddOnNotFoundError | LedgerError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=archive-add-on.d.ts.map

package/dist/commonjs/funcs/archive-add-on.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive-add-on.d.ts","sourceRoot":"","sources":["../../../src/funcs/archive-add-on.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAMxC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,aAAa,EAClB,MAAM,CAAC,2BAA2B,GAClC,MAAM,CAAC,6BAA6B,GACpC,MAAM,CAAC,yBAAyB,GAChC,WAAW,GACX,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}