@clocknext/sdk 0.17.0 → 0.19.0

package/README.md

@@ -561,7 +561,8 @@ await cnk.customers.unitBalance(customerId, { unitName: "Seats" });
 let cursor: string | undefined;
 do {
   const page = await cnk.signals.usageLog({ customerId, limit: 50, cursor });
-  // page.usageLogs — each row has a `kind`: credit | outcome | unit | wallet | composite
+  // page.usageLogs — each row has a `type`: credit | outcome | unit | wallet | composite,
+  // and `custom`: the `custom` object sent on the signal (or null)
   cursor = page.nextCursor ?? undefined;
 } while (cursor);
 ```
@@ -617,6 +618,43 @@ wallet.reservedBalance; // number | undefined
 
 When the feature is off, `wallet.reservedBalance` is left out of `balances()`.
 
+### Wallet ledger
+
+`customers.wallet()` lists every movement of wallet money, newest first, with
+both balances. Each row's `source` says what caused it:
+
+| `source` | Meaning |
+|---|---|
+| `SUBSCRIPTION` | Wallet money from a new plan purchase |
+| `RENEWAL` | Wallet money from a plan renewal, or unused money removed at renewal |
+| `MANUAL` | Changed in the ClockNext dashboard |
+| `API` | Changed with `adjustWallet()` |
+| `CUSTOMER_PORTAL` | Top-up paid by the customer in the customer portal |
+| `USAGE_LOG` | Charged by a signal; `usageLogId` links the signal |
+| `INVOICE_SETTLEMENT` | Usage cleared by a paid pay-as-you-go invoice |
+| `INVOICE_VOID` | Settlement undone by a voided invoice |
+
+On a `USAGE_LOG` row, `usageLogId` is the id of the matching row in
+`signals.usageLog()`, so each charge links to the exact signal that caused it.
+`notes` is only text a person wrote — your own note on an `API` row, the
+admin's note on a `MANUAL` row — and `null` on every row the system writes.
+
+```ts
+const page = await cnk.customers.wallet(customerId, { from: "2026-10-01", to: "2026-10-07" });
+page.balanceUsd;          // ordinary wallet, USD
+page.reservedBalanceUsd;  // Reserved Wallet, or null when the feature is off
+
+for (const t of page.transactions) {
+  // t.type: "CREDIT" | "DEBIT"; t.amount is always positive
+  // t.entitlementType: "CREDIT" | "OUTCOME" | "UNIT" | "COMPOSITE" | null
+}
+
+// Every row, across all pages — pick out the signal charges:
+for await (const t of cnk.customers.iterateWallet(customerId)) {
+  if (t.source === "USAGE_LOG") console.log(t.usageLogId, t.amountUsd);
+}
+```
+
 To change how much a customer is granted **every billing cycle** (not just
 their balance right now), use `updateRecurringGrant`. Any increase or decrease
 applies to their balance immediately. `quantity` is USD for the wallet and a
@@ -655,9 +693,10 @@ cnk.customers.get / update / delete / iterate
 cnk.customers.getByExternalId / updateByExternalId / updateRecurringGrantByExternalId
 cnk.customers.adjustCreditByExternalId / adjustOutcomeByExternalId / adjustUnitByExternalId
 cnk.customers.adjustCompositeByExternalId / adjustWalletByExternalId
-cnk.customers.deleteByExternalId / balancesByExternalId / planByExternalId
+cnk.customers.deleteByExternalId / balancesByExternalId / planByExternalId / walletByExternalId
 cnk.customers.listMembers / addMember / updateMember / removeMember
 cnk.customers.balances / creditBalance / outcomeBalance / unitBalance / plan
+cnk.customers.wallet / iterateWallet
 cnk.customers.adjustCredit / adjustOutcome / adjustUnit / adjustComposite / adjustWallet
 cnk.customers.updateRecurringGrant
 
@@ -774,6 +813,42 @@ await cnk.units.unarchive(unit.id);                         // and bring it back
 Models are enabled in the ClockNext dashboard. A bundle line names its model by
 `modelId` — the same id you send as `usage.model` on a signal.
 
+## Taxes
+
+`cnk.taxes` manages the tax rates charged to your customers by billing country
+— the same rates as **Settings → Taxes** in the dashboard. Every active tax for
+a customer's country is applied to their invoices and portal purchases
+automatically; a customer with no country is charged no tax.
+
+It has four calls: `list()`, `get(id)`, `create(input)` and `update(id, input)`.
+
+- **`behavior` is lower case:** `"inclusive"` (already inside the price) or
+  `"exclusive"` (added on top).
+- **`countryCode`** is a 2-letter ISO code (`"IN"`, `"GB"`); lower case is
+  accepted, a country name is refused.
+- **No duplicates:** two active taxes can't share a name (ignoring case) in the
+  same country — that's a `ConflictError`.
+- **`update()` is partial**, and only affects invoices issued afterwards —
+  issued invoices keep the tax they were issued with.
+- **Archiving is dashboard-only.** There is no `archive()` / `unarchive()` /
+  `delete()`; an archived tax reads back with `isActive: false` and can still
+  be updated.
+
+```ts
+const gst = await cnk.taxes.create({
+  name: "GST",
+  percentage: 18,
+  countryCode: "IN",
+  behavior: "exclusive",
+  description: "India GST",
+});
+
+const active = await cnk.taxes.list({ active: true }); // omit for archived ones too
+const one = await cnk.taxes.get(gst.id);
+
+await cnk.taxes.update(gst.id, { percentage: 12 }); // only the percentage changes
+```
+
 ## Customer portal
 
 ```ts

package/dist/index.cjs

@@ -333,7 +333,7 @@ function sleep(ms) {
 }
 
 // src/http.ts
-var SDK_VERSION = "0.17.0" ;
+var SDK_VERSION = "0.19.0" ;
 var Transport = class {
   constructor(cfg) {
     this.cfg = cfg;
@@ -682,6 +682,47 @@ var Customers = class {
       path: `/api/v1/customers/${encodeURIComponent(id)}/balances`
     });
   }
+  /**
+   * One page of the customer's wallet ledger — every movement of wallet
+   * money, newest first — plus both wallet balances. Cursor-paginated: pass
+   * back `nextCursor` as `cursor`. `GET /api/v1/customers/:id/wallet`.
+   */
+  wallet(id, params = {}) {
+    return this.walletPage(`/api/v1/customers/${encodeURIComponent(id)}/wallet`, params);
+  }
+  /** {@link wallet}, addressing the customer by its `externalId`.
+   *  `GET /api/v1/customers/ext/:externalId/wallet`. */
+  walletByExternalId(externalId, params = {}) {
+    return this.walletPage(
+      `/api/v1/customers/ext/${encodeURIComponent(externalId)}/wallet`,
+      params
+    );
+  }
+  /**
+   * Async iterator over the customer's WHOLE wallet ledger, newest first,
+   * following the cursor. `params.cursor` is ignored.
+   * `for await (const t of cnk.customers.iterateWallet(id)) { … }`
+   */
+  async *iterateWallet(id, params = {}) {
+    let cursor;
+    do {
+      const page = await this.wallet(id, { ...params, cursor });
+      for (const t of page.transactions) yield t;
+      cursor = page.nextCursor ?? void 0;
+    } while (cursor);
+  }
+  walletPage(path, params) {
+    return this.transport.request({
+      method: "GET",
+      path,
+      query: {
+        limit: params.limit,
+        cursor: params.cursor,
+        from: params.from,
+        to: params.to
+      }
+    });
+  }
   /** {@link balances}, addressing the customer by its `externalId`.
    *  `GET /api/v1/customers/ext/:externalId/balances`. */
   balancesByExternalId(externalId) {
@@ -1306,6 +1347,7 @@ var Signals = class {
         ...customerRefToWire(input),
         runId: input.runId,
         ...input.member ? { member: input.member } : {},
+        ...input.custom ? { custom: input.custom } : {},
         idempotencyKey
       },
       retry: true
@@ -1343,6 +1385,7 @@ var Signals = class {
         ...input.quantity != null ? { quantity: input.quantity } : {},
         ...input.member ? { member: input.member } : {},
         ...input.composite ? { composite: { [input.composite.ref]: input.composite.value } } : {},
+        ...input.custom ? { custom: input.custom } : {},
         // Assigned HERE, before the send, so the SAME key rides every
         // transport-level retry below. Without it a single 500 followed by a
         // success is TWO un-keyed reports, and the server dedups on the key —
@@ -1397,6 +1440,7 @@ var Signals = class {
       body: {
         ...customerRefToWire(input),
         composite: { [input.composite.ref]: input.composite.value },
+        ...input.custom ? { custom: input.custom } : {},
         // Auto-assigned like the others. A retry here could not double-BILL
         // even without it — closing a closed occurrence is a server-side
         // no-op — but that safety comes from occurrence-level dedup, not from
@@ -1441,7 +1485,6 @@ var Signals = class {
         customerId: params.customerId,
         limit: params.limit,
         cursor: params.cursor,
-        period: params.period,
         from: params.from,
         to: params.to
       }
@@ -1513,6 +1556,54 @@ var Units = class {
   }
 };
 
+// src/resources/taxes.ts
+var Taxes = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  /** List them, oldest first. `{ active: true }` returns only active ones,
+   *  `{ active: false }` only archived ones; omit it for both. */
+  async list(params = {}) {
+    const res = await this.transport.request({
+      method: "GET",
+      path: "/api/v1/taxes",
+      query: { active: activeQuery(params.active) }
+    });
+    return filterByActive(res.taxes, params.active);
+  }
+  /** One tax. */
+  async get(id) {
+    const res = await this.transport.request({
+      method: "GET",
+      path: `/api/v1/taxes/${encodeURIComponent(id)}`
+    });
+    return res.tax;
+  }
+  /** Create one. It starts active. Two active taxes can't share a name
+   *  (ignoring case) in the same country — that's a `ConflictError`. Not
+   *  retried on failure — a retry could create a second row. */
+  async create(input) {
+    const res = await this.transport.request({
+      method: "POST",
+      path: "/api/v1/taxes",
+      body: input
+    });
+    return res.tax;
+  }
+  /** PARTIAL update: only the fields you send change. Archived taxes can be
+   *  edited and stay archived. Only invoices issued afterwards use the new
+   *  values. */
+  async update(id, input) {
+    const res = await this.transport.request({
+      method: "PATCH",
+      path: `/api/v1/taxes/${encodeURIComponent(id)}`,
+      body: input
+    });
+    return res.tax;
+  }
+};
+
 // src/client.ts
 var ClockNext = class {
   /** Record usage signals (credit / wallet / outcome / unit) and read the usage log. */
@@ -1529,6 +1620,8 @@ var ClockNext = class {
   units;
   /** Composites: list, get, create, update, archive, unarchive (no delete). */
   composites;
+  /** Tax rates by country: list, get, create, update (archive in the dashboard). */
+  taxes;
   /** Subscribe customers to plans (purchases). */
   purchases;
   /** Read invoices and mint hosted pay links. */
@@ -1555,6 +1648,7 @@ var ClockNext = class {
     this.outcomes = new Outcomes(transport);
     this.units = new Units(transport);
     this.composites = new Composites(transport);
+    this.taxes = new Taxes(transport);
     this.purchases = new Purchases(transport);
     this.invoices = new Invoices(transport);
     this.payments = new Payments(transport);