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

package/data/docs/models/notification-record.md

@@ -0,0 +1,619 @@
+---
+title: "NotificationRecord"
+sidebar_label: "NotificationRecord"
+sidebar_position: 20
+---
+
+# NotificationRecord
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "type": "phone",
+  "status": "status",
+  "subject": null,
+  "recipients": {
+    "to": [
+      {}
+    ]
+  },
+  "relatedEntity": {
+    "type": "phone",
+    "id": "bk_abc123def456"
+  },
+  "wamid": null,
+  "templateParams": null,
+  "metadata": null,
+  "error": null,
+  "sentAt": "sentAt",
+  "createdAt": "createdAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `type`](#type)
+- [3. Property `status`](#status)
+- [4. Property `subject`](#subject)
+- [5. Property `recipients`](#recipients)
+  - [5.1. Property `to`](#recipients_to)
+    - [5.1.1. to items](#recipients_to_items)
+      - [5.1.1.1. Property `email`](#recipients_to_items_email)
+      - [5.1.1.2. Property `phone`](#recipients_to_items_phone)
+      - [5.1.1.3. Property `name`](#recipients_to_items_name)
+      - [5.1.1.4. Property `role`](#recipients_to_items_role)
+  - [5.2. Property `cc`](#recipients_cc)
+    - [5.2.1. cc items](#recipients_cc_items)
+      - [5.2.1.1. Property `email`](#recipients_cc_items_email)
+      - [5.2.1.2. Property `phone`](#recipients_cc_items_phone)
+      - [5.2.1.3. Property `name`](#recipients_cc_items_name)
+      - [5.2.1.4. Property `role`](#recipients_cc_items_role)
+  - [5.3. Property `bcc`](#recipients_bcc)
+    - [5.3.1. bcc items](#recipients_bcc_items)
+      - [5.3.1.1. Property `email`](#recipients_bcc_items_email)
+      - [5.3.1.2. Property `phone`](#recipients_bcc_items_phone)
+      - [5.3.1.3. Property `name`](#recipients_bcc_items_name)
+      - [5.3.1.4. Property `role`](#recipients_bcc_items_role)
+- [6. Property `relatedEntity`](#relatedEntity)
+  - [6.1. Property `type`](#relatedEntity_type)
+  - [6.2. Property `id`](#relatedEntity_id)
+- [7. Property `wamid`](#wamid)
+- [8. Property `templateParams`](#templateParams)
+  - [8.1. Property `additionalProperties`](#templateParams_additionalProperties)
+- [9. Property `metadata`](#metadata)
+  - [9.1. Property `additionalProperties`](#metadata_additionalProperties)
+- [10. Property `error`](#error)
+- [11. Property `sentAt`](#sentAt)
+  - [11.1. Property `_seconds`](#sentAt__seconds)
+  - [11.2. Property `_nanoseconds`](#sentAt__nanoseconds)
+- [12. Property `createdAt`](#createdAt)
+  - [12.1. Property `_seconds`](#sentAt__seconds)
+  - [12.2. Property `_nanoseconds`](#sentAt__nanoseconds)
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | No                                |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/notification-record |
+
+**Description:** NotificationRecord — backend-written, multi-channel notification audit log (GH#48). Paths: companies/\{cid\}/notifications/\{id\} (always) and companies/\{cid\}/orders/\{oid\}/notifications/\{id\} (dual-write when relatedEntity.type=order). Consumers read only. Distinct from WhatsappOutboundMessage (GH#43).
+
+| Property                             | Pattern | Type             | Deprecated | Definition                            | Title/Description                                                                                                               |
+| ------------------------------------ | ------- | ---------------- | ---------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                         | No      | string or null   | No         | -                                     | (Read-only) Firestore document ID, auto-generated. Same ID is used in both the company-wide and order-scoped copies.            |
+| + [type](#type )                     | No      | enum (of string) | No         | In #/definitions/notification-channel | (Read-only) Delivery channel.                                                                                                   |
+| + [status](#status )                 | No      | enum (of string) | No         | In #/definitions/notification-status  | (Read-only) Delivery status after the send attempt.                                                                             |
+| - [subject](#subject )               | No      | string or null   | No         | -                                     | (Read-only) Subject line. Present for email notifications only.                                                                 |
+| + [recipients](#recipients )         | No      | object           | No         | -                                     | (Read-only) Recipients of the notification.                                                                                     |
+| + [relatedEntity](#relatedEntity )   | No      | object           | No         | -                                     | (Read-only) Entity that triggered the notification. type=order triggers the dual-write to the order subcollection.              |
+| - [wamid](#wamid )                   | No      | string or null   | No         | -                                     | (Read-only) WhatsApp message ID from the Meta API response. Present on successful whatsapp sends only.                          |
+| - [templateParams](#templateParams ) | No      | object or null   | No         | -                                     | (Read-only) Filled-in template variable values at send time. Allows reconstructing the sent message without fetching from Meta. |
+| - [metadata](#metadata )             | No      | object or null   | No         | -                                     | (Read-only) Channel-specific extras (e.g. senderPhoneId, templateName, orderNumber).                                            |
+| - [error](#error )                   | No      | string or null   | No         | -                                     | (Read-only) Failure reason. Present on status=failed.                                                                           |
+| + [sentAt](#sentAt )                 | No      | object           | No         | In #/definitions/firestore-timestamp  | (Read-only) When the send was attempted.                                                                                        |
+| + [createdAt](#createdAt )           | No      | object           | No         | In #/definitions/firestore-timestamp  | (Read-only) When the record was created.                                                                                        |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID, auto-generated. Same ID is used in both the company-wide and order-scoped copies.
+
+:::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="type"></a>2. Property `type`
+
+|                |                                    |
+| -------------- | ---------------------------------- |
+| **Type**       | `enum (of string)`                 |
+| **Required**   | Yes                                |
+| **Defined in** | #/definitions/notification-channel |
+
+**Description:** (Read-only) Delivery channel.
+
+Must be one of:
+* "email"
+* "whatsapp"
+* "sms"
+* "push"
+
+:::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="status"></a>3. Property `status`
+
+|                |                                   |
+| -------------- | --------------------------------- |
+| **Type**       | `enum (of string)`                |
+| **Required**   | Yes                               |
+| **Defined in** | #/definitions/notification-status |
+
+**Description:** (Read-only) Delivery status after the send attempt.
+
+Must be one of:
+* "sent"
+* "failed"
+* "pending"
+
+:::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="subject"></a>4. Property `subject`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Subject line. Present for email notifications only.
+
+:::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="recipients"></a>5. Property `recipients`
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | Yes         |
+| **Additional properties** | Not allowed |
+
+**Description:** (Read-only) Recipients of the notification.
+
+| Property                  | Pattern | Type            | Deprecated | Definition | Title/Description       |
+| ------------------------- | ------- | --------------- | ---------- | ---------- | ----------------------- |
+| + [to](#recipients_to )   | No      | array of object | No         | -          | Primary recipients.     |
+| - [cc](#recipients_cc )   | No      | array of object | No         | -          | CC recipients (email).  |
+| - [bcc](#recipients_bcc ) | No      | array of object | No         | -          | BCC recipients (email). |
+
+### <a name="recipients_to"></a>5.1. Property `to`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `array of object` |
+| **Required** | Yes               |
+
+**Description:** Primary recipients.
+
+|                      | Array restrictions |
+| -------------------- | ------------------ |
+| **Min items**        | N/A                |
+| **Max items**        | N/A                |
+| **Items unicity**    | False              |
+| **Additional items** | False              |
+| **Tuple validation** | See below          |
+
+| Each item of this array must be  | Description                       |
+| -------------------------------- | --------------------------------- |
+| [to items](#recipients_to_items) | A notification recipient (GH#48). |
+
+#### <a name="recipients_to_items"></a>5.1.1. to items
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | No          |
+| **Additional properties** | Not allowed |
+
+**Description:** A notification recipient (GH#48).
+
+| Property                               | Pattern | Type   | Deprecated | Definition | Title/Description                                                       |
+| -------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------- |
+| - [email](#recipients_to_items_email ) | No      | string | No         | -          | Recipient email address. Present for email notifications.               |
+| - [phone](#recipients_to_items_phone ) | No      | string | No         | -          | Recipient phone number (E.164). Present for whatsapp/sms notifications. |
+| - [name](#recipients_to_items_name )   | No      | string | No         | -          | Recipient display name.                                                 |
+| - [role](#recipients_to_items_role )   | No      | string | No         | -          | Recipient role (e.g. organizer, customer).                              |
+
+##### <a name="recipients_to_items_email"></a>5.1.1.1. Property `email`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient email address. Present for email notifications.
+
+##### <a name="recipients_to_items_phone"></a>5.1.1.2. Property `phone`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient phone number (E.164). Present for whatsapp/sms notifications.
+
+##### <a name="recipients_to_items_name"></a>5.1.1.3. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient display name.
+
+##### <a name="recipients_to_items_role"></a>5.1.1.4. Property `role`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient role (e.g. organizer, customer).
+
+### <a name="recipients_cc"></a>5.2. Property `cc`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `array of object` |
+| **Required** | No                |
+
+**Description:** CC recipients (email).
+
+|                      | Array restrictions |
+| -------------------- | ------------------ |
+| **Min items**        | N/A                |
+| **Max items**        | N/A                |
+| **Items unicity**    | False              |
+| **Additional items** | False              |
+| **Tuple validation** | See below          |
+
+| Each item of this array must be  | Description                       |
+| -------------------------------- | --------------------------------- |
+| [cc items](#recipients_cc_items) | A notification recipient (GH#48). |
+
+#### <a name="recipients_cc_items"></a>5.2.1. cc items
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | No          |
+| **Additional properties** | Not allowed |
+
+**Description:** A notification recipient (GH#48).
+
+| Property                               | Pattern | Type   | Deprecated | Definition | Title/Description                                                       |
+| -------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------- |
+| - [email](#recipients_cc_items_email ) | No      | string | No         | -          | Recipient email address. Present for email notifications.               |
+| - [phone](#recipients_cc_items_phone ) | No      | string | No         | -          | Recipient phone number (E.164). Present for whatsapp/sms notifications. |
+| - [name](#recipients_cc_items_name )   | No      | string | No         | -          | Recipient display name.                                                 |
+| - [role](#recipients_cc_items_role )   | No      | string | No         | -          | Recipient role (e.g. organizer, customer).                              |
+
+##### <a name="recipients_cc_items_email"></a>5.2.1.1. Property `email`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient email address. Present for email notifications.
+
+##### <a name="recipients_cc_items_phone"></a>5.2.1.2. Property `phone`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient phone number (E.164). Present for whatsapp/sms notifications.
+
+##### <a name="recipients_cc_items_name"></a>5.2.1.3. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient display name.
+
+##### <a name="recipients_cc_items_role"></a>5.2.1.4. Property `role`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient role (e.g. organizer, customer).
+
+### <a name="recipients_bcc"></a>5.3. Property `bcc`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `array of object` |
+| **Required** | No                |
+
+**Description:** BCC recipients (email).
+
+|                      | Array restrictions |
+| -------------------- | ------------------ |
+| **Min items**        | N/A                |
+| **Max items**        | N/A                |
+| **Items unicity**    | False              |
+| **Additional items** | False              |
+| **Tuple validation** | See below          |
+
+| Each item of this array must be    | Description                       |
+| ---------------------------------- | --------------------------------- |
+| [bcc items](#recipients_bcc_items) | A notification recipient (GH#48). |
+
+#### <a name="recipients_bcc_items"></a>5.3.1. bcc items
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | No          |
+| **Additional properties** | Not allowed |
+
+**Description:** A notification recipient (GH#48).
+
+| Property                                | Pattern | Type   | Deprecated | Definition | Title/Description                                                       |
+| --------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------- |
+| - [email](#recipients_bcc_items_email ) | No      | string | No         | -          | Recipient email address. Present for email notifications.               |
+| - [phone](#recipients_bcc_items_phone ) | No      | string | No         | -          | Recipient phone number (E.164). Present for whatsapp/sms notifications. |
+| - [name](#recipients_bcc_items_name )   | No      | string | No         | -          | Recipient display name.                                                 |
+| - [role](#recipients_bcc_items_role )   | No      | string | No         | -          | Recipient role (e.g. organizer, customer).                              |
+
+##### <a name="recipients_bcc_items_email"></a>5.3.1.1. Property `email`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient email address. Present for email notifications.
+
+##### <a name="recipients_bcc_items_phone"></a>5.3.1.2. Property `phone`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient phone number (E.164). Present for whatsapp/sms notifications.
+
+##### <a name="recipients_bcc_items_name"></a>5.3.1.3. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient display name.
+
+##### <a name="recipients_bcc_items_role"></a>5.3.1.4. Property `role`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Recipient role (e.g. organizer, customer).
+
+:::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="relatedEntity"></a>6. Property `relatedEntity`
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | Yes         |
+| **Additional properties** | Not allowed |
+
+**Description:** (Read-only) Entity that triggered the notification. type=order triggers the dual-write to the order subcollection.
+
+| Property                       | Pattern | Type             | Deprecated | Definition                                | Title/Description                                  |
+| ------------------------------ | ------- | ---------------- | ---------- | ----------------------------------------- | -------------------------------------------------- |
+| + [type](#relatedEntity_type ) | No      | enum (of string) | No         | In #/definitions/notification-entity-type | Entity type this notification relates to.          |
+| + [id](#relatedEntity_id )     | No      | string           | No         | -                                         | Entity document ID (e.g. orderId when type=order). |
+
+### <a name="relatedEntity_type"></a>6.1. Property `type`
+
+|                |                                        |
+| -------------- | -------------------------------------- |
+| **Type**       | `enum (of string)`                     |
+| **Required**   | Yes                                    |
+| **Defined in** | #/definitions/notification-entity-type |
+
+**Description:** Entity type this notification relates to.
+
+Must be one of:
+* "order"
+* "booking"
+* "customer"
+* "digest"
+* "magic_link"
+* "other"
+
+### <a name="relatedEntity_id"></a>6.2. Property `id`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Entity document ID (e.g. orderId when type=order).
+
+:::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="wamid"></a>7. Property `wamid`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) WhatsApp message ID from the Meta API response. Present on successful whatsapp sends only.
+
+:::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="templateParams"></a>8. Property `templateParams`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `object or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Filled-in template variable values at send time. Allows reconstructing the sent message without fetching from Meta.
+
+| Property                                    | Pattern | Type   | Deprecated | Definition | Title/Description |
+| ------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
+| - [](#templateParams_additionalProperties ) | No      | string | No         | -          | -                 |
+
+### <a name="templateParams_additionalProperties"></a>8.1. Property `additionalProperties`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+:::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="metadata"></a>9. Property `metadata`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `object or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Channel-specific extras (e.g. senderPhoneId, templateName, orderNumber).
+
+| Property                              | Pattern | Type   | Deprecated | Definition | Title/Description |
+| ------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
+| - [](#metadata_additionalProperties ) | No      | object | No         | -          | -                 |
+
+### <a name="metadata_additionalProperties"></a>9.1. Property `additionalProperties`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `object`         |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+:::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="error"></a>10. Property `error`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Failure reason. Present on status=failed.
+
+:::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="sentAt"></a>11. Property `sentAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) When the send was attempted.
+
+| Property                                | Pattern | Type    | Deprecated | Definition | Title/Description |
+| --------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#sentAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#sentAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="sentAt__seconds"></a>11.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="sentAt__nanoseconds"></a>11.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+:::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="createdAt"></a>12. Property `createdAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) When the record was created.
+
+| Property                                | Pattern | Type    | Deprecated | Definition | Title/Description |
+| --------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#sentAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#sentAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="sentAt__seconds"></a>12.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="sentAt__nanoseconds"></a>12.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +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: 21
+sidebar_position: 22
 ---
 
 # 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-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +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: 20
+sidebar_position: 21
 ---
 
 # Order
@@ -1652,7 +1652,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-05-27 at 14:03:20 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 15:51:05 +0000
 
 ## Related Decisions
 

package/data/docs/models/sale.md

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