master-zapier-plan-draft/docs/models/README.md
George Lambert 10c663cc0c Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log
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.
2026-09-09 02:44:51 -04:00

1,016 B

Data models

Each model has its own MD, Sphinx RST, and PDF under docs/models/ and docs/models-pdf/.

Model Defined in Role
PriceRule packages/zappier/src/pricing.ts free / fixed / variable list price
TierConfig pricing.ts multiplier + monthly credit
RateCard pricing.ts map of operationId → PriceRule
Quote pricing.ts listCents, totalCents, breakdown
CallUsage pricing.ts metadataBytes, attachmentBytes
Customer packages/zappier/src/auth.ts id, tierId, apiKey
AddNumbersResult packages/verae-activate/creates/add_numbers.js number1, number2, sum, mode
TimestampRequest Verae OpenAPI data, hashAlg
TimestampResponse Verae OpenAPI jobId
StatusResponse Verae OpenAPI id, status, result, metadata