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

package/data/docs/models/event.md

@@ -0,0 +1,386 @@
+---
+title: "Event"
+sidebar_label: "Event"
+sidebar_position: 6
+---
+
+# Event
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": "bk_abc123def456",
+  "companyId": "comp_xyz789",
+  "name": "Amadou Diallo",
+  "description": null,
+  "location": null,
+  "startDate": "2026-02-15",
+  "endDate": "2026-02-20",
+  "status": "status",
+  "maxTickets": null,
+  "ticketsSold": 47,
+  "ticketsUsed": 12,
+  "ticketPrice": null,
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt",
+  "createdBy": null
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `name`](#name)
+- [4. Property `description`](#description)
+- [5. Property `location`](#location)
+- [6. Property `startDate`](#startDate)
+  - [6.1. Property `_seconds`](#startDate__seconds)
+  - [6.2. Property `_nanoseconds`](#startDate__nanoseconds)
+- [7. Property `endDate`](#endDate)
+  - [7.1. Property `firestore-timestamp`](#endDate_anyOf_i0)
+  - [7.2. Property `item 1`](#endDate_anyOf_i1)
+- [8. Property `status`](#status)
+- [9. Property `maxTickets`](#maxTickets)
+- [10. Property `ticketsSold`](#ticketsSold)
+- [11. Property `ticketsUsed`](#ticketsUsed)
+- [12. Property `ticketPrice`](#ticketPrice)
+- [13. Property `createdAt`](#createdAt)
+  - [13.1. Property `_seconds`](#startDate__seconds)
+  - [13.2. Property `_nanoseconds`](#startDate__nanoseconds)
+- [14. Property `updatedAt`](#updatedAt)
+  - [14.1. Property `_seconds`](#startDate__seconds)
+  - [14.2. Property `_nanoseconds`](#startDate__nanoseconds)
+- [15. Property `createdBy`](#createdBy)
+
+|                           |                     |
+| ------------------------- | ------------------- |
+| **Type**                  | `object`            |
+| **Required**              | No                  |
+| **Additional properties** | Not allowed         |
+| **Defined in**            | #/definitions/event |
+
+**Description:** Event model (D26, D32). Collection: companies/\{companyId\}/events/\{eventId\}. Mobile-only today; Dashboard in Wave 4.
+
+| Property                       | Pattern | Type             | Deprecated | Definition                           | Title/Description                                                                               |
+| ------------------------------ | ------- | ---------------- | ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |
+| + [id](#id )                   | No      | string           | No         | -                                    | (Read-only) Firestore document ID. Note: Event does not have a uid field.                       |
+| + [companyId](#companyId )     | No      | string           | No         | -                                    | (Immutable) FK → Company document ID. Scopes all queries.                                       |
+| + [name](#name )               | No      | string           | No         | -                                    | -                                                                                               |
+| - [description](#description ) | No      | string or null   | No         | -                                    | -                                                                                               |
+| - [location](#location )       | No      | string or null   | No         | -                                    | -                                                                                               |
+| + [startDate](#startDate )     | No      | object           | No         | In #/definitions/firestore-timestamp | Firestore Timestamp serialized representation                                                   |
+| - [endDate](#endDate )         | No      | Combination      | No         | -                                    | Firestore Timestamp serialized representation                                                   |
+| + [status](#status )           | No      | enum (of string) | No         | In #/definitions/event-status        | Event lifecycle status (D32). SCREAMING_SNAKE per D04. MIG-09 migrates legacy lowercase values. |
+| - [maxTickets](#maxTickets )   | No      | integer or null  | No         | -                                    | -                                                                                               |
+| + [ticketsSold](#ticketsSold ) | No      | integer          | No         | -                                    | (Read-only) Counter: total tickets sold. Updated by Firebase triggers (D28).                    |
+| + [ticketsUsed](#ticketsUsed ) | No      | integer          | No         | -                                    | (Read-only) Counter: tickets scanned/used. Updated by Firebase triggers (D28).                  |
+| - [ticketPrice](#ticketPrice ) | No      | number or null   | No         | -                                    | -                                                                                               |
+| + [createdAt](#createdAt )     | No      | object           | No         | In #/definitions/firestore-timestamp | (Read-only) Server-generated creation timestamp.                                                |
+| + [updatedAt](#updatedAt )     | No      | object           | No         | In #/definitions/firestore-timestamp | (Read-only) Server-generated update timestamp.                                                  |
+| - [createdBy](#createdBy )     | No      | string or null   | No         | -                                    | (Immutable) FK → User/staff UID who created this event.                                         |
+
+## <a name="id"></a>1. Property `id`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Read-only) Firestore document ID. Note: Event does not have a uid field.
+
+:::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. Scopes all queries.
+
+:::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="name"></a>3. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+## <a name="description"></a>4. Property `description`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+## <a name="location"></a>5. Property `location`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+## <a name="startDate"></a>6. Property `startDate`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** Firestore Timestamp serialized representation
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#startDate__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#startDate__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="startDate__seconds"></a>6.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="startDate__nanoseconds"></a>6.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="endDate"></a>7. Property `endDate`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** Firestore Timestamp serialized representation
+
+| Any of(Option)                           |
+| ---------------------------------------- |
+| [firestore-timestamp](#endDate_anyOf_i0) |
+| [item 1](#endDate_anyOf_i1)              |
+
+### <a name="endDate_anyOf_i0"></a>7.1. Property `firestore-timestamp`
+
+|                           |                         |
+| ------------------------- | ----------------------- |
+| **Type**                  | `object`                |
+| **Required**              | No                      |
+| **Additional properties** | Not allowed             |
+| **Same definition as**    | [startDate](#startDate) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="endDate_anyOf_i1"></a>7.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+## <a name="status"></a>8. Property `status`
+
+|                |                            |
+| -------------- | -------------------------- |
+| **Type**       | `enum (of string)`         |
+| **Required**   | Yes                        |
+| **Defined in** | #/definitions/event-status |
+
+**Description:** Event lifecycle status (D32). SCREAMING_SNAKE per D04. MIG-09 migrates legacy lowercase values.
+
+Must be one of:
+* "DRAFT"
+* "ACTIVE"
+* "CANCELLED"
+* "COMPLETED"
+
+## <a name="maxTickets"></a>9. Property `maxTickets`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `integer or null` |
+| **Required** | No                |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="ticketsSold"></a>10. Property `ticketsSold`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** (Read-only) Counter: total tickets sold. Updated by Firebase triggers (D28).
+
+| 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="ticketsUsed"></a>11. Property `ticketsUsed`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** (Read-only) Counter: tickets scanned/used. Updated by Firebase triggers (D28).
+
+| 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="ticketPrice"></a>12. Property `ticketPrice`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+## <a name="createdAt"></a>13. Property `createdAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) Server-generated creation timestamp.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#startDate__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#startDate__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="startDate__seconds"></a>13.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="startDate__nanoseconds"></a>13.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="updatedAt"></a>14. Property `updatedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) Server-generated update timestamp.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#startDate__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#startDate__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="startDate__seconds"></a>14.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="startDate__nanoseconds"></a>14.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="createdBy"></a>15. Property `createdBy`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Immutable) FK → User/staff UID who created this event.
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-06 at 19:27:48 +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.
+:::
+
+## Related Decisions
+
+| Decision | Title |
+|---|---|
+| **D26** | Event/Ticket support in dashboard |
+| **D28** | Firebase Event/Ticket triggers |