@ingenx-io/valets-schema-mcp-server 0.1.3 → 0.1.5

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 (49) hide show
  1. package/data/docs/collections/firestore-paths.md +56 -3
  2. package/data/docs/enums/attention-status.md +24 -0
  3. package/data/docs/enums/booking-status.md +2 -2
  4. package/data/docs/enums/customer-payment-status.md +2 -2
  5. package/data/docs/enums/customer-payment-target-type.md +2 -2
  6. package/data/docs/enums/delivery-type.md +2 -2
  7. package/data/docs/enums/deployment-link-type.md +26 -0
  8. package/data/docs/enums/event-status.md +2 -2
  9. package/data/docs/enums/fulfillment-status.md +2 -2
  10. package/data/docs/enums/loyalty-transaction-type.md +2 -2
  11. package/data/docs/enums/order-status.md +2 -2
  12. package/data/docs/enums/payment-method.md +2 -2
  13. package/data/docs/enums/payment-proof-status.md +2 -2
  14. package/data/docs/enums/payment-status.md +2 -2
  15. package/data/docs/enums/pending-issue.md +31 -0
  16. package/data/docs/enums/return-status.md +2 -2
  17. package/data/docs/enums/session-status.md +2 -2
  18. package/data/docs/enums/site-status.md +24 -0
  19. package/data/docs/enums/ticket-status.md +2 -2
  20. package/data/docs/index.md +15 -3
  21. package/data/docs/models/allowed-user.md +188 -0
  22. package/data/docs/models/analytics-backfill.md +398 -0
  23. package/data/docs/models/analytics-daily.md +351 -0
  24. package/data/docs/models/analytics-event.md +533 -0
  25. package/data/docs/models/analytics-hourly.md +372 -0
  26. package/data/docs/models/booking-version.md +2 -2
  27. package/data/docs/models/booking.md +2 -2
  28. package/data/docs/models/customer-payment-allocation.md +2 -2
  29. package/data/docs/models/customer-payment.md +2 -2
  30. package/data/docs/models/customer.md +2 -2
  31. package/data/docs/models/event.md +2 -2
  32. package/data/docs/models/loyalty-config.md +2 -2
  33. package/data/docs/models/loyalty-reward.md +2 -2
  34. package/data/docs/models/loyalty-status.md +2 -2
  35. package/data/docs/models/loyalty-transaction.md +2 -2
  36. package/data/docs/models/magic-link-request.md +285 -0
  37. package/data/docs/models/metrics-current.md +2 -2
  38. package/data/docs/models/metrics-daily.md +2 -2
  39. package/data/docs/models/metrics-monthly.md +2 -2
  40. package/data/docs/models/order-item.md +2 -2
  41. package/data/docs/models/order.md +248 -220
  42. package/data/docs/models/sale.md +2 -2
  43. package/data/docs/models/site-payment.md +200 -0
  44. package/data/docs/models/site.md +561 -0
  45. package/data/docs/models/ticket.md +2 -2
  46. package/data/static/llms.txt +362 -2
  47. package/data/static/openapi.yaml +1068 -0
  48. package/data/static/schemas.json +1229 -44
  49. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: "Sale"
3
3
  sidebar_label: "Sale"
4
- sidebar_position: 16
4
+ sidebar_position: 22
5
5
  ---
6
6
 
7
7
  # Sale
@@ -524,7 +524,7 @@ Set at creation only. This field cannot be modified after the document is create
524
524
  | **Required** | No |
525
525
 
526
526
  ----------------------------------------------------------------------------------------------------------------------------
527
- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-06 at 19:27:48 +0000
527
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
528
528
 
529
529
  :::warning Server-set
530
530
  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.
@@ -0,0 +1,200 @@
1
+ ---
2
+ title: "SitePayment"
3
+ sidebar_label: "SitePayment"
4
+ sidebar_position: 24
5
+ ---
6
+
7
+ # SitePayment
8
+
9
+ <details>
10
+ <summary>Example JSON</summary>
11
+
12
+ ```json
13
+ {
14
+ "id": null,
15
+ "companyId": "comp_xyz789",
16
+ "siteId": "sit_ref123",
17
+ "contact": "contact",
18
+ "sessionId": "ses_ref123",
19
+ "transactionId": "tra_ref123",
20
+ "tier": "Gold",
21
+ "amount": 45000,
22
+ "currency": "XOF",
23
+ "paidAt": "pai_ref123"
24
+ }
25
+ ```
26
+
27
+ </details>
28
+
29
+
30
+ - [1. Property `id`](#id)
31
+ - [2. Property `companyId`](#companyId)
32
+ - [3. Property `siteId`](#siteId)
33
+ - [4. Property `contact`](#contact)
34
+ - [5. Property `sessionId`](#sessionId)
35
+ - [6. Property `transactionId`](#transactionId)
36
+ - [7. Property `tier`](#tier)
37
+ - [8. Property `amount`](#amount)
38
+ - [9. Property `currency`](#currency)
39
+ - [10. Property `paidAt`](#paidAt)
40
+ - [10.1. Property `_seconds`](#paidAt__seconds)
41
+ - [10.2. Property `_nanoseconds`](#paidAt__nanoseconds)
42
+
43
+ | | |
44
+ | ------------------------- | -------------------------- |
45
+ | **Type** | `object` |
46
+ | **Required** | No |
47
+ | **Additional properties** | Not allowed |
48
+ | **Defined in** | #/definitions/site-payment |
49
+
50
+ **Description:** SitePayment model (D40 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/payments/\{paymentId\}. Immutable append-only transaction ledger. Distinct from AllowedUser (access state) and CustomerPayment (D22 — customer-level billing).
51
+
52
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
53
+ | ---------------------------------- | ------- | -------------- | ---------- | ------------------------------------ | -------------------------------------------------------------------------------------- |
54
+ | - [id](#id ) | No | string or null | No | - | (Read-only) Firestore document ID, auto-generated. |
55
+ | + [companyId](#companyId ) | No | string | No | - | (Immutable) FK → Company document ID. |
56
+ | + [siteId](#siteId ) | No | string | No | - | (Immutable) FK → Site document ID (D40 sub-tenant scope). |
57
+ | + [contact](#contact ) | No | string | No | - | Email or E.164 phone number. Matches AllowedUser.contact. |
58
+ | + [sessionId](#sessionId ) | No | string | No | - | Payment provider checkout session ID (e.g. Wave). Usable for dedup across dual writes. |
59
+ | + [transactionId](#transactionId ) | No | string | No | - | Payment provider transaction ID. |
60
+ | + [tier](#tier ) | No | string | No | - | Access tier. Free string per site (ING-304 open question). |
61
+ | + [amount](#amount ) | No | number | No | - | Amount paid. Generalized from amount_xof per D40 decision. |
62
+ | + [currency](#currency ) | No | string | No | - | Currency code (ISO 4217). Defaults to XOF for legacy SR-Single parity. |
63
+ | + [paidAt](#paidAt ) | No | object | No | In #/definitions/firestore-timestamp | RFC3339Nano UTC when payment was completed. |
64
+
65
+ ## <a name="id"></a>1. Property `id`
66
+
67
+ | | |
68
+ | ------------ | ---------------- |
69
+ | **Type** | `string or null` |
70
+ | **Required** | No |
71
+
72
+ **Description:** (Read-only) Firestore document ID, auto-generated.
73
+
74
+ :::warning Server-set
75
+ 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.
76
+ :::
77
+
78
+ ## <a name="companyId"></a>2. Property `companyId`
79
+
80
+ | | |
81
+ | ------------ | -------- |
82
+ | **Type** | `string` |
83
+ | **Required** | Yes |
84
+
85
+ **Description:** (Immutable) FK → Company document ID.
86
+
87
+ :::info Immutable
88
+ Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
89
+ :::
90
+
91
+ ## <a name="siteId"></a>3. Property `siteId`
92
+
93
+ | | |
94
+ | ------------ | -------- |
95
+ | **Type** | `string` |
96
+ | **Required** | Yes |
97
+
98
+ **Description:** (Immutable) FK → Site document ID (D40 sub-tenant scope).
99
+
100
+ :::info Immutable
101
+ Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
102
+ :::
103
+
104
+ ## <a name="contact"></a>4. Property `contact`
105
+
106
+ | | |
107
+ | ------------ | -------- |
108
+ | **Type** | `string` |
109
+ | **Required** | Yes |
110
+
111
+ **Description:** Email or E.164 phone number. Matches AllowedUser.contact.
112
+
113
+ ## <a name="sessionId"></a>5. Property `sessionId`
114
+
115
+ | | |
116
+ | ------------ | -------- |
117
+ | **Type** | `string` |
118
+ | **Required** | Yes |
119
+
120
+ **Description:** Payment provider checkout session ID (e.g. Wave). Usable for dedup across dual writes.
121
+
122
+ ## <a name="transactionId"></a>6. Property `transactionId`
123
+
124
+ | | |
125
+ | ------------ | -------- |
126
+ | **Type** | `string` |
127
+ | **Required** | Yes |
128
+
129
+ **Description:** Payment provider transaction ID.
130
+
131
+ ## <a name="tier"></a>7. Property `tier`
132
+
133
+ | | |
134
+ | ------------ | -------- |
135
+ | **Type** | `string` |
136
+ | **Required** | Yes |
137
+
138
+ **Description:** Access tier. Free string per site (ING-304 open question).
139
+
140
+ ## <a name="amount"></a>8. Property `amount`
141
+
142
+ | | |
143
+ | ------------ | -------- |
144
+ | **Type** | `number` |
145
+ | **Required** | Yes |
146
+
147
+ **Description:** Amount paid. Generalized from amount_xof per D40 decision.
148
+
149
+ ## <a name="currency"></a>9. Property `currency`
150
+
151
+ | | |
152
+ | ------------ | -------- |
153
+ | **Type** | `string` |
154
+ | **Required** | Yes |
155
+ | **Default** | `"XOF"` |
156
+
157
+ **Description:** Currency code (ISO 4217). Defaults to XOF for legacy SR-Single parity.
158
+
159
+ ## <a name="paidAt"></a>10. Property `paidAt`
160
+
161
+ | | |
162
+ | ------------------------- | --------------------------------- |
163
+ | **Type** | `object` |
164
+ | **Required** | Yes |
165
+ | **Additional properties** | Not allowed |
166
+ | **Defined in** | #/definitions/firestore-timestamp |
167
+
168
+ **Description:** RFC3339Nano UTC when payment was completed.
169
+
170
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
171
+ | --------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
172
+ | + [_seconds](#paidAt__seconds ) | No | integer | No | - | - |
173
+ | + [_nanoseconds](#paidAt__nanoseconds ) | No | integer | No | - | - |
174
+
175
+ ### <a name="paidAt__seconds"></a>10.1. Property `_seconds`
176
+
177
+ | | |
178
+ | ------------ | --------- |
179
+ | **Type** | `integer` |
180
+ | **Required** | Yes |
181
+
182
+ | Restrictions | |
183
+ | ------------ | ---------------------- |
184
+ | **Minimum** | &ge; -9007199254740991 |
185
+ | **Maximum** | &le; 9007199254740991 |
186
+
187
+ ### <a name="paidAt__nanoseconds"></a>10.2. Property `_nanoseconds`
188
+
189
+ | | |
190
+ | ------------ | --------- |
191
+ | **Type** | `integer` |
192
+ | **Required** | Yes |
193
+
194
+ | Restrictions | |
195
+ | ------------ | ---------------------- |
196
+ | **Minimum** | &ge; -9007199254740991 |
197
+ | **Maximum** | &le; 9007199254740991 |
198
+
199
+ ----------------------------------------------------------------------------------------------------------------------------
200
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000