@ingenx-io/valets-schema-mcp-server 0.1.2 → 0.1.4

package/data/docs/models/loyalty-reward.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyReward"
 sidebar_label: "LoyaltyReward"
-sidebar_position: 8
+sidebar_position: 10
 ---
 
 # LoyaltyReward
@@ -229,7 +229,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/loyalty-status.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyStatus"
 sidebar_label: "LoyaltyStatus"
-sidebar_position: 9
+sidebar_position: 11
 ---
 
 # LoyaltyStatus
@@ -315,7 +315,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/loyalty-transaction.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyTransaction"
 sidebar_label: "LoyaltyTransaction"
-sidebar_position: 10
+sidebar_position: 12
 ---
 
 # LoyaltyTransaction
@@ -313,7 +313,7 @@ Set at creation only. This field cannot be modified after the document is create
 **Description:** (Immutable, Denormalized) From User display name at creation time.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::info Immutable
 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.

package/data/docs/models/magic-link-request.md

@@ -0,0 +1,285 @@
+---
+title: "MagicLinkRequest"
+sidebar_label: "MagicLinkRequest"
+sidebar_position: 13
+---
+
+# MagicLinkRequest
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "siteId": "sit_ref123",
+  "email": "amadou@example.com",
+  "phone": "+225 07 00 11 22",
+  "ip": "ip",
+  "allowed": true,
+  "link": "link",
+  "tier": "Gold",
+  "authStatusReason": "Customer request",
+  "referredBy": "referredBy",
+  "requestedAt": "requestedAt",
+  "verifyReason": null,
+  "verified": null,
+  "verifiedAt": "verifiedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `siteId`](#siteId)
+- [4. Property `email`](#email)
+- [5. Property `phone`](#phone)
+- [6. Property `ip`](#ip)
+- [7. Property `allowed`](#allowed)
+- [8. Property `link`](#link)
+- [9. Property `tier`](#tier)
+- [10. Property `authStatusReason`](#authStatusReason)
+- [11. Property `referredBy`](#referredBy)
+- [12. Property `requestedAt`](#requestedAt)
+  - [12.1. Property `_seconds`](#requestedAt__seconds)
+  - [12.2. Property `_nanoseconds`](#requestedAt__nanoseconds)
+- [13. Property `verifyReason`](#verifyReason)
+- [14. Property `verified`](#verified)
+- [15. Property `verifiedAt`](#verifiedAt)
+  - [15.1. Property `firestore-timestamp`](#verifiedAt_anyOf_i0)
+  - [15.2. Property `item 1`](#verifiedAt_anyOf_i1)
+
+|                           |                                  |
+| ------------------------- | -------------------------------- |
+| **Type**                  | `object`                         |
+| **Required**              | No                               |
+| **Additional properties** | Not allowed                      |
+| **Defined in**            | #/definitions/magic-link-request |
+
+**Description:** MagicLinkRequest model (D40 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/magic_link_requests/\{requestId\}. Authentication audit log — every request is logged regardless of outcome. Two-stage write: Log() then LogVerify().
+
+| Property                                 | Pattern | Type            | Deprecated | Definition                           | Title/Description                                                                                                                |
+| ---------------------------------------- | ------- | --------------- | ---------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                             | No      | string or null  | No         | -                                    | (Read-only) Firestore document ID. 16-byte random hex.                                                                           |
+| + [companyId](#companyId )               | No      | string          | No         | -                                    | (Immutable) FK → Company document ID.                                                                                            |
+| + [siteId](#siteId )                     | No      | string          | No         | -                                    | (Immutable) FK → Site document ID (D40 sub-tenant scope).                                                                        |
+| + [email](#email )                       | No      | string          | No         | -                                    | Populated if identifier is email; empty string if phone. Mutually exclusive with phone per document.                             |
+| + [phone](#phone )                       | No      | string          | No         | -                                    | Populated if identifier is E.164 format (starts with +); empty string if email.                                                  |
+| + [ip](#ip )                             | No      | string          | No         | -                                    | Client IP from X-Forwarded-For or RemoteAddr.                                                                                    |
+| + [allowed](#allowed )                   | No      | boolean         | No         | -                                    | Whether the user passed the access control check.                                                                                |
+| + [link](#link )                         | No      | string          | No         | -                                    | Magic-link URL — non-empty only when DEV_MODE=true; empty in production (audit integrity).                                       |
+| + [tier](#tier )                         | No      | string          | No         | -                                    | Access tier selected by the user. Free string per site (ING-304 open question — tier values are site-specific today).            |
+| + [authStatusReason](#authStatusReason ) | No      | string          | No         | -                                    | Outcome reason code: whitelist \| allowed_users \| payment_redirect \| payment_complete \| not_allowed \| redirected_to_payment. |
+| + [referredBy](#referredBy )             | No      | string          | No         | -                                    | Contact identifier of the referrer, resolved from submitted referral_code; empty if none.                                        |
+| + [requestedAt](#requestedAt )           | No      | object          | No         | In #/definitions/firestore-timestamp | RFC3339Nano UTC at request time.                                                                                                 |
+| - [verifyReason](#verifyReason )         | No      | string or null  | No         | -                                    | Verify outcome reason: mirrors authStatusReason on success, or link_expired \| link_invalid \| not_allowed.                      |
+| - [verified](#verified )                 | No      | boolean or null | No         | -                                    | Whether the verify attempt succeeded.                                                                                            |
+| - [verifiedAt](#verifiedAt )             | No      | Combination     | No         | -                                    | RFC3339Nano UTC at verify time.                                                                                                  |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID. 16-byte random hex.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="companyId"></a>2. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID.
+
+:::info Immutable
+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.
+:::
+
+## <a name="siteId"></a>3. Property `siteId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Site document ID (D40 sub-tenant scope).
+
+:::info Immutable
+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.
+:::
+
+## <a name="email"></a>4. Property `email`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Populated if identifier is email; empty string if phone. Mutually exclusive with phone per document.
+
+## <a name="phone"></a>5. Property `phone`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Populated if identifier is E.164 format (starts with +); empty string if email.
+
+## <a name="ip"></a>6. Property `ip`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Client IP from X-Forwarded-For or RemoteAddr.
+
+## <a name="allowed"></a>7. Property `allowed`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `boolean` |
+| **Required** | Yes       |
+
+**Description:** Whether the user passed the access control check.
+
+## <a name="link"></a>8. Property `link`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Magic-link URL — non-empty only when DEV_MODE=true; empty in production (audit integrity).
+
+## <a name="tier"></a>9. Property `tier`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Access tier selected by the user. Free string per site (ING-304 open question — tier values are site-specific today).
+
+## <a name="authStatusReason"></a>10. Property `authStatusReason`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Outcome reason code: whitelist | allowed_users | payment_redirect | payment_complete | not_allowed | redirected_to_payment.
+
+## <a name="referredBy"></a>11. Property `referredBy`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Contact identifier of the referrer, resolved from submitted referral_code; empty if none.
+
+## <a name="requestedAt"></a>12. Property `requestedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** RFC3339Nano UTC at request time.
+
+| Property                                     | Pattern | Type    | Deprecated | Definition | Title/Description |
+| -------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#requestedAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#requestedAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="requestedAt__seconds"></a>12.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="requestedAt__nanoseconds"></a>12.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="verifyReason"></a>13. Property `verifyReason`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Verify outcome reason: mirrors authStatusReason on success, or link_expired | link_invalid | not_allowed.
+
+## <a name="verified"></a>14. Property `verified`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `boolean or null` |
+| **Required** | No                |
+
+**Description:** Whether the verify attempt succeeded.
+
+## <a name="verifiedAt"></a>15. Property `verifiedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** RFC3339Nano UTC at verify time.
+
+| Any of(Option)                              |
+| ------------------------------------------- |
+| [firestore-timestamp](#verifiedAt_anyOf_i0) |
+| [item 1](#verifiedAt_anyOf_i1)              |
+
+### <a name="verifiedAt_anyOf_i0"></a>15.1. Property `firestore-timestamp`
+
+|                           |                             |
+| ------------------------- | --------------------------- |
+| **Type**                  | `object`                    |
+| **Required**              | No                          |
+| **Additional properties** | Not allowed                 |
+| **Same definition as**    | [requestedAt](#requestedAt) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="verifiedAt_anyOf_i1"></a>15.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000

package/data/docs/models/metrics-current.md

@@ -1,7 +1,7 @@
 ---
 title: "MetricsCurrent"
 sidebar_label: "MetricsCurrent"
-sidebar_position: 11
+sidebar_position: 14
 ---
 
 # MetricsCurrent
@@ -525,7 +525,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

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

@@ -1,7 +1,7 @@
 ---
 title: "MetricsDaily"
 sidebar_label: "MetricsDaily"
-sidebar_position: 12
+sidebar_position: 15
 ---
 
 # MetricsDaily
@@ -541,7 +541,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 **Description:** (Read-only) YYYY-MM-DD document ID repeated as a field. Identifies the day this snapshot covers.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/metrics-monthly.md

@@ -1,7 +1,7 @@
 ---
 title: "MetricsMonthly"
 sidebar_label: "MetricsMonthly"
-sidebar_position: 13
+sidebar_position: 16
 ---
 
 # MetricsMonthly
@@ -541,7 +541,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 **Description:** (Read-only) YYYY-MM document ID repeated as a field. Identifies the month this rollup covers.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/order-item.md

@@ -1,7 +1,7 @@
 ---
 title: "OrderItem"
 sidebar_label: "OrderItem"
-sidebar_position: 15
+sidebar_position: 18
 ---
 
 # OrderItem
@@ -350,7 +350,7 @@ TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. C
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/order.md

@@ -1,7 +1,7 @@
 ---
 title: "Order"
 sidebar_label: "Order"
-sidebar_position: 14
+sidebar_position: 17
 ---
 
 # Order
@@ -1624,7 +1624,7 @@ Set only by the mobile app when the user manually edits the order total. Dashboa
 **Description:** FK → Sale.id. Link to associated Sale document.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 ## Related Decisions
 

package/data/docs/models/payment-summary.md

@@ -0,0 +1,123 @@
+---
+title: "PaymentSummary"
+sidebar_label: "PaymentSummary"
+sidebar_position: 99
+---
+
+# PaymentSummary
+
+**Collection:** `companies/{companyId}/paymentSummaries/{period}`
+
+Aggregated payment totals broken down by payment method for a given period. This is a **server-owned, read-only** model — clients never write to it directly. It is maintained by Cloud Function triggers that fire on `Order.payments[]` and `CustomerPayment` changes.
+
+## Schema
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": "2026-03-09",
+  "companyId": "comp_xyz789",
+  "period": "2026-03-09",
+  "periodType": "DAILY",
+  "paymentsByMethod": {
+    "CASH": { "total": 245000, "count": 12 },
+    "WAVE": { "total": 180000, "count": 8 },
+    "ORANGE_MONEY": { "total": 95000, "count": 5 }
+  },
+  "grandTotal": 520000,
+  "totalCount": 25,
+  "currency": "XOF",
+  "lastUpdatedAt": { "_seconds": 1741478400, "_nanoseconds": 0 },
+  "createdAt": { "_seconds": 1741435200, "_nanoseconds": 0 }
+}
+```
+
+</details>
+
+## Fields
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `id` | `string` | — | (Read-only) Document ID. Matches the period key. |
+| `companyId` | `string` | + | (Immutable) FK → Company document ID. |
+| `period` | `string` | + | Period key: `YYYY-MM-DD` (daily), `YYYY-Www` (weekly), `YYYY-MM` (monthly). |
+| `periodType` | `enum` | + | `DAILY`, `WEEKLY`, or `MONTHLY`. |
+| `paymentsByMethod` | `map` | + | Keyed by PaymentMethod enum value. Each value has `total` (number) and `count` (integer). |
+| `grandTotal` | `number` | + | (Read-only) Sum of all `paymentsByMethod[*].total`. |
+| `totalCount` | `integer` | + | (Read-only) Sum of all `paymentsByMethod[*].count`. |
+| `currency` | `string` | + | Locked to `XOF`. |
+| `lastUpdatedAt` | `Timestamp` | — | (Read-only) Last increment timestamp. |
+| `createdAt` | `Timestamp` | + | (Read-only) Server-generated creation timestamp. |
+
+:::info PaymentMethod keys
+The `paymentsByMethod` map uses [PaymentMethod](/enums/payment-method) enum values as keys: `CASH`, `WAVE`, `ORANGE_MONEY`, `CREDIT_CARD`, etc. Missing keys imply zero for that method.
+:::
+
+:::warning Server-owned
+This document is entirely server-set. All fields are computed by Cloud Function triggers. Clients should treat it as read-only.
+:::
+
+## Trigger design
+
+### Source events
+
+The summary is updated by **two independent triggers**:
+
+1. **`onOrderPaymentChange`** — fires when `Order.payments[]` array changes (new payment added or existing payment updated). Computes the delta and applies `FieldValue.increment()` to the matching `paymentsByMethod.{method}.total` and `.count`, plus `grandTotal` and `totalCount`.
+
+2. **`onCustomerPaymentWrite`** — fires on `CustomerPayment` create/update. Same increment logic for standalone customer payments not tied to an order.
+
+### Increment pattern
+
+```typescript
+// Pseudo-code for the trigger
+const summaryRef = db.doc(
+  `companies/${companyId}/paymentSummaries/${todayKey}`
+);
+
+await summaryRef.set({
+  companyId,
+  period: todayKey,
+  periodType: 'DAILY',
+  currency: 'XOF',
+  [`paymentsByMethod.${method}.total`]: FieldValue.increment(amount),
+  [`paymentsByMethod.${method}.count`]: FieldValue.increment(1),
+  grandTotal: FieldValue.increment(amount),
+  totalCount: FieldValue.increment(1),
+  lastUpdatedAt: FieldValue.serverTimestamp(),
+  createdAt: FieldValue.serverTimestamp(), // only sets on first write (merge)
+}, { merge: true });
+```
+
+### Idempotency
+
+To avoid double-counting on trigger retries, the trigger should check if the payment has already been counted (e.g., via a `_summarized` flag on the payment or by comparing `before`/`after` snapshots in the `onUpdate` trigger).
+
+### Rollups
+
+A scheduled Cloud Function (daily at midnight WAT) can roll up daily summaries into weekly and monthly documents. This is optional — daily granularity alone may be sufficient for the dashboard.
+
+## Querying
+
+```typescript
+// Get today's summary
+const today = '2026-03-09';
+const snap = await db.doc(`companies/${companyId}/paymentSummaries/${today}`).get();
+const summary = snap.data(); // PaymentSummary
+
+// Get summaries for a date range
+const snaps = await db.collection(`companies/${companyId}/paymentSummaries`)
+  .where('periodType', '==', 'DAILY')
+  .where('period', '>=', '2026-03-01')
+  .where('period', '<=', '2026-03-09')
+  .get();
+```
+
+## Related
+
+- [PaymentMethod](/enums/payment-method) — enum used as map keys
+- [CustomerPayment](/models/customer-payment) — source event for trigger
+- [Order](/models/order) — `payments[]` array is the other source event
+- Decision D02 — Unified PaymentMethod enum

package/data/docs/models/sale.md

@@ -1,7 +1,7 @@
 ---
 title: "Sale"
 sidebar_label: "Sale"
-sidebar_position: 16
+sidebar_position: 19
 ---
 
 # Sale
@@ -524,7 +524,7 @@ Set at creation only. This field cannot be modified after the document is create
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-03-09 at 13:15:53 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 21:21:09 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.