George Lambert
10c663cc0c
74 source modules documented with extracted signatures, JSDoc params, imports, and call graphs. 10 first-class models (PriceRule through StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf. Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS. Learned: RST includes are relative to the RST file; keep one PDF per module; Add Numbers remains the only push required tomorrow.
60 lines
2 KiB
Markdown
60 lines
2 KiB
Markdown
# `zappier/billing/stripe`
|
||
|
||
**Package:** `zappier`
|
||
**Source:** `packages/zappier/src/billing/stripe.ts`
|
||
**Lines:** 42
|
||
|
||
## What this module is
|
||
|
||
Implementation module in `zappier`. The tables below are extracted from the source (signatures + JSDoc).
|
||
|
||
## Exports
|
||
|
||
`METER_EVENT_NAME`, `MeterEventClient`, `computeBillableCents`, `computeDelta`, `reportUsage`
|
||
|
||
## Types / interfaces / classes
|
||
|
||
| Kind | Name |
|
||
|------|------|
|
||
| interface | `MeterEventClient` |
|
||
|
||
## Functions
|
||
|
||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||
|------|------------|---------------------|---------|-----------------------------|
|
||
| `computeBillableCents` | `entries: UsageEntry[], monthlyCreditCents: number` | — | `unknown` | see Call graph |
|
||
| | _Stripe-side dedup key; events with the same identifier are dropped._ | | | |
|
||
| `computeDelta` | `billableCents: number, previouslyReportedCents: number` | — | `unknown` | see Call graph |
|
||
| `reportUsage` | `client: MeterEventClient,
|
||
stripeCustomerId: string,
|
||
entries: UsageEntry[],
|
||
monthlyCreditCents: number,` | — | `unknown` | see Call graph |
|
||
|
||
## Methods (class / object)
|
||
|
||
| Name | Parameters |
|
||
|------|------------|
|
||
| `createMeterEvent` | `params: {
|
||
eventName: string;
|
||
customerId: string;
|
||
value: string;
|
||
/** Stripe-side dedup key; events with the same identifier are dropped. */
|
||
identifier?: string;
|
||
}` |
|
||
|
||
## What it imports / requires
|
||
|
||
- `../usage`
|
||
|
||
## Call graph (identifiers invoked)
|
||
|
||
`createMeterEvent`, `computeBillableCents`, `reduce`, `max`, `computeDelta`, `ts`, `reportUsage`
|
||
|
||
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`.
|
||
|