@openmeter/client 1.0.0-beta-4d26c6d3c7fe → 1.0.0-beta-e7a04be10ed8

package/README.md

@@ -1,11 +1,12 @@
+<!-- Code generated by @openmeter/typespec-typescript. DO NOT EDIT. -->
+
 # OpenMeter SDK
 
 TypeScript client for the OpenMeter API — usage metering and billing for
 AI and DevTool companies. This package is generated from the OpenMeter
 TypeSpec definitions and ships fully-typed request and response models.
 
-> [!IMPORTANT]
-> This SDK is a work in progress.
+> **Important:** This SDK is a work in progress.
 >
 > This SDK targets the [OpenMeter API v3](https://openmeter.io/docs/api/v3),
 > a rewrite of the OpenMeter API following AIP (API Improvement Proposal)
@@ -15,7 +16,9 @@ TypeSpec definitions and ships fully-typed request and response models.
 
 - [Installation](#installation)
 - [Initialization](#initialization)
+- [Configuration](#configuration)
 - [Usage](#usage)
+- [Pagination](#pagination)
 - [Available Resources and Operations](#available-resources-and-operations)
   - [Events](#events)
   - [Meters](#meters)
@@ -24,16 +27,18 @@ TypeSpec definitions and ships fully-typed request and response models.
   - [Subscriptions](#subscriptions)
   - [Apps](#apps)
   - [Billing](#billing)
-  - [Invoices](#invoices)
   - [Tax](#tax)
-  - [Currencies](#currencies)
   - [Features](#features)
   - [LLMCost](#llmcost)
   - [Plans](#plans)
   - [Addons](#addons)
   - [PlanAddons](#planaddons)
   - [Defaults](#defaults)
-  - [Governance](#governance)
+- [Internal Operations](#internal-operations)
+  - [Internal Subscriptions](#internal-subscriptions)
+  - [Internal Currencies](#internal-currencies)
+- [Runtime Validation (validate option)](#runtime-validation-validate-option)
+- [Zod Schemas (./zod export)](#zod-schemas-zod-export)
 - [Error Handling](#error-handling)
 - [Standalone Functions](#standalone-functions)
 
@@ -80,6 +85,76 @@ const client = new OpenMeter({
 The `apiKey` may also be a function returning a `string` or
 `Promise<string>`, so tokens can be refreshed per request.
 
+## Configuration
+
+`SDKOptions` extends [ky](https://github.com/sindresorhus/ky)'s
+`Options`, so every transport setting ky supports is a top-level client
+option: retry policy, per-attempt timeout (ky defaults to 10 seconds),
+lifecycle hooks, a custom `fetch`, and so on.
+
+```typescript
+import { OpenMeter } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+  timeout: 30_000,
+  hooks: {
+    beforeRequest: [
+      ({ request }) => {
+        console.log(`-> ${request.method} ${request.url}`)
+      },
+    ],
+  },
+  fetch: async (input, init) => {
+    const start = Date.now()
+    const response = await fetch(input, init)
+    console.log(`${response.status} in ${Date.now() - start}ms`)
+    return response
+  },
+})
+```
+
+ky only retries the idempotent methods by default — `get`, `put`,
+`head`, `delete`, `options`, `trace` — never `post`. That means a
+dropped `client.events.ingest` call is not retried on a network error
+or a 5xx response unless you opt in explicitly:
+
+```typescript
+import { OpenMeter } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+  retry: { limit: 3, methods: ['get', 'put', 'head', 'delete', 'post'] },
+})
+```
+
+This is safe specifically for event ingestion: the event `id` is its
+deduplication key server-side, so resending the same event on retry is
+a no-op rather than a duplicate.
+
+Every method also takes a per-request `RequestOptions` as its second
+argument — a curated subset of ky's options (`signal`, `headers`,
+`timeout`, `retry`) applied to that call only:
+
+```typescript
+import { OpenMeter } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+})
+
+const controller = new AbortController()
+setTimeout(() => controller.abort(), 5_000)
+
+const meters = await client.meters.list(undefined, {
+  signal: controller.signal,
+  headers: { 'X-Request-Id': 'batch-42' },
+})
+```
+
 ## Usage
 
 Every operation is reachable through a fluent, namespaced client and
@@ -112,6 +187,70 @@ Responses return date-time fields as native `Date` objects (every
 either a `Date` or an RFC 3339 string — a meter query `from`/`to`, an
 ingested event's `time`, filter operands, all alike.
 
+## Pagination
+
+Every list operation that returns pages also has an `…All` companion —
+`client.meters.listAll(request?)` alongside `client.meters.list(request?)` —
+that returns an `AsyncIterable` of items instead of one page. It fetches
+each following page lazily, only when the previous page is exhausted, so a
+`break` (or a `return`) partway through never fires a request for a page
+nothing consumes:
+
+```typescript
+import { OpenMeter } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+})
+
+for await (const meter of client.meters.listAll()) {
+  console.log(meter.key)
+}
+```
+
+The request object accepts the same filters, sort, and page size as the
+single-page method — only the page cursor/number itself advances between
+requests:
+
+```typescript
+for await (const meter of client.meters.listAll({ filter: { key: 'api' } })) {
+  if (meter.key === 'api-requests') {
+    break // stops iterating; no further pages are fetched
+  }
+}
+```
+
+Cursor-paginated resources (`events`, credit transactions) work the same
+way:
+
+```typescript
+for await (const event of client.events.listAll()) {
+  console.log(event.event.id)
+}
+```
+
+Auto-pagination takes the same optional `RequestOptions` as every other
+method, so one `AbortSignal` cancels the whole iteration, not just the page
+in flight:
+
+```typescript
+const controller = new AbortController()
+setTimeout(() => controller.abort(), 30_000)
+
+for await (const meter of client.meters.listAll(undefined, {
+  signal: controller.signal,
+})) {
+  console.log(meter.key)
+}
+```
+
+Iteration stops after the server’s last page — an empty or short-of-`size`
+page for a page-number resource, or a response with no next cursor for a
+cursor resource. A misbehaving server that never signals the end of the
+list fails fast instead of looping forever: after 10,000 pages the
+iterable throws `PaginationLimitExceededError`.
+
 ## Available Resources and Operations
 
 Operations are grouped by resource and exposed as methods on the client.
@@ -140,14 +279,14 @@ The full call path, HTTP route, and a short description are listed below.
 
 | Method                                                     | HTTP                                                                                        | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.customers.create`                                  | `POST /openmeter/customers`                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.get`                                     | `GET /openmeter/customers/{customerId}`                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.list`                                    | `GET /openmeter/customers`                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.upsert`                                  | `PUT /openmeter/customers/{customerId}`                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.delete`                                  | `DELETE /openmeter/customers/{customerId}`                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.billing.get`                             | `GET /openmeter/customers/{customerId}/billing`                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.billing.update`                          | `PUT /openmeter/customers/{customerId}/billing`                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `client.customers.billing.updateAppData`                   | `PUT /openmeter/customers/{customerId}/billing/app-data`                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `client.customers.create`                                  | `POST /openmeter/customers`                                                                 | Create customer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `client.customers.get`                                     | `GET /openmeter/customers/{customerId}`                                                     | Get customer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `client.customers.list`                                    | `GET /openmeter/customers`                                                                  | List customers                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| `client.customers.upsert`                                  | `PUT /openmeter/customers/{customerId}`                                                     | Upsert customer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `client.customers.delete`                                  | `DELETE /openmeter/customers/{customerId}`                                                  | Delete customer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `client.customers.billing.get`                             | `GET /openmeter/customers/{customerId}/billing`                                             | Get customer billing data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `client.customers.billing.update`                          | `PUT /openmeter/customers/{customerId}/billing`                                             | Update customer billing data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `client.customers.billing.updateAppData`                   | `PUT /openmeter/customers/{customerId}/billing/app-data`                                    | Update customer billing app data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `client.customers.billing.createStripeCheckoutSession`     | `POST /openmeter/customers/{customerId}/billing/stripe/checkout-sessions`                   | Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout) for the customer. Creates a Checkout Session for collecting payment method information from customers. The session operates in "setup" mode, which collects payment details without charging the customer immediately. The collected payment method can be used for future subscription billing. For hosted checkout sessions, redirect customers to the returned URL. For embedded sessions, use the client_secret to initialize Stripe.js in your application. |
 | `client.customers.billing.createStripePortalSession`       | `POST /openmeter/customers/{customerId}/billing/stripe/portal-sessions`                     | Create Stripe Customer Portal Session. Useful to redirect the customer to the Stripe Customer Portal to manage their payment methods, change their billing address and access their invoice history. Only returns URL if the customer billing profile is linked to a stripe app and customer.                                                                                                                                                                                                                                                  |
 | `client.customers.credits.grants.create`                   | `POST /openmeter/customers/{customerId}/credits/grants`                                     | Create a new credit grant. A credit grant represents an allocation of prepaid credits to a customer.                                                                                                                                                                                                                                                                                                                                                                                                                                           |
@@ -162,21 +301,20 @@ The full call path, HTTP route, and a short description are listed below.
 
 ### Entitlements
 
-| Method                                   | HTTP                                                       | Description |
-| ---------------------------------------- | ---------------------------------------------------------- | ----------- |
-| `client.entitlements.listCustomerAccess` | `GET /openmeter/customers/{customerId}/entitlement-access` |             |
+| Method                                   | HTTP                                                       | Description                      |
+| ---------------------------------------- | ---------------------------------------------------------- | -------------------------------- |
+| `client.entitlements.listCustomerAccess` | `GET /openmeter/customers/{customerId}/entitlement-access` | List customer entitlement access |
 
 ### Subscriptions
 
 | Method                                       | HTTP                                                                         | Description                                                                                                                                    |
 | -------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.subscriptions.create`                | `POST /openmeter/subscriptions`                                              |                                                                                                                                                |
-| `client.subscriptions.list`                  | `GET /openmeter/subscriptions`                                               |                                                                                                                                                |
-| `client.subscriptions.get`                   | `GET /openmeter/subscriptions/{subscriptionId}`                              |                                                                                                                                                |
+| `client.subscriptions.create`                | `POST /openmeter/subscriptions`                                              | Create subscription                                                                                                                            |
+| `client.subscriptions.list`                  | `GET /openmeter/subscriptions`                                               | List subscriptions                                                                                                                             |
+| `client.subscriptions.get`                   | `GET /openmeter/subscriptions/{subscriptionId}`                              | Get subscription                                                                                                                               |
 | `client.subscriptions.cancel`                | `POST /openmeter/subscriptions/{subscriptionId}/cancel`                      | Cancels the subscription. Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancelation time. |
 | `client.subscriptions.unscheduleCancelation` | `POST /openmeter/subscriptions/{subscriptionId}/unschedule-cancelation`      | Unschedules the subscription cancelation.                                                                                                      |
 | `client.subscriptions.change`                | `POST /openmeter/subscriptions/{subscriptionId}/change`                      | Closes a running subscription and starts a new one according to the specification. Can be used for upgrades, downgrades, and plan changes.     |
-| `client.subscriptions.createAddon`           | `POST /openmeter/subscriptions/{subscriptionId}/addons`                      | Add add-on to a subscription.                                                                                                                  |
 | `client.subscriptions.listAddons`            | `GET /openmeter/subscriptions/{subscriptionId}/addons`                       | List the add-ons of a subscription.                                                                                                            |
 | `client.subscriptions.getAddon`              | `GET /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}` | Get an add-on association for a subscription.                                                                                                  |
 
@@ -197,33 +335,15 @@ The full call path, HTTP route, and a short description are listed below.
 | `client.billing.updateProfile` | `PUT /openmeter/profiles/{id}`    | Update a billing profile.                                                                                                                                                                                                                                                                                                |
 | `client.billing.deleteProfile` | `DELETE /openmeter/profiles/{id}` | Delete a billing profile. Only such billing profiles can be deleted that are: - not the default profile - not pinned to any customer using customer overrides - only have finalized invoices                                                                                                                             |
 
-### Invoices
-
-| Method                   | HTTP                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                           |
-| ------------------------ | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.invoices.list`   | `GET /openmeter/billing/invoices`                | List billing invoices. Returns a page of invoices. Gathering invoices are never included. Use `filter` to narrow by status, customer, dates, or service period start. Use `sort` to control ordering.                                                                                                                                                                                                                 |
-| `client.invoices.get`    | `GET /openmeter/billing/invoices/{invoiceId}`    | Get a billing invoice by ID. Returns the full invoice resource including line items, status details, totals, and workflow configuration snapshot.                                                                                                                                                                                                                                                                     |
-| `client.invoices.update` | `PUT /openmeter/billing/invoices/{invoiceId}`    | Update a billing invoice. Only the mutable fields of the invoice can be edited: description, labels, supplier, customer, workflow settings, and top-level lines. Top-level lines are matched by `id`; lines without an `id` are created, and existing lines omitted from `lines` are deleted. Detailed (child) lines are always computed and cannot be edited directly. Only invoices in draft status can be updated. |
-| `client.invoices.delete` | `DELETE /openmeter/billing/invoices/{invoiceId}` | Delete a billing invoice. Only standard invoices in draft status can be deleted. Deleting an invoice will also delete all associated line items and workflow configuration.                                                                                                                                                                                                                                           |
-
 ### Tax
 
-| Method                  | HTTP                                      | Description |
-| ----------------------- | ----------------------------------------- | ----------- |
-| `client.tax.createCode` | `POST /openmeter/tax-codes`               |             |
-| `client.tax.getCode`    | `GET /openmeter/tax-codes/{taxCodeId}`    |             |
-| `client.tax.listCodes`  | `GET /openmeter/tax-codes`                |             |
-| `client.tax.upsertCode` | `PUT /openmeter/tax-codes/{taxCodeId}`    |             |
-| `client.tax.deleteCode` | `DELETE /openmeter/tax-codes/{taxCodeId}` |             |
-
-### Currencies
-
-| Method                                   | HTTP                                                        | Description                                                                                                                    |
-| ---------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| `client.currencies.list`                 | `GET /openmeter/currencies`                                 | List currencies supported by the billing system.                                                                               |
-| `client.currencies.createCustomCurrency` | `POST /openmeter/currencies/custom`                         | Create a custom currency. This operation allows defining your own custom currency for billing purposes.                        |
-| `client.currencies.listCostBases`        | `GET /openmeter/currencies/custom/{currencyId}/cost-bases`  | List cost bases for a currency. For custom currencies, there can be multiple cost bases with different `effective_from` dates. |
-| `client.currencies.createCostBasis`      | `POST /openmeter/currencies/custom/{currencyId}/cost-bases` | Create a cost basis for a currency.                                                                                            |
+| Method                  | HTTP                                      | Description     |
+| ----------------------- | ----------------------------------------- | --------------- |
+| `client.tax.createCode` | `POST /openmeter/tax-codes`               | Create tax code |
+| `client.tax.getCode`    | `GET /openmeter/tax-codes/{taxCodeId}`    | Get tax code    |
+| `client.tax.listCodes`  | `GET /openmeter/tax-codes`                | List tax codes  |
+| `client.tax.upsertCode` | `PUT /openmeter/tax-codes/{taxCodeId}`    | Upsert tax code |
+| `client.tax.deleteCode` | `DELETE /openmeter/tax-codes/{taxCodeId}` | Delete tax code |
 
 ### Features
 
@@ -282,21 +402,107 @@ The full call path, HTTP route, and a short description are listed below.
 
 ### Defaults
 
-| Method                                       | HTTP                                | Description |
-| -------------------------------------------- | ----------------------------------- | ----------- |
-| `client.defaults.getOrganizationTaxCodes`    | `GET /openmeter/defaults/tax-codes` |             |
-| `client.defaults.updateOrganizationTaxCodes` | `PUT /openmeter/defaults/tax-codes` |             |
+| Method                                       | HTTP                                | Description                           |
+| -------------------------------------------- | ----------------------------------- | ------------------------------------- |
+| `client.defaults.getOrganizationTaxCodes`    | `GET /openmeter/defaults/tax-codes` | Get organization default tax codes    |
+| `client.defaults.updateOrganizationTaxCodes` | `PUT /openmeter/defaults/tax-codes` | Update organization default tax codes |
+
+## Internal Operations
+
+Operations marked internal in the API definition are exposed under
+`client.internal.*`, quarantined from the customer surface. They are not
+intended for customer use: they may require additional permissions, and
+they can change or be removed without notice or semver consideration.
+
+### Internal Subscriptions
+
+| Method                                      | HTTP                                                    | Description                   |
+| ------------------------------------------- | ------------------------------------------------------- | ----------------------------- |
+| `client.internal.subscriptions.createAddon` | `POST /openmeter/subscriptions/{subscriptionId}/addons` | Add add-on to a subscription. |
+
+### Internal Currencies
+
+| Method                                            | HTTP                                                        | Description                                                                                                                    |
+| ------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `client.internal.currencies.list`                 | `GET /openmeter/currencies`                                 | List currencies supported by the billing system.                                                                               |
+| `client.internal.currencies.createCustomCurrency` | `POST /openmeter/currencies/custom`                         | Create a custom currency. This operation allows defining your own custom currency for billing purposes.                        |
+| `client.internal.currencies.listCostBases`        | `GET /openmeter/currencies/custom/{currencyId}/cost-bases`  | List cost bases for a currency. For custom currencies, there can be multiple cost bases with different `effective_from` dates. |
+| `client.internal.currencies.createCostBasis`      | `POST /openmeter/currencies/custom/{currencyId}/cost-bases` | Create a cost basis for a currency.                                                                                            |
+
+## Runtime Validation (validate option)
+
+`validate` is off by default. The SDK's normal request/response mapping
+only renames keys and converts dates — it never rejects a payload — so
+an additive server-side change (a new response field, a new enum value)
+never breaks a client running an older SDK version.
+
+Set `validate: true` to additionally check the wire payload — the
+request body after mapping to snake_case, and the raw response before
+mapping back — against the generated `…Wire` schemas. Those schemas are
+strict: an unknown field or an unrecognized enum value fails validation
+instead of being silently accepted. That makes `validate` a tool for
+catching SDK/server contract drift in development or CI, not something
+to run in production, where forward compatibility with additive server
+changes matters more than strict rejection.
+
+```typescript
+import { OpenMeter, ValidationError } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+  validate: true,
+})
+
+try {
+  await client.meters.get({ meterId: 'meter_123' })
+} catch (error) {
+  if (error instanceof ValidationError) {
+    console.error(error.issues)
+  }
+}
+```
+
+The standalone functions surface the same failure as a `Result` instead
+of throwing — check `result.error instanceof ValidationError`.
+
+## Zod Schemas (./zod export)
+
+`@openmeter/client/zod` exports every model twice: once shaped like the
+SDK's public surface (camelCase keys, `Date` for date-time fields — the
+same shape `meter.eventType`/`meter.createdAt` have in TypeScript) and
+once as a strict `…Wire` schema shaped like the literal JSON the server
+sends and accepts (snake_case keys, RFC 3339 date-time strings, unknown
+fields rejected) — the same `…Wire` schemas the `validate` option checks
+internally.
+
+Use the public schemas to validate a payload the SDK did not produce —
+a webhook body, a cached record, a test fixture — before trusting its
+shape:
+
+```typescript
+import * as schemas from '@openmeter/client/zod'
 
-### Governance
+const parsed = schemas.meter.safeParse({
+  id: '01HZY3W6VXQK6H3NPC6DFA0PJT',
+  name: 'Tokens',
+  key: 'tokens',
+  aggregation: 'sum',
+  eventType: 'request',
+  createdAt: new Date(),
+  updatedAt: new Date(),
+})
 
-| Method                          | HTTP                               | Description                                                                                                                                                                                                                                                                                                          |
-| ------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.governance.queryAccess` | `POST /openmeter/governance/query` | Query feature access for a list of customers. The endpoint resolves each provided identifier to a customer and returns the access status for the requested features, plus optional credit balance availability. _Designed to be called on a fixed refresh interval and the query response is intended to be cached._ |
+if (parsed.success) {
+  console.log(parsed.data.eventType)
+}
+```
 
 ## Error Handling
 
-A non-2xx response rejects with an `HTTPError` carrying the problem-details
-fields (`status`, `type`, `title`, `url`) from the response.
+A non-2xx response rejects with an `HTTPError` (`error.name === 'HTTPError'`)
+carrying the problem-details fields (`status`, `type`, `title`, `url`)
+from the response.
 
 ```typescript
 import { OpenMeter, HTTPError } from '@openmeter/client'
@@ -315,6 +521,46 @@ try {
 }
 ```
 
+`error.retryAfter` is the delta-seconds form of a numeric `Retry-After`
+header (the common case on 429 and 503 responses) and `undefined`
+otherwise. A 400 Bad Request additionally carries a typed
+`error.invalidParameters` array describing which fields failed
+validation; `error.getField(key)` is an untyped escape hatch for any
+other problem-details extension member:
+
+```typescript
+import { OpenMeter, HTTPError } from '@openmeter/client'
+
+const client = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+})
+
+try {
+  await client.meters.create({
+    name: 'Tokens',
+    key: 'tokens',
+    aggregation: 'sum',
+    eventType: 'request',
+  })
+} catch (error) {
+  if (error instanceof HTTPError && error.status === 400) {
+    for (const param of error.invalidParameters ?? []) {
+      console.error(param)
+    }
+  }
+}
+```
+
+The SDK's other typed errors are `ValidationError` (see
+[Runtime Validation (validate option)](#runtime-validation-validate-option)), `UnsafeIntegerError`
+(an `int64`/`uint64` value exceeds what JSON can represent without
+precision loss), `DepthLimitExceededError` (response data nested deeper
+than the mapper's safety limit), and `PaginationLimitExceededError` (an
+[Pagination](#pagination) iterable exceeded
+its page-count safety limit) — each distinguished the same way, by
+`instanceof` or by `.name`.
+
 ## Standalone Functions
 
 Every method is also available as a standalone, tree-shakeable function
@@ -335,3 +581,18 @@ if (result.ok) {
   console.error(result.error)
 }
 ```
+
+`ok`, `err`, and `unwrap` — the helpers `Result` is built from — are
+exported too, so a func call can be unwrapped back into a throwing call
+where that is more convenient:
+
+```typescript
+import { Client, funcs, unwrap } from '@openmeter/client'
+
+const client = new Client({
+  baseUrl: 'https://openmeter.cloud/api/v3',
+  apiKey: process.env.OPENMETER_API_KEY,
+})
+
+const meters = unwrap(await funcs.listMeters(client))
+```

package/dist/core.d.ts

@@ -7,4 +7,3 @@ export declare class Client {
 }
 export declare function http(client: Client): HTTPClient;
 export type { HTTPClient };
-//# sourceMappingURL=core.d.ts.map

package/dist/core.js

@@ -1,5 +1,7 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import ky from 'ky';
 import { encodePath } from './lib/encodings.js';
+import { SDK_VERSION } from './lib/version.js';
 export class Client {
     _options;
     _http;
@@ -20,6 +22,12 @@ export class Client {
                 beforeRequest: [
                     ...(options.hooks?.beforeRequest ?? []),
                     async ({ request }) => {
+                        // Browsers treat User-Agent as a forbidden header and silently drop
+                        // it; that's fine here, this is only observable server-side (e.g.
+                        // request logs) and Node/server callers get it.
+                        if (!request.headers.has('User-Agent')) {
+                            request.headers.set('User-Agent', `openmeter-node/${SDK_VERSION}`);
+                        }
                         const token = typeof options.apiKey === 'function'
                             ? await options.apiKey()
                             : options.apiKey;
@@ -35,4 +43,3 @@ export class Client {
 export function http(client) {
     return client._http;
 }
-//# sourceMappingURL=core.js.map

package/dist/funcs/addons.d.ts

@@ -1,11 +1,59 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
 import type { ListAddonsRequest, ListAddonsResponse, CreateAddonRequest, CreateAddonResponse, UpdateAddonRequest, UpdateAddonResponse, GetAddonRequest, GetAddonResponse, DeleteAddonRequest, DeleteAddonResponse, ArchiveAddonRequest, ArchiveAddonResponse, PublishAddonRequest, PublishAddonResponse } from '../models/operations/addons.js';
+/**
+ * List add-ons
+ *
+ * List all add-ons.
+ *
+ * GET /openmeter/addons
+ */
 export declare function listAddons(client: Client, req?: ListAddonsRequest, options?: RequestOptions): Promise<Result<ListAddonsResponse>>;
+/**
+ * Create add-on
+ *
+ * Create a new add-on.
+ *
+ * POST /openmeter/addons
+ */
 export declare function createAddon(client: Client, req: CreateAddonRequest, options?: RequestOptions): Promise<Result<CreateAddonResponse>>;
+/**
+ * Update add-on
+ *
+ * Update an add-on by id.
+ *
+ * PUT /openmeter/addons/{addonId}
+ */
 export declare function updateAddon(client: Client, req: UpdateAddonRequest, options?: RequestOptions): Promise<Result<UpdateAddonResponse>>;
+/**
+ * Get add-on
+ *
+ * Get add-on by id.
+ *
+ * GET /openmeter/addons/{addonId}
+ */
 export declare function getAddon(client: Client, req: GetAddonRequest, options?: RequestOptions): Promise<Result<GetAddonResponse>>;
+/**
+ * Soft delete add-on
+ *
+ * Soft delete add-on by id.
+ *
+ * DELETE /openmeter/addons/{addonId}
+ */
 export declare function deleteAddon(client: Client, req: DeleteAddonRequest, options?: RequestOptions): Promise<Result<DeleteAddonResponse>>;
+/**
+ * Archive add-on version
+ *
+ * Archive an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/archive
+ */
 export declare function archiveAddon(client: Client, req: ArchiveAddonRequest, options?: RequestOptions): Promise<Result<ArchiveAddonResponse>>;
+/**
+ * Publish add-on version
+ *
+ * Publish an add-on version.
+ *
+ * POST /openmeter/addons/{addonId}/publish
+ */
 export declare function publishAddon(client: Client, req: PublishAddonRequest, options?: RequestOptions): Promise<Result<PublishAddonResponse>>;
-//# sourceMappingURL=addons.d.ts.map