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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/data/docs/enums/app-status.md +1 -1
  2. package/data/docs/enums/attention-status.md +1 -1
  3. package/data/docs/enums/booking-status.md +1 -1
  4. package/data/docs/enums/contract-status.md +24 -0
  5. package/data/docs/enums/customer-payment-status.md +2 -2
  6. package/data/docs/enums/customer-payment-target-type.md +2 -2
  7. package/data/docs/enums/delivery-type.md +2 -2
  8. package/data/docs/enums/deployment-link-type.md +2 -2
  9. package/data/docs/enums/event-status.md +2 -2
  10. package/data/docs/enums/fulfillment-status.md +2 -2
  11. package/data/docs/enums/loyalty-transaction-type.md +2 -2
  12. package/data/docs/enums/milestone-status.md +23 -0
  13. package/data/docs/enums/notification-channel.md +2 -2
  14. package/data/docs/enums/notification-entity-type.md +2 -2
  15. package/data/docs/enums/notification-status.md +2 -2
  16. package/data/docs/enums/order-status.md +2 -2
  17. package/data/docs/enums/outbound-message-format.md +2 -2
  18. package/data/docs/enums/outbound-message-purpose.md +2 -2
  19. package/data/docs/enums/outbound-message-status.md +2 -2
  20. package/data/docs/enums/payment-method.md +2 -2
  21. package/data/docs/enums/payment-proof-status.md +2 -2
  22. package/data/docs/enums/payment-status.md +2 -2
  23. package/data/docs/enums/pending-issue.md +2 -2
  24. package/data/docs/enums/return-status.md +2 -2
  25. package/data/docs/enums/session-status.md +2 -2
  26. package/data/docs/enums/site-status.md +2 -2
  27. package/data/docs/enums/stocktake-frequency.md +2 -2
  28. package/data/docs/enums/stocktake-item-status.md +2 -2
  29. package/data/docs/enums/stocktake-status.md +2 -2
  30. package/data/docs/enums/ticket-status.md +2 -2
  31. package/data/docs/enums/waba-label.md +3 -3
  32. package/data/docs/enums/whatsapp-button-sub-type.md +2 -2
  33. package/data/docs/enums/whatsapp-template-component.md +2 -2
  34. package/data/docs/enums/whatsapp-template-status.md +2 -2
  35. package/data/docs/index.md +11 -5
  36. package/data/docs/models/allowed-user.md +1 -1
  37. package/data/docs/models/analytics-backfill.md +1 -1
  38. package/data/docs/models/analytics-daily.md +1 -1
  39. package/data/docs/models/analytics-event.md +1 -1
  40. package/data/docs/models/analytics-hourly.md +1 -1
  41. package/data/docs/models/app-payment.md +1 -1
  42. package/data/docs/models/app.md +45 -21
  43. package/data/docs/models/booking-version.md +1 -1
  44. package/data/docs/models/booking.md +1 -1
  45. package/data/docs/models/contract.md +454 -0
  46. package/data/docs/models/customer-payment-allocation.md +2 -2
  47. package/data/docs/models/customer-payment.md +2 -2
  48. package/data/docs/models/customer.md +2 -2
  49. package/data/docs/models/event.md +2 -2
  50. package/data/docs/models/loyalty-config.md +2 -2
  51. package/data/docs/models/loyalty-reward.md +2 -2
  52. package/data/docs/models/loyalty-status.md +2 -2
  53. package/data/docs/models/loyalty-transaction.md +2 -2
  54. package/data/docs/models/magic-link-request.md +2 -2
  55. package/data/docs/models/metrics-current.md +2 -2
  56. package/data/docs/models/metrics-daily.md +2 -2
  57. package/data/docs/models/metrics-monthly.md +2 -2
  58. package/data/docs/models/notification-record.md +2 -2
  59. package/data/docs/models/order-item.md +2 -2
  60. package/data/docs/models/order.md +238 -218
  61. package/data/docs/models/outbound-payment-allocation.md +195 -0
  62. package/data/docs/models/outbound-payment.md +318 -0
  63. package/data/docs/models/payment-webhook-endpoint.md +191 -0
  64. package/data/docs/models/sale.md +2 -2
  65. package/data/docs/models/site-payment.md +2 -2
  66. package/data/docs/models/site.md +2 -2
  67. package/data/docs/models/stocktake-item.md +2 -2
  68. package/data/docs/models/stocktake.md +2 -2
  69. package/data/docs/models/ticket.md +2 -2
  70. package/data/docs/models/user.md +2 -2
  71. package/data/docs/models/whatsapp-inbound-message.md +6 -2
  72. package/data/docs/models/whatsapp-outbound-lifecycle-event.md +2 -2
  73. package/data/docs/models/whatsapp-outbound-message.md +39 -23
  74. package/data/docs/models/whatsapp-template.md +6 -2
  75. package/data/static/llms.txt +145 -5
  76. package/data/static/openapi.yaml +456 -14
  77. package/data/static/schemas.json +477 -9
  78. package/package.json +1 -1
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "ARCHIVED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:44 +0000
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "ESCALATED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -23,4 +23,4 @@ Must be one of:
23
23
  * "COMPLETED_MIXED"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: "ContractStatus"
3
+ sidebar_label: "ContractStatus"
4
+ sidebar_position: 4
5
+ ---
6
+
7
+ # ContractStatus
8
+
9
+ | | |
10
+ | -------------- | ----------------------------- |
11
+ | **Type** | `enum (of string)` |
12
+ | **Required** | No |
13
+ | **Defined in** | #/definitions/contract-status |
14
+
15
+ **Description:** Lifecycle status of a Contract. DRAFT = not yet signed. ACTIVE = in force. COMPLETED = all milestones paid and obligations met. TERMINATED = ended early by either party.
16
+
17
+ Must be one of:
18
+ * "DRAFT"
19
+ * "ACTIVE"
20
+ * "COMPLETED"
21
+ * "TERMINATED"
22
+
23
+ ----------------------------------------------------------------------------------------------------------------------------
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "CustomerPaymentStatus"
3
3
  sidebar_label: "CustomerPaymentStatus"
4
- sidebar_position: 4
4
+ sidebar_position: 5
5
5
  ---
6
6
 
7
7
  # CustomerPaymentStatus
@@ -23,4 +23,4 @@ Must be one of:
23
23
  * "CANCELLED"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "CustomerPaymentTargetType"
3
3
  sidebar_label: "CustomerPaymentTargetType"
4
- sidebar_position: 5
4
+ sidebar_position: 6
5
5
  ---
6
6
 
7
7
  # CustomerPaymentTargetType
@@ -20,4 +20,4 @@ Must be one of:
20
20
  * "PURCHASE"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "DeliveryType"
3
3
  sidebar_label: "DeliveryType"
4
- sidebar_position: 6
4
+ sidebar_position: 7
5
5
  ---
6
6
 
7
7
  # DeliveryType
@@ -20,4 +20,4 @@ Must be one of:
20
20
  * "DELIVERY"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "DeploymentLinkType"
3
3
  sidebar_label: "DeploymentLinkType"
4
- sidebar_position: 7
4
+ sidebar_position: 8
5
5
  ---
6
6
 
7
7
  # DeploymentLinkType
@@ -23,4 +23,4 @@ Must be one of:
23
23
  * "other"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "EventStatus"
3
3
  sidebar_label: "EventStatus"
4
- sidebar_position: 8
4
+ sidebar_position: 9
5
5
  ---
6
6
 
7
7
  # EventStatus
@@ -21,7 +21,7 @@ Must be one of:
21
21
  * "COMPLETED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
25
25
 
26
26
  ## Related Decisions
27
27
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "FulfillmentStatus"
3
3
  sidebar_label: "FulfillmentStatus"
4
- sidebar_position: 9
4
+ sidebar_position: 10
5
5
  ---
6
6
 
7
7
  # FulfillmentStatus
@@ -23,7 +23,7 @@ Must be one of:
23
23
  * "PICKED_UP"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
27
27
 
28
28
  ## Related Decisions
29
29
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "LoyaltyTransactionType"
3
3
  sidebar_label: "LoyaltyTransactionType"
4
- sidebar_position: 10
4
+ sidebar_position: 11
5
5
  ---
6
6
 
7
7
  # LoyaltyTransactionType
@@ -23,7 +23,7 @@ Must be one of:
23
23
  * "REFUND"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
27
27
 
28
28
  ## Related Decisions
29
29
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: "MilestoneStatus"
3
+ sidebar_label: "MilestoneStatus"
4
+ sidebar_position: 12
5
+ ---
6
+
7
+ # MilestoneStatus
8
+
9
+ | | |
10
+ | -------------- | ------------------------------ |
11
+ | **Type** | `enum (of string)` |
12
+ | **Required** | No |
13
+ | **Defined in** | #/definitions/milestone-status |
14
+
15
+ **Description:** Status of a ContractMilestone (#17). PENDING = created, not yet invoiced. INVOICED = invoice issued, awaiting payment. PAID = payment received.
16
+
17
+ Must be one of:
18
+ * "PENDING"
19
+ * "INVOICED"
20
+ * "PAID"
21
+
22
+ ----------------------------------------------------------------------------------------------------------------------------
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "NotificationChannel"
3
3
  sidebar_label: "NotificationChannel"
4
- sidebar_position: 11
4
+ sidebar_position: 13
5
5
  ---
6
6
 
7
7
  # NotificationChannel
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "push"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "NotificationEntityType"
3
3
  sidebar_label: "NotificationEntityType"
4
- sidebar_position: 12
4
+ sidebar_position: 14
5
5
  ---
6
6
 
7
7
  # NotificationEntityType
@@ -23,4 +23,4 @@ Must be one of:
23
23
  * "other"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "NotificationStatus"
3
3
  sidebar_label: "NotificationStatus"
4
- sidebar_position: 13
4
+ sidebar_position: 15
5
5
  ---
6
6
 
7
7
  # NotificationStatus
@@ -20,4 +20,4 @@ Must be one of:
20
20
  * "pending"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "OrderStatus"
3
3
  sidebar_label: "OrderStatus"
4
- sidebar_position: 14
4
+ sidebar_position: 16
5
5
  ---
6
6
 
7
7
  # OrderStatus
@@ -24,7 +24,7 @@ Must be one of:
24
24
  * "EXPIRED"
25
25
 
26
26
  ----------------------------------------------------------------------------------------------------------------------------
27
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
27
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
28
28
 
29
29
  ## Related Decisions
30
30
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "OutboundMessageFormat"
3
3
  sidebar_label: "OutboundMessageFormat"
4
- sidebar_position: 15
4
+ sidebar_position: 17
5
5
  ---
6
6
 
7
7
  # OutboundMessageFormat
@@ -19,4 +19,4 @@ Must be one of:
19
19
  * "template"
20
20
 
21
21
  ----------------------------------------------------------------------------------------------------------------------------
22
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
22
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "OutboundMessagePurpose"
3
3
  sidebar_label: "OutboundMessagePurpose"
4
- sidebar_position: 16
4
+ sidebar_position: 18
5
5
  ---
6
6
 
7
7
  # OutboundMessagePurpose
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "conversational"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "OutboundMessageStatus"
3
3
  sidebar_label: "OutboundMessageStatus"
4
- sidebar_position: 17
4
+ sidebar_position: 19
5
5
  ---
6
6
 
7
7
  # OutboundMessageStatus
@@ -22,4 +22,4 @@ Must be one of:
22
22
  * "failed"
23
23
 
24
24
  ----------------------------------------------------------------------------------------------------------------------------
25
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
25
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "PaymentMethod"
3
3
  sidebar_label: "PaymentMethod"
4
- sidebar_position: 18
4
+ sidebar_position: 20
5
5
  ---
6
6
 
7
7
  # PaymentMethod
@@ -27,7 +27,7 @@ Must be one of:
27
27
  * "OTHER"
28
28
 
29
29
  ----------------------------------------------------------------------------------------------------------------------------
30
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
30
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
31
31
 
32
32
  ## Related Decisions
33
33
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "PaymentProofStatus"
3
3
  sidebar_label: "PaymentProofStatus"
4
- sidebar_position: 19
4
+ sidebar_position: 21
5
5
  ---
6
6
 
7
7
  # PaymentProofStatus
@@ -20,4 +20,4 @@ Must be one of:
20
20
  * "REJECTED"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "PaymentStatus"
3
3
  sidebar_label: "PaymentStatus"
4
- sidebar_position: 20
4
+ sidebar_position: 22
5
5
  ---
6
6
 
7
7
  # PaymentStatus
@@ -24,7 +24,7 @@ Must be one of:
24
24
  * "PARTIALLY_REFUNDED"
25
25
 
26
26
  ----------------------------------------------------------------------------------------------------------------------------
27
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
27
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
28
28
 
29
29
  ## Related Decisions
30
30
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "PendingIssue"
3
3
  sidebar_label: "PendingIssue"
4
- sidebar_position: 21
4
+ sidebar_position: 23
5
5
  ---
6
6
 
7
7
  # PendingIssue
@@ -28,4 +28,4 @@ Must be one of:
28
28
  * "NO_SHOW_UNRESOLVED"
29
29
 
30
30
  ----------------------------------------------------------------------------------------------------------------------------
31
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
31
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "ReturnStatus"
3
3
  sidebar_label: "ReturnStatus"
4
- sidebar_position: 22
4
+ sidebar_position: 24
5
5
  ---
6
6
 
7
7
  # ReturnStatus
@@ -23,7 +23,7 @@ Must be one of:
23
23
  * "EXCHANGE_COMPLETED"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
27
27
 
28
28
  ## Related Decisions
29
29
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "SessionStatus"
3
3
  sidebar_label: "SessionStatus"
4
- sidebar_position: 23
4
+ sidebar_position: 25
5
5
  ---
6
6
 
7
7
  # SessionStatus
@@ -23,7 +23,7 @@ Must be one of:
23
23
  * "CANCELLED"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
27
27
 
28
28
  ## Related Decisions
29
29
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "SiteStatus"
3
3
  sidebar_label: "SiteStatus"
4
- sidebar_position: 24
4
+ sidebar_position: 26
5
5
  ---
6
6
 
7
7
  # SiteStatus
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "ARCHIVED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "StocktakeFrequency"
3
3
  sidebar_label: "StocktakeFrequency"
4
- sidebar_position: 25
4
+ sidebar_position: 27
5
5
  ---
6
6
 
7
7
  # StocktakeFrequency
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "AD_HOC"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "StocktakeItemStatus"
3
3
  sidebar_label: "StocktakeItemStatus"
4
- sidebar_position: 26
4
+ sidebar_position: 28
5
5
  ---
6
6
 
7
7
  # StocktakeItemStatus
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "ADJUSTED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "StocktakeStatus"
3
3
  sidebar_label: "StocktakeStatus"
4
- sidebar_position: 27
4
+ sidebar_position: 29
5
5
  ---
6
6
 
7
7
  # StocktakeStatus
@@ -21,4 +21,4 @@ Must be one of:
21
21
  * "CANCELLED"
22
22
 
23
23
  ----------------------------------------------------------------------------------------------------------------------------
24
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
24
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "TicketStatus"
3
3
  sidebar_label: "TicketStatus"
4
- sidebar_position: 28
4
+ sidebar_position: 30
5
5
  ---
6
6
 
7
7
  # TicketStatus
@@ -20,7 +20,7 @@ Must be one of:
20
20
  * "CANCELLED"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
24
24
 
25
25
  ## Related Decisions
26
26
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "WabaLabel"
3
3
  sidebar_label: "WabaLabel"
4
- sidebar_position: 29
4
+ sidebar_position: 31
5
5
  ---
6
6
 
7
7
  # WabaLabel
@@ -12,11 +12,11 @@ sidebar_position: 29
12
12
  | **Required** | No |
13
13
  | **Defined in** | #/definitions/waba-label |
14
14
 
15
- **Description:** Human-readable WABA label identifying which Meta business number received the message (GH#36).
15
+ **Description:** WABA label identifying which Meta Business Account sent/received the message. cmz = Chez Miss Zahoui sender; val = Valets sender. See WhatsApp platform constraints doc (#50).
16
16
 
17
17
  Must be one of:
18
18
  * "cmz"
19
19
  * "val"
20
20
 
21
21
  ----------------------------------------------------------------------------------------------------------------------------
22
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
22
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "WhatsappButtonSubType"
3
3
  sidebar_label: "WhatsappButtonSubType"
4
- sidebar_position: 30
4
+ sidebar_position: 32
5
5
  ---
6
6
 
7
7
  # WhatsappButtonSubType
@@ -19,4 +19,4 @@ Must be one of:
19
19
  * "quick_reply"
20
20
 
21
21
  ----------------------------------------------------------------------------------------------------------------------------
22
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
22
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "WhatsappTemplateComponent"
3
3
  sidebar_label: "WhatsappTemplateComponent"
4
- sidebar_position: 31
4
+ sidebar_position: 33
5
5
  ---
6
6
 
7
7
  # WhatsappTemplateComponent
@@ -20,4 +20,4 @@ Must be one of:
20
20
  * "button"
21
21
 
22
22
  ----------------------------------------------------------------------------------------------------------------------------
23
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
23
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "WhatsappTemplateStatus"
3
3
  sidebar_label: "WhatsappTemplateStatus"
4
- sidebar_position: 32
4
+ sidebar_position: 34
5
5
  ---
6
6
 
7
7
  # WhatsappTemplateStatus
@@ -23,4 +23,4 @@ Must be one of:
23
23
  * "IN_APPEAL"
24
24
 
25
25
  ----------------------------------------------------------------------------------------------------------------------------
26
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
26
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:45 +0000
@@ -19,7 +19,7 @@ Developers own the Zod source in `packages/schema/src/`. When schemas change, th
19
19
 
20
20
  ## What's documented
21
21
 
22
- ### Enums (32)
22
+ ### Enums (34)
23
23
 
24
24
  Status enums that drive business logic across Order, Booking, Event, and Loyalty domains:
25
25
 
@@ -28,6 +28,7 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
28
28
  | [AppStatus](enums/app-status) | 4 values | Lifecycle status for an App (formerly Site — renamed per decision #40 / D44). Drives whether the app is reachable and whether analytics/payments flow. |
29
29
  | [AttentionStatus](enums/attention-status) | 4 values | Operational attention status for Order and Booking (D39). Controls home-page queue assignment. Server-owned — set via triggers or callable fn only. |
30
30
  | [BookingStatus](enums/booking-status) | 6 values | Booking lifecycle status. COMPLETED_MIXED = some sessions completed, others cancelled/no-show. |
31
+ | [ContractStatus](enums/contract-status) | 4 values | Lifecycle status of a Contract. DRAFT = not yet signed. ACTIVE = in force. COMPLETED = all milestones paid and obligations met. TERMINATED = ended early by either party. |
31
32
  | [CustomerPaymentStatus](enums/customer-payment-status) | 6 values | Customer payment lifecycle status (D22). Tracks allocation progress of received payments. |
32
33
  | [CustomerPaymentTargetType](enums/customer-payment-target-type) | 3 values | Target document type for customer payment allocation. |
33
34
  | [DeliveryType](enums/delivery-type) | 3 values | Fulfillment channel for an order. Determines whether the customer comes to the business (ON_SITE), collects their order themselves (PICK_UP), or receives a physical delivery (DELIVERY). Drives whether fulfillmentStatus is relevant. |
@@ -35,6 +36,7 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
35
36
  | [EventStatus](enums/event-status) | 4 values | Ticketed event lifecycle (D32). Mobile-only today; Dashboard in Wave 4. |
36
37
  | [FulfillmentStatus](enums/fulfillment-status) | 6 values | Delivery/fulfillment lifecycle (D34). Optional — null for in-person orders. |
37
38
  | [LoyaltyTransactionType](enums/loyalty-transaction-type) | 6 values | Loyalty point transaction type (D07). SCREAMING_SNAKE past tense. |
39
+ | [MilestoneStatus](enums/milestone-status) | 3 values | Status of a ContractMilestone (#17). PENDING = created, not yet invoiced. INVOICED = invoice issued, awaiting payment. PAID = payment received. |
38
40
  | [NotificationChannel](enums/notification-channel) | 4 values | Delivery channel of a NotificationRecord (GH#48). |
39
41
  | [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). |
40
42
  | [NotificationStatus](enums/notification-status) | 3 values | Delivery status of a NotificationRecord, set by the Cloud Function after a send attempt (GH#48). |
@@ -53,13 +55,13 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
53
55
  | [StocktakeItemStatus](enums/stocktake-item-status) | 4 values | Per-line workflow status inside a Stocktake (GH#29 §4, audit Q21). |
54
56
  | [StocktakeStatus](enums/stocktake-status) | 4 values | Lifecycle status of a Stocktake session (GH#29 §3, §4). |
55
57
  | [TicketStatus](enums/ticket-status) | 3 values | Event ticket status (D32). VALID = active and unused. |
56
- | [WabaLabel](enums/waba-label) | 2 values | Human-readable WABA label identifying which Meta business number received the message (GH#36). |
58
+ | [WabaLabel](enums/waba-label) | 2 values | WABA label identifying which Meta Business Account sent/received the message. cmz = Chez Miss Zahoui sender; val = Valets sender. See WhatsApp platform constraints doc (#50). |
57
59
  | [WhatsappButtonSubType](enums/whatsapp-button-sub-type) | 2 values | Sub-type of a WhatsApp template button parameter. Set when WhatsappTemplateParameter.component === "button" — maps to Meta `components[].sub_type` (GH#46). |
58
60
  | [WhatsappTemplateComponent](enums/whatsapp-template-component) | 3 values | WhatsApp template component a parameter targets. Determines which Meta `components` entry the supplied value is placed in at send time (GH#46). |
59
61
  | [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). |
60
62
 
61
63
 
62
- ### Models (35)
64
+ ### Models (39)
63
65
 
64
66
  Core Firestore document schemas:
65
67
 
@@ -70,10 +72,11 @@ Core Firestore document schemas:
70
72
  | [AnalyticsDaily](models/analytics-daily) | 16 | 14 | — |
71
73
  | [AnalyticsEvent](models/analytics-event) | 12 | 10 | — |
72
74
  | [AnalyticsHourly](models/analytics-hourly) | 17 | 15 | — |
73
- | [App](models/app) | 14 | 6 | — |
75
+ | [App](models/app) | 14 | 5 | — |
74
76
  | [AppPayment](models/app-payment) | 10 | 9 | — |
75
77
  | [Booking](models/booking) | 52 | 7 | — |
76
78
  | [BookingVersion](models/booking-version) | 9 | 6 | — |
79
+ | [Contract](models/contract) | 15 | 8 | — |
77
80
  | [Customer](models/customer) | 17 | 4 | — |
78
81
  | [CustomerPayment](models/customer-payment) | 17 | 12 | — |
79
82
  | [CustomerPaymentAllocation](models/customer-payment-allocation) | 14 | 8 | — |
@@ -87,8 +90,11 @@ Core Firestore document schemas:
87
90
  | [MetricsDaily](models/metrics-daily) | 31 | 26 | — |
88
91
  | [MetricsMonthly](models/metrics-monthly) | 31 | 26 | — |
89
92
  | [NotificationRecord](models/notification-record) | 12 | 6 | — |
90
- | [Order](models/order) | 48 | 8 | — |
93
+ | [Order](models/order) | 49 | 8 | — |
91
94
  | [OrderItem](models/order-item) | 12 | 3 | — |
95
+ | [OutboundPayment](models/outbound-payment) | 13 | 7 | — |
96
+ | [OutboundPaymentAllocation](models/outbound-payment-allocation) | 7 | 4 | — |
97
+ | [PaymentWebhookEndpoint](models/payment-webhook-endpoint) | 6 | 5 | — |
92
98
  | [Sale](models/sale) | 12 | 1 | — |
93
99
  | [Site](models/site) | 14 | 6 | — |
94
100
  | [SitePayment](models/site-payment) | 10 | 9 | — |
@@ -185,4 +185,4 @@ Set at creation only. This field cannot be modified after the document is create
185
185
  | **Maximum** | ≤ 9007199254740991 |
186
186
 
187
187
  ----------------------------------------------------------------------------------------------------------------------------
188
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
188
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:44 +0000