@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.
- package/data/docs/collections/firestore-paths.md +56 -3
- package/data/docs/enums/attention-status.md +24 -0
- package/data/docs/enums/booking-status.md +2 -2
- package/data/docs/enums/customer-payment-status.md +2 -2
- package/data/docs/enums/customer-payment-target-type.md +2 -2
- package/data/docs/enums/delivery-type.md +2 -2
- package/data/docs/enums/deployment-link-type.md +26 -0
- package/data/docs/enums/event-status.md +2 -2
- package/data/docs/enums/fulfillment-status.md +2 -2
- package/data/docs/enums/loyalty-transaction-type.md +2 -2
- package/data/docs/enums/order-status.md +2 -2
- package/data/docs/enums/payment-method.md +2 -2
- package/data/docs/enums/payment-proof-status.md +2 -2
- package/data/docs/enums/payment-status.md +2 -2
- package/data/docs/enums/pending-issue.md +31 -0
- package/data/docs/enums/return-status.md +2 -2
- package/data/docs/enums/session-status.md +2 -2
- package/data/docs/enums/site-status.md +24 -0
- package/data/docs/enums/ticket-status.md +2 -2
- package/data/docs/index.md +15 -3
- package/data/docs/models/allowed-user.md +188 -0
- package/data/docs/models/analytics-backfill.md +398 -0
- package/data/docs/models/analytics-daily.md +351 -0
- package/data/docs/models/analytics-event.md +533 -0
- package/data/docs/models/analytics-hourly.md +372 -0
- package/data/docs/models/booking-version.md +2 -2
- package/data/docs/models/booking.md +2 -2
- package/data/docs/models/customer-payment-allocation.md +2 -2
- package/data/docs/models/customer-payment.md +2 -2
- package/data/docs/models/customer.md +2 -2
- package/data/docs/models/event.md +2 -2
- package/data/docs/models/loyalty-config.md +2 -2
- package/data/docs/models/loyalty-reward.md +2 -2
- package/data/docs/models/loyalty-status.md +2 -2
- package/data/docs/models/loyalty-transaction.md +2 -2
- package/data/docs/models/magic-link-request.md +285 -0
- package/data/docs/models/metrics-current.md +2 -2
- package/data/docs/models/metrics-daily.md +2 -2
- package/data/docs/models/metrics-monthly.md +2 -2
- package/data/docs/models/order-item.md +2 -2
- package/data/docs/models/order.md +248 -220
- package/data/docs/models/sale.md +2 -2
- package/data/docs/models/site-payment.md +200 -0
- package/data/docs/models/site.md +561 -0
- package/data/docs/models/ticket.md +2 -2
- package/data/static/llms.txt +362 -2
- package/data/static/openapi.yaml +1068 -0
- package/data/static/schemas.json +1229 -44
- package/package.json +1 -1
|
@@ -0,0 +1,372 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "AnalyticsHourly"
|
|
3
|
+
sidebar_label: "AnalyticsHourly"
|
|
4
|
+
sidebar_position: 5
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# AnalyticsHourly
|
|
8
|
+
|
|
9
|
+
<details>
|
|
10
|
+
<summary>Example JSON</summary>
|
|
11
|
+
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"totalEvents": 0,
|
|
15
|
+
"pageViews": 0,
|
|
16
|
+
"sessions": 0,
|
|
17
|
+
"uniqueUsers": 0,
|
|
18
|
+
"anonymousSessions": 0,
|
|
19
|
+
"orders": 0,
|
|
20
|
+
"paymentsCompleted": 0,
|
|
21
|
+
"paymentsFailed": 0,
|
|
22
|
+
"errors": 0,
|
|
23
|
+
"eventCounts": {},
|
|
24
|
+
"id": null,
|
|
25
|
+
"companyId": "comp_xyz789",
|
|
26
|
+
"siteId": "sit_ref123",
|
|
27
|
+
"date": "2026-02-15",
|
|
28
|
+
"hour": 0,
|
|
29
|
+
"computedAt": "computedAt",
|
|
30
|
+
"sourceEventCount": null
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
</details>
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
- [1. Property `totalEvents`](#totalEvents)
|
|
38
|
+
- [2. Property `pageViews`](#pageViews)
|
|
39
|
+
- [3. Property `sessions`](#sessions)
|
|
40
|
+
- [4. Property `uniqueUsers`](#uniqueUsers)
|
|
41
|
+
- [5. Property `anonymousSessions`](#anonymousSessions)
|
|
42
|
+
- [6. Property `orders`](#orders)
|
|
43
|
+
- [7. Property `paymentsCompleted`](#paymentsCompleted)
|
|
44
|
+
- [8. Property `paymentsFailed`](#paymentsFailed)
|
|
45
|
+
- [9. Property `errors`](#errors)
|
|
46
|
+
- [10. Property `eventCounts`](#eventCounts)
|
|
47
|
+
- [10.1. Property `additionalProperties`](#eventCounts_additionalProperties)
|
|
48
|
+
- [11. Property `id`](#id)
|
|
49
|
+
- [12. Property `companyId`](#companyId)
|
|
50
|
+
- [13. Property `siteId`](#siteId)
|
|
51
|
+
- [14. Property `date`](#date)
|
|
52
|
+
- [15. Property `hour`](#hour)
|
|
53
|
+
- [16. Property `computedAt`](#computedAt)
|
|
54
|
+
- [16.1. Property `_seconds`](#computedAt__seconds)
|
|
55
|
+
- [16.2. Property `_nanoseconds`](#computedAt__nanoseconds)
|
|
56
|
+
- [17. Property `sourceEventCount`](#sourceEventCount)
|
|
57
|
+
|
|
58
|
+
| | |
|
|
59
|
+
| ------------------------- | ------------------------------ |
|
|
60
|
+
| **Type** | `object` |
|
|
61
|
+
| **Required** | No |
|
|
62
|
+
| **Additional properties** | Not allowed |
|
|
63
|
+
| **Defined in** | #/definitions/analytics-hourly |
|
|
64
|
+
|
|
65
|
+
**Description:** AnalyticsHourly rollup (D42 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/analytics_hourly/\{YYYY-MM-DD-HH\}. Scheduled-CF writer; idempotent set/merge.
|
|
66
|
+
|
|
67
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
68
|
+
| ------------------------------------------ | ------- | --------------- | ---------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
|
|
69
|
+
| + [totalEvents](#totalEvents ) | No | integer | No | - | Total event count within the bucket. |
|
|
70
|
+
| + [pageViews](#pageViews ) | No | integer | No | - | Count of \`page_view\` + \`screen_view\` events. |
|
|
71
|
+
| + [sessions](#sessions ) | No | integer | No | - | Distinct session count within the bucket (by \`sessionId\`). |
|
|
72
|
+
| + [uniqueUsers](#uniqueUsers ) | No | integer | No | - | Distinct identified \`userId\` count. Anonymous sessions (userId=null) are excluded. |
|
|
73
|
+
| + [anonymousSessions](#anonymousSessions ) | No | integer | No | - | Distinct session count where \`userId\` was null for the entire session. |
|
|
74
|
+
| + [orders](#orders ) | No | integer | No | - | Count of \`order_submitted\` events (or Order documents scoped to this site, D43) within the bucket. |
|
|
75
|
+
| + [paymentsCompleted](#paymentsCompleted ) | No | integer | No | - | Count of \`payment_completed\` events within the bucket. |
|
|
76
|
+
| + [paymentsFailed](#paymentsFailed ) | No | integer | No | - | Count of \`payment_failed\` events within the bucket. |
|
|
77
|
+
| + [errors](#errors ) | No | integer | No | - | Count of \`error_occurred\` + \`exception_caught\` events within the bucket. |
|
|
78
|
+
| + [eventCounts](#eventCounts ) | No | object | No | - | Per-event-name counts — key is the event name (canonical or custom), value is the count within the bucket. |
|
|
79
|
+
| - [id](#id ) | No | string or null | No | - | (Read-only) Firestore document ID = \`YYYY-MM-DD-HH\`. |
|
|
80
|
+
| + [companyId](#companyId ) | No | string | No | - | (Immutable) FK → Company document ID. |
|
|
81
|
+
| + [siteId](#siteId ) | No | string | No | - | (Immutable) FK → Site document ID (D40). |
|
|
82
|
+
| + [date](#date ) | No | string | No | - | (Immutable) \`YYYY-MM-DD\` UTC for the bucket day. |
|
|
83
|
+
| + [hour](#hour ) | No | integer | No | - | (Immutable) UTC hour of day, 0–23. |
|
|
84
|
+
| + [computedAt](#computedAt ) | No | object | No | In #/definitions/firestore-timestamp | (Read-only) When this rollup was last (re)computed. |
|
|
85
|
+
| - [sourceEventCount](#sourceEventCount ) | No | integer or null | No | - | (Read-only, Optional) Total source events scanned when producing this rollup. |
|
|
86
|
+
|
|
87
|
+
## <a name="totalEvents"></a>1. Property `totalEvents`
|
|
88
|
+
|
|
89
|
+
| | |
|
|
90
|
+
| ------------ | --------- |
|
|
91
|
+
| **Type** | `integer` |
|
|
92
|
+
| **Required** | Yes |
|
|
93
|
+
|
|
94
|
+
**Description:** Total event count within the bucket.
|
|
95
|
+
|
|
96
|
+
| Restrictions | |
|
|
97
|
+
| ------------ | ---------------------- |
|
|
98
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
99
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
100
|
+
|
|
101
|
+
## <a name="pageViews"></a>2. Property `pageViews`
|
|
102
|
+
|
|
103
|
+
| | |
|
|
104
|
+
| ------------ | --------- |
|
|
105
|
+
| **Type** | `integer` |
|
|
106
|
+
| **Required** | Yes |
|
|
107
|
+
|
|
108
|
+
**Description:** Count of `page_view` + `screen_view` events.
|
|
109
|
+
|
|
110
|
+
| Restrictions | |
|
|
111
|
+
| ------------ | ---------------------- |
|
|
112
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
113
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
114
|
+
|
|
115
|
+
## <a name="sessions"></a>3. Property `sessions`
|
|
116
|
+
|
|
117
|
+
| | |
|
|
118
|
+
| ------------ | --------- |
|
|
119
|
+
| **Type** | `integer` |
|
|
120
|
+
| **Required** | Yes |
|
|
121
|
+
|
|
122
|
+
**Description:** Distinct session count within the bucket (by `sessionId`).
|
|
123
|
+
|
|
124
|
+
| Restrictions | |
|
|
125
|
+
| ------------ | ---------------------- |
|
|
126
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
127
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
128
|
+
|
|
129
|
+
## <a name="uniqueUsers"></a>4. Property `uniqueUsers`
|
|
130
|
+
|
|
131
|
+
| | |
|
|
132
|
+
| ------------ | --------- |
|
|
133
|
+
| **Type** | `integer` |
|
|
134
|
+
| **Required** | Yes |
|
|
135
|
+
|
|
136
|
+
**Description:** Distinct identified `userId` count. Anonymous sessions (userId=null) are excluded.
|
|
137
|
+
|
|
138
|
+
| Restrictions | |
|
|
139
|
+
| ------------ | ---------------------- |
|
|
140
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
141
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
142
|
+
|
|
143
|
+
## <a name="anonymousSessions"></a>5. Property `anonymousSessions`
|
|
144
|
+
|
|
145
|
+
| | |
|
|
146
|
+
| ------------ | --------- |
|
|
147
|
+
| **Type** | `integer` |
|
|
148
|
+
| **Required** | Yes |
|
|
149
|
+
|
|
150
|
+
**Description:** Distinct session count where `userId` was null for the entire session.
|
|
151
|
+
|
|
152
|
+
| Restrictions | |
|
|
153
|
+
| ------------ | ---------------------- |
|
|
154
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
155
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
156
|
+
|
|
157
|
+
## <a name="orders"></a>6. Property `orders`
|
|
158
|
+
|
|
159
|
+
| | |
|
|
160
|
+
| ------------ | --------- |
|
|
161
|
+
| **Type** | `integer` |
|
|
162
|
+
| **Required** | Yes |
|
|
163
|
+
|
|
164
|
+
**Description:** Count of `order_submitted` events (or Order documents scoped to this site, D43) within the bucket.
|
|
165
|
+
|
|
166
|
+
| Restrictions | |
|
|
167
|
+
| ------------ | ---------------------- |
|
|
168
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
169
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
170
|
+
|
|
171
|
+
## <a name="paymentsCompleted"></a>7. Property `paymentsCompleted`
|
|
172
|
+
|
|
173
|
+
| | |
|
|
174
|
+
| ------------ | --------- |
|
|
175
|
+
| **Type** | `integer` |
|
|
176
|
+
| **Required** | Yes |
|
|
177
|
+
|
|
178
|
+
**Description:** Count of `payment_completed` events within the bucket.
|
|
179
|
+
|
|
180
|
+
| Restrictions | |
|
|
181
|
+
| ------------ | ---------------------- |
|
|
182
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
183
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
184
|
+
|
|
185
|
+
## <a name="paymentsFailed"></a>8. Property `paymentsFailed`
|
|
186
|
+
|
|
187
|
+
| | |
|
|
188
|
+
| ------------ | --------- |
|
|
189
|
+
| **Type** | `integer` |
|
|
190
|
+
| **Required** | Yes |
|
|
191
|
+
|
|
192
|
+
**Description:** Count of `payment_failed` events within the bucket.
|
|
193
|
+
|
|
194
|
+
| Restrictions | |
|
|
195
|
+
| ------------ | ---------------------- |
|
|
196
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
197
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
198
|
+
|
|
199
|
+
## <a name="errors"></a>9. Property `errors`
|
|
200
|
+
|
|
201
|
+
| | |
|
|
202
|
+
| ------------ | --------- |
|
|
203
|
+
| **Type** | `integer` |
|
|
204
|
+
| **Required** | Yes |
|
|
205
|
+
|
|
206
|
+
**Description:** Count of `error_occurred` + `exception_caught` events within the bucket.
|
|
207
|
+
|
|
208
|
+
| Restrictions | |
|
|
209
|
+
| ------------ | ---------------------- |
|
|
210
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
211
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
212
|
+
|
|
213
|
+
## <a name="eventCounts"></a>10. Property `eventCounts`
|
|
214
|
+
|
|
215
|
+
| | |
|
|
216
|
+
| ------------------------- | ---------------------------------------------------------------------------------------- |
|
|
217
|
+
| **Type** | `object` |
|
|
218
|
+
| **Required** | Yes |
|
|
219
|
+
| **Additional properties** | [Each additional property must conform to the schema](#eventCounts_additionalProperties) |
|
|
220
|
+
|
|
221
|
+
**Description:** Per-event-name counts — key is the event name (canonical or custom), value is the count within the bucket.
|
|
222
|
+
|
|
223
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
224
|
+
| ---------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
|
|
225
|
+
| - [](#eventCounts_additionalProperties ) | No | integer | No | - | - |
|
|
226
|
+
|
|
227
|
+
### <a name="eventCounts_additionalProperties"></a>10.1. Property `additionalProperties`
|
|
228
|
+
|
|
229
|
+
| | |
|
|
230
|
+
| ------------ | --------- |
|
|
231
|
+
| **Type** | `integer` |
|
|
232
|
+
| **Required** | No |
|
|
233
|
+
|
|
234
|
+
| Restrictions | |
|
|
235
|
+
| ------------ | ---------------------- |
|
|
236
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
237
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
238
|
+
|
|
239
|
+
## <a name="id"></a>11. Property `id`
|
|
240
|
+
|
|
241
|
+
| | |
|
|
242
|
+
| ------------ | ---------------- |
|
|
243
|
+
| **Type** | `string or null` |
|
|
244
|
+
| **Required** | No |
|
|
245
|
+
|
|
246
|
+
**Description:** (Read-only) Firestore document ID = `YYYY-MM-DD-HH`.
|
|
247
|
+
|
|
248
|
+
:::warning Server-set
|
|
249
|
+
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.
|
|
250
|
+
:::
|
|
251
|
+
|
|
252
|
+
## <a name="companyId"></a>12. Property `companyId`
|
|
253
|
+
|
|
254
|
+
| | |
|
|
255
|
+
| ------------ | -------- |
|
|
256
|
+
| **Type** | `string` |
|
|
257
|
+
| **Required** | Yes |
|
|
258
|
+
|
|
259
|
+
**Description:** (Immutable) FK → Company document ID.
|
|
260
|
+
|
|
261
|
+
:::info Immutable
|
|
262
|
+
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.
|
|
263
|
+
:::
|
|
264
|
+
|
|
265
|
+
## <a name="siteId"></a>13. Property `siteId`
|
|
266
|
+
|
|
267
|
+
| | |
|
|
268
|
+
| ------------ | -------- |
|
|
269
|
+
| **Type** | `string` |
|
|
270
|
+
| **Required** | Yes |
|
|
271
|
+
|
|
272
|
+
**Description:** (Immutable) FK → Site document ID (D40).
|
|
273
|
+
|
|
274
|
+
:::info Immutable
|
|
275
|
+
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.
|
|
276
|
+
:::
|
|
277
|
+
|
|
278
|
+
## <a name="date"></a>14. Property `date`
|
|
279
|
+
|
|
280
|
+
| | |
|
|
281
|
+
| ------------ | -------- |
|
|
282
|
+
| **Type** | `string` |
|
|
283
|
+
| **Required** | Yes |
|
|
284
|
+
|
|
285
|
+
**Description:** (Immutable) `YYYY-MM-DD` UTC for the bucket day.
|
|
286
|
+
|
|
287
|
+
:::info Immutable
|
|
288
|
+
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.
|
|
289
|
+
:::
|
|
290
|
+
|
|
291
|
+
## <a name="hour"></a>15. Property `hour`
|
|
292
|
+
|
|
293
|
+
| | |
|
|
294
|
+
| ------------ | --------- |
|
|
295
|
+
| **Type** | `integer` |
|
|
296
|
+
| **Required** | Yes |
|
|
297
|
+
|
|
298
|
+
**Description:** (Immutable) UTC hour of day, 0–23.
|
|
299
|
+
|
|
300
|
+
| Restrictions | |
|
|
301
|
+
| ------------ | ---------------------- |
|
|
302
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
303
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
304
|
+
|
|
305
|
+
:::info Immutable
|
|
306
|
+
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.
|
|
307
|
+
:::
|
|
308
|
+
|
|
309
|
+
## <a name="computedAt"></a>16. Property `computedAt`
|
|
310
|
+
|
|
311
|
+
| | |
|
|
312
|
+
| ------------------------- | --------------------------------- |
|
|
313
|
+
| **Type** | `object` |
|
|
314
|
+
| **Required** | Yes |
|
|
315
|
+
| **Additional properties** | Not allowed |
|
|
316
|
+
| **Defined in** | #/definitions/firestore-timestamp |
|
|
317
|
+
|
|
318
|
+
**Description:** (Read-only) When this rollup was last (re)computed.
|
|
319
|
+
|
|
320
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
321
|
+
| ------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
|
|
322
|
+
| + [_seconds](#computedAt__seconds ) | No | integer | No | - | - |
|
|
323
|
+
| + [_nanoseconds](#computedAt__nanoseconds ) | No | integer | No | - | - |
|
|
324
|
+
|
|
325
|
+
### <a name="computedAt__seconds"></a>16.1. Property `_seconds`
|
|
326
|
+
|
|
327
|
+
| | |
|
|
328
|
+
| ------------ | --------- |
|
|
329
|
+
| **Type** | `integer` |
|
|
330
|
+
| **Required** | Yes |
|
|
331
|
+
|
|
332
|
+
| Restrictions | |
|
|
333
|
+
| ------------ | ---------------------- |
|
|
334
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
335
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
336
|
+
|
|
337
|
+
### <a name="computedAt__nanoseconds"></a>16.2. Property `_nanoseconds`
|
|
338
|
+
|
|
339
|
+
| | |
|
|
340
|
+
| ------------ | --------- |
|
|
341
|
+
| **Type** | `integer` |
|
|
342
|
+
| **Required** | Yes |
|
|
343
|
+
|
|
344
|
+
| Restrictions | |
|
|
345
|
+
| ------------ | ---------------------- |
|
|
346
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
347
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
348
|
+
|
|
349
|
+
:::warning Server-set
|
|
350
|
+
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.
|
|
351
|
+
:::
|
|
352
|
+
|
|
353
|
+
## <a name="sourceEventCount"></a>17. Property `sourceEventCount`
|
|
354
|
+
|
|
355
|
+
| | |
|
|
356
|
+
| ------------ | ----------------- |
|
|
357
|
+
| **Type** | `integer or null` |
|
|
358
|
+
| **Required** | No |
|
|
359
|
+
|
|
360
|
+
**Description:** (Read-only, Optional) Total source events scanned when producing this rollup.
|
|
361
|
+
|
|
362
|
+
| Restrictions | |
|
|
363
|
+
| ------------ | ---------------------- |
|
|
364
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
365
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
366
|
+
|
|
367
|
+
----------------------------------------------------------------------------------------------------------------------------
|
|
368
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:54 +0000
|
|
369
|
+
|
|
370
|
+
:::warning Server-set
|
|
371
|
+
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.
|
|
372
|
+
:::
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "BookingVersion"
|
|
3
3
|
sidebar_label: "BookingVersion"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 7
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# BookingVersion
|
|
@@ -270,7 +270,7 @@ Dot-notation paths for nested fields (e.g. "bookingDates.0.status"). Populated b
|
|
|
270
270
|
| **Additional properties** | Any type allowed |
|
|
271
271
|
|
|
272
272
|
----------------------------------------------------------------------------------------------------------------------------
|
|
273
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
273
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:54 +0000
|
|
274
274
|
|
|
275
275
|
:::warning Server-set
|
|
276
276
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Booking"
|
|
3
3
|
sidebar_label: "Booking"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 6
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# Booking
|
|
@@ -1739,7 +1739,7 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
1739
1739
|
**Description:** When true, suppresses Firebase notification triggers (D20/IG-8).
|
|
1740
1740
|
|
|
1741
1741
|
----------------------------------------------------------------------------------------------------------------------------
|
|
1742
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
1742
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
1743
1743
|
|
|
1744
1744
|
## Related Decisions
|
|
1745
1745
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "CustomerPaymentAllocation"
|
|
3
3
|
sidebar_label: "CustomerPaymentAllocation"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 10
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# CustomerPaymentAllocation
|
|
@@ -329,7 +329,7 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
329
329
|
| **Maximum** | ≤ 9007199254740991 |
|
|
330
330
|
|
|
331
331
|
----------------------------------------------------------------------------------------------------------------------------
|
|
332
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
332
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
333
333
|
|
|
334
334
|
:::warning Server-set
|
|
335
335
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "CustomerPayment"
|
|
3
3
|
sidebar_label: "CustomerPayment"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 9
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# CustomerPayment
|
|
@@ -379,7 +379,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
379
379
|
| **Required** | No |
|
|
380
380
|
|
|
381
381
|
----------------------------------------------------------------------------------------------------------------------------
|
|
382
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
382
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
383
383
|
|
|
384
384
|
:::warning Server-set
|
|
385
385
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Customer"
|
|
3
3
|
sidebar_label: "Customer"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 8
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# Customer
|
|
@@ -459,7 +459,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
459
459
|
**Description:** (Read-only, Denormalized) Derived summary from loyalty/status subcollection (D08). Source of truth is LoyaltyStatus.pointsBalance.
|
|
460
460
|
|
|
461
461
|
----------------------------------------------------------------------------------------------------------------------------
|
|
462
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
462
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
463
463
|
|
|
464
464
|
:::warning Server-set
|
|
465
465
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Event"
|
|
3
3
|
sidebar_label: "Event"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 11
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# Event
|
|
@@ -372,7 +372,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
372
372
|
**Description:** (Immutable) FK → User/staff UID who created this event.
|
|
373
373
|
|
|
374
374
|
----------------------------------------------------------------------------------------------------------------------------
|
|
375
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
375
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
376
376
|
|
|
377
377
|
:::info Immutable
|
|
378
378
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "LoyaltyConfig"
|
|
3
3
|
sidebar_label: "LoyaltyConfig"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 12
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# LoyaltyConfig
|
|
@@ -304,7 +304,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
304
304
|
| **Required** | No |
|
|
305
305
|
|
|
306
306
|
----------------------------------------------------------------------------------------------------------------------------
|
|
307
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
307
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
308
308
|
|
|
309
309
|
:::warning Server-set
|
|
310
310
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "LoyaltyReward"
|
|
3
3
|
sidebar_label: "LoyaltyReward"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 13
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# LoyaltyReward
|
|
@@ -229,7 +229,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
229
229
|
| **Required** | No |
|
|
230
230
|
|
|
231
231
|
----------------------------------------------------------------------------------------------------------------------------
|
|
232
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
232
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
233
233
|
|
|
234
234
|
:::warning Server-set
|
|
235
235
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "LoyaltyStatus"
|
|
3
3
|
sidebar_label: "LoyaltyStatus"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 14
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# LoyaltyStatus
|
|
@@ -315,7 +315,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
315
315
|
| **Required** | No |
|
|
316
316
|
|
|
317
317
|
----------------------------------------------------------------------------------------------------------------------------
|
|
318
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
318
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
319
319
|
|
|
320
320
|
:::warning Server-set
|
|
321
321
|
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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "LoyaltyTransaction"
|
|
3
3
|
sidebar_label: "LoyaltyTransaction"
|
|
4
|
-
sidebar_position:
|
|
4
|
+
sidebar_position: 15
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# LoyaltyTransaction
|
|
@@ -313,7 +313,7 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
313
313
|
**Description:** (Immutable, Denormalized) From User display name at creation time.
|
|
314
314
|
|
|
315
315
|
----------------------------------------------------------------------------------------------------------------------------
|
|
316
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-
|
|
316
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:55 +0000
|
|
317
317
|
|
|
318
318
|
:::info Immutable
|
|
319
319
|
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.
|