@ingenx-io/valets-schema-mcp-server 0.2.3 → 0.2.5

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

@@ -6,13 +6,13 @@ sidebar_position: 1
 
 # Firestore Collection Paths
 
-All collections are scoped under a company document. Per **D40**, a `sites/{siteId}/` sub-tenant scope sits below `companies/{companyId}/` for site-specific collections (ING-304). **D41** canonicalizes the Site document; **D42** adds the analytics rollup collections; **D43** adds optional `Order.siteId` for site attribution (per ADR-003).
+All collections are scoped under a company document. Per **D40**, a `apps/{appId}/` sub-tenant scope sits below `companies/{companyId}/` for site-specific collections (ING-304). **D41** canonicalizes the App document; **D42** adds the analytics rollup collections; **D43** adds optional `Order.appId` (renamed from `siteId` per D44) for site attribution (per ADR-003).
 
 ```
 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
+├── orders/{orderId}                     ← Order.appId? (D43 / ADR-003, D44) attributes to an app
+│   └── notification_records/{notifId}   ← GH#48 — order-scoped notification log (dual-write)
+├── notification_records/{notifId}       ← GH#48 — company-wide notification audit log
 ├── customers/{customerId}
 ├── bookings/{bookingId}
 │   └── sessions/{sessionId}
@@ -24,7 +24,7 @@ companies/{companyId}/
 ├── paymentSummaries/{period}
 ├── loyaltyTransactions/{transactionId}
 ├── loyaltyConfig (singleton document)
-└── sites/{siteId}                        ← D41 Site document (D40 sub-tenant root)
+└── apps/{appId}                        ← D41 App document (D40 sub-tenant root). ⚠️ Existing data still at sites/{siteId} pending migration (#60)
     ├── magic_link_requests/{requestId}   ← 16-byte hex; auth audit log
     ├── allowed_users/{contactId}         ← access allowlist; doc ID = email / E.164 phone (URL-escaped)
     ├── payments/{paymentId}              ← SitePayment — immutable transaction ledger
@@ -37,29 +37,37 @@ companies/{companyId}/
 ## Path conventions
 
 - All paths are **tenant-scoped** under `companies/{companyId}/`
-- Site-specific collections live under `companies/{companyId}/sites/{siteId}/` (D40)
+- App-specific collections live under `companies/{companyId}/apps/{appId}/` (D40/D44). Existing production data is still at `companies/{companyId}/sites/{siteId}/` pending migration — see the caution block above
 - Sub-collections (sessions, tickets) are nested under their parent
 - `loyaltyConfig` is a singleton document, not a collection
 - Document IDs are auto-generated Firestore IDs unless specified
 
-## D40 — Site sub-tenant scope
+:::caution Migration in progress — `sites/` still supported
+The Firestore collection path segment was renamed from **`sites/{siteId}`** to **`apps/{appId}`** as part of D44. The data migration has not yet run in production — existing documents still live under `sites/`. Until the migration script is executed and all consumers are updated (tracked in [#60](https://github.com/IngenX-IO/valets-data-architecture/issues/60)):
 
-Introduced for ING-304 (canonical Firestore models derived from the SR Single site reference). The site-scoped collections share one rationale: they belong to a *site* (a per-company product surface), not to the company as a whole. A company may host many sites.
+- **New code** should use `apps/{appId}` — this is the canonical path going forward.
+- **Existing code** reading `sites/{siteId}` continues to work against production data.
+- **Do not write new documents under `sites/`** — write to `apps/` only.
+:::
+
+## D40/D44 — App sub-tenant scope (formerly Site)
+
+Introduced for ING-304 (canonical Firestore models derived from the SR Single site reference). The site-scoped collections share one rationale: they belong to an *app* (a per-company digital product surface), not to the company as a whole. A company may operate many apps.
 
 | Collection | Purpose | Write pattern |
 |---|---|---|
 | `magic_link_requests` | Authentication audit log — every access request | Two-stage PATCH (request → verify) |
 | `allowed_users` | Authoritative paid-access allowlist; referral-code resolution table | Upsert by contact ID |
-| `payments` | Immutable SitePayment ledger (distinct from `customerPayments`) | Append-only; dual-write (redirect + webhook) |
+| `payments` | Immutable AppPayment ledger (distinct from `customerPayments`) | Append-only; dual-write (redirect + webhook) |
 | `analytics_events` | Product/behavior event stream (page views, funnel, forms, orders, identity, errors) | Append-only, immutable |
 
 Related follow-ups: [ING-340](https://linear.app/ingenx/issue/ING-340) (retention/TTL), [ING-341](https://linear.app/ingenx/issue/ING-341) (PII redaction convention).
 
-## D41 — Site document
+## D41 — App document
 
-The Site document at `companies/{companyId}/sites/{siteId}` is the root of the site sub-tenant scope. It holds:
+The App document at `companies/{companyId}/apps/{appId}` is the root of the site sub-tenant scope. It holds:
 
-- `name`, `description`, `status` (`SiteStatus`: ACTIVE / INACTIVE / EXPIRED / ARCHIVED)
+- `name`, `description`, `status` (`AppStatus`: ACTIVE / INACTIVE / EXPIRED / ARCHIVED)
 - `deploymentLinks[]` — ordered list of deployment URLs by `DeploymentLinkType` (web, mobile, pwa, app-store, play-store, other)
 - `expiresAt?` and derived `isExpired?`
 - `analyticsEnabled` feature flag; `lastAnalyticsSync` sentinel
@@ -72,19 +80,19 @@ Per GH ticket IngenX-IO/valets-dashboard#199, rollups are written by a scheduled
 
 | Collection | Doc ID | Writer | Notes |
 |---|---|---|---|
-| `analytics_daily` | `YYYY-MM-DD` (UTC) | Scheduled CF + backfill | `computeRollup(companyId, siteId, date)` — idempotent set/merge; reruns overwrite |
+| `analytics_daily` | `YYYY-MM-DD` (UTC) | Scheduled CF + backfill | `computeRollup(companyId, appId, date)` — idempotent set/merge; reruns overwrite |
 | `analytics_hourly` | `YYYY-MM-DD-HH` (UTC) | Scheduled CF (hourly) | Same writer, scoped to a single hour bucket |
 | `analytics_backfills` | auto | Admin `onCall` | Tracks `status`, `from`/`to`, `processedDates`, `errors`, `dryRun`, audit fields |
 
 Readers should fall back to the raw `analytics_events` collection for slices not yet covered by a rollup.
 
-## D43 — `Order.siteId` attribution (ADR-003)
+## D43/D44 — `Order.appId` attribution (renamed from siteId) (ADR-003)
 
-Orders live at the existing company-scoped path `companies/{companyId}/orders/{orderId}`. D43 adds an **optional** `siteId?: string` field — when set, the order is attributed to a specific site (enables site-scoped dashboards, analytics joins, and per-site revenue slices). When null or absent, the order is company-wide (legacy behavior).
+Orders live at the existing company-scoped path `companies/{companyId}/orders/{orderId}`. D43 adds an **optional** `appId?: string` field (renamed from `siteId` per D44) — when set, the order is attributed to a specific app (enables site-scoped dashboards, analytics joins, and per-site revenue slices). When null or absent the order is company-wide (legacy behavior).
 
-- **No migration.** Existing orders keep `siteId = null`.
-- **Composite index:** `(companyId, siteId, createdAt)` for per-site recency queries.
-- **Physical relocation** of Order under `sites/{siteId}/orders/` is explicitly deferred (ADR-004, not approved).
+- **No migration.** Existing orders keep `appId = null` (previously `siteId`).
+- **Composite index:** `(companyId, appId, createdAt)` for per-site recency queries.
+- **Physical relocation** of Order under `apps/{appId}/orders/` is explicitly deferred (ADR-004, not approved).
 
 ## WhatsApp messaging — top-level collections (GH#36 / GH#43)
 
@@ -110,10 +118,14 @@ whatsapp_templates/{waba__name__language}            ← GH#43 — Meta-approved
 
 `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).
 
+:::note Collection renamed
+The collection path was renamed from `notifications` → `notification_records` (decision #55, 2026-05-30) to resolve a collision with the legacy in-app Notification model. Consumer code must update to the new path. The dashboard band-aid filter in PR #307 can be removed once the rename is deployed.
+:::
+
 | 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 |
+| `companies/{cid}/notification_records/{id}` | **Always** | Company-wide audit log for every notification |
+| `companies/{cid}/orders/{oid}/notification_records/{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.
 

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

@@ -0,0 +1,24 @@
+---
+title: "AppStatus"
+sidebar_label: "AppStatus"
+sidebar_position: 1
+---
+
+# AppStatus
+
+|                |                          |
+| -------------- | ------------------------ |
+| **Type**       | `enum (of string)`       |
+| **Required**   | No                       |
+| **Defined in** | #/definitions/app-status |
+
+**Description:** Lifecycle status for an App (formerly Site — renamed per decision #40 / D44). Drives whether the app is reachable and whether analytics/payments flow.
+
+Must be one of:
+* "ACTIVE"
+* "INACTIVE"
+* "EXPIRED"
+* "ARCHIVED"
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "AttentionStatus"
 sidebar_label: "AttentionStatus"
-sidebar_position: 1
+sidebar_position: 2
 ---
 
 # AttentionStatus
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "BookingStatus"
 sidebar_label: "BookingStatus"
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # BookingStatus
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "CustomerPaymentStatus"
 sidebar_label: "CustomerPaymentStatus"
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # CustomerPaymentStatus
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "CustomerPaymentTargetType"
 sidebar_label: "CustomerPaymentTargetType"
-sidebar_position: 4
+sidebar_position: 5
 ---
 
 # CustomerPaymentTargetType
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "DeliveryType"
 sidebar_label: "DeliveryType"
-sidebar_position: 5
+sidebar_position: 6
 ---
 
 # DeliveryType
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "DeploymentLinkType"
 sidebar_label: "DeploymentLinkType"
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # DeploymentLinkType
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "EventStatus"
 sidebar_label: "EventStatus"
-sidebar_position: 7
+sidebar_position: 8
 ---
 
 # EventStatus
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "FulfillmentStatus"
 sidebar_label: "FulfillmentStatus"
-sidebar_position: 8
+sidebar_position: 9
 ---
 
 # FulfillmentStatus
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyTransactionType"
 sidebar_label: "LoyaltyTransactionType"
-sidebar_position: 9
+sidebar_position: 10
 ---
 
 # LoyaltyTransactionType
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

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

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

@@ -1,7 +1,7 @@
 ---
 title: "NotificationEntityType"
 sidebar_label: "NotificationEntityType"
-sidebar_position: 11
+sidebar_position: 12
 ---
 
 # NotificationEntityType
@@ -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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

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

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

@@ -1,7 +1,7 @@
 ---
 title: "OrderStatus"
 sidebar_label: "OrderStatus"
-sidebar_position: 13
+sidebar_position: 14
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessageFormat"
 sidebar_label: "OutboundMessageFormat"
-sidebar_position: 14
+sidebar_position: 15
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessagePurpose"
 sidebar_label: "OutboundMessagePurpose"
-sidebar_position: 15
+sidebar_position: 16
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "OutboundMessageStatus"
 sidebar_label: "OutboundMessageStatus"
-sidebar_position: 16
+sidebar_position: 17
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "PaymentMethod"
 sidebar_label: "PaymentMethod"
-sidebar_position: 17
+sidebar_position: 18
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "PaymentProofStatus"
 sidebar_label: "PaymentProofStatus"
-sidebar_position: 18
+sidebar_position: 19
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "PaymentStatus"
 sidebar_label: "PaymentStatus"
-sidebar_position: 19
+sidebar_position: 20
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "PendingIssue"
 sidebar_label: "PendingIssue"
-sidebar_position: 20
+sidebar_position: 21
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "ReturnStatus"
 sidebar_label: "ReturnStatus"
-sidebar_position: 21
+sidebar_position: 22
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "SessionStatus"
 sidebar_label: "SessionStatus"
-sidebar_position: 22
+sidebar_position: 23
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions
 

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

@@ -1,7 +1,7 @@
 ---
 title: "SiteStatus"
 sidebar_label: "SiteStatus"
-sidebar_position: 23
+sidebar_position: 24
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeFrequency"
 sidebar_label: "StocktakeFrequency"
-sidebar_position: 24
+sidebar_position: 25
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeItemStatus"
 sidebar_label: "StocktakeItemStatus"
-sidebar_position: 25
+sidebar_position: 26
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "StocktakeStatus"
 sidebar_label: "StocktakeStatus"
-sidebar_position: 26
+sidebar_position: 27
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000

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

@@ -1,7 +1,7 @@
 ---
 title: "TicketStatus"
 sidebar_label: "TicketStatus"
-sidebar_position: 27
+sidebar_position: 28
 ---
 
 # 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 15:51:05 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
 
 ## Related Decisions