George Lambert
ddf772454b
Some checks are pending
offline / test (push) Waiting to run
Persist account-balance books; edge caches prepaid from books. Add zappier-identity, verae-nats-accounts, verae-jobs-events, verae-access-staff, zapier-decisions. Edge binds loopback; lan-134 stays off; HTTP services prefer local spawn.
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# `zappier/ledger`
|
||
|
||
**Package:** `zappier`
|
||
**Source:** `packages/zappier/src/ledger.ts`
|
||
**Lines:** 51
|
||
|
||
## What this module is
|
||
|
||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||
|
||
## Exports
|
||
|
||
`PrepaidRow`, `booksConfigured`, `ledgerAdjust`, `ledgerStatement`
|
||
|
||
## Types / interfaces / classes
|
||
|
||
| Kind | Name |
|
||
|------|------|
|
||
| type | `PrepaidRow` |
|
||
|
||
## Functions
|
||
|
||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||
|------|------------|---------------------|---------|-----------------------------|
|
||
| `booksUrl` | `(none)` | — | `unknown` | see Call graph |
|
||
| `booksConfigured` | `(none)` | — | `unknown` | see Call graph |
|
||
| `ledgerAdjust` | `row: PrepaidRow, plane: AccessPlane` | — | `unknown` | see Call graph |
|
||
| `ledgerStatement` | `customerId: string, plane: AccessPlane, veraeUserId?: string` | — | `unknown` | see Call graph |
|
||
|
||
## Methods (class / object)
|
||
|
||
| Name | Parameters |
|
||
|------|------------|
|
||
| `return` | `process.env.ACCOUNT_BALANCE_URL || ''` |
|
||
| `return` | `await r.json(` |
|
||
|
||
## What it imports / requires
|
||
|
||
- `./billing-nats`
|
||
|
||
## Call graph (identifiers invoked)
|
||
|
||
`booksUrl`, `replace`, `booksConfigured`, `ledgerAdjust`, `natsAdjust`, `fetch`, `stringify`, `json`, `ledgerStatement`, `natsStatement`, `encodeURIComponent`
|
||
|
||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||
|
||
## Return values (how to read this)
|
||
|
||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||
|