@ingenx-io/valets-schema-mcp-server 0.1.6 → 0.1.8

package/data/docs/models/whatsapp-inbound-message.md

@@ -0,0 +1,369 @@
+---
+title: "WhatsappInboundMessage"
+sidebar_label: "WhatsappInboundMessage"
+sidebar_position: 28
+---
+
+# WhatsappInboundMessage
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "wabaId": "wab_ref123",
+  "waba": "waba",
+  "messageId": "mes_ref123",
+  "from": "from",
+  "type": "phone",
+  "timestamp": "timestamp",
+  "receivedAt": "receivedAt",
+  "text": null,
+  "mediaId": null,
+  "caption": null,
+  "storageUrl": null,
+  "context": null
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `wabaId`](#wabaId)
+- [3. Property `waba`](#waba)
+- [4. Property `messageId`](#messageId)
+- [5. Property `from`](#from)
+- [6. Property `type`](#type)
+  - [6.1. Property `item 0`](#type_anyOf_i0)
+  - [6.2. Property `item 1`](#type_anyOf_i1)
+- [7. Property `timestamp`](#timestamp)
+  - [7.1. Property `_seconds`](#timestamp__seconds)
+  - [7.2. Property `_nanoseconds`](#timestamp__nanoseconds)
+- [8. Property `receivedAt`](#receivedAt)
+  - [8.1. Property `_seconds`](#timestamp__seconds)
+  - [8.2. Property `_nanoseconds`](#timestamp__nanoseconds)
+- [9. Property `text`](#text)
+- [10. Property `mediaId`](#mediaId)
+- [11. Property `caption`](#caption)
+- [12. Property `storageUrl`](#storageUrl)
+- [13. Property `context`](#context)
+  - [13.1. Property `id`](#context_id)
+  - [13.2. Property `from`](#context_from)
+  - [13.3. Property `forwarded`](#context_forwarded)
+
+|                           |                                        |
+| ------------------------- | -------------------------------------- |
+| **Type**                  | `object`                               |
+| **Required**              | No                                     |
+| **Additional properties** | Not allowed                            |
+| **Defined in**            | #/definitions/whatsapp-inbound-message |
+
+**Description:** WhatsappInboundMessage — inbound WhatsApp message persisted from Meta Cloud API webhook (GH#36). Collection: whatsapp_inbound_messages/\{docId\} in ratenplate project. Top-level scope: company resolution happens post-ingestion.
+
+| Property                     | Pattern | Type             | Deprecated | Definition                           | Title/Description                                                                                                           |
+| ---------------------------- | ------- | ---------------- | ---------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                 | No      | string or null   | No         | -                                    | (Read-only) Firestore document ID — wamid from Meta Cloud API.                                                              |
+| + [wabaId](#wabaId )         | No      | string           | No         | -                                    | (Immutable) Meta WABA ID identifying which business number received the message.                                            |
+| + [waba](#waba )             | No      | enum (of string) | No         | In #/definitions/waba-label          | (Immutable) Human-readable WABA label (cmz \| val). See WabaLabel enum.                                                     |
+| + [messageId](#messageId )   | No      | string           | No         | -                                    | (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the document ID.                                         |
+| + [from](#from )             | No      | string           | No         | -                                    | (Immutable) Sender phone number in E.164 format.                                                                            |
+| + [type](#type )             | No      | Combination      | No         | -                                    | (Immutable) Meta message type.                                                                                              |
+| + [timestamp](#timestamp )   | No      | object           | No         | In #/definitions/firestore-timestamp | (Immutable) Message timestamp as reported by Meta.                                                                          |
+| + [receivedAt](#receivedAt ) | No      | object           | No         | In #/definitions/firestore-timestamp | (Read-only) Server-side ingestion timestamp.                                                                                |
+| - [text](#text )             | No      | string or null   | No         | -                                    | Message body text. Present on type=text messages only.                                                                      |
+| - [mediaId](#mediaId )       | No      | string or null   | No         | -                                    | Meta media ID. Present on image, audio, video, document, sticker messages.                                                  |
+| - [caption](#caption )       | No      | string or null   | No         | -                                    | Media caption text. Present when the sender included a caption.                                                             |
+| - [storageUrl](#storageUrl ) | No      | string or null   | No         | -                                    | Durable Cloud Storage URL for the downloaded media binary. Present after the media has been fetched and stored server-side. |
+| - [context](#context )       | No      | object or null   | No         | -                                    | Reply/forward context. Present on replies and forwarded messages.                                                           |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID — wamid from Meta Cloud API.
+
+:::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="wabaId"></a>2. Property `wabaId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Meta WABA ID identifying which business number received the message.
+
+:::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="waba"></a>3. Property `waba`
+
+|                |                          |
+| -------------- | ------------------------ |
+| **Type**       | `enum (of string)`       |
+| **Required**   | Yes                      |
+| **Defined in** | #/definitions/waba-label |
+
+**Description:** (Immutable) Human-readable WABA label (cmz | val). See WabaLabel enum.
+
+Must be one of:
+* "cmz"
+* "val"
+
+:::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="messageId"></a>4. Property `messageId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the 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="from"></a>5. Property `from`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Sender phone number in E.164 format.
+
+:::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="type"></a>6. Property `type`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | Yes              |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Immutable) Meta message type.
+
+| Any of(Option)           |
+| ------------------------ |
+| [item 0](#type_anyOf_i0) |
+| [item 1](#type_anyOf_i1) |
+
+### <a name="type_anyOf_i0"></a>6.1. Property `item 0`
+
+|              |                    |
+| ------------ | ------------------ |
+| **Type**     | `enum (of string)` |
+| **Required** | No                 |
+
+Must be one of:
+* "text"
+* "image"
+* "audio"
+* "video"
+* "document"
+* "sticker"
+* "reaction"
+* "location"
+* "contacts"
+* "interactive"
+* "button"
+* "order"
+* "system"
+* "unsupported"
+
+### <a name="type_anyOf_i1"></a>6.2. Property `item 1`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+:::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="timestamp"></a>7. Property `timestamp`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Immutable) Message timestamp as reported by Meta.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#timestamp__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#timestamp__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="timestamp__seconds"></a>7.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="timestamp__nanoseconds"></a>7.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+:::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="receivedAt"></a>8. Property `receivedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) Server-side ingestion timestamp.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#timestamp__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#timestamp__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="timestamp__seconds"></a>8.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="timestamp__nanoseconds"></a>8.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="text"></a>9. Property `text`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Message body text. Present on type=text messages only.
+
+## <a name="mediaId"></a>10. Property `mediaId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Meta media ID. Present on image, audio, video, document, sticker messages.
+
+## <a name="caption"></a>11. Property `caption`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Media caption text. Present when the sender included a caption.
+
+## <a name="storageUrl"></a>12. Property `storageUrl`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Durable Cloud Storage URL for the downloaded media binary. Present after the media has been fetched and stored server-side.
+
+## <a name="context"></a>13. Property `context`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `object or null` |
+| **Required** | No               |
+
+**Description:** Reply/forward context. Present on replies and forwarded messages.
+
+| Property                           | Pattern | Type   | Deprecated | Definition | Title/Description                                        |
+| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------- |
+| - [id](#context_id )               | No      | string | No         | -          | wamid of the quoted/replied-to message.                  |
+| - [from](#context_from )           | No      | string | No         | -          | Sender phone number of the quoted message.               |
+| - [forwarded](#context_forwarded ) | No      | const  | No         | -          | Present (true) when Meta marks the message as forwarded. |
+
+### <a name="context_id"></a>13.1. Property `id`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** wamid of the quoted/replied-to message.
+
+### <a name="context_from"></a>13.2. Property `from`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Sender phone number of the quoted message.
+
+### <a name="context_forwarded"></a>13.3. Property `forwarded`
+
+|              |         |
+| ------------ | ------- |
+| **Type**     | `const` |
+| **Required** | No      |
+
+**Description:** Present (true) when Meta marks the message as forwarded.
+
+Specific value: `true`
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-15 at 17:25:23 +0000

package/data/static/llms.txt

@@ -4,7 +4,7 @@
 > Source of truth: Zod schemas in packages/schema/src/
 > All Firestore documents are scoped under companies/{companyId}/
 
-> Generated: 2026-05-05
+> Generated: 2026-05-15
 
 ---
 
@@ -94,6 +94,10 @@ Values: PENDING, IN_PROGRESS, COMPLETED, CANCELLED
 Event ticket status (D32). VALID = active and unused.
 Values: VALID, USED, CANCELLED
 
+### WabaLabel
+Human-readable WABA label identifying which Meta business number received the message (GH#36).
+Values: cmz, val
+
 ---
 
 ## Models
@@ -1468,6 +1472,44 @@ Example:
 }
 ```
 
+### WhatsappInboundMessage
+Fields: 13 (7 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID — wamid from Meta Cloud API. |
+| wabaId | string | yes | (Immutable) Meta WABA ID identifying which business number received the message. |
+| waba | WabaLabel | yes | (Immutable) Human-readable WABA label (cmz | val). See WabaLabel enum. |
+| messageId | string | yes | (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the document ID. |
+| from | string | yes | (Immutable) Sender phone number in E.164 format. |
+| type | any | yes | (Immutable) Meta message type. |
+| timestamp | FirestoreTimestamp | yes | (Immutable) Message timestamp as reported by Meta. |
+| receivedAt | FirestoreTimestamp | yes | (Read-only) Server-side ingestion timestamp. |
+| text | ['string', 'null'] | no | Message body text. Present on type=text messages only. |
+| mediaId | ['string', 'null'] | no | Meta media ID. Present on image, audio, video, document, sticker messages. |
+| caption | ['string', 'null'] | no | Media caption text. Present when the sender included a caption. |
+| storageUrl | ['string', 'null'] | no | Durable Cloud Storage URL for the downloaded media binary. Present after the media has been fetched and stored server-side. |
+| context | ['object', 'null'] | no | Reply/forward context. Present on replies and forwarded messages. |
+
+Example:
+```json
+{
+  "id": null,
+  "wabaId": "wab_ref123",
+  "waba": "waba",
+  "messageId": "mes_ref123",
+  "from": "from",
+  "type": "phone",
+  "timestamp": "timestamp",
+  "receivedAt": "receivedAt",
+  "text": null,
+  "mediaId": null,
+  "caption": null,
+  "storageUrl": null,
+  "context": null
+}
+```
+
 ---
 
 ## Proposed (Work In Progress)

package/data/static/openapi.yaml

@@ -235,6 +235,13 @@ components:
       - USED
       - CANCELLED
       description: Event ticket status (D32). VALID = active and unused.
+    WabaLabel:
+      type: string
+      enum:
+      - cmz
+      - val
+      description: Human-readable WABA label identifying which Meta business number
+        received the message (GH#36).
     FirestoreTimestamp:
       type: object
       properties:
@@ -4371,6 +4378,133 @@ components:
       description: Write payload for partial update (PATCH) of a Ticket document.
         All fields optional. Fields marked `readOnly` or `x-immutable` must not be
         sent.
+    WhatsappInboundMessage:
+      type: object
+      properties:
+        id:
+          readOnly: true
+          description: (Read-only) Firestore document ID — wamid from Meta Cloud API.
+          type:
+          - string
+          - 'null'
+        wabaId:
+          type: string
+          x-immutable: true
+          description: (Immutable) Meta WABA ID identifying which business number
+            received the message.
+        waba:
+          $ref: '#/components/schemas/WabaLabel'
+          description: (Immutable) Human-readable WABA label (cmz | val). See WabaLabel
+            enum.
+          x-immutable: true
+        messageId:
+          type: string
+          x-immutable: true
+          description: (Immutable) WhatsApp message ID (wamid) returned by Meta —
+            mirrors the document ID.
+        from:
+          type: string
+          x-immutable: true
+          description: (Immutable) Sender phone number in E.164 format.
+        type:
+          anyOf:
+          - type: string
+            enum:
+            - text
+            - image
+            - audio
+            - video
+            - document
+            - sticker
+            - reaction
+            - location
+            - contacts
+            - interactive
+            - button
+            - order
+            - system
+            - unsupported
+          - type: string
+          description: (Immutable) Meta message type.
+          x-immutable: true
+        timestamp:
+          $ref: '#/components/schemas/FirestoreTimestamp'
+          description: (Immutable) Message timestamp as reported by Meta.
+          x-immutable: true
+        receivedAt:
+          $ref: '#/components/schemas/FirestoreTimestamp'
+          description: (Read-only) Server-side ingestion timestamp.
+          readOnly: true
+        text:
+          description: Message body text. Present on type=text messages only.
+          type:
+          - string
+          - 'null'
+        mediaId:
+          description: Meta media ID. Present on image, audio, video, document, sticker
+            messages.
+          type:
+          - string
+          - 'null'
+        caption:
+          description: Media caption text. Present when the sender included a caption.
+          type:
+          - string
+          - 'null'
+        storageUrl:
+          description: Durable Cloud Storage URL for the downloaded media binary.
+            Present after the media has been fetched and stored server-side.
+          type:
+          - string
+          - 'null'
+        context:
+          description: Reply/forward context. Present on replies and forwarded messages.
+          type:
+          - object
+          - 'null'
+          properties:
+            id:
+              description: wamid of the quoted/replied-to message.
+              type: string
+            from:
+              description: Sender phone number of the quoted message.
+              type: string
+            forwarded:
+              description: Present (true) when Meta marks the message as forwarded.
+              type: boolean
+              const: true
+          additionalProperties: false
+      required:
+      - wabaId
+      - waba
+      - messageId
+      - from
+      - type
+      - timestamp
+      - receivedAt
+      additionalProperties: false
+      description: 'WhatsappInboundMessage — inbound WhatsApp message persisted from
+        Meta Cloud API webhook (GH#36). Collection: whatsapp_inbound_messages/{docId}
+        in ratenplate project. Top-level scope: company resolution happens post-ingestion.'
+    WhatsappInboundMessageCreate:
+      allOf:
+      - $ref: '#/components/schemas/WhatsappInboundMessage'
+      description: Write payload for creating a new WhatsappInboundMessage document.
+        Fields marked `readOnly` are server-set and must not be included. Fields marked
+        `x-immutable` may be set once at creation.
+      required:
+      - wabaId
+      - waba
+      - messageId
+      - from
+      - type
+      - timestamp
+    WhatsappInboundMessageUpdate:
+      allOf:
+      - $ref: '#/components/schemas/WhatsappInboundMessage'
+      description: Write payload for partial update (PATCH) of a WhatsappInboundMessage
+        document. All fields optional. Fields marked `readOnly` or `x-immutable` must
+        not be sent.
     PaymentSummary:
       type: object
       properties: