@klappay/types 1.0.4 → 1.0.6

package/README.md

@@ -1,16 +1,16 @@
-<img src="https://raw.githubusercontent.com/klappay/.github/refs/heads/main/profile/logo.png" alt="Klap" width="80" />
+<img src="https://raw.githubusercontent.com/klappay/.github/refs/heads/main/profile/logo.png" alt="Klappay" width="80" />
 
 # @klappay/types
 
-TypeScript types and [Zod](https://zod.dev) schemas for the Klap Core
+TypeScript types and [Zod](https://zod.dev) schemas for the Klappay Core
 API — the request/response contracts for creating charges, managing
 webhooks, and everything else the API exposes. Published separately from
 the API implementation itself (which is closed-source) so integrators get
-accurate, versioned types without needing access to Klap's own codebase.
+accurate, versioned types without needing access to Klappay's own codebase.
 
-Klap is a non-custodial crypto payments API — a merchant creates a
-charge, Klap predicts a deterministic on-chain address for it, the payer
-sends funds directly to that address, and Klap detects and distributes the
+Klappay is a non-custodial crypto payments API — a merchant creates a
+charge, Klappay predicts a deterministic on-chain address for it, the payer
+sends funds directly to that address, and Klappay detects and distributes the
 payment without ever holding the funds itself.
 
 ## Install
@@ -66,6 +66,7 @@ actually exported.
 | [Webhooks](https://api.klappay.com/types/webhooks) | Every `WebhookEventType`, categories, `Webhook`, `WebhookPayload`, `TypedWebhookPayload` |
 | [Sandbox](https://api.klappay.com/types/sandbox) | `SandboxTriggerInput`, `SandboxEventTriggerInput`, `TriggerableChargeEvent` |
 | [Distributions](https://api.klappay.com/types/distributions) | `PendingDistribution`, `PendingDistributionEvent` — the 0xSplits keeper feed |
+| [Metrics query](https://api.klappay.com/types/metrics-query) | `MetricsQuerySchema`, `MetricsQueryResult` — the ad-hoc analytics query endpoint |
 | [Auth & accounts](https://api.klappay.com/types/auth-and-accounts) | Signup/login, email verification, password reset, `ApiKey`, `User`/`UserRole`, `Organization` |
 | [Tokens & networks](https://api.klappay.com/types/tokens-and-networks) | `Token`, `Network`, and every chain/token constant |
 | [Errors & health](https://api.klappay.com/types/errors-and-health) | `ErrorPayload` (every non-2xx response shape), `Health` |
@@ -103,7 +104,7 @@ app.post('/webhooks/klap', (req, res) => {
 ```
 
 Note: this package only validates the *shape* of a webhook payload — it
-does not verify the `X-Klap-Signature` HMAC header, which you must still
+does not verify the `X-Klappay-Signature` HMAC header, which you must still
 check yourself against the signing secret returned when you created the
 webhook. Validating shape without verifying the signature means anyone
 who can reach your endpoint can send you a structurally-valid payload.
@@ -127,5 +128,5 @@ what changed release to release.
 
 MIT — see the
 [`LICENSE`](https://unpkg.com/@klappay/types/LICENSE) file included in
-this package. This applies to this package only; the Klap Core API
+this package. This applies to this package only; the Klappay Core API
 implementation itself is closed-source.