Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Internal documentation. Working drafts under review — nothing here is a public commitment, and the Legal section has not been reviewed by a lawyer.
Event → conditions (profile attrs, segment/tier membership, aggregates, frequency) → effects (parametric rule_effect_types, is_system seed: award_points, issue_coupon, send_webhook, trigger_campaign; F2 row: apply_discount per DEC-H4).
| Table | Key invariants |
|---|---|
| programs | program_id on EVERY loyalty table from migration 1; tenant-named, full CRUD, count gated by entitlement; default program auto-created and resolved when a request omits it (ADR-021) |
| point_currencies | ≥2 per program: redeemable + status; never mixed (ADR-011) |
| ledger_transactions | append-only; parametric types earn|redeem|expire|revoke|adjust; pending→available after tenant return window |
| point_lots | FIFO consumption; expiration rolling|end_of_month|end_of_year, tier-overridable; expiring_soon scan (cron fan-out) |
| contact_balances | projection, SAME transaction as ledger write; nightly drift reconciliation (freshness add-on raises reconciliation frequency only) |
| rule_campaigns / rules | versioned; condition AST (JSON) + effects; budgets total & per-contact; publishing invalidates compiled-rules cache |
| rewards | parametric reward_types (tenant-extensible); cost_points; catalog per program |
| coupon_campaigns / coupon_codes | unique-code mass generation (F1b) or generic; states issued→redeemed|expired|void |
| redemptions | parent/child from day 1; Idempotency-Key mandatory; rollback parent-level revert|keep; money_component nullable (mixed points+money seam, DEC-H3 — F1 unused) |
| stacking_rules | F1b UI; ALL vs PARTIAL policy; discount categories + hierarchy; non-combinable sets |
| referral_codes / referral_conversions | double-sided reward released on qualifying event (first PAID purchase, never signup); fraud flags: self-referral, velocity, device/IP heuristics |
| tier_definitions / tier_memberships | qualification_metric: points_earned|spend|event_count; qualification window rolling|calendar; explicit downgrade policy + grace period; tier_overrides (earning multipliers, reward pricing, expiration) — schema day 1, UI F1b |
| badges / challenges | reserved schema, F2 (strategic gamification: goal-gradient, endowed progress) |