@ingenx-io/valets-schema-mcp-server 0.2.2 → 0.2.4

package/README.md

@@ -45,6 +45,32 @@ claude mcp add valets-schema -- npx -y @ingenx-io/valets-schema-mcp-server
 | `list_decisions` | All data model decisions (D00–D37+) with status and summary |
 | `get_decision` | Full details for a specific decision by ID (e.g. `D12`) |
 | `get_openapi` | OpenAPI 3.1 spec — full or filtered to a single component (e.g. `Order`, `OrderCreate`) |
+| `get_guidance` | Use-case recipes: tool call sequences, field constraint cheatsheets, and workaround notes. Call with no args for the index, or pass a `slug` for the full recipe. |
+
+## Cookbook
+
+`get_guidance` exposes a set of use-case recipes — each one describes the right sequence of MCP tool calls for a specific task.
+
+### Available recipes
+
+| Slug | When to use |
+|------|-------------|
+| `write-model-code` | You need to read or write a Firestore document and want to know which fields are server-set, immutable, or deprecated. |
+| `field-history` | You found a field and want to understand why it exists, what decision drove it, and whether it's been migrated. |
+| `whatsapp-conversation-display` | You need to render a per-order WhatsApp message thread. Uses `NotificationRecord` as a workaround (outbound only). |
+
+### Example usage
+
+```
+# Get the index
+get_guidance()
+
+# Get a specific recipe
+get_guidance(slug="write-model-code")
+get_guidance(slug="whatsapp-conversation-display")
+```
+
+Each recipe returns JSON with ordered `steps` (tool + args + note), tips, and any relevant caveats or cheatsheets.
 
 ## Resources
 

package/data/docs/collections/firestore-paths.md

@@ -11,6 +11,8 @@ All collections are scoped under a company document. Per **D40**, a `sites/{site
 ```
 companies/{companyId}/
 ├── orders/{orderId}                     ← Order.siteId? (D43 / ADR-003) attributes to a site
+│   └── notifications/{notifId}          ← GH#48 — order-scoped notification log (dual-write)
+├── notifications/{notifId}              ← GH#48 — company-wide notification audit log
 ├── customers/{customerId}
 ├── bookings/{bookingId}
 │   └── sessions/{sessionId}
@@ -104,6 +106,19 @@ whatsapp_templates/{waba__name__language}            ← GH#43 — Meta-approved
 
 **Field ownership on `whatsapp_outbound_messages`:** the dashboard writes `to, waba, wabaId, kind, text/template, purpose?, orderUuid?, sentBy, createdAt` once with `status: 'queued'` (all `x-immutable`); the backend owns every server-set field after — `status` transitions plus `wamid, error, sentAt, deliveredAt, readAt, failedAt` (all `readOnly`). No WABA credentials live in the dashboard.
 
+## Notifications (GH#48)
+
+`NotificationRecord` is a backend-written, multi-channel (email / whatsapp / sms / push) audit log. It is written by Firebase Cloud Functions and **read-only** for consumers (registered server-owned, no Create/Update variant).
+
+| Collection | When written | Notes |
+|---|---|---|
+| `companies/{cid}/notifications/{id}` | **Always** | Company-wide audit log for every notification |
+| `companies/{cid}/orders/{oid}/notifications/{id}` | **Only when** `relatedEntity.type === 'order'` | Dual-write (`Promise.all`) of the same record; enables O(1) per-order history and same-sender WhatsApp threading |
+
+For non-order entities (`magic_link`, `booking`, `digest`, …) only the company-wide collection is written. The same document ID is used in both copies.
+
+**Distinct from `whatsapp_outbound_messages` (GH#43):** that is a top-level, dashboard-initiated, whatsapp-only send queue; this is a company-scoped, backend-written, multi-channel audit trail.
+
 ## Security rules pattern
 
 ```

package/data/docs/enums/attention-status.md

@@ -21,4 +21,4 @@ Must be one of:
 * "ESCALATED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/booking-status.md

@@ -23,4 +23,4 @@ Must be one of:
 * "COMPLETED_MIXED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/customer-payment-status.md

@@ -23,4 +23,4 @@ Must be one of:
 * "CANCELLED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/customer-payment-target-type.md

@@ -20,4 +20,4 @@ Must be one of:
 * "PURCHASE"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/delivery-type.md

@@ -20,4 +20,4 @@ Must be one of:
 * "DELIVERY"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/deployment-link-type.md

@@ -23,4 +23,4 @@ Must be one of:
 * "other"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/event-status.md

@@ -21,7 +21,7 @@ Must be one of:
 * "COMPLETED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/fulfillment-status.md

@@ -23,7 +23,7 @@ Must be one of:
 * "PICKED_UP"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/loyalty-transaction-type.md

@@ -23,7 +23,7 @@ Must be one of:
 * "REFUND"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/notification-channel.md

@@ -0,0 +1,24 @@
+---
+title: "NotificationChannel"
+sidebar_label: "NotificationChannel"
+sidebar_position: 10
+---
+
+# NotificationChannel
+
+|                |                                    |
+| -------------- | ---------------------------------- |
+| **Type**       | `enum (of string)`                 |
+| **Required**   | No                                 |
+| **Defined in** | #/definitions/notification-channel |
+
+**Description:** Delivery channel of a NotificationRecord (GH#48).
+
+Must be one of:
+* "email"
+* "whatsapp"
+* "sms"
+* "push"
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/notification-entity-type.md

@@ -0,0 +1,26 @@
+---
+title: "NotificationEntityType"
+sidebar_label: "NotificationEntityType"
+sidebar_position: 11
+---
+
+# NotificationEntityType
+
+|                |                                        |
+| -------------- | -------------------------------------- |
+| **Type**       | `enum (of string)`                     |
+| **Required**   | No                                     |
+| **Defined in** | #/definitions/notification-entity-type |
+
+**Description:** Type of entity a NotificationRecord relates to. When `order`, the record is dual-written to the order-scoped subcollection (GH#48).
+
+Must be one of:
+* "order"
+* "booking"
+* "customer"
+* "digest"
+* "magic_link"
+* "other"
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/notification-status.md

@@ -0,0 +1,23 @@
+---
+title: "NotificationStatus"
+sidebar_label: "NotificationStatus"
+sidebar_position: 12
+---
+
+# NotificationStatus
+
+|                |                                   |
+| -------------- | --------------------------------- |
+| **Type**       | `enum (of string)`                |
+| **Required**   | No                                |
+| **Defined in** | #/definitions/notification-status |
+
+**Description:** Delivery status of a NotificationRecord, set by the Cloud Function after a send attempt (GH#48).
+
+Must be one of:
+* "sent"
+* "failed"
+* "pending"
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/order-status.md

@@ -1,7 +1,7 @@
 ---
 title: "OrderStatus"
 sidebar_label: "OrderStatus"
-sidebar_position: 10
+sidebar_position: 13
 ---
 
 # OrderStatus
@@ -24,7 +24,7 @@ Must be one of:
 * "EXPIRED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/outbound-message-format.md

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessageFormat"
 sidebar_label: "OutboundMessageFormat"
-sidebar_position: 11
+sidebar_position: 14
 ---
 
 # OutboundMessageFormat
@@ -19,4 +19,4 @@ Must be one of:
 * "template"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/outbound-message-purpose.md

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessagePurpose"
 sidebar_label: "OutboundMessagePurpose"
-sidebar_position: 12
+sidebar_position: 15
 ---
 
 # OutboundMessagePurpose
@@ -21,4 +21,4 @@ Must be one of:
 * "conversational"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/outbound-message-status.md

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessageStatus"
 sidebar_label: "OutboundMessageStatus"
-sidebar_position: 13
+sidebar_position: 16
 ---
 
 # OutboundMessageStatus
@@ -22,4 +22,4 @@ Must be one of:
 * "failed"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/payment-method.md

@@ -1,7 +1,7 @@
 ---
 title: "PaymentMethod"
 sidebar_label: "PaymentMethod"
-sidebar_position: 14
+sidebar_position: 17
 ---
 
 # PaymentMethod
@@ -27,7 +27,7 @@ Must be one of:
 * "OTHER"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/payment-proof-status.md

@@ -1,7 +1,7 @@
 ---
 title: "PaymentProofStatus"
 sidebar_label: "PaymentProofStatus"
-sidebar_position: 15
+sidebar_position: 18
 ---
 
 # PaymentProofStatus
@@ -20,4 +20,4 @@ Must be one of:
 * "REJECTED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/payment-status.md

@@ -1,7 +1,7 @@
 ---
 title: "PaymentStatus"
 sidebar_label: "PaymentStatus"
-sidebar_position: 16
+sidebar_position: 19
 ---
 
 # PaymentStatus
@@ -24,7 +24,7 @@ Must be one of:
 * "PARTIALLY_REFUNDED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/pending-issue.md

@@ -1,7 +1,7 @@
 ---
 title: "PendingIssue"
 sidebar_label: "PendingIssue"
-sidebar_position: 17
+sidebar_position: 20
 ---
 
 # PendingIssue
@@ -28,4 +28,4 @@ Must be one of:
 * "NO_SHOW_UNRESOLVED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/return-status.md

@@ -1,7 +1,7 @@
 ---
 title: "ReturnStatus"
 sidebar_label: "ReturnStatus"
-sidebar_position: 18
+sidebar_position: 21
 ---
 
 # ReturnStatus
@@ -23,7 +23,7 @@ Must be one of:
 * "EXCHANGE_COMPLETED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/session-status.md

@@ -1,7 +1,7 @@
 ---
 title: "SessionStatus"
 sidebar_label: "SessionStatus"
-sidebar_position: 19
+sidebar_position: 22
 ---
 
 # SessionStatus
@@ -23,7 +23,7 @@ Must be one of:
 * "CANCELLED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/site-status.md

@@ -1,7 +1,7 @@
 ---
 title: "SiteStatus"
 sidebar_label: "SiteStatus"
-sidebar_position: 20
+sidebar_position: 23
 ---
 
 # SiteStatus
@@ -21,4 +21,4 @@ Must be one of:
 * "ARCHIVED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/stocktake-frequency.md

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeFrequency"
 sidebar_label: "StocktakeFrequency"
-sidebar_position: 21
+sidebar_position: 24
 ---
 
 # StocktakeFrequency
@@ -21,4 +21,4 @@ Must be one of:
 * "AD_HOC"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/stocktake-item-status.md

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeItemStatus"
 sidebar_label: "StocktakeItemStatus"
-sidebar_position: 22
+sidebar_position: 25
 ---
 
 # StocktakeItemStatus
@@ -21,4 +21,4 @@ Must be one of:
 * "ADJUSTED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/stocktake-status.md

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeStatus"
 sidebar_label: "StocktakeStatus"
-sidebar_position: 23
+sidebar_position: 26
 ---
 
 # StocktakeStatus
@@ -21,4 +21,4 @@ Must be one of:
 * "CANCELLED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/ticket-status.md

@@ -1,7 +1,7 @@
 ---
 title: "TicketStatus"
 sidebar_label: "TicketStatus"
-sidebar_position: 24
+sidebar_position: 27
 ---
 
 # TicketStatus
@@ -20,7 +20,7 @@ Must be one of:
 * "CANCELLED"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/enums/waba-label.md

@@ -1,7 +1,7 @@
 ---
 title: "WabaLabel"
 sidebar_label: "WabaLabel"
-sidebar_position: 25
+sidebar_position: 28
 ---
 
 # WabaLabel
@@ -19,4 +19,4 @@ Must be one of:
 * "val"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/whatsapp-button-sub-type.md

@@ -1,7 +1,7 @@
 ---
 title: "WhatsappButtonSubType"
 sidebar_label: "WhatsappButtonSubType"
-sidebar_position: 26
+sidebar_position: 29
 ---
 
 # WhatsappButtonSubType
@@ -19,4 +19,4 @@ Must be one of:
 * "quick_reply"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/enums/whatsapp-template-component.md

@@ -1,7 +1,7 @@
 ---
 title: "WhatsappTemplateComponent"
 sidebar_label: "WhatsappTemplateComponent"
-sidebar_position: 27
+sidebar_position: 30
 ---
 
 # WhatsappTemplateComponent
@@ -20,4 +20,4 @@ Must be one of:
 * "button"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:06 +0000

package/data/docs/enums/whatsapp-template-status.md

@@ -1,7 +1,7 @@
 ---
 title: "WhatsappTemplateStatus"
 sidebar_label: "WhatsappTemplateStatus"
-sidebar_position: 28
+sidebar_position: 31
 ---
 
 # WhatsappTemplateStatus
@@ -23,4 +23,4 @@ Must be one of:
 * "IN_APPEAL"
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:06 +0000

package/data/docs/index.md

@@ -19,7 +19,7 @@ Developers own the Zod source in `packages/schema/src/`. When schemas change, th
 
 ## What's documented
 
-### Enums (28)
+### Enums (31)
 
 Status enums that drive business logic across Order, Booking, Event, and Loyalty domains:
 
@@ -34,6 +34,9 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
 | [EventStatus](enums/event-status) | 4 values | Ticketed event lifecycle (D32). Mobile-only today; Dashboard in Wave 4. |
 | [FulfillmentStatus](enums/fulfillment-status) | 6 values | Delivery/fulfillment lifecycle (D34). Optional — null for in-person orders. |
 | [LoyaltyTransactionType](enums/loyalty-transaction-type) | 6 values | Loyalty point transaction type (D07). SCREAMING_SNAKE past tense. |
+| [NotificationChannel](enums/notification-channel) | 4 values | Delivery channel of a NotificationRecord (GH#48). |
+| [NotificationEntityType](enums/notification-entity-type) | 6 values | Type of entity a NotificationRecord relates to. When `order`, the record is dual-written to the order-scoped subcollection (GH#48). |
+| [NotificationStatus](enums/notification-status) | 3 values | Delivery status of a NotificationRecord, set by the Cloud Function after a send attempt (GH#48). |
 | [OrderStatus](enums/order-status) | 7 values | Core order lifecycle status (D03, D34). Universal across all business types. Replaces the Dashboard's legacy 20-value flat enum (MIG-11). |
 | [OutboundMessageFormat](enums/outbound-message-format) | 2 values | Outbound WhatsApp message format. `text` is a free-form body (only valid inside the 24h customer-care window); `template` is a pre-approved WhatsApp template send. The backend is the authority on which is allowed (GH#43). |
 | [OutboundMessagePurpose](enums/outbound-message-purpose) | 4 values | Business purpose of an outbound WhatsApp message — orthogonal to its format (see OutboundMessageFormat). `otp`/`review_request`/`adhoc` are system-originated; `conversational` is a human agent reply from the dashboard inbox. Optional signal carried for analytics/triggers (GH#43; supersedes the GH#38 OutboundMessageKind). |
@@ -55,7 +58,7 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
 | [WhatsappTemplateStatus](enums/whatsapp-template-status) | 6 values | Meta review status of a WhatsApp message template, synced from the WhatsApp Business API. Only APPROVED templates can be sent. The fuller Meta status set is used deliberately (vs just APPROVED/PENDING/REJECTED) so this enum has a distinct value signature from PaymentProofStatus in the JSON-Schema $ref matcher (GH#43). |
 
 
-### Models (31)
+### Models (32)
 
 Core Firestore document schemas:
 
@@ -80,6 +83,7 @@ Core Firestore document schemas:
 | [MetricsCurrent](models/metrics-current) | 25 | 25 | — |
 | [MetricsDaily](models/metrics-daily) | 26 | 26 | — |
 | [MetricsMonthly](models/metrics-monthly) | 26 | 26 | — |
+| [NotificationRecord](models/notification-record) | 12 | 6 | — |
 | [Order](models/order) | 48 | 8 | — |
 | [OrderItem](models/order-item) | 12 | 3 | — |
 | [Sale](models/sale) | 12 | 1 | — |

package/data/docs/models/allowed-user.md

@@ -185,4 +185,4 @@ Set at creation only. This field cannot be modified after the document is create
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/models/analytics-backfill.md

@@ -391,7 +391,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/analytics-daily.md

@@ -344,7 +344,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/analytics-event.md

@@ -530,4 +530,4 @@ Must be one of:
 | **Additional properties** | Any type allowed |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000

package/data/docs/models/analytics-hourly.md

@@ -365,7 +365,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/booking-version.md

@@ -270,7 +270,7 @@ Dot-notation paths for nested fields (e.g. "bookingDates.0.status"). Populated b
 | **Additional properties** | Any type allowed |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.